mandoc/man.7 - diff

Return to man.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/man.7 between version 1.51 and 1.55

version 1.51, 2009/11/12 08:00:21

version 1.55, 2010/01/07 19:10:09

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

Line 118 A numerical representation 3, 2, or 1 (bold, italic, a

Line 110 A numerical representation 3, 2, or 1 (bold, italic, a

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 144 Both

Line 139 Both

.Sq \es

and

.Sq \ef

attributes are forgotten when exiting a subsequent (or current) macro

attributes are forgotten when entering or exiting a macro block.

invocation.

.Ss Whitespace

Line 301 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 316 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 367 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 510 sub-section, closed by a section or

Line 504 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 569 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 825 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 966 Insert vertical spaces into output with the following

Line 960 Insert vertical spaces into output with the following

.Op Cm height

.Ed

.Pp

Insert

.Cm height

spaces, which must conform to

.Sx Scaling Widths .

CVSweb