mandoc/man.7 - diff

Return to man.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/man.7 between version 1.48 and 1.57

version 1.48, 2009/11/09 05:11:46

version 1.57, 2010/03/23 11:30:48

Line 67 line termination.

Blank lines are acceptable; where found, the output will assert a

vertical space.

.Pp

The

.Sq \ec

escape is common in historical

.Nm

documents; if encountered at the end of a word, it ensures that the

subsequent word isn't off-set by whitespace.

.Ss Comments

Text following a

.Sq \e\*" ,

Line 110 and

Line 102 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

A numerical representation 3, 2, or 1 (bold, italic, and Roman,

respectively) may be used instead.

respectively) may be used instead. A text decoration is only valid, if

specified in free-form text, until the next macro invocation; if

specified within a macro, it's only valid until the macro closes scope.

Note that macros like

.Sx \&BR

open and close a font scope with each argument.

.Pp

Text may also be sized with the

.Sq \es

Line 137 for arbitrary-digit numerals:

Line 134 for arbitrary-digit numerals:

.D1 \es[+10]much bigger\es[-10]

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

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

.Pp

Both

.Sq \es

and

.Sq \ef

attributes are forgotten when entering or exiting a macro block.

.Ss Whitespace

Line 292 the C library, this may be as follows:

Line 295 the C library, this may be as follows:

.D1 Standard C Library (libc, -lc)

.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 307 And for the third, configurations (section 4):

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

.Pp

.D1 \&.B name* at cardbus ? function ?

.Pp

Manuals not in these sections generally don't need a

.Em SYNOPSIS .

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

Line 358 Documents error handling in sections 2, 3, and 9.

Line 361 Documents error handling in sections 2, 3, and 9.

.It Em SEE ALSO

References other manuals with related topics. This section should exist

for most manuals.

.Pp

.D1 \&.BR bar \&( 1 \&),

.Pp

Line 420 subsequent lines until closed by another block macro.

Line 423 subsequent lines until closed by another block macro.

.Ss Line Macros

Line macros are generally scoped to the current line, with the body

consisting of zero or more arguments. If a macro is scoped to the next

line and the line arguments are empty, the next line is used instead,

line and the line arguments are empty, the next line, which must be

else the general syntax is used. Thus:

text, is used instead. Thus:

.Bd -literal -offset indent

\&.I

foo

Line 430 foo

Line 433 foo

.Pp

is equivalent to

.Sq \&.I foo .

If next-line macros are invoked consecutively, only the last is used; in

If next-line macros are invoked consecutively, only the last is used.

other words, if a next-line macro is preceded by a block macro, it is

If a next-line macro is followed by a non-next-line macro, an error is

ignored.

raised (unless in the case of

.Sx \&br ,

.Sx \&sp ,

.Sx \&Sp ,

.Sx \&na ) .

.Pp

The syntax is as follows:

.Bd -literal -offset indent

