mandoc/man.7 - diff

Return to man.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/man.7 between version 1.38 and 1.39

version 1.38, 2009/10/18 19:00:57

version 1.39, 2009/10/19 07:44:30

Line 191 literal text.

Each

.Nm

document must contain contains at least the

.Sq TH

.Sx \&TH

macro describing the document's section and title. It may occur

anywhere in the document, although conventionally, it appears as the

first macro.

.Pp

Beyond

.Sq TH ,

.Sx \&TH ,

at least one macro or text node must appear in the document. Documents

are generally structured as follows:

.Bd -literal -offset indent

Line 244 Macros are one to three three characters in length and

control character ,

.Sq \&. ,

at the beginning of the line. An arbitrary amount of whitespace may

sit between the control character and the macro name. Thus,

sit between the control character and the macro name. Thus, the

.Sq .PP

following are equivalent:

and

.Bd -literal -offset indent

.Sq \&.\ \ \ PP

\&.PP

are equivalent.

\&.\ \ \ PP

.Ed

.Pp

The

Line 282 If a next-line macro is proceded by a block macro, it

Line 283 If a next-line macro is proceded by a block macro, it

.Pp

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

.It Em Macro Ta Em Arguments Ta Em Scope

.It B Ta n Ta next-line

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

.It BI Ta n Ta current

.It Sx \&BI Ta n Ta current

.It BR Ta n Ta current

.It Sx \&BR Ta n Ta current

.It DT Ta 0 Ta current

.It Sx \&DT Ta 0 Ta current

.It I Ta n Ta next-line

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

.It IB Ta n Ta current

.It Sx \&IB Ta n Ta current

.It IR Ta n Ta current

.It Sx \&IR Ta n Ta current

.It R Ta n Ta next-line

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

.It RB Ta n Ta current

.It Sx \&RB Ta n Ta current

.It RI Ta n Ta current

.It Sx \&RI Ta n Ta current

.It SB Ta n Ta next-line

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

.It SM Ta n Ta next-line

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

.It TH Ta >1, <6 Ta current

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

.It UC Ta n Ta current

.It Sx \&UC Ta n Ta current

.It br Ta 0 Ta current

.It Sx \&br Ta 0 Ta current

.It fi Ta 0 Ta current

.It Sx \&fi Ta 0 Ta current

.It i Ta n Ta current

.It Sx \&i Ta n Ta current

.It na Ta 0 Ta current

.It Sx \&na Ta 0 Ta current

.It nf Ta 0 Ta current

.It Sx \&nf Ta 0 Ta current

.It r Ta 0 Ta current

.It Sx \&r Ta 0 Ta current

.It sp Ta 1 Ta current

.It Sx \&sp Ta 1 Ta current

.El

.Pp

The

.Sq RS ,

.Sx \&RS ,

.Sq RE ,

.Sx \&RE ,

.Sq UC ,

.Sx \&UC ,

.Sq br ,

.Sx \&br ,

.Sq fi ,

.Sx \&fi ,

.Sq i ,

.Sx \&i ,

.Sq na ,

.Sx \&na ,

.Sq nf ,

.Sx \&nf ,

.Sq r ,

.Sx \&r ,

and

.Sq sp

.Sx \&sp

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

Line 335 subsequent block macro invocation.

Line 336 subsequent block macro invocation.

.Pp

The closure of body scope may be to the section, where a macro is closed

.Sq SH ;

.Sx \&SH ;

sub-section, closed by a section or

.Sq SS ;

.Sx \&SS ;

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

.Sq RE ;

.Sx \&RE ;

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

.Sq HP ,

.Sx \&HP ,

.Sq IP ,

.Sx \&IP ,

.Sq LP ,

.Sx \&LP ,

.Sq P ,

.Sx \&P ,

.Sq PP ,

.Sx \&PP ,

.Sq TP .

.Sx \&TP .

No closure refers to an explicit block closing macro.

.Pp

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

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

.It HP Ta <2 Ta current Ta paragraph

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

.It IP Ta <3 Ta current Ta paragraph

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

.It LP Ta 0 Ta current Ta paragraph

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

.It P Ta 0 Ta current Ta paragraph

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

.It PP Ta 0 Ta current Ta paragraph

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

.It RE Ta 0 Ta current Ta none

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

.It RS Ta 1 Ta current Ta part

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

.It SH Ta >0 Ta next-line Ta section

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

.It SS Ta >0 Ta next-line Ta sub-section

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

.It TP Ta n Ta next-line Ta paragraph

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

.El

.Pp

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

macros (excluding

.Sq DT ,

.Sx \&DT ,

.Sq TH ,

.Sx \&TH ,

.Sq UC ,

.Sx \&UC ,

.Sq br ,

.Sx \&br ,

.Sq na ,

.Sx \&na ,

.Sq sp ,

.Sx \&sp ,

.Sq nf ,

.Sx \&nf ,

and

.Sq fi ) .

.Sx \&fi ) .

.Sh REFERENCE

