version 1.220, 2013/08/14 15:08:31 |
version 1.225, 2014/01/20 00:51:43 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2010, 2011, 2013 Ingo Schwarze <schwarze@openbsd.org> |
.\" |
.\" |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" purpose with or without fee is hereby granted, provided that the above |
Line 477 in the alphabetical |
|
Line 477 in the alphabetical |
|
.Bl -column "Brq, Bro, Brc" description |
.Bl -column "Brq, Bro, Brc" description |
.It Sx \&Lb Ta function library (one argument) |
.It Sx \&Lb Ta function library (one argument) |
.It Sx \&In Ta include file (one argument) |
.It Sx \&In Ta include file (one argument) |
|
.It Sx \&Fd Ta other preprocessor directive (>0 arguments) |
.It Sx \&Ft Ta function type (>0 arguments) |
.It Sx \&Ft Ta function type (>0 arguments) |
.It Sx \&Fo , \&Fc Ta function block: Ar funcname |
.It Sx \&Fo , \&Fc Ta function block: Ar funcname |
.It Sx \&Fn Ta function name: |
.It Sx \&Fn Ta function name: |
Line 1304 It should be capitalised. |
|
Line 1305 It should be capitalised. |
|
.It Ar section |
.It Ar section |
The manual section. |
The manual section. |
This may be one of |
This may be one of |
.Ar 1 |
.Cm 1 |
.Pq utilities , |
.Pq utilities , |
.Ar 2 |
.Cm 2 |
.Pq system calls , |
.Pq system calls , |
.Ar 3 |
.Cm 3 |
.Pq libraries , |
.Pq libraries , |
.Ar 3p |
.Cm 3p |
.Pq Perl libraries , |
.Pq Perl libraries , |
.Ar 4 |
.Cm 4 |
.Pq devices , |
.Pq devices , |
.Ar 5 |
.Cm 5 |
.Pq file formats , |
.Pq file formats , |
.Ar 6 |
.Cm 6 |
.Pq games , |
.Pq games , |
.Ar 7 |
.Cm 7 |
.Pq miscellaneous , |
.Pq miscellaneous , |
.Ar 8 |
.Cm 8 |
.Pq system utilities , |
.Pq system utilities , |
.Ar 9 |
.Cm 9 |
.Pq kernel functions , |
.Pq kernel functions , |
.Ar X11 |
.Cm X11 |
.Pq X Window System , |
.Pq X Window System , |
.Ar X11R6 |
.Cm X11R6 |
.Pq X Window System , |
.Pq X Window System , |
.Ar unass |
.Cm unass |
.Pq unassociated , |
.Pq unassociated , |
.Ar local |
.Cm local |
.Pq local system , |
.Pq local system , |
.Ar draft |
.Cm draft |
.Pq draft manual , |
.Pq draft manual , |
or |
or |
.Ar paper |
.Cm paper |
.Pq paper . |
.Pq paper . |
It should correspond to the manual's filename suffix and defaults to |
It should correspond to the manual's filename suffix and defaults to |
.Dq 1 |
.Cm 1 |
if unspecified. |
if unspecified. |
.It Ar volume |
.It Ar volume |
This overrides the volume inferred from |
This overrides the volume inferred from |
.Ar section . |
.Ar section . |
This field is optional, and if specified, must be one of |
This field is optional, and if specified, must be one of |
.Ar USD |
.Cm USD |
.Pq users' supplementary documents , |
.Pq users' supplementary documents , |
.Ar PS1 |
.Cm PS1 |
.Pq programmers' supplementary documents , |
.Pq programmers' supplementary documents , |
.Ar AMD |
.Cm AMD |
.Pq administrators' supplementary documents , |
.Pq administrators' supplementary documents , |
.Ar SMM |
.Cm SMM |
.Pq system managers' manuals , |
.Pq system managers' manuals , |
.Ar URM |
.Cm URM |
.Pq users' reference manuals , |
.Pq users' reference manuals , |
.Ar PRM |
.Cm PRM |
.Pq programmers' reference manuals , |
.Pq programmers' reference manuals , |
.Ar KM |
.Cm KM |
.Pq kernel manuals , |
.Pq kernel manuals , |
.Ar IND |
.Cm IND |
.Pq master index , |
.Pq master index , |
.Ar MMI |
.Cm MMI |
.Pq master index , |
.Pq master index , |
.Ar LOCAL |
.Cm LOCAL |
.Pq local manuals , |
.Pq local manuals , |
.Ar LOC |
.Cm LOC |
.Pq local manuals , |
.Pq local manuals , |
or |
or |
.Ar CON |
.Cm CON |
.Pq contributed manuals . |
.Pq contributed manuals . |
.It Ar arch |
.It Ar arch |
This specifies the machine architecture a manual page applies to, |
This specifies the machine architecture a manual page applies to, |
|
|
.Sx \&Er |
.Sx \&Er |
and |
and |
.Sx \&Ev |
.Sx \&Ev |
for special-purpose constants and |
for special-purpose constants, |
.Sx \&Va |
.Sx \&Va |
for variable symbols. |
for variable symbols, and |
|
.Sx \&Fd |
|
for listing preprocessor variable definitions in the |
|
.Em SYNOPSIS . |
.Ss \&Dx |
.Ss \&Dx |
Format the |
Format the |
.Dx |
.Dx |
|
|
End a function context started by |
End a function context started by |
.Sx \&Fo . |
.Sx \&Fo . |
.Ss \&Fd |
.Ss \&Fd |
Historically used to document include files. |
Preprocessor directive, in particular for listing it in the |
This usage has been deprecated in favour of |
.Em SYNOPSIS . |
|
Historically, it was also used to document include files. |
|
The latter usage has been deprecated in favour of |
.Sx \&In . |
.Sx \&In . |
Do not use this macro. |
|
.Pp |
.Pp |
|
Its syntax is as follows: |
|
.Bd -ragged -offset indent |
|
.Pf \. Sx \&Fd |
|
.Li # Ns Ar directive |
|
.Op Ar argument ... |
|
.Ed |
|
.Pp |
|
Examples: |
|
.Dl \&.Fd #define sa_handler __sigaction_u.__sa_handler |
|
.Dl \&.Fd #define SIO_MAXNFDS |
|
.Dl \&.Fd #ifdef FS_DEBUG |
|
.Dl \&.Ft void |
|
.Dl \&.Fn dbg_open \(dqconst char *\(dq |
|
.Dl \&.Fd #endif |
|
.Pp |
See also |
See also |
.Sx MANUAL STRUCTURE |
.Sx MANUAL STRUCTURE , |
|
.Sx \&In , |
and |
and |
.Sx \&In . |
.Sx \&Dv . |
.Ss \&Fl |
.Ss \&Fl |
Command-line flag or option. |
Command-line flag or option. |
Used when listing arguments to command-line utilities. |
Used when listing arguments to command-line utilities. |
Line 1859 section as described in |
|
Line 1880 section as described in |
|
.Pp |
.Pp |
Examples: |
Examples: |
.Dl \&.Lb libz |
.Dl \&.Lb libz |
.Dl \&.Lb mdoc |
.Dl \&.Lb libmandoc |
.Ss \&Li |
.Ss \&Li |
Denotes text that should be in a |
Denotes text that should be in a |
.Li literal |
.Li literal |
Line 2348 The following standards are recognised: |
|
Line 2369 The following standards are recognised: |
|
.St -p1003.1-2004 |
.St -p1003.1-2004 |
.It \-p1003.1-2008 |
.It \-p1003.1-2008 |
.St -p1003.1-2008 |
.St -p1003.1-2008 |
|
.It \-p1003.1-2013 |
|
.St -p1003.1-2013 |
.It \-p1003.1 |
.It \-p1003.1 |
.St -p1003.1 |
.St -p1003.1 |
.It \-p1003.1b |
.It \-p1003.1b |
Line 2422 The following standards are recognised: |
|
Line 2445 The following standards are recognised: |
|
.St -xbd5 |
.St -xbd5 |
.It \-xcu5 |
.It \-xcu5 |
.St -xcu5 |
.St -xcu5 |
|
.It \-xsh4.2 |
|
.St -xsh4.2 |
.It \-xsh5 |
.It \-xsh5 |
.St -xsh5 |
.St -xsh5 |
.It \-xns5 |
.It \-xns5 |
Line 3120 The following features are unimplemented in mandoc: |
|
Line 3145 The following features are unimplemented in mandoc: |
|
.Fl file Ar file . |
.Fl file Ar file . |
.It |
.It |
.Sx \&Bd |
.Sx \&Bd |
.Fl offset Ar center |
.Fl offset Cm center |
and |
and |
.Fl offset Ar right . |
.Fl offset Cm right . |
Groff does not implement centred and flush-right rendering either, |
Groff does not implement centred and flush-right rendering either, |
but produces large indentations. |
but produces large indentations. |
.It |
.It |