diff options
author | ru <ru@FreeBSD.org> | 2001-07-18 10:04:34 +0000 |
---|---|---|
committer | ru <ru@FreeBSD.org> | 2001-07-18 10:04:34 +0000 |
commit | f24cad11ffba09a2fd48e40e9afb8b7f7453033c (patch) | |
tree | 7dc9663cd616b2208667d9155a0c11f4d6b1243f /share/examples/mdoc/example.1 | |
parent | 06fdcd5035e75a5e46d2049a186d4ceed2d03ece (diff) | |
download | FreeBSD-src-f24cad11ffba09a2fd48e40e9afb8b7f7453033c.zip FreeBSD-src-f24cad11ffba09a2fd48e40e9afb8b7f7453033c.tar.gz |
Removed the comment that required all FreeBSD manpages
to have the $FreeBSD$ keyword, as this is now enforced
by the CVSROOT/commit_prep.pl script.
Fold multi-word macro arguments into a single argument
by putting the surrounding double quotes - this speeds
up the -mdoc processing drastically (of course if used
systematically).
Use the new features of -mdoc: exact -width specifiers,
.In macro as an ``.Fd #include'' replacement.
Diffstat (limited to 'share/examples/mdoc/example.1')
-rw-r--r-- | share/examples/mdoc/example.1 | 33 |
1 files changed, 15 insertions, 18 deletions
diff --git a/share/examples/mdoc/example.1 b/share/examples/mdoc/example.1 index eb6d1bf..bba765e 100644 --- a/share/examples/mdoc/example.1 +++ b/share/examples/mdoc/example.1 @@ -23,9 +23,6 @@ .\" SUCH DAMAGE. .\" .\" $FreeBSD$ -.\" Note: All FreeBSD man pages should have a FreeBSD revision -.\" control id to make it easier for translation teams to track -.\" changes. .\" .\" Note: The date here should be updated whenever a non-trivial .\" change is made to the manual page. @@ -34,7 +31,7 @@ .Os .Sh NAME .Nm example -.Nd example command manual page +.Nd "example command manual page" .Sh SYNOPSIS .Nm .Op Fl abc @@ -48,7 +45,7 @@ It is intended that this example can be used as a template when writing a new manual page. .Pp The options are as follows: -.Bl -tag -width Fl +.Bl -tag -width ".Fl d Ar argument" .It Fl a Example optional .Fl a @@ -77,7 +74,7 @@ command ignores the .Ev EXAMPLE environment variable. .Sh FILES -.Bl -tag -width /dev/null -compact +.Bl -tag -width ".Pa /dev/null" -compact .It Pa /dev/null Example of a file in the .Sx FILES @@ -89,14 +86,14 @@ of the .Nm command: .Pp -.Dl % example -abc -d xyzzy /dev/null +.Dl "% example -abc -d xyzzy /dev/null" .Sh DIAGNOSTICS Exit status is 0 on success, and 1 if the command -fails for one of the following reasons +fails for one of the following reasons: .Bl -diag -.It example error message +.It "example error message" An example of an error message. -.It another example error message. +.It "another example error message." Self explanatory. .El .Sh COMPATIBILITY @@ -108,20 +105,20 @@ command has no known compatibility issues. .Xr example 4 , .Xr mdoc 7 .Rs -.%A A. B. Author -.%T Example RFC Title +.%A "A. B. Author" +.%T "Example RFC Title" .%O RFC0000 .Re .Rs -.%A A. B. Author -.%B Example Book Title +.%A "A. B. Author" +.%B "Example Book Title" .%O ISBN-0-000-00000-0 .Re .Rs -.%A A. B. Author -.%D January 1997 -.%J Example Journal Name -.%T Example Article Title +.%A "A. B. Author" +.%D "January 1997" +.%J "Example Journal Name" +.%T "Example Article Title" .Re .Sh STANDARDS If the command conforms to some standard, such as |