mandoc/mdoc.7 - diff

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.173 and 1.187

version 1.173, 2010/12/29 16:16:50

version 1.187, 2011/05/21 15:55:42

Line 1

.\" $Id$

.\"

.\" Permission to use, copy, modify, and distribute this software for any

Line 40 An

.Nm

document follows simple rules: lines beginning with the control

character

.Sq \.

.Sq \&.

are parsed for macros.

Other lines are interpreted within the scope of

Text lines, those not beginning with the control character, are

prior macros:

interpreted within the scope of prior macros:

.Bd -literal -offset indent

\&.Sh Macro lines change control state.

Other lines are interpreted within the current state.

Text lines are interpreted within the current state.

.Ed

.Sh LANGUAGE SYNTAX

.Nm

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

character, and, in certain circumstances, the tab character.

All manuals must have

.Pp

.Ux

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

line terminators.

with a leading newline.

.Ss Comments

Text following a

.Sq \e\*q ,

whether in a macro or free-form text line, is ignored to the end of

whether in a macro or text line, is ignored to the end of

line.

A macro line with only a control character and comment escape,

.Sq \&.\e\*q ,

is also ignored.

Macro lines with only a control character and optional whitespace are

stripped from input.

.Ss Reserved Characters

.Ss Reserved Terms

Within a macro line, the following characters are reserved:

Within a macro line, the following terms are reserved:

.Pp

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

.It \&.

.Pq period

.It \e.

.Pq escaped period

.It \&,

.Pq comma

.It \&:

Line 91 Within a macro line, the following characters are rese

Line 93 Within a macro line, the following characters are rese

.Pq exclamation

.It \&|

.Pq vertical bar

.It \e*(Ba

.Pq reserved-word vertical bar

.El

.Pp

Use of reserved characters is described in

For general use in macro lines, these can be escaped with a non-breaking

.Sx MACRO SYNTAX .

space

For general use in macro lines, these characters can either be escaped

.Pq Sq \e& .

with a non-breaking space

In text lines, these may be used as normal punctuation.

.Pq Sq \e&

or, if applicable, an appropriate escape sequence can be used.

.Ss Special Characters

Special characters may occur in both macro and free-form lines.

Special characters may occur in both macro and text lines.

Sequences begin with the escape character

.Sq \e

followed by either an open-parenthesis

Line 129 escape followed by an indicator: B (bold), I (italic),

Line 131 escape followed by an indicator: B (bold), I (italic),

.Pp

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

respectively) may be used instead.

A text decoration is valid within

If a macro opens a font scope after calling

the current font scope only: if a macro opens a font scope alongside

.Sq \ef ,

its own scope, such as

such as with

.Sx \&Bf

.Sx \&Bf ,

.Cm \&Sy ,

the

in-scope invocations of

.Sq \ef

are only valid within the font scope of the macro.

mode will be restored upon exiting the

.Sx \&Bf

.Sq \ef

scope.

is specified outside of any font scope, such as in unenclosed, free-form

text, it will affect the remainder of the document.

.Pp

Note this form is

.Em not

Line 174 and

Line 173 and

.Pq vertical bar .

.Ss Whitespace

Whitespace consists of the space character.

In free-form lines, whitespace is preserved within a line; unescaped

In text lines, whitespace is preserved within a line; unescaped

trailing spaces are stripped from input (unless in a literal context).

Blank free-form lines, which may include whitespace, are only permitted

Blank text lines, which may include whitespace, are only permitted

within literal contexts.

.Pp

In macro lines, whitespace delimits arguments and is discarded.

Line 196 Thus, the following produces

Line 195 Thus, the following produces

\&.Op "Fl a"

.Ed

.Pp

In free-form mode, quotes are regarded as opaque text.

In text lines, quotes are regarded as opaque text.

.Ss Dates

There are several macros in

.Nm

that require a date argument.

The canonical form for dates is the American format:

.Pp

.D1 Cm Month Day , Year

.Pp

The

.Cm Day

value is an optionally zero-padded numeral.

The

.Cm Month

value is the full month name.

The

.Cm Year

value is the full four-digit year.

.Pp

Reduced form dates are broken-down canonical form dates:

