summaryrefslogtreecommitdiffstats
path: root/share/man
diff options
context:
space:
mode:
authorjkoshy <jkoshy@FreeBSD.org>1998-12-03 03:38:45 +0000
committerjkoshy <jkoshy@FreeBSD.org>1998-12-03 03:38:45 +0000
commitdd093dc58135d9e5ecbcb9a6bcac72e6cbbb4022 (patch)
tree5742c3c5a4df8bb7ada65d03f34e2a3780f4e165 /share/man
parentd77705b6d872e99ed9c1fe6ed1a27d8678cf7117 (diff)
downloadFreeBSD-src-dd093dc58135d9e5ecbcb9a6bcac72e6cbbb4022.zip
FreeBSD-src-dd093dc58135d9e5ecbcb9a6bcac72e6cbbb4022.tar.gz
Fix bugs in mdoc.samples(7): clean up references, quote usage of macros,
correct typos. PR: docs/9942 Submitted by: vanitas@ma3.seikyou.ne.jp Reviewed by: jkoshy
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man7/mdoc.samples.744
1 files changed, 25 insertions, 19 deletions
diff --git a/share/man/man7/mdoc.samples.7 b/share/man/man7/mdoc.samples.7
index d8a9495..6de3323 100644
--- a/share/man/man7/mdoc.samples.7
+++ b/share/man/man7/mdoc.samples.7
@@ -30,7 +30,7 @@
.\" SUCH DAMAGE.
.\"
.\" @(#)mdoc.samples.7 8.2 (Berkeley) 12/30/93
-.\" $Id: mdoc.samples.7,v 1.15 1997/03/20 16:04:04 mpp Exp $
+.\" $Id: mdoc.samples.7,v 1.16 1997/12/08 07:44:20 charnier Exp $
.\"
.\" This tutorial sampler invokes every macro in the package several
.\" times and is guaranteed to give a worst case performance
@@ -120,7 +120,7 @@ outlined as follows:
.It "A manual page template" .
.El
.It
-.Tn "INTRODUCTION OF TITLE MACROS" .
+.Tn "TITLE MACROS" .
.It
.Tn "INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS" .
.Bl -tag -width flag -compact -offset indent
@@ -156,6 +156,7 @@ outlined as follows:
.Bl -tag -width flag -compact -offset indent
.It "AT&T Macro" .
.It "BSD Macro" .
+.It "FreeBSD Macro" .
.It "UNIX Macro" .
.It "Enclosure/Quoting Macros"
.Bl -tag -width flag -compact -offset indent
@@ -166,13 +167,13 @@ outlined as follows:
.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 +395,7 @@ is created by
.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
@@ -444,6 +445,7 @@ Several example man pages can also be found
in
.Pa /usr/share/examples/mdoc .
.Pp
+.Ss A manual page template
.Bd -literal -offset indent
\&.\e" The following requests are required for all man pages.
\&.Dd Month day, year
@@ -594,7 +596,7 @@ The date should be written formally:
.ne 5
.Dl January 25, 1989
.El
-.Sh MANUAL DOMAIN
+.Sh INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS
.Ss What's in a name...
The manual domain macro names are derived from the day to day
informal language used to describe commands, subroutines and related
@@ -802,6 +804,7 @@ escape them with
Typical syntax is shown in the first content macro displayed
below,
.Ql \&.Ad .
+.Sh MANUAL DOMAIN
.Ss Address Macro
The address macro identifies an address construct
of the form addr1[,addr2[,addr3]].
@@ -821,9 +824,9 @@ of the form addr1[,addr2[,addr3]].
.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 +857,7 @@ without
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 +878,12 @@ a command line argument is referenced.
.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 +1173,7 @@ anywhere else in the man page without problems, but its main purpose
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 +1561,7 @@ example of
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 +1681,9 @@ macro
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
@@ -1851,7 +1854,8 @@ name macro
.Ql \&.Nm
is required for sections 1, 5, 6, 7, 8.
Section 4 manuals require a
-.Ql ".Nm" , ".Fd"
+.Ql ".Nm" ,
+.Ql ".Fd"
or a
.Ql ".Cd"
configuration device usage macro.
@@ -1995,12 +1999,14 @@ User specified
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 +2147,7 @@ and
.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 +2532,7 @@ Here is the source text which produced the above example:
\&.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
OpenPOWER on IntegriCloud