mandoc/mdoc.7 - diff

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.221 and 1.225

version 1.221, 2013/10/06 17:01:52

version 1.225, 2014/01/20 00:51:43

Line 1

.\" $Id$

.\"

.\" Permission to use, copy, modify, and distribute this software for any

.\" purpose with or without fee is hereby granted, provided that the above

Line 477 in the alphabetical

.Bl -column "Brq, Bro, Brc" description

.It Sx \&Lb Ta function library (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 \&Fo , \&Fc Ta function block: Ar funcname

.It Sx \&Fn Ta function name:

Line 1304 It should be capitalised.

Line 1305 It should be capitalised.

.It Ar section

The manual section.

This may be one of

.Ar 1

.Cm 1

.Pq utilities ,

.Ar 2

.Cm 2

.Pq system calls ,

.Ar 3

.Cm 3

.Pq libraries ,

.Ar 3p

.Cm 3p

.Pq Perl libraries ,

.Ar 4

.Cm 4

.Pq devices ,

.Ar 5

.Cm 5

.Pq file formats ,

.Ar 6

.Cm 6

.Pq games ,

.Ar 7

.Cm 7

.Pq miscellaneous ,

.Ar 8

.Cm 8

.Pq system utilities ,

.Ar 9

.Cm 9

.Pq kernel functions ,

.Ar X11

.Cm X11

.Pq X Window System ,

.Ar X11R6

.Cm X11R6

.Pq X Window System ,

.Ar unass

.Cm unass

.Pq unassociated ,

.Ar local

.Cm local

.Pq local system ,

.Ar draft

.Cm draft

.Pq draft manual ,

.Ar paper

.Cm paper

.Pq paper .

It should correspond to the manual's filename suffix and defaults to

.Dq 1

.Cm 1

if unspecified.

.It Ar volume

This overrides the volume inferred from

.Ar section .

This field is optional, and if specified, must be one of

.Ar USD

.Cm USD

.Pq users' supplementary documents ,

.Ar PS1

.Cm PS1

.Pq programmers' supplementary documents ,

.Ar AMD

.Cm AMD

.Pq administrators' supplementary documents ,

.Ar SMM

.Cm SMM

.Pq system managers' manuals ,

.Ar URM

.Cm URM

.Pq users' reference manuals ,

.Ar PRM

.Cm PRM

.Pq programmers' reference manuals ,

.Ar KM

.Cm KM

.Pq kernel manuals ,

.Ar IND

.Cm IND

.Pq master index ,

.Ar MMI

.Cm MMI

.Pq master index ,

.Ar LOCAL

.Cm LOCAL

.Pq local manuals ,

.Ar LOC

.Cm LOC

.Pq local manuals ,

.Ar CON

.Cm CON

.Pq contributed manuals .

.It Ar arch

This specifies the machine architecture a manual page applies to,

Line 1407 See also

Line 1408 See also

.Sx \&Er

and

.Sx \&Ev

for special-purpose constants and

for special-purpose constants,

.Sx \&Va

for variable symbols.

for variable symbols, and

.Sx \&Fd

for listing preprocessor variable definitions in the

.Em SYNOPSIS .

.Ss \&Dx

Format the

.Dx

Line 1570 See also

Line 1574 See also

End a function context started by

.Sx \&Fo .

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

Do not use this macro.

.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