mandoc/mdoc.7 - diff

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.230 and 1.237

version 1.230, 2014/06/24 21:43:08

version 1.237, 2014/09/17 00:43:15

Line 468 in the alphabetical

.It Sx \&Pf Ta prefix, no following horizontal space (one argument)

.It Sx \&Ns Ta roman font, no preceding horizontal space (no arguments)

.It Sx \&Ap Ta apostrophe without surrounding whitespace (no arguments)

.It Sx \&Sm Ta switch horizontal spacing mode: Cm on | off

.It Sx \&Sm Ta switch horizontal spacing mode: Op Cm on | off

.It Sx \&Bk , \&Ek Ta keep block: Fl words

.It Sx \&br Ta force output line break in text mode (no arguments)

.It Sx \&sp Ta force vertical space: Op Ar height

Line 1195 Close a

block.

Does not have any tail arguments.

.Ss \&Dd

Document date.

Document date for display in the page footer.

This is the mandatory first macro of any

.Nm

manual.

Line 1224 the special string

.Dq $\&Mdocdate$

can be given as an argument.

.It

A few alternative date formats are accepted as well

The traditional, purely numeric

and converted to the standard form.

.Xr man 7

format

.Ar year Ns \(en Ns Ar month Ns \(en Ns Ar day

is accepted, too.

.It

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

.It

Line 1242 See also

Line 1245 See also

and

.Sx \&Os .

.Ss \&Dl

One-line intended display.

One-line indented display.

This is formatted as literal text and is useful for commands and

invocations.

It is followed by a newline.

Line 1285 See also

Line 1288 See also

and

.Sx \&Do .

.Ss \&Dt

Document title.

Document title for display in the page header.

This is the mandatory second macro of any

.Nm

file.

Its syntax is as follows:

.Bd -ragged -offset indent

.Pf \. Sx \&Dt

.Oo

.Ar TITLE

.Ar title

.Oo

.Ar section

.Op Ar volume

.Op Ar volume | arch

.Op Ar arch

.Oc

.Ed

.Pp

Its arguments are as follows:

.Bl -tag -width Ds -offset Ds

.Bl -tag -width section -offset 2n

.It Ar title

.It Ar TITLE

The document's title (name), defaulting to

.Dq UNKNOWN

.Dq UNTITLED

if unspecified.

It should be capitalised.

To achieve a uniform appearance of page header lines,

it should by convention be all caps.

.It Ar section

The manual section.

This may be one of

Line 1346 or

Line 1345 or

.Cm paper

.Pq paper .

It should correspond to the manual's filename suffix and defaults to

.Cm 1

the empty string if unspecified.

if unspecified.

.It Ar volume

This overrides the volume inferred from

.Ar section .

Line 1469 See also

Line 1467 See also

and

.Sx \&It .

.Ss \&Em

Denotes text that should be

Request an italic font.

.Em emphasised .

If the output device does not provide that, underline.

Note that this is a presentation term and should not be used for

stylistically decorating technical terms.

Depending on the output device, this is usually represented

using an italic font or underlined characters.

.Pp

This is most often used for stress emphasis (not to be confused with

importance, see

.Sx \&Sy ) .

In the rare cases where none of the semantic markup macros fit,

it can also be used for technical terms and placeholders, except

that for syntax elements,

.Sx \&Sy

and

.Sx \&Ar

are preferred, respectively.

.Pp

Examples:

.Dl \&.Em Warnings!

.Bd -literal -compact -offset indent

.Dl \&.Em Remarks :

Selected lines are those

\&.Em not

matching any of the specified patterns.

Some of the functions use a

\&.Em hold space

to save the pattern space for subsequent retrieval.

.Ed

.Pp

See also

.Sx \&Bf ,

Line 1487 See also

Line 1498 See also

and

.Sx \&Sy .

.Ss \&En

This macro is obsolete and ignored by

This macro is obsolete.

.Xr mandoc 1 .

Use

.Sx \&Eo

or any of the other enclosure macros.

.Pp

It encloses its argument in the delimiters specified by the last

.Sx \&Es

macro.

.Ss \&Eo

An arbitrary enclosure.

Its syntax is as follows:

Line 1514 See also

Line 1531 See also

.Sx \&Dv

for general constants.

.Ss \&Es

This macro is obsolete and ignored by

This macro is obsolete.

.Xr mandoc 1 .

Use

.Sx \&Eo

or any of the other enclosure macros.

.Pp

It takes two arguments, defining the delimiters to be used by subsequent

.Sx \&En

macros.

.Ss \&Ev

Environmental variables such as those specified in

.Xr environ 7 .

Line 1551 Function argument.

Line 1574 Function argument.

Its syntax is as follows:

.Bd -ragged -offset indent

.Pf \. Sx \&Fa

.Op Cm argtype

.Qo

.Cm argname

.Op Ar argtype

.Op Ar argname

.Qc Ar \&...

.Ed

.Pp

This may be invoked for names with or without the corresponding type.

Each argument may be a name and a type (recommended for the

It is also used to specify the field name of a structure.

.Em SYNOPSIS

section), a name alone (for function invocations),

or a type alone (for function prototypes).

If both a type and a name are given or if the type consists of multiple

words, all words belonging to the same function argument have to be

given in a single argument to the

.Sx \&Fa

macro.

.Pp

This macro is also used to specify the field name of a structure.

.Pp

Most often, the

.Sx \&Fa

macro is used in the

.Em SYNOPSIS

within

.Sx \&Fo

section when documenting multi-line function prototypes.

blocks when documenting multi-line function prototypes.

If invoked with multiple arguments, the arguments are separated by a

comma.

Furthermore, if the following macro is another

Line 1573 the last argument will also have a trailing comma.

Line 1608 the last argument will also have a trailing comma.

Examples:

.Dl \&.Fa \(dqconst char *p\(dq

.Dl \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq

.Dl \&.Fa foo

.Dl \&.Fa \(dqchar *\(dq size_t

.Pp

See also

.Sx \&Fo .

Line 1676 Invocations usually occur in the following context:

Line 1711 Invocations usually occur in the following context:

.br

.Pf \. Sx \&Fo Ar funcname

.br

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

.Pf \. Sx \&Fa Qq Ar argtype Ar argname

.br

\&.\.\.

.br

Line 1695 See also

Line 1730 See also

and

.Sx \&Ft .

.Ss \&Fr

This macro is obsolete and ignored by

This macro is obsolete.

.Xr mandoc 1 .

No replacement markup is needed.

.Pp

It was used to show function return values.

It was used to show numerical function return values in an italic font.

The syntax was:

.Pp

.Dl Pf . Sx \&Fr Ar value

.Ss \&Ft

A function type.

Its syntax is as follows:

Line 2089 Examples:

Line 2121 Examples:

See also

.Sx \&Oo .

.Ss \&Os

Document operating system version.

Operating system version for display in the page footer.

This is the mandatory third macro of

any

.Nm

Line 2114 See also

Line 2146 See also

and

.Sx \&Dt .

.Ss \&Ot

This macro is obsolete and ignored by

This macro is obsolete.

.Xr mandoc 1 .

Use

.Sx \&Ft

instead; with

.Xr mandoc 1 ,

both have the same effect.

.Pp

Historical

.Nm

Line 2312 and

Line 2348 and

Switches the spacing mode for output generated from macros.

Its syntax is as follows:

.Pp

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

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

.Pp

By default, spacing is

.Cm on .

Line 2321 When switched

Line 2357 When switched

no white space is inserted between macro arguments and between the

output generated from adjacent macros, but text lines

still get normal spacing between words and sentences.

.Pp

When called without an argument, the

.Sx \&Sm

macro toggles the spacing mode.

Using this is not recommended because it makes the code harder to read.

.Ss \&So

Multi-line version of

.Sx \&Sq .

Line 2469 Based on POSIX.1 and POSIX.2, published in 1992.

Line 2510 Based on POSIX.1 and POSIX.2, published in 1992.

.It Single UNIX Specification version 1 and related standards

.Pp

.Bl -tag -width "-p1003.1g-2000" -compact

.It \-susv1

.St -susv1

.It \-xpg4.2

.St -xpg4.2

.br

This standard was published in 1994 and is also called SUSv1.

This standard was published in 1994.

It was used as the basis for UNIX 95 certification.

The following three refer to parts of it.

.Pp

Line 2565 The second and last Technical Corrigendum.

Line 2608 The second and last Technical Corrigendum.

.Bl -tag -width "-p1003.1g-2000" -compact

.It \-p1003.1-2008

.St -p1003.1-2008

.It \-susv4

.St -susv4

.br

This standard is also called SUSv4 and

This standard is also called

X/Open Portability Guide version 7.

.Pp

.It \-p1003.1-2013

Line 2609 See also

Line 2654 See also

and

.Sx \&Ss .

.Ss \&Sy

Format enclosed arguments in symbolic

Request a boldface font.

.Pq Dq boldface .

Note that this is a presentation term and should not be used for

stylistically decorating technical terms.

.Pp

This is most often used to indicate importance or seriousness (not to be

confused with stress emphasis, see

.Sx \&Em ) .

When none of the semantic macros fit, it is also adequate for syntax

elements that have to be given or that appear verbatim.

.Pp

Examples:

.Bd -literal -compact -offset indent

\&.Sy Warning :

\&.Sy s

appears in the owner permissions, set-user-ID mode is set.

This utility replaces the former

\&.Sy dumpdir

program.

.Ed

.Pp

See also

.Sx \&Bf ,

.Sx \&Em ,

Line 2890 end of the line.

Line 2949 end of the line.

.It Sx \&D1 Ta \&No Ta \&Yes

.It Sx \&Dl Ta \&No Ta Yes

.It Sx \&Dq Ta Yes Ta Yes

.It Sx \&En Ta Yes Ta Yes

.It Sx \&Op Ta Yes Ta Yes

.It Sx \&Pq Ta Yes Ta Yes

.It Sx \&Ql Ta Yes Ta Yes

Line 2967 then the macro accepts an arbitrary number of argument

Line 3027 then the macro accepts an arbitrary number of argument

.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 \&Es Ta Yes Ta Yes Ta 2

.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 >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 \&Fr Ta Yes Ta Yes Ta >0

.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

Line 2993 then the macro accepts an arbitrary number of argument

Line 3052 then the macro accepts an arbitrary number of argument

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

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

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

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

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

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

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

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

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

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

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

.It Sx \&Sm Ta \&No Ta \&No Ta <2

.It Sx \&St Ta \&No Ta Yes Ta 1

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

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

CVSweb