Aren
/
NetBSD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Sync mentioned section headers with mdoc.template; update descriptions of 

.Os and .Dt arguments to current practice; don't hardwire NetBSD version
name (was still at 1.4...).
This commit is contained in:
wiz 2002-01-12 02:25:32 +00:00
parent d0a7520fe5
commit 81cc127219
1 changed files with 24 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
share/man/man7/mdoc.samples.7
View File

@ -1,4 +1,4 @@
.\" $NetBSD: mdoc.samples.7,v 1.31 2001/07/08 06:23:15 blymn Exp $ .\" $NetBSD: mdoc.samples.7,v 1.32 2002/01/12 02:25:32 wiz Exp $
.\" .\"
.\" Copyright (c) 1990, 1993 .\" Copyright (c) 1990, 1993
.\" The Regents of the University of California. All rights reserved. .\" The Regents of the University of California. All rights reserved.
@ -449,16 +449,19 @@ template found in the file:
\&.\e" /usr/share/misc/mdoc.template: \&.\e" /usr/share/misc/mdoc.template:
\&.\e" The following six lines are required. \&.\e" The following six lines are required.
\&.Dd Month day, year \&.Dd Month day, year
\&.Os OPERATING_SYSTEM [version/release] \&.Os
\&.Dt DOCUMENT_TITLE [section number] [volume] \&.Dt DOCUMENT_TITLE SECTION_NUMBER [MACHINE]
\&.Sh NAME \&.Sh NAME
\&.\e" This next request is for sections 2 and 3 only; see next comment. \&.\e" This next request is for sections 2 and 3 only; see next comment.
\&.Sh LIBRARY \&.Sh LIBRARY
\&.Sh SYNOPSIS \&.Sh SYNOPSIS
\&.Sh DESCRIPTION \&.Sh DESCRIPTION
\&.\e" The following requests should be uncommented and \&.\e" The following requests should be uncommented and
\&.\e" used where appropriate. This next request is \&.\e" used where appropriate. This next request is for
\&.\e" for sections 2 and 3 function return values only. \&.\e" sections 1 and 8 exit statuses only.
\&.\e" .Sh EXIT STATUS
\&.\e" This next request is for sections 2 and 3 function return
\&.\e" values only.
\&.\e" .Sh RETURN VALUES \&.\e" .Sh RETURN VALUES
\&.\e" This next request is for sections 1, 6, 7 & 8 only \&.\e" This next request is for sections 1, 6, 7 & 8 only
\&.\e" .Sh ENVIRONMENT \&.\e" .Sh ENVIRONMENT
@ -466,7 +469,7 @@ template found in the file:
\&.\e" .Sh EXAMPLES \&.\e" .Sh EXAMPLES
\&.\e" This next request is for sections 1, 6, 7 & 8 only \&.\e" This next request is for sections 1, 6, 7 & 8 only
\&.\e" (command return values (to shell) and \&.\e" (command return values (to shell) and
\&.\e" fprintf/stderr type diagnostics) \&.\e" fprintf/stderr type diagnostics)
\&.\e" .Sh DIAGNOSTICS \&.\e" .Sh DIAGNOSTICS
\&.\e" The next request is for sections 2 and 3 error \&.\e" The next request is for sections 2 and 3 error
\&.\e" and signal handling only. \&.\e" and signal handling only.
@ -476,17 +479,18 @@ template found in the file:
\&.\e" .Sh HISTORY \&.\e" .Sh HISTORY
\&.\e" .Sh AUTHORS \&.\e" .Sh AUTHORS
\&.\e" .Sh BUGS \&.\e" .Sh BUGS
\&.\e" .Sh SECURITY CONSIDERATIONS
.Ed .Ed
.Pp .Pp
The first items in the template are the macros The first items in the template are the macros
.Pq Li \&.Dd , \&.Os , \&.Dt ; .Pq Li \&.Dd , \&.Os , \&.Dt ;
the document date, the document date,
the operating system the man page or subject source is developed the operating system the man page or subject source is developed
or modified for, or modified for (should have no argument by default),
and the man page title and the man page title
.Pq Em in upper case .Pq Em in upper case
along with the section of the manual the page along with the section of the manual the page
belongs in. belongs in, and optionally the machine if it is machine specific.
These macros identify the page, These macros identify the page,
and are discussed below in and are discussed below in
.Sx TITLE MACROS . .Sx TITLE MACROS .
@ -519,46 +523,21 @@ and the date of authorship.
These macros are one called once at the very beginning of the document These macros are one called once at the very beginning of the document
and are used to construct the headers and footers only. and are used to construct the headers and footers only.
.Bl -tag -width 6n .Bl -tag -width 6n
.It Li \&.Dt DOCUMENT_TITLE section# [volume] .It Li \&.Dt DOCUMENT_TITLE SECTION_NUMBER [MACHINE]
The document title is the The document title is the
subject of the man page and must be in subject of the man page and must be in
.Tn CAPITALS .Tn CAPITALS
due to troff due to troff
limitations. limitations.
The section number may be 1,\ ...,\ 9, The section number may be 1,\ ...,\ 9, and the machine should be the
and if it is specified, machine the man page is for (that is, the
the volume title may be omitted. .Nx
A volume title may be arbitrary or one of the following: port to which it applies).
.\" .Cl
.\" USD UNIX User's Supplementary Documents
.\" .Cl
.\" PS1 UNIX Programmer's Supplementary Documents
.Pp
.Bl -column SMM -offset indent -compact
.It Li AMD NetBSD Ancestral Manual Documents
.It Li SMM NetBSD System Manager's Manual
.It Li URM NetBSD Reference Manual
.It Li PRM NetBSD Programmer's Manual
.It Li KM NetBSD Kernel Manual
.El
.Pp
The default volume labeling is
.Li URM
for sections 1, 6, and 7;
.Li SMM
for section 8;
.Li PRM
for sections 2, 3, 4, and 5;
.Li KM
for section 9.
.\" .Cl
.\" MMI UNIX Manual Master Index
.\" .Cl
.\" CON UNIX Contributed Software Manual
.\" .Cl
.\" LOC UNIX Local Manual
.It Li \&.Os operating_system release# .It Li \&.Os operating_system release#
The name of the operating system This should have no argument on
.Nx
man pages by default.
Otherwise, the name of the operating system
should be the common acronym, e.g. should be the common acronym, e.g.
.Tn BSD .Tn BSD
or or
@ -577,9 +556,9 @@ or for a locally produced set
.Pp .Pp
The Berkeley default, The Berkeley default,
.Ql \&.Os .Ql \&.Os
without an argument, has been defined as without an argument, has been defined as the current
.Nx 1.4 .Nx
in the site specific file version, see
.Pa /usr/share/tmac/tmac.doc-common . .Pa /usr/share/tmac/tmac.doc-common .
Note, if the Note, if the
.Ql \&.Os .Ql \&.Os