mandoc/mdoc.7 - diff - 1.223

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.219 and 1.223

version 1.219, 2013/07/13 19:41:16

version 1.223, 2013/12/25 14:09:32

Line 1

Line 1

.\" $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 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

Line 1089 Examples:

Line 1092 Examples:

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:

Line 1109 and

Line 1114 and

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:

Line 1401 See also

Line 1408 See also

.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:

Line 1562 See also

Line 1574 See also

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 2414 The following standards are recognised:

Line 2443 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 2474 Examples:

Line 2505 Examples:

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: