version 1.216, 2012/08/29 23:38:50 |
version 1.224, 2013/12/31 23:29:41 |
|
|
.\" $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 657 for all other author listings. |
|
Line 658 for all other author listings. |
|
.Pp |
.Pp |
Examples: |
Examples: |
.Dl \&.An -nosplit |
.Dl \&.An -nosplit |
.Dl \&.An Kristaps Dzonsons \&Aq kristaps@bsd.lv |
.Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv |
.Ss \&Ao |
.Ss \&Ao |
Begin a block enclosed by angle brackets. |
Begin a block enclosed by angle brackets. |
Does not have any head arguments. |
Does not have any head arguments. |
Line 711 for fixed strings to be passed verbatim as arguments, |
|
Line 712 for fixed strings to be passed verbatim as arguments, |
|
or |
or |
.Sx \&Cm . |
.Sx \&Cm . |
.Ss \&At |
.Ss \&At |
Formats an AT&T version. |
Formats an |
|
.At |
|
version. |
Accepts one optional argument: |
Accepts one optional argument: |
.Pp |
.Pp |
.Bl -tag -width "v[1-7] | 32vX" -offset indent -compact |
.Bl -tag -width "v[1-7] | 32vX" -offset indent -compact |
|
|
See also |
See also |
.Sx \&Bro . |
.Sx \&Bro . |
.Ss \&Bsx |
.Ss \&Bsx |
Format the BSD/OS version provided as an argument, or a default value if |
Format the |
|
.Bsx |
|
version provided as an argument, or a default value if |
no argument is provided. |
no argument is provided. |
.Pp |
.Pp |
Examples: |
Examples: |
|
|
Prints |
Prints |
.Dq is currently in beta test. |
.Dq is currently in beta test. |
.Ss \&Bx |
.Ss \&Bx |
Format the BSD version provided as an argument, or a default value if no |
Format the |
|
.Bx |
|
version provided as an argument, or a default value if no |
argument is provided. |
argument is provided. |
.Pp |
.Pp |
Examples: |
Examples: |
|
|
.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 DragonFly BSD version provided as an argument, or a default |
Format the |
|
.Dx |
|
version provided as an argument, or a default |
value if no argument is provided. |
value if no argument is provided. |
.Pp |
.Pp |
Examples: |
Examples: |
|
|
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 1851 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 1902 Its syntax is as follows: |
|
Line 1931 Its syntax is as follows: |
|
.Pp |
.Pp |
Examples: |
Examples: |
.Dl \&.Mt discuss@manpages.bsd.lv |
.Dl \&.Mt discuss@manpages.bsd.lv |
|
.Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv |
.Ss \&Nd |
.Ss \&Nd |
A one line description of the manual's content. |
A one line description of the manual's content. |
This may only be invoked in the |
This may only be invoked in the |
Line 2083 This macro is obsolete and not implemented in |
|
Line 2113 This macro is obsolete and not implemented in |
|
.Xr mandoc 1 . |
.Xr mandoc 1 . |
.Pp |
.Pp |
Historical |
Historical |
.Xr mdoc 7 |
.Nm |
packages described it as |
packages described it as |
.Dq "old function type (FORTRAN)" . |
.Dq "old function type (FORTRAN)" . |
.Ss \&Ox |
.Ss \&Ox |
Line 2339 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 2347 The following standards are recognised: |
|
Line 2379 The following standards are recognised: |
|
.St -p1003.1b-93 |
.St -p1003.1b-93 |
.It \-p1003.1c-95 |
.It \-p1003.1c-95 |
.St -p1003.1c-95 |
.St -p1003.1c-95 |
|
.It \-p1003.1d-99 |
|
.St -p1003.1d-99 |
.It \-p1003.1g-2000 |
.It \-p1003.1g-2000 |
.St -p1003.1g-2000 |
.St -p1003.1g-2000 |
.It \-p1003.1i-95 |
.It \-p1003.1i-95 |
.St -p1003.1i-95 |
.St -p1003.1i-95 |
|
.It \-p1003.1j-2000 |
|
.St -p1003.1j-2000 |
|
.It \-p1003.1q-2000 |
|
.St -p1003.1q-2000 |
|
.It \-p1003.2 |
|
.St -p1003.2 |
.It \-p1003.2-92 |
.It \-p1003.2-92 |
.St -p1003.2-92 |
.St -p1003.2-92 |
.It \-p1003.2a-92 |
.It \-p1003.2a-92 |
.St -p1003.2a-92 |
.St -p1003.2a-92 |
.It \-p1387.2-95 |
|
.St -p1387.2-95 |
|
.It \-p1003.2 |
|
.St -p1003.2 |
|
.It \-p1387.2 |
.It \-p1387.2 |
.St -p1387.2 |
.St -p1387.2 |
|
.It \-p1387.2-95 |
|
.St -p1387.2-95 |
.It \-isoC |
.It \-isoC |
.St -isoC |
.St -isoC |
.It \-isoC-90 |
.It \-isoC-90 |
Line 2407 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 |
|
|
Prints out |
Prints out |
.Dq currently under development. |
.Dq currently under development. |
.Ss \&Ux |
.Ss \&Ux |
Format the UNIX name. |
Format the |
|
.Ux |
|
name. |
Accepts no argument. |
Accepts no argument. |
.Pp |
.Pp |
Examples: |
Examples: |
Line 2958 Manually switching the font using the |
|
Line 3000 Manually switching the font using the |
|
.Ql \ef |
.Ql \ef |
font escape sequences is never required. |
font escape sequences is never required. |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
This section documents compatibility between mandoc and other other |
This section documents compatibility between mandoc and other |
troff implementations, at this time limited to GNU troff |
troff implementations, at this time limited to GNU troff |
.Pq Qq groff . |
.Pq Qq groff . |
The term |
The term |
Line 3162 utility written by Kristaps Dzonsons appeared in |
|
Line 3204 utility written by Kristaps Dzonsons appeared in |
|
The |
The |
.Nm |
.Nm |
reference was written by |
reference was written by |
.An Kristaps Dzonsons , |
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . |
.Mt kristaps@bsd.lv . |
|