.Pp

.D1 Cm Month , Year

.D1 Cm Year

.Pp

Some examples of valid dates follow:

.Pp

.D1 "May, 2009" Pq reduced form

.D1 "2009" Pq reduced form

.D1 "May 20, 2009" Pq canonical form

.Ss Scaling Widths

Many macros support scaled widths for their arguments, such as

stipulating a two-inch list indentation with the following:

Line 283 a line.

Line 254 a line.

By doing so, front-ends will be able to apply the proper amount of

spacing after the end of sentence (unescaped) period, exclamation mark,

or question mark followed by zero or more non-sentence closing

delimiters (

delimiters

.Ns Sq \&) ,

.Po

.Sq \&) ,

.Sq \&] ,

.Sq \&' ,

.Sq \&" ) .

.Sq \&"

.Pc .

.Pp

The proper spacing is also intelligently preserved if a sentence ends at

the boundary of a macro line.

For example:

.Pp

.Dl \&Xr mandoc 1 \.

.Dl \&.Xr mandoc 1 \&.

.Dl \&Fl T \&Ns \&Cm ascii \.

.Dl \&.Fl T \&Ns \&Cm ascii \&.

.Sh MANUAL STRUCTURE

A well-formed

.Nm

Line 382 The syntax for this as follows:

Line 355 The syntax for this as follows:

\&.Nd a one line description

.Ed

.Pp

Multiple

.Sq \&Nm

names should be separated by commas.

.Pp

The

.Sx \&Nm

macro(s) must precede the

Line 409 configuration.

Line 386 configuration.

For the first, utilities (sections 1, 6, and 8), this is

generally structured as follows:

.Bd -literal -offset indent

\&.Nm foo

\&.Nm bar

\&.Op Fl v

\&.Op Fl o Ar file

\&.Op Ar

\&.Nm bar

\&.Nm foo

\&.Op Fl v

\&.Op Fl o Ar file

\&.Op Ar

.Ed

.Pp

Commands should be ordered alphabetically.

.Pp

For the second, function calls (sections 2, 3, 9):

.Bd -literal -offset indent

\&.In header.h

Line 429 For the second, function calls (sections 2, 3, 9):

Line 408 For the second, function calls (sections 2, 3, 9):

\&.Fn bar "const char *src"

.Ed

.Pp

Ordering of

.Sx \&In ,

.Sx \&Vt ,

.Sx \&Fn ,

and

.Sx \&Fo

macros should follow C header-file conventions.

.Pp

And for the third, configurations (section 4):

.Bd -literal -offset indent

\&.Cd \*qit* at isa? port 0x2e\*q

Line 477 or

Line 464 or

.Sx \&Ss

macro or the end of an enclosing block, whichever comes first.

.It Em DESCRIPTION

This expands upon the brief, one line description in

This begins with an expansion of the brief, one line description in

.Em NAME .

.Em NAME :