Line 384 This section is a canonical reference to all macros, a

Line 385 This section is a canonical reference to all macros, a

alphabetically. For the scoping of individual macros, see

.Sx MACRO SYNTAX .

.Bl -tag -width Ds

.Ss \&B

.It B

Text is rendered in bold face.

.It BI

.Ss \&BI

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

.Sq .BI this word and that

causes

Line 399 to render in bold face, while

and

.Sq that

render in italics. Whitespace between arguments is omitted in output.

.It BR

.Ss \&BR

Text is rendered alternately in bold face and roman (the default font).

Whitespace between arguments is omitted in output.

.It DT

.Ss \&DT

Has no effect. Included for compatibility.

.It HP

.Ss \&HP

Begin a paragraph whose initial output line is left-justified, but

subsequent output lines are indented, with the following syntax:

.Bd -literal -offset indent

Line 416 If scaling width

.Va width

is specified, it's saved for later paragraph left-margins; if

unspecified, the saved or default width is used.

.It I

.Ss \&I

Text is rendered in italics.

.It IB

.Ss \&IB

Text is rendered alternately in italics and bold face. Whitespace

between arguments is omitted in output.

.It IP

.Ss \&IP

Begin a paragraph with the following syntax:

.Bd -literal -offset indent

\&.IP [head [width]]

Line 429 Begin a paragraph with the following syntax:

.Pp

This follows the behaviour of the

.Sq TP

.Sx \&TP

except for the macro syntax (all arguments on the line, instead of

having next-line scope). If

.Va width

is specified, it's saved for later paragraph left-margins; if

unspecified, the saved or default width is used.

.It IR

.Ss \&IR

Text is rendered alternately in italics and roman (the default font).

Whitespace between arguments is omitted in output.

.It LP, P, PP

.Ss \&LP

Begin an undecorated paragraph. The scope of a paragraph is closed by a

subsequent paragraph, sub-section, section, or end of file. The saved

paragraph left-margin width is re-set to the default.

.It R

.Ss \&P

Synonym for

.Sx \&LP .

.Ss \&PP

Synonym for

.Sx \&LP .

.Ss \&R

Text is rendered in roman (the default font).

.It RB

.Ss \&RB

Text is rendered alternately in roman (the default font) and bold face.

Whitespace between arguments is omitted in output.

.It RE

.Ss \&RE

Explicitly close out the scope of a prior

.Sq RS .

.Sx \&RS .

.It RI

.Ss \&RI

Text is rendered alternately in roman (the default font) and italics.

Whitespace between arguments is omitted in output.

.It RS

.Ss \&RS

Begin a part setting the left margin. The left margin controls the

offset, following an initial indentation, to un-indented text such as

that of

.Sq PP .

.Sx \&PP .

A scaling width may be specified as following:

.Bd -literal -offset indent

\&.RS [width]

Line 467 A scaling width may be specified as following:

Line 473 A scaling width may be specified as following:

.Va width

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

.It SB

.Ss \&SB

Text is rendered in small size (one point smaller than the default font)

bold face.

.It SH

.Ss \&SH

Begin a section. The scope of a section is only closed by another

section or the end of file. The paragraph left-margin width is re-set

to the default.

.It SM

.Ss \&SM

Text is rendered in small size (one point smaller than the default

font).

.It SS

.Ss \&SS

Begin a sub-section. The scope of a sub-section is closed by a

subsequent sub-section, section, or end of file. The paragraph

left-margin width is re-set to the default.

.It TH

.Ss \&TH

Sets the title of the manual page with the following syntax:

.Bd -literal -offset indent

\&.TH title section [date [source [volume]]]

Line 503 The

Line 509 The

string specifies the organisation providing the utility. The

.Va volume

replaces the default rendered volume as dictated by the manual section.

.It TP

.Ss \&TP

Begin a paragraph where the head, if exceeding the indentation width, is

followed by a newline; if not, the body follows on the same line after a

buffer to the indentation width. Subsequent output lines are indented.

Line 519 If

Line 525 If

.Va width

is specified, it's saved for later paragraph left-margins; if

unspecified, the saved or default width is used.

.It UC

.Ss \&UC

Has no effect. Included for compatibility.

.It br

.Ss \&br

Breaks the current line. Consecutive invocations have no further effect.

.It fi

.Ss \&fi

End literal mode begun by

.Sq nf .

.Sx \&nf .

.It i

.Ss \&i

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

is italicised.

.It na

.Ss \&na

Don't align to the right margin.

.It nf

.Ss \&nf

Begin literal mode: all subsequent free-form lines have their end of

line boundaries preserved. May be ended by

.Sq fi .

.Sx \&fi .

.It r

.Ss \&r

Fonts and styles (bold face, italics) reset to roman (default font).

.It sp

.Ss \&sp

Insert n spaces, where n is the macro's positive numeric argument. If

0, this is equivalent to the

.Sq br

.Sx \&br

macro.

.El

.Sh COMPATIBILITY

CVSweb