mandoc/mdoc.7 - diff

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.185 and 1.192

version 1.185, 2011/04/06 11:39:25

version 1.192, 2011/07/31 17:30:33

Line 97 Within a macro line, the following terms are reserved:

.Pq reserved-word vertical bar

.El

.Pp

Use of reserved terms is described in

.Sx MACRO SYNTAX .

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

space

.Pq Sq \e& .

Line 298 sections, although this varies between manual sections

Line 296 sections, although this varies between manual sections

.Pp

The following is a well-formed skeleton

.Nm

file:

file for a utility

.Qq progname :

.Bd -literal -offset indent

\&.Dd $\&Mdocdate$

\&.Dt mdoc 7

\&.Dt PROGNAME section

\&.Os

\&.Sh NAME

\&.Nm foo

\&.Nm progname

\&.Nd a description goes here

\&.\e\*q .Sh LIBRARY

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

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

\&.Sh SYNOPSIS

\&.Nm foo

\&.Nm progname

\&.Op Fl options

\&.Ar

\&.Sh DESCRIPTION

Line 761 in a

Line 760 in a

.Em SYNOPSIS

section line, else it is

.Sx In-line .

.Ss Special block macro

The

.Sx \&Ta

macro can only be used below

.Sx \&It

.Sx \&Bl Fl column

lists.

It delimits blocks representing table cells;

these blocks have bodies, but no heads.

.Pp

.Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -compact -offset indent

.It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope

.It Sx \&Ta Ta Yes Ta Yes Ta closed by Sx \&Ta , Sx \&It

.El

.Ss In-line

Closed by

.Sx Reserved Terms ,

Line 1024 Accepts one optional argument:

Line 1038 Accepts one optional argument:

.It Cm v[1-7] | 32v

A version of

.At .

.It Cm III

.At III .

.It Cm V[.[1-4]]?

A version of

.At V .

Line 1033 Note that these arguments do not begin with a hyphen.

Line 1049 Note that these arguments do not begin with a hyphen.

.Pp

Examples:

.Dl \&.At

.Dl \&.At III

.Dl \&.At V.1

.Pp

See also

Line 1176 See also

Line 1193 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,

whichever comes first.

Line breaks in text lines are unaffected.

The syntax is as follows:

.Pp

Line 1691 See also

Line 1709 See also

and

.Sx \&Os .

.Ss \&Dv

Defined variables such as preprocessor constants.

Defined variables such as preprocessor constants, constant symbols,

enumeration values, and so on.

.Pp

Examples:

.Dl \&.Dv NULL

.Dl \&.Dv BUFSIZ

.Dl \&.Dv STDOUT_FILENO

.Pp

See also

.Sx \&Er .

.Sx \&Er

and

.Sx \&Ev

for special-purpose constants and

.Sx \&Va

for variable symbols.

.Ss \&Dx

Format the DragonFly BSD version provided as an argument, or a default

value if no argument is provided.

Line 1774 argument is used as the enclosure head, for example, s

Line 1799 argument is used as the enclosure head, for example, s

will emulate

.Sx \&Do .

.Ss \&Er

Display error constants.

Error constants for definitions of the

.Va errno

libc global variable.

.Pp

Examples:

.Dl \&.Er EPERM

.Dl \&.Er ENOENT

.Pp

See also

.Sx \&Dv .

.Sx \&Dv

for general constants.

.Ss \&Es

This macro is obsolete and not implemented.

.Ss \&Ev

Line 1791 Environmental variables such as those specified in

Line 1819 Environmental variables such as those specified in

Examples:

.Dl \&.Ev DISPLAY

.Dl \&.Ev PATH

.Pp

See also

.Sx \&Dv

for general constants.

.Ss \&Ex

Insert a standard sentence regarding exit values.

Insert a standard sentence regarding command exit values of 0 on success

and >0 on failure.

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&Ex Fl std Op Ar utility

.D1 Pf \. Sx \&Ex Fl std Op Ar utility...

.Pp

When

.Ar utility

is not specified, the document's name set by

.Sx \&Nm

is used.

Multiple

.Ar utility

arguments are treated as separate utilities.

.Pp

See also

.Sx \&Rv .

Line 1928 See also

Line 1964 See also

.Sx \&Fc ,

and

.Sx \&Ft .

.Ss \&Fr

This macro is obsolete and not implemented.

.Ss \&Ft

A function type.

Its syntax is as follows:

Line 2050 The

Line 2088 The

list is the most complicated.

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&It Op Cm args

.D1 Pf \. Sx \&It Ar cell Op <TAB> Ar cell ...

.D1 Pf \. Sx \&It Ar cell Op Sx \&Ta Ar cell ...

.Pp

The

The arguments consist of one or more lines of text and macros

.Cm args

representing a complete table line.

are phrases, a mix of macros and text corresponding to a line column,

Cells within the line are delimited by tabs or by the special

delimited by tabs or the special

.Sx \&Ta

.Sq \&Ta

block macro.

pseudo-macro.

The tab cell delimiter may only be used within the

Lines subsequent the

.Sx \&It

are interpreted within the scope of the last phrase.

line itself; on following lines, only the

Calling the pseudo-macro

.Sx \&Ta

.Sq \&Ta

macro can be used to delimit cells, and

will open a new phrase scope (this must occur on a macro line to be

.Sx \&Ta

interpreted as a macro).

is only recognized as a macro when called by other macros,

Note that the tab phrase delimiter may only be used within the

not as the first macro on a line.

.Pp

Note that quoted strings may span tab-delimited cells on an

.Sx \&It

line itself.

line.

Subsequent this, only the

For example,

.Sq \&Ta

pseudo-macro may be used to delimit phrases.

Furthermore, note that quoted sections propagate over tab-delimited

phrases on an

.Sx \&It ,

for example,

.Pp

.Dl .It \(dqcol1 ; <TAB> col2 ;\(dq \&;

.Pp

Line 2435 block is used within a SEE ALSO section, a vertical sp

Line 2469 block is used within a SEE ALSO section, a vertical sp

before the rendered output, else the block continues on the current

line.

.Ss \&Rv

Inserts text regarding a function call's return value.

Insert a standard sentence regarding a system call's return value of 0

This macro must consist of the

on success and \-1 on error, with the

.Fl std

.Va errno

argument followed by an optional

libc global variable set on error.

.Ar function .

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&Rv Fl std Op Ar function...

.Pp

.Ar function

is not provided, the document's name as stipulated by the first

is not specified, the document's name set by

.Sx \&Nm

is provided.

is used.

Multiple

.Ar function

arguments are treated as separate functions.

.Pp

See also

.Sx \&Ex .

Line 2629 See also

Line 2669 See also

.Sx \&Li ,

and

.Sx \&Em .

.Ss \&Ta

Table cell separator in

.Sx \&Bl Fl column

lists; can only be used below

.Sx \&It .

.Ss \&Tn

Format a tradename.

.Pp

Line 2778 Newer groff and mandoc print

Line 2823 Newer groff and mandoc print

.Qq AT&T UNIX

and the arguments.

.It

.Sx \&Bd Fl column

.Sx \&Bl Fl column

does not recognize trailing punctuation characters when they immediately

precede tabulator characters, but treats them as normal text and

outputs a space before them.

CVSweb