Date: Thu, 3 Dec 1998 06:30:52 +0900 (JST) From: =?ISO-2022-JP?B?GyRCNmJFRDlAO0obKEI=?= <vanitas@ma3.seikyou.ne.jp> To: FreeBSD-gnats-submit@FreeBSD.ORG Cc: vanitas@ma3.seikyou.ne.jp Subject: docs/8942: [send-pr] doc bugs in mdoc.samples.7 Message-ID: <199812022130.GAA00263@hiloshi.seikyou.ne.jp>
next in thread | raw e-mail | index | archive | help
>Number: 8942 >Category: docs >Synopsis: doc bugs in mdoc.samples.7 >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: doc-bug >Submitter-Id: current-users >Arrival-Date: Wed Dec 2 13:40:00 PST 1998 >Last-Modified: >Originator: Kaneda Hiloshi >Organization: FreeBSD jp-man project >Release: FreeBSD 2.2.1-RELEASE i386 >Environment: http://www.freebsd.org/cgi/cvsweb.cgi/src/share/man/man7/mdoc.samples.7?rev=1.4.2.7 @(#)mdoc.samples.7 8.2 (Berkeley) 12/30/93 >Description: PROBLEMS (on each line number): (a) 169: This list shows "Extended Arguments" subsection before "No-Op or Normal Text Macro" subsection, but it really comes after "Trade Names" subsection. (b) 397: `*char' would be `char'. (c) 824, 826, 857, 878, 883, 1561, 1681, 1683, 2003: Only these macros are not quoted although they are within text. (d) 1173: `page break' would be `line break'. (e) 1929-1933: It says, "See the EXAMPLES section below for details." But the ``EXAMPLES'' section is missing. Perhaps ``Examples and Displays'' section on the line 2164...? (f) 1996-1998: It says, "for example, this section was set with: .Sh PAGE LAYOUT MACROS." But in fact it is set with ``.Sh PAGE STRUCTURE DOMAIN'' on the line 1794. (g) 2144: `.Bl' must be `.Bk'. (h) 2529: It says, "Here is a hanged list with just one item:" The list really has two itmes. >How-To-Repeat: man 7 mdoc.samples >Fix: (a) move the line 169 to 176. (b) *char -> char (c) .Li -> .Ql (d) page -> line (e) I'm not sure. (f) PAGE LAYOUT MACROS -> PAGE STRUCTURE DOMAIN (g) .Bl -> .Bk (h) with just one item -> with two items To fix problems other than (e), apply the following patch: --- mdoc.samples.7.orig Thu Dec 3 04:34:14 1998 +++ mdoc.samples.7 Thu Dec 3 05:21:15 1998 @@ -166,13 +166,13 @@ .It "Single Quotes/Enclosure" . .It "Prefix Macro" . .El -.It "Extended Arguments" . .It "No\-Op or Normal Text Macro" . .It "No Space Macro" . .It "Section Cross References" . .It "References and Citations" . .It "Return Values (sections two and three only)" .It "Trade Names (Acronyms and Type Names)" . +.It "Extended Arguments" . .El .It .Tn "PAGE STRUCTURE DOMAIN" @@ -394,7 +394,7 @@ .Ql \&.Fn fetch char\e *str .It Fn fetch "char *str" can also be created by -.Ql \&.Fn fetch "\\*q*char *str\\*q" +.Ql \&.Fn fetch "\\*qchar *str\\*q" .El .Pp If the @@ -821,9 +821,9 @@ .El .Pp It is an error to call -.Li \&.Ad +.Ql \&.Ad without arguments. -.Li \&.Ad +.Ql \&.Ad is callable by other macros and is parsed. .Ss Author Name The @@ -854,7 +854,7 @@ any arguments. .Ss Argument Macro The -.Li \&.Ar +.Ql \&.Ar argument macro may be used whenever a command line argument is referenced. .Pp @@ -875,12 +875,12 @@ .El .Pp If -.Li \&.Ar +.Ql \&.Ar is called without arguments .Ql Ar is assumed. The -.Li \&.Ar +.Ql \&.Ar macro is parsed and is callable. .Ss Configuration Declaration (section four only) The @@ -1170,7 +1170,7 @@ is to present the function type in kernel normal form for the .Sx SYNOPSIS of sections two and three -(it causes a page break allowing the function name to appear +(it causes a line break allowing the function name to appear on the next line). .Pp .Dl Usage: .Ft type ... \*(Pu @@ -1558,7 +1558,7 @@ macro usage at its worst. .Ss No\-Op or Normal Text Macro The macro -.Li \&.No +.Ql \&.No is a hack for words in a macro command line which should .Em not @@ -1678,9 +1678,9 @@ is parsed and is callable by other macros. .Ss Extended Arguments The -.Li \&.Xo +.Ql \&.Xo and -.Li \&.Xc +.Ql \&.Xc macros allow one to extend an argument list on a macro boundary. Argument lists cannot @@ -1995,12 +1995,14 @@ sections may be added, for example, this section was set with: .Bd -literal -offset 14n -\&.Sh PAGE LAYOUT MACROS +\&.Sh PAGE STRUCTURE DOMAIN .Ed .Ss Paragraphs and Line Spacing. .Bl -tag -width 6n .It \&.Pp -The \&.Pp paragraph command may +The +.Ql \&.Pp +paragraph command may be used to specify a line space where necessary. The macro is not necessary after a .Ql \&.Sh @@ -2141,7 +2143,7 @@ .Ql \&.Ek (end-keep). The only option that -.Ql \&.Bl +.Ql \&.Bk accepts is .Fl words and is useful for preventing line breaks in the middle of options. @@ -2526,7 +2528,7 @@ \&.El .Ed .Pp -Here is a hanged list with just one item: +Here is a hanged list with two items: .Bl -hang -offset indent .It Em Hanged labels appear similar to tagged lists when the >Audit-Trail: >Unformatted: To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?199812022130.GAA00263>