mandoc/man.7 - diff

Return to man.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

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

version 1.35, 2009/08/21 12:12:12

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

Line 119 from input. These are later re-added, if applicable,

utility such as

.Xr mandoc 1 .

.Ss Scaling Widths

Many macros support scaled widths for their arguments, such as

stipulating a two-inch paragraph indentation with the following:

.Bd -literal -offset indent

\&.HP 2i

.Ed

.Pp

The syntax for scaled widths is

.Sq Li [+-]?[0-9]*.[0-9]*[:unit:]? ,

where a decimal must be preceded or proceeded by at least one digit.

Negative numbers, while accepted, are truncated to zero. The following

scaling units are accepted:

.Pp

.Bl -tag -width Ds -offset indent -compact

.It c

centimetre

.It i

inch

.It P

pica (~1/6 inch)

.It p

point (~1/72 inch)

.It f

synonym for

.Sq u

.It v

default vertical span

.It m

width of rendered

.Sq m

.Pq em

character

.It n

width of rendered

.Sq n

.Pq en

character

.It u

default horizontal span

.It M

mini-em (~1/100 em)

.El

.Pp

Using anything other than

.Sq m ,

.Sq n ,

.Sq u ,

.Sq v

is necessarily non-portable across output media. See

.Sx COMPATIBILITY .

.Pp

If a scaling unit is not provided, the numerical value is interpreted

under the default rules of

.Sq v

for vertical spaces and

.Sq u

for horizontal ones.

.Em Note :

this differs from

.Xr mdoc 7 ,

which, if a unit is not provided, will instead interpret the string as

literal text.

.Sh MANUAL STRUCTURE

Each

.Nm

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

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

.It SB Ta n Ta next-line

.It SM Ta n Ta next-line

.It TH Ta >1, <6 Ta current

.It UC Ta n Ta current

.It br Ta 0 Ta current

.It fi Ta 0 Ta current

.It i Ta n Ta current

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

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

The

.Sq RS ,

.Sq RE ,

.Sq UC ,

.Sq br ,

.Sq fi ,

.Sq i ,

Line 249 The

Line 318 The

.Sq r ,

and

.Sq sp

macros aren't historically part of

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

.Nm

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

.Ss Block Macros

Line 303 If a block macro is next-line scoped, it may only be f

Line 370 If a block macro is next-line scoped, it may only be f

macros (excluding

.Sq DT ,

.Sq TH ,

.Sq UC ,

.Sq br ,

.Sq na ,

.Sq sp ,

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

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

alphabetically. For the scoping of individual macros, see

.Sx MACRO SYNTAX .

.Ss Definitions

In this reference, a numerical width may be either a standalone natural

number (such as 3, 4, 10, etc.) or a natural number followed by a width

multiplier

.Qq n ,

corresponding to the width of the formatted letter n, or

.Qq m ,

corresponding to the width of the formatted letter m. The latter is the

default, if unspecified. Thus,

.Bd -literal -offset indent

\&.HP 12n

.Ed

.Pp

indicates an offset of 12

.Qq n

.Ns -sized

letters.

.Ss Macro Reference

.Bl -tag -width Ds

.It B

Text is rendered in bold face.

Line 357 render in italics. Whitespace between arguments is om

Line 403 render in italics. Whitespace between arguments is om

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

Whitespace between arguments is omitted in output.

.It DT

Re-set the tab spacing to 0.5 inches.

Has no effect. Included for compatibility.

.It HP

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

subsequent output lines are indented, with the following syntax:

Line 366 subsequent output lines are indented, with the followi

Line 412 subsequent output lines are indented, with the followi

.Ed

.Pp

If scaling width

.Va width

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

unspecified, the saved or default width is used.

Line 412 Begin a part setting the left margin. The left margin

Line 458 Begin a part setting the left margin. The left margin

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

that of

.Sq PP .

The width may be specified as following:

A scaling width may be specified as following:

.Bd -literal -offset indent

\&.RS [width]

.Ed

Line 463 followed by a newline; if not, the body follows on the

Line 509 followed by a newline; if not, the body follows on the

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

.Pp

The indentation width may be set as follows:

The indentation scaling width may be set as follows:

.Bd -literal -offset indent

\&.TP [width]

.Ed

.Pp

Where

.Va width

must be a properly-formed numeric width. If

.Va width

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

unspecified, the saved or default width is used.

.It UC

Has no effect. Included for compatibility.

.It br

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

.It fi

Line 484 End literal mode begun by

Line 530 End literal mode begun by

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

is italicised.

.It na

Don't alignment the right margin.

Don't align to the right margin.

.It nf

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

line boundaries preserved. May be ended by

CVSweb