diff options
| author |   jmc <jmc@openbsd.org> | 2003-05-29 08:46:22 +0000 |
|---|---|---|
| committer | jmc <jmc@openbsd.org> | 2003-05-29 08:46:22 +0000 |
| commit | f55d494c3f9c8a2977b4975e44eb55efce21044e (patch) | |
| tree | d3a977a00bc0591308a3f9c70be6540b744eeee9 /share/man/man7/mdoc.7 | |
| parent | use IN6_LINKMTU for IPv6 link MTU. sync w/kame (diff) | |
| download | wireguard-openbsd-f55d494c3f9c8a2977b4975e44eb55efce21044e.tar.xz wireguard-openbsd-f55d494c3f9c8a2977b4975e44eb55efce21044e.zip | |
sync docs to agree on section header (.Sh) order for man pages. This also
matches order used by NetBSD, though we don't use all their sections.
Order is:
NAME
SYNOPSIS
DESCRIPTION
RETURN VALUES
ENVIRONMENT
FILES
EXAMPLES
DIAGNOSTICS
ERRORS
SEE ALSO
STANDARDS
HISTORY
AUTHORS
CAVEATS
BUGS
ok krw@ millert@
Diffstat (limited to 'share/man/man7/mdoc.7')
| -rw-r--r-- | share/man/man7/mdoc.7 | 24 |
1 files changed, 11 insertions, 13 deletions
diff --git a/share/man/man7/mdoc.7 b/share/man/man7/mdoc.7 index 0a0d7741214..4917511ea2b 100644 --- a/share/man/man7/mdoc.7 +++ b/share/man/man7/mdoc.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mdoc.7,v 1.25 2003/04/13 11:06:21 jmc Exp $ +.\" $OpenBSD: mdoc.7,v 1.26 2003/05/29 08:46:22 jmc Exp $ .\" .\" Copyright (c) 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -102,33 +102,31 @@ All macros must be given an argument. .It Ar DESCRIPTION General description, including any options, operands, or other parameters. -.It Ar EXAMPLES -Examples and suggestions. .It Ar RETURN VALUES Sections two and three function calls. -.It Ar ERRORS -Sections two and three error and signal handling. -.It Ar DIAGNOSTICS -Section four device interface diagnostics. .It Ar ENVIRONMENT Describe environment variables. .It Ar FILES Files associated with the subject, with short descriptions. +.It Ar EXAMPLES +Examples and suggestions. +.It Ar DIAGNOSTICS +Section four device interface diagnostics. +.It Ar ERRORS +Sections two and three error and signal handling. .It Ar SEE ALSO Cross references and citations. -.It Ar COMPATIBILITY -Compatibility issues, i.e., deprecated options or parameters. .It Ar STANDARDS Conformance to standards if applicable. -.It Ar AUTHORS -Credit to the person or persons who wrote the code and/or documentation. .It Ar HISTORY A brief history of the subject, including where support first appeared. -.It Ar BUGS -Gotchas and caveats. +.It Ar AUTHORS +Credit to the person or persons who wrote the code and/or documentation. .It Ar CAVEATS Explanations of common misuses, i.e., security considerations for certain library functions. +.It Ar BUGS +Gotchas and caveats. .It Ar other Customized headers may be added at the author's discretion. .El |