\&.YO \(lBbody...\(rB

\(lBbody...\(rB

.Ed

.Pp

.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX"

.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX"

.It Em Macro Ta Em Arguments Ta Em Scope

.It Em Macro Ta Em Arguments Ta Em Scope Ta Em Notes

.It Sx \&B Ta n Ta next-line

.It Sx \&B Ta n Ta next-line Ta \&

.It Sx \&BI Ta n Ta current

.It Sx \&BI Ta n Ta current Ta \&

.It Sx \&BR Ta n Ta current

.It Sx \&BR Ta n Ta current Ta \&

.It Sx \&DT Ta 0 Ta current

.It Sx \&DT Ta 0 Ta current Ta \&

.It Sx \&I Ta n Ta next-line

.It Sx \&I Ta n Ta next-line Ta \&

.It Sx \&IB Ta n Ta current

.It Sx \&IB Ta n Ta current Ta \&

.It Sx \&IR Ta n Ta current

.It Sx \&IR Ta n Ta current Ta \&

.It Sx \&PD Ta n Ta current

.It Sx \&PD Ta n Ta current Ta compat

.It Sx \&R Ta n Ta next-line

.It Sx \&R Ta n Ta next-line Ta \&

.It Sx \&RB Ta n Ta current

.It Sx \&RB Ta n Ta current Ta \&

.It Sx \&RI Ta n Ta current

.It Sx \&RI Ta n Ta current Ta \&

.It Sx \&SB Ta n Ta next-line

.It Sx \&SB Ta n Ta next-line Ta \&

.It Sx \&SM Ta n Ta next-line

.It Sx \&SM Ta n Ta next-line Ta \&

.It Sx \&TH Ta >1, <6 Ta current

.It Sx \&TH Ta >1, <6 Ta current Ta \&

.It Sx \&UC Ta n Ta current

.It Sx \&UC Ta n Ta current Ta compat

.It Sx \&br Ta 0 Ta current

.It Sx \&br Ta 0 Ta current Ta compat

.It Sx \&fi Ta 0 Ta current

.It Sx \&fi Ta 0 Ta current Ta compat

.It Sx \&i Ta n Ta current

.It Sx \&i Ta n Ta current Ta compat

.It Sx \&na Ta 0 Ta current

.It Sx \&na Ta 0 Ta current Ta compat

.It Sx \&nf Ta 0 Ta current

.It Sx \&nf Ta 0 Ta current Ta compat

.It Sx \&r Ta 0 Ta current

.It Sx \&r Ta 0 Ta current Ta compat

.It Sx \&sp Ta 1 Ta current

.It Sx \&sp Ta 1 Ta current Ta compat

.It Sx \&Sp Ta 0 Ta current Ta compat

.It Sx \&Vb Ta <1 Ta current Ta compat

.It Sx \&Ve Ta 0 Ta current Ta compat

.El

.Pp

The

Macros marked as

.Sx \&PD ,

.Qq compat

.Sx \&RS ,

are included for compatibility with the significant corpus of existing

.Sx \&RE ,

manuals that mix dialects of roff. These macros should not be used for

.Sx \&UC ,

portable manuals.

.Sx \&br ,

.Sx \&fi ,

.Sx \&i ,

.Sx \&na ,

.Sx \&nf ,

.Sx \&r ,

and

.Sx \&sp

macros should not be used. They're included for compatibility.

.Ss Block Macros

Block macros are comprised of a head and body. Like for in-line macros,

the head is scoped to the current line and, in one circumstance, the

next line; the body is scoped to subsequent lines and is closed out by a

next line (the next-line stipulations as in

subsequent block macro invocation.

.Sx Line Macros

apply here as well).

.Pp

The syntax is as follows:

.Bd -literal -offset indent

\&.YO \(lBhead...\(rB

\(lBhead...\(rB

Line 501 sub-section, closed by a section or

Line 508 sub-section, closed by a section or

.Sx \&SS ;

part, closed by a section, sub-section, or

.Sx \&RE ;

or paragraph, closed by a section, sub-section, part,

.Sx \&HP ,

.Sx \&IP ,

.Sx \&LP ,

Line 512 or

Line 519 or

No closure refers to an explicit block closing macro.

.Pp

.Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" -compact -offset indent

.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" "compatX"

.It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope

.It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope Ta Em Notes

.It Sx \&HP Ta <2 Ta current Ta paragraph

.It Sx \&HP Ta <2 Ta current Ta paragraph Ta \&

.It Sx \&IP Ta <3 Ta current Ta paragraph

.It Sx \&IP Ta <3 Ta current Ta paragraph Ta \&

.It Sx \&LP Ta 0 Ta current Ta paragraph

.It Sx \&LP Ta 0 Ta current Ta paragraph Ta \&

.It Sx \&P Ta 0 Ta current Ta paragraph

.It Sx \&P Ta 0 Ta current Ta paragraph Ta \&

.It Sx \&PP Ta 0 Ta current Ta paragraph

.It Sx \&PP Ta 0 Ta current Ta paragraph Ta \&

.It Sx \&RE Ta 0 Ta current Ta none

.It Sx \&RE Ta 0 Ta current Ta none Ta compat

.It Sx \&RS Ta 1 Ta current Ta part

.It Sx \&RS Ta 1 Ta current Ta part Ta compat

.It Sx \&SH Ta >0 Ta next-line Ta section

.It Sx \&SH Ta >0 Ta next-line Ta section Ta \&

.It Sx \&SS Ta >0 Ta next-line Ta sub-section

.It Sx \&SS Ta >0 Ta next-line Ta sub-section Ta \&

.It Sx \&TP Ta n Ta next-line Ta paragraph

.It Sx \&TP Ta n Ta next-line Ta paragraph Ta \&

.El

.Pp

Macros marked

.Qq compat

are as mentioned in

.Sx Line Macros .

.Pp

If a block macro is next-line scoped, it may only be followed by in-line

macros (excluding

macros for decorating text.

.Sx \&DT ,

.Sx \&PD ,

.Sx \&TH ,

.Sx \&UC ,

.Sx \&br ,

.Sx \&na ,

.Sx \&sp ,

.Sx \&nf ,

and

.Sx \&fi ) .

.Sh REFERENCE

Line 560 and

Line 563 and

.Ss \&BI

Text is rendered alternately in bold face and italic. Thus,

.Sq .BI this word and that

causes

.Sq this

and

.Sq and

to render in bold face, while

.Sq word

and

.Sq that

Line 816 The

Line 819 The

.Cm width

argument must conform to

.Sx Scaling Widths .

If not specified, the saved or default width is used.

.Ss \&SB

Line 916 End literal mode begun by

Line 919 End literal mode begun by

.Ss \&i

Italicise arguments. If no arguments are specified, all subsequent text

Italicise arguments. Synonym for

is italicised.

.Sx \&I .

.Pp