diff options
author | Jason McIntyre <jmc@cvs.openbsd.org> | 2004-02-20 10:34:42 +0000 |
---|---|---|
committer | Jason McIntyre <jmc@cvs.openbsd.org> | 2004-02-20 10:34:42 +0000 |
commit | ffb0004ce1dab7e03acda5777444f4c1c51b86a7 (patch) | |
tree | 120888c66afe4e4922302c3aa45dd32928d30258 /share/man/man7 | |
parent | 58cfb016091fc370fc698bb47d0d68f66cb4e3a4 (diff) |
- document .In, .Ex, and .Rv
- keep the description of .Cd on one line
- note that .Fd may be used w/ section 9 pages
Diffstat (limited to 'share/man/man7')
-rw-r--r-- | share/man/man7/mdoc.7 | 7 | ||||
-rw-r--r-- | share/man/man7/mdoc.samples.7 | 76 |
2 files changed, 78 insertions, 5 deletions
diff --git a/share/man/man7/mdoc.7 b/share/man/man7/mdoc.7 index 18cd190e099..f6555408720 100644 --- a/share/man/man7/mdoc.7 +++ b/share/man/man7/mdoc.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mdoc.7,v 1.31 2004/01/25 14:58:41 jmc Exp $ +.\" $OpenBSD: mdoc.7,v 1.32 2004/02/20 10:34:41 jmc Exp $ .\" .\" Copyright (c) 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -295,23 +295,26 @@ Produces .It Li \&Ad Ta Yes Ta Yes Ta Address. "(This macro may be deprecated.)" .It Li \&An Ta Yes Ta \&No Ta "Author name." .It Li \&Ar Ta Yes Ta Yes Ta "Command line argument." -.It Li \&Cd Ta \&No Ta \&No Ta "Configuration declaration (section four only)." +.It Li \&Cd Ta \&No Ta \&No Ta "Configuration declaration." .It Li \&Cm Ta Yes Ta Yes Ta "Command line argument modifier." .It Li \&Dv Ta Yes Ta Yes Ta "Defined variable (source code)." .It Li \&Er Ta Yes Ta Yes Ta "Error number (source code)." .It Li \&Ev Ta Yes Ta Yes Ta "Environment variable." +.It Li \&Ex Ta \&No Ta \&No Ta "Exit values." .It Li \&Fa Ta Yes Ta Yes Ta "Function argument." .It Li \&Fd Ta \&No Ta \&No Ta "Function declaration." .It Li \&Fl Ta Yes Ta Yes Ta "Flags." .It Li \&Fn Ta Yes Ta Yes Ta "Function call (also .Fo and .Fc)." .It Li \&Ft Ta Yes Ta Yes Ta "Function type." .It Li \&Ic Ta Yes Ta Yes Ta "Interactive command." +.It Li \&In Ta \&No Ta \&No Ta "Include header file." .It Li \&Li Ta Yes Ta Yes Ta "Literal text." .It Li \&Nd Ta \&No Ta \&No Ta "Command description." .It Li \&Nm Ta Yes Ta Yes Ta "Command name." .It Li \&Op Ta Yes Ta Yes Ta "Option (also .Oo and .Oc)." .It Li \&Ot Ta Yes Ta Yes Ta "Old style function type (Fortran only)." .It Li \&Pa Ta Yes Ta Yes Ta "Pathname or file name." +.It Li \&Rv Ta \&No Ta \&No Ta "Return values." .It Li \&St Ta Yes Ta Yes Ta "Standards (see below)." .It Li \&Va Ta Yes Ta Yes Ta "Variable name." .It Li \&Vt Ta Yes Ta Yes Ta "Variable type." diff --git a/share/man/man7/mdoc.samples.7 b/share/man/man7/mdoc.samples.7 index d34b85af33e..4996a510132 100644 --- a/share/man/man7/mdoc.samples.7 +++ b/share/man/man7/mdoc.samples.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mdoc.samples.7,v 1.51 2004/02/14 18:04:00 jmc Exp $ +.\" $OpenBSD: mdoc.samples.7,v 1.52 2004/02/20 10:34:41 jmc Exp $ .\" $NetBSD: mdoc.samples.7,v 1.5 1996/04/03 20:17:34 jtc Exp $ .\" .\" Copyright (c) 1990, 1993 @@ -142,16 +142,19 @@ outlined as follows: .It "Defined Variables" . .It "Environment Variables" . .It "Errno (section two only)" . +.It "Exit Values" . .It "Flags" . .It "Functions (library routines)" . .It "Function Argument" . .It "Function Declaration" . .It "Function Types" . .It "Interactive Commands" . +.It "Includes" . .It "Literals" . .It "Names" . .It "Options" . .It "Pathnames" . +.It "Return Values" . .It "Standards" . .It "Variables" . .It "Cross References" . @@ -1017,6 +1020,26 @@ without arguments. The .Ql \&.Er macro is parsed and is callable. +.Ss Exit Values (sections one, six, and eight only) +The +.Ql \&.Ex +macro displays a standardised text concerning the exit values of applications. +The +.Ql \&.Ex +macro does not call other macros and is not callable by other macros. +The +.Ql -std +flag is purely for compatibility purposes, and must be included. +.Pp +.Dl Usage: .Ex [-std] utility +.Pp +For example, +.Ql \&.Ex -std cat +produces: +.Pp +The +.Nm cat +utility exits 0 on success, and \*(Gt0 if an error occurs. .Ss Flags The .Ql \&.Fl @@ -1188,8 +1211,7 @@ The .Ql \&.Fd macro is used in the .Sx SYNOPSIS -section with section two or three -functions. +section with section two, three, and nine functions. The .Ql \&.Fd macro does not call other macros and is not callable by other @@ -1248,6 +1270,31 @@ without arguments. The .Ql \&.Ic macro is parsed and is callable. +.Ss Includes +The +.Ql \&.In +macro is used in the +.Sx SYNOPSIS +section with section two, three, and nine header files. +The +.Ql \&.In +macro does not call other macros and is not callable by other macros. +.Pp +.Dl Usage: .In include_file +.Bl -tag -width ".In stdio.h " -compact -offset 14n +.It Li \&.In stdio.h +.In stdio.h +.El +.Pp +In the +.Sx SYNOPSIS +section a +.Ql \&.In +request causes a line break if a function has already been presented +and a break has not occurred. +This leaves a nice vertical space +in between the previous function call and the declaration for the +include file. .Ss Literals The .Ql \&.Li @@ -1406,6 +1453,29 @@ macro formats path or file names. The .Ql \&.Pa macro is parsed and is callable. +.Ss Return Values (sections two and three only) +The +.Ql \&.Rv +macro displays a standardised text concerning the return values of functions. +The +.Ql \&.Rv +macro does not call other macros and is not callable by other macros. +The +.Ql -std +flag is purely for compatibility purposes, and must be included. +.Pp +.Dl Usage: .Rv [-std] function +.Pp +For example, +.Ql \&.Rv -std open +produces: +.Pp +The +.Fn open +function returns the value 0 if successful; +otherwise the value \-1 is returned and the global variable +.Va errno +is set to indicate the error. .Ss Standards The .Ql \&.St |