It usually contains a breakdown of the options (if documenting a

.Bd -literal -offset indent

The

\&.Nm

utility does this, that, and the other.

.Ed

.Pp

It usually follows with a breakdown of the options (if documenting a

command), such as:

.Bd -literal -offset indent

The arguments are as follows:

Line 627 column, if applicable, describes closure rules.

Line 620 column, if applicable, describes closure rules.

Multi-line scope closed by an explicit closing macro.

All macros contains bodies; only

.Sx \&Bf

contains a head.

and

.Pq optionally

.Sx \&Bl

contain a head.

.Bd -literal -offset indent

\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB

\(lBbody...\(rB

Line 732 and/or tail

Line 728 and/or tail

.El

.Ss Block partial-implicit

Like block full-implicit, but with single-line scope closed by

.Sx Reserved Characters

.Sx Reserved Terms

or end of line.

.Bd -literal -offset indent

\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB

Line 765 section line, else it is

Line 761 section line, else it is

.Sx In-line .

.Ss In-line

Closed by

.Sx Reserved Characters ,

.Sx Reserved Terms ,

end of line, fixed argument lengths, and/or subsequent macros.

In-line macros have only text children.

If a number (or inequality) of arguments is

Line 795 then the macro accepts an arbitrary number of argument

Line 791 then the macro accepts an arbitrary number of argument

.It Sx \&%T Ta \&No Ta \&No Ta >0

.It Sx \&%U Ta \&No Ta \&No Ta >0

.It Sx \&%V Ta \&No Ta \&No Ta >0

.It Sx \&Ad Ta Yes Ta Yes Ta n

.It Sx \&Ad Ta Yes Ta Yes Ta >0

.It Sx \&An Ta Yes Ta Yes Ta n

.It Sx \&An Ta Yes Ta Yes Ta >0

.It Sx \&Ap Ta Yes Ta Yes Ta 0

.It Sx \&Ar Ta Yes Ta Yes Ta n

.It Sx \&At Ta Yes Ta Yes Ta 1

Line 804 then the macro accepts an arbitrary number of argument

Line 800 then the macro accepts an arbitrary number of argument

.It Sx \&Bt Ta \&No Ta \&No Ta 0

.It Sx \&Bx Ta Yes Ta Yes Ta n

.It Sx \&Cd Ta Yes Ta Yes Ta >0

.It Sx \&Cm Ta Yes Ta Yes Ta n

.It Sx \&Cm Ta Yes Ta Yes Ta >0

.It Sx \&Db Ta \&No Ta \&No Ta 1

.It Sx \&Dd Ta \&No Ta \&No Ta n

.It Sx \&Dt Ta \&No Ta \&No Ta n

.It Sx \&Dv Ta Yes Ta Yes Ta n

.It Sx \&Dv Ta Yes Ta Yes Ta >0

.It Sx \&Dx Ta Yes Ta Yes Ta n

.It Sx \&Em Ta Yes Ta Yes Ta >0

.It Sx \&En Ta \&No Ta \&No Ta 0

.It Sx \&Er Ta Yes Ta Yes Ta >0

.It Sx \&Es Ta \&No Ta \&No Ta 0

.It Sx \&Ev Ta Yes Ta Yes Ta n

.It Sx \&Ev Ta Yes Ta Yes Ta >0

.It Sx \&Ex Ta \&No Ta \&No Ta n

.It Sx \&Fa Ta Yes Ta Yes Ta n

.It Sx \&Fa Ta Yes Ta Yes Ta >0

.It Sx \&Fd Ta \&No Ta \&No Ta >0

.It Sx \&Fl Ta Yes Ta Yes Ta n

.It Sx \&Fn Ta Yes Ta Yes Ta >0

.It Sx \&Fr Ta \&No Ta \&No Ta n

.It Sx \&Ft Ta Yes Ta Yes Ta n

.It Sx \&Ft Ta Yes Ta Yes Ta >0

.It Sx \&Fx Ta Yes Ta Yes Ta n

.It Sx \&Hf Ta \&No Ta \&No Ta n

.It Sx \&Ic Ta Yes Ta Yes Ta >0

.It Sx \&In Ta \&No Ta \&No Ta n

.It Sx \&In Ta \&No Ta \&No Ta 1

.It Sx \&Lb Ta \&No Ta \&No Ta 1

.It Sx \&Li Ta Yes Ta Yes Ta n

.It Sx \&Li Ta Yes Ta Yes Ta >0

.It Sx \&Lk Ta Yes Ta Yes Ta n

.It Sx \&Lk Ta Yes Ta Yes Ta >0

.It Sx \&Lp Ta \&No Ta \&No Ta 0

.It Sx \&Ms Ta Yes Ta Yes Ta >0

.It Sx \&Mt Ta Yes Ta Yes Ta >0

Line 884 block.

Line 880 block.

Publication date of an

.Sx \&Rs

block.

This should follow the reduced or canonical form syntax described in

Recommended formats of arguments are

.Sx Dates .

.Ar month day , year

or just

.Ar year .

.Ss \&%I

Publisher or issuer name of an

.Sx \&Rs

Line 1061 Its syntax is as follows:

Line 1059 Its syntax is as follows:

.Pp

Display blocks are used to select a different indentation and

justification than the one used by the surrounding text.

They may contain both macro lines and free-form text lines.

They may contain both macro lines and text lines.

By default, a display block is preceded by a vertical space.

.Pp

The

Line 1176 See also

Line 1174 See also

and

.Sx \&Sy .

.Ss \&Bk

Keep the output generated from each macro input line together

For each macro, keep its output together on the same output line,

on one single output line.

until the end of the macro or the end of the input line is reached,

Line breaks in free-form text lines are unaffected.

whichever comes first.

Line breaks in text lines are unaffected.

The syntax is as follows:

.Pp

.D1 Pf \. Sx \&Bk Fl words

Line 1467 This is the mandatory first macro of any

Line 1466 This is the mandatory first macro of any

manual.

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&Dd Op Ar date

.D1 Pf \. Sx \&Dd Ar month day , year

.Pp

The

.Ar date

.Ar month

may be either

is the full English month name, the

.Ar $\&Mdocdate$ ,

.Ar day

which signifies the current manual revision date dictated by

is an optionally zero-padded numeral, and the

.Ar year

is the full four-digit year.

.Pp

Other arguments are not portable; the

.Xr mandoc 1

utility handles them as follows:

.Bl -dash -offset 3n -compact

.It

To have the date automatically filled in by the

.Ox

version of

.Xr cvs 1 ,

or instead a valid canonical date as specified by

the special string

.Sx Dates .

.Dq $\&Mdocdate$

If a date does not conform or is empty, the current date is used.

can be given as an argument.

.It

A few alternative date formats are accepted as well

and converted to the standard form.

.It

If a date string cannot be parsed, it is used verbatim.

.It

If no date string is given, the current date is used.

.El

.Pp

Examples:

.Dl \&.Dd $\&Mdocdate$

Line 1853 A function name.

Line 1871 A function name.

Its syntax is as follows:

.Bd -ragged -offset indent

.Pf \. Ns Sx \&Fn

.Op Cm functype

.Op Ar functype

.Cm funcname

.Ar funcname

.Op Oo Cm argtype Oc Cm argname

.Op Oo Ar argtype Oc Ar argname

.Ed

.Pp

Function arguments are surrounded in parenthesis and

Line 1863 are delimited by commas.

Line 1881 are delimited by commas.

If no arguments are specified, blank parenthesis are output.

.Pp

Examples:

.Dl \&.Fn "int funcname" "int arg0" "int arg1"

.Dl \&.Fn \*qint funcname\*q \*qint arg0\*q \*qint arg1\*q

.Dl \&.Fn funcname "int arg0"

.Dl \&.Fn funcname \*qint arg0\*q

.Dl \&.Fn funcname arg0

.Bd -literal -offset indent -compact

\&.Ft functype

Line 1884 This is a multi-line version of

Line 1902 This is a multi-line version of

.Sx \&Fn .

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&Fo Cm funcname

.D1 Pf \. Sx \&Fo Ar funcname

.Pp

Invocations usually occur in the following context:

.Bd -ragged -offset indent

.Pf \. Sx \&Ft Cm functype

.Pf \. Sx \&Ft Ar functype

.br

.Pf \. Sx \&Fo Cm funcname

.Pf \. Sx \&Fo Ar funcname

.br

.Pf \. Sx \&Fa Oo Cm argtype Oc Cm argname

.Pf \. Sx \&Fa Oo Ar argtype Oc Ar argname

.br

\.\.\.

\&.\.\.

.br

.Pf \. Sx \&Fc

.Ed

Line 1913 and

Line 1931 and

A function type.

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&Ft Cm functype

.D1 Pf \. Sx \&Ft Ar functype

.Pp

Examples:

.Dl \&.Ft int

Line 1994 and

Line 2012 and

.Fl diag

have the following syntax:

.Pp

.D1 Pf \. Sx \&It Cm args

.D1 Pf \. Sx \&It Ar args

.Pp

Lists of type

.Fl bullet ,

Line 2067 See also

Line 2085 See also

Specify a library.

The syntax is as follows:

.Pp

.D1 Pf \. Sx \&Lb Cm library

.D1 Pf \. Sx \&Lb Ar library

.Pp

The

.Cm library

.Ar library

parameter may be a system library, such as

.Cm libz

.Ar libz

.Cm libpam ,

.Ar libpam ,

in which case a small library description is printed next to the linker

invocation; or a custom library, in which case the library name is

printed in quotes.

Line 2100 and

Line 2118 and

Format a hyperlink.

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&Lk Cm uri Op Cm name

.D1 Pf \. Sx \&Lk Ar uri Op Ar name

.Pp

Examples:

.Dl \&.Lk http://bsd.lv \*qThe BSD.lv Project\*q

Line 2115 Synonym for

Line 2133 Synonym for

Display a mathematical symbol.

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&Ms Cm symbol

.D1 Pf \. Sx \&Ms Ar symbol

.Pp

Examples:

.Dl \&.Ms sigma

Line 2126 Format a

Line 2144 Format a

hyperlink.

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&Mt Cm address

.D1 Pf \. Sx \&Mt Ar address

.Pp

Examples:

.Dl \&.Mt discuss@manpages.bsd.lv

Line 2203 Suppress a space.

Line 2221 Suppress a space.

Following invocation, text is interpreted as free-form text until a

macro is encountered.

.Pp

This has no effect when invoked at the start of a macro line.

.Pp

Examples:

.Dl \&.Fl o \&Ns \&Ar output

.Pp

Line 2262 any

Line 2282 any

file.

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&Os Op Cm system Op Cm version

.D1 Pf \. Sx \&Os Op Ar system Op Ar version

.Pp

The optional

.Cm system

.Ar system

parameter specifies the relevant operating system or environment.

Left unspecified, it defaults to the local operating system version.

This is the suggested form.

Line 2324 Removes the space

Line 2344 Removes the space

between its arguments.

Its syntax is as follows:

.Pp

.D1 Pf \. \&Pf Cm prefix suffix

.D1 Pf \. \&Pf Ar prefix suffix

.Pp

The

.Cm suffix

.Ar suffix

argument may be a macro.

.Pp

Examples:

.Dl \&.Pf \e. \&Sx \&Pf \&Cm prefix suffix

.Dl \&.Pf \e. \&Sx \&Pf \&Ar prefix suffix

.Ss \&Po

Multi-line version of

.Sx \&Pq .

Line 2452 Its syntax is as follows:

Line 2472 Its syntax is as follows:

.D1 Pf \. Sx \&Sm Cm on | off

.Pp

By default, spacing is

.Cm on .

.Ar on .

When switched

.Cm off ,

.Ar off ,

no white space is inserted between macro arguments and between the

output generated from adjacent macros, but free-form text lines

output generated from adjacent macros, but text lines

still get normal spacing between words and sentences.

.Ss \&So

Multi-line version of

Line 2679 Link to another manual

Line 2699 Link to another manual

.Pq Qq cross-reference .

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&Xr Cm name section

.D1 Pf \. Sx \&Xr Ar name section

.Pp

The

.Cm name

.Ar name

and

.Cm section

.Ar section

are the name and section of the linked manual.

.Cm section

.Ar section

is followed by non-punctuation, an

.Sx \&Ns

is inserted into the token stream.

Line 2712 This macro should not be used; it is implemented for c

Line 2732 This macro should not be used; it is implemented for c

historical manuals.

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&sp Op Cm height

.D1 Pf \. Sx \&sp Op Ar height

.Pp

The

.Cm height

.Ar height

argument must be formatted as described in

.Sx Scaling Widths .

If unspecified,

Line 2767 does not start a new line.

Line 2787 does not start a new line.

\*[hist]

.It

.Sx \&Dd

without an argument prints

with non-standard arguments behaves very strangely.

.Dq Epoch .

When there are three arguments, they are printed verbatim.

In mandoc, it resolves to the current date.

Any other number of arguments is replaced by the current date,

but without any arguments the string

.Dq Epoch

is printed.

.It

.Sx \&Fl

does not print a dash for an empty argument.

Line 2903 This is not supported by mandoc.

Line 2926 This is not supported by mandoc.

.Sh SEE ALSO

.Xr man 1 ,

.Xr mandoc 1 ,

.Xr eqn 7 ,

.Xr man 7 ,

.Xr mandoc_char 7

.Xr roff 7 ,

.Xr tbl 7

.Sh HISTORY

The

.Nm

CVSweb