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.
This commit is contained in:
Ruslan Ermilov 2001-07-18 10:04:34 +00:00
parent 2f7538d646
commit d72ca9ddd1
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=79857
3 changed files with 36 additions and 45 deletions

View File

@ -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

View File

@ -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,12 +31,12 @@
.Os
.Sh NAME
.Nm example
.Nd example library function manual page
.Nd "example library function manual page"
.Sh LIBRARY
.\" Note: list of available libraries is available in mdoc(7)
.Lb libc
.Sh SYNOPSIS
.Fd #include <example.h>
.In example.h
.Ft int
.Fn example "char *ptr" "int mode"
.Sh DESCRIPTION
@ -58,7 +55,7 @@ and
The argument
.Fa mode
may have one of the following values:
.Bl -tag -width EXAMPLE_ONE
.Bl -tag -width ".Dv EXAMPLE_ONE"
.It Dv EXAMPLE_ONE
First example of a defined variable.
.Dv EXAMPLE_ONE
@ -67,7 +64,7 @@ is described below.
Second example.
.El
.Pp
The above value are defined in
The above values are defined in
.Aq Pa example.h
as follows:
.Bd -literal
@ -87,7 +84,7 @@ library function 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
@ -223,7 +220,7 @@ Socket is not connected.
.It Bq Er ESHUTDOWN
Cannot send after socket shutdown.
.It Bq Er ETOOMANYREFS
Too many references: cannot splice.
Too many references: cannot splice.
.It Bq Er ETIMEDOUT
Operation timed out.
.It Bq Er ECONNREFUSED
@ -274,20 +271,20 @@ Need authenticator.
.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

View File

@ -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,10 +31,10 @@
.Os
.Sh NAME
.Nm example
.Nd example device driver manual page
.Nd "example device driver manual page"
.Sh SYNOPSIS
.Cd device example
.Cd options EXAMPLE_DEBUG
.Cd "device example"
.Cd "options EXAMPLE_DEBUG"
.Sh DESCRIPTION
This is an example device driver manual page for the
.Nm
@ -48,7 +45,7 @@ when writing a new manual page.
The
.Nm
driver supports the following ioctls:
.Bl -tag -width XXXXXXXXXXX
.Bl -tag -width ".Dv EIOCNULL"
.It Dv EIOCEX
Example ioctl.
.It Dv EIOCNULL
@ -59,7 +56,7 @@ If the kernel is compiled with the
.Dv EXAMPLE_DEBUG
option, then additional debugging messages will be displayed.
.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
@ -67,9 +64,9 @@ section.
.El
.Sh DIAGNOSTICS
.Bl -diag
.It example%d: example diagnostic message.
.It "example%d: example diagnostic message."
An example of a diagnostic message.
.It example%d: another example diagnostic message.
.It "example%d: another example diagnostic message."
Self explanatory.
.El
.Sh SEE ALSO