mandoc/man.7 - diff

Return to man.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/man.7 between version 1.91 and 1.102

version 1.91, 2010/12/06 15:31:19

version 1.102, 2011/07/08 09:35:06

Line 53 Other lines are interpreted within the current state.

.Nm

documents may contain only graphable 7-bit ASCII characters, the

space character, and the tab character.

All manuals must have

.Ux

line termination.

.Pp

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

vertical space.

.Pp

If the first character of a line is a space, that line is printed

with a leading newline.

.Ss Comments

Text following a

.Sq \e\*q ,

Line 118 rendered as an empty line.

.Pp

In macro lines, whitespace delimits arguments and is discarded.

If arguments are quoted, whitespace within the quotes is retained.

.Ss Dates

The

.Sx \&TH

macro is the only

.Nm

macro that requires a date.

The form for this date is the ISO-8601

standard

.Cm YYYY-MM-DD .

.Ss Scaling Widths

Many macros support scaled widths for their arguments, such as

stipulating a two-inch paragraph indentation with the following:

Line 214 appears as the first macro.

Line 205 appears as the first macro.

Beyond

.Sx \&TH ,

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

Documents are generally structured as follows:

.Pp

The following is a well-formed skeleton

.Nm

file for a utility

.Qq progname :

.Bd -literal -offset indent

\&.TH FOO 1 2009-10-10

\&.TH PROGNAME 1 2009-10-10

\&.SH NAME

\efBfoo\efR \e(en a description goes here

\efBprogname\efR \e(en a description goes here

\&.\e\*q .SH LIBRARY

\&.\e\*q For sections 2 & 3 only.

\&.\e\*q Not used in OpenBSD.

\&.SH SYNOPSIS

\efBfoo\efR [\efB\e-options\efR] arguments...

\efBprogname\efR [\efB\e-options\efR] arguments...

\&.SH DESCRIPTION

The \efBfoo\efR utility processes files...

\&.\e\*q .SH IMPLEMENTATION NOTES

Line 370 Thus, the following are equivalent:

Line 365 Thus, the following are equivalent:

\&.\ \ \ PP

.Ed

.Pp

To include space characters in macro arguments, arguments may be quoted;

see the

.Sq MACRO SYNTAX

section in the

.Xr roff 7

manual for details.

.Pp

The

.Nm

macros are classified by scope: line scope or block scope.

Line 424 The syntax is as follows:

Line 426 The syntax is as follows:

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

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

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

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

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

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

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

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

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

.El

.Pp

Line 509 The optional arguments specify which release it is fro

Text is rendered in bold face.

.Pp

See also

.Sx \&I ,

.Sx \&I

.Sx \&R ,

.Sx \&b ,

.Sx \&i ,

and

.Sx \&r .

.Sx \&R .

.Ss \&BI

Text is rendered alternately in bold face and italic.

Thus,

Line 532 Whitespace between arguments is omitted in output.

Line 529 Whitespace between arguments is omitted in output.

.Pp

Examples:

.Pp

.D1 \&.BI bold italic bold italic

.Dl \&.BI bold italic bold italic

.Pp

The output of this example will be emboldened

.Dq bold

Line 591 and

Line 588 and

Text is rendered in italics.

.Pp

See also

.Sx \&B ,

.Sx \&B

.Sx \&R ,

.Sx \&b ,

.Sx \&i ,

and

.Sx \&r .

.Sx \&R .

.Ss \&IB

Text is rendered alternately in italics and bold face.

Whitespace between arguments is omitted in output.

Line 692 and

Line 686 and

Text is rendered in roman (the default font).

.Pp

See also

.Sx \&I ,

.Sx \&I

.Sx \&B ,

.Sx \&b ,

.Sx \&i ,

and

.Sx \&r .

.Sx \&B .

.Ss \&RB

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

Whitespace between arguments is omitted in output.

Line 716 and

Line 707 and

.Ss \&RE

Explicitly close out the scope of a prior

.Sx \&RS .

The default left margin is restored to the state of the original

.Sx \&RS

invocation.

.Ss \&RI

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

Whitespace between arguments is omitted in output.

Line 732 See also

Line 726 See also

and

.Sx \&IR .

.Ss \&RS

Begin a part setting the left margin.

Temporarily reset the default left margin.

The left margin controls the offset, following an initial indentation,

to un-indented text such as that of

.Sx \&PP .

This has the following syntax:

.Bd -filled -offset indent

.Pf \. Sx \&Rs

.Pf \. Sx \&RS

.Op Cm width

.Ed

.Pp

Line 747 The

Line 738 The

argument must conform to

.Sx Scaling Widths .

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

.Pp

See also

.Sx \&RE .

.Ss \&SB

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

bold face.

Line 767 The paragraph left-margin width is reset to the defaul

Line 761 The paragraph left-margin width is reset to the defaul

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

.Bd -filled -offset indent

.Pf \. Sx \&TH

.Cm title section

.Ar title section date

.Op Cm date Op Cm source Op Cm volume

.Op Ar source Op Ar volume

.Ed

.Pp

At least the upper-case document

Conventionally, the document

.Cm title

.Ar title

and the manual

is given in all caps.

.Cm section

The recommended

arguments must be provided.

.Ar date

The

format is

.Cm date

.Sy YYYY-MM-DD

argument should be formatted as described in

as specified in the ISO-8601 standard;

.Sx Dates ,

if the argument does not conform, it is printed verbatim.

but will be printed verbatim if it is not.

If the

If the date is not specified, the current date is used.

.Ar date

The

is empty or not specified, the current date is used.

.Cm source

The optional

.Ar source

string specifies the organisation providing the utility.

The

.Cm volume

.Ar volume

string replaces the default rendered volume, which is dictated by the

manual section.

.Pp

Examples:

.Pp

.D1 \&.TH CVS 5 "1992-02-12" GNU

.Dl \&.TH CVS 5 "1992-02-12" GNU

.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

Line 836 Change the current font mode.

Line 831 Change the current font mode.

See

.Sx Text Decoration

for a listing of available font modes.

.Ss \&i

Italicise arguments.

Synonym for

.Sx \&I .

.Pp

See also

.Sx \&B ,

.Sx \&I ,

.Sx \&R .

.Sx \&b ,

and

.Sx \&r .

.Ss \&in

Indent relative to the current indentation:

.Pp

Line 865 Begin literal mode: all subsequent free-form lines hav

Line 848 Begin literal mode: all subsequent free-form lines hav

line boundaries preserved.

May be ended by

.Sx \&fi .

.Ss \&r

Literal mode is implicitly ended by

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

.Sx \&SH

.Pp

See also

.Sx \&SS .

.Sx \&B ,

.Sx \&I ,

.Sx \&R ,

.Sx \&b ,

and

.Sx \&i .

.Ss \&sp

Insert vertical spaces into output with the following syntax:

.Bd -filled -offset indent

Line 945 In GNU troff, this would result in strange behaviour.

Line 922 In GNU troff, this would result in strange behaviour.

.Sh SEE ALSO

.Xr man 1 ,

.Xr mandoc 1 ,

.Xr eqn 7 ,

.Xr mandoc_char 7 ,

.Xr mdoc 7

.Xr mdoc 7 ,

.Xr roff 7 ,

.Xr tbl 7

.Sh HISTORY

The

.Nm

CVSweb