mandoc/mdoc.7 - diff

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.80 and 1.87

version 1.80, 2010/01/01 16:27:32

version 1.87, 2010/03/31 07:13:53

Line 132 and

Terms may be text-decorated using the

.Sq \ef

escape followed by an indicator: B (bold), I, (italic), R (Roman), or P

(revert to previous mode):

.Pp

.D1 \efBbold\efR \efIitalic\efP

.Pp

Line 170 for arbitrary-digit numerals:

.D1 \es+(10much bigger\es-(10

.D1 \es+'100'much much bigger\es-'100'

.Pp

Note these forms are

.Em not

recommended for

.Nm ,

which encourages semantic annotation.

.Ss Predefined Strings

Historically,

.Xr groff 1

also defined a set of package-specific

.Dq predefined strings ,

which, like

.Sx Special Characters ,

demark special output characters and strings by way of input codes.

Predefined strings are escaped with the slash-asterisk,

Line 343 and

.Sx \&Os

macros, is required for every document.

.Pp

The first section (sections are denoted by

.Sx \&Sh )

must be the NAME section, consisting of at least one

.Sx \&Nm

Line 420 macro(s) must precede the

.Sx \&Nd

macro.

.Pp

See

.Sx \&Nm

and

.Sx \&Nd .

Line 438 See

.It Em SYNOPSIS

Documents the utility invocation syntax, function call syntax, or device

configuration.

.Pp

For the first, utilities (sections 1, 6, and 8), this is

generally structured as follows:

Line 469 And for the third, configurations (section 4):

\&.Cd \*qit* at isa? port 0x4e\*q

.Ed

.Pp

Manuals not in these sections generally don't need a

.Em SYNOPSIS .

.Pp

See

.Sx \&Op ,

.Sx \&Cd ,

.Sx \&Fn ,

Line 481 and

.Sx \&Vt .

.It Em DESCRIPTION

This expands upon the brief, one-line description in

.Em NAME .

It usually contains a break-down of the options (if documenting a

command), such as:

Line 683 All macros have bodies; some

don't have heads; only one

.Po

.Sx \&It Fl column

.Pc

has multiple heads.

.Bd -literal -offset indent

\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB

Line 770 or end of line.

.It Sx \&Ql Ta Yes Ta Yes

.It Sx \&Qq Ta Yes Ta Yes

.It Sx \&Sq Ta Yes Ta Yes

.It Sx \&Vt Ta Yes Ta Yes

.El

.Pp

Note that the

.Sx \&Vt

macro is a

.Sx Block partial-implicit

only when invoked as the first macro

in a SYNOPSIS section line, else it is

.Sx In-line .

.Ss In-line

Line 863 then the macro accepts an arbitrary number of argument

Line 872 then the macro accepts an arbitrary number of argument

.It Sx \&Ux Ta Yes Ta Yes Ta n

.It Sx \&Va Ta Yes Ta Yes Ta n

.It Sx \&Vt Ta Yes Ta Yes Ta >0

.It Sx \&Xr Ta Yes Ta Yes Ta >0, <3

.It Sx \&Xr Ta Yes Ta Yes Ta >0

.It Sx \&br Ta \&No Ta \&No Ta 0

.It Sx \&sp Ta \&No Ta \&No Ta 1

.El

.Sh REFERENCE

Line 1026 a function:

Line 1035 a function:

.Ed

.Ss \&Aq

Encloses its arguments in angled brackets.

.Pp

Examples:

.Bd -literal -offset indent

Line 1073 Note that these parameters do not begin with a hyphen.

Line 1082 Note that these parameters do not begin with a hyphen.

.Pp

Examples:

.Bd -literal -offset indent

\&.At

\&.At V.1

.Ed

.Pp

Line 1242 See also

Line 1251 See also

.Sx \&Bq .

.Ss \&Bq

Encloses its arguments in square brackets.

.Pp

Examples:

.Bd -literal -offset indent

Line 1389 manual. Its calling syntax is as follows:

Line 1398 manual. Its calling syntax is as follows:

.Pp

.D1 \. Ns Sx \&Dd Cm date

.Pp

The

.Cm date

field may be either

.Ar $\&Mdocdate$ ,

Line 1438 See also

Line 1447 See also

.Sx \&Dq .

.Ss \&Dq

Encloses its arguments in double quotes.

.Pp

Examples:

.Bd -literal -offset indent

Line 1544 subsequent that. It, too, is optional. It must be on

Line 1553 subsequent that. It, too, is optional. It must be on

.Ar hppa64 ,

.Ar i386 ,

.Ar landisk ,

.Ar loongson ,

.Ar luna88k ,

.Ar mac68k ,

.Ar macppc ,

Line 1892 and

Line 1902 and

.Ss \&Va

.Ss \&Vt

A variable type. This is also used for indicating global variables in the

SYNOPSIS section, in which case a variable name is also specified. Note that

it accepts

.Sx Block partial-implicit

syntax when invoked as the first macro in the SYNOPSIS section, else it

accepts ordinary

.Sx In-line

syntax.

.Pp

Note that this should not be confused with

.Sx \&Ft ,

which is used for function return types.

.Pp

Examples:

.Bd -literal -offset indent

\&.Vt unsigned char

\&.Vt extern const char * const sys_signame[] ;

.Ed

.Pp