mandoc/mdoc.7 - diff

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.213 and 1.251

version 1.213, 2011/11/01 14:59:27

version 1.251, 2015/02/15 17:57:45

Line 1

.\" $Id$

.\"

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

.\" purpose with or without fee is hereby granted, provided that the above

Line 125 file for a utility

\&.Nm progname

\&.Nd one line about what it does

\&.\e\(dq .Sh LIBRARY

\&.\e\(dq For sections 2, 3, & 9 only.

\&.\e\(dq For sections 2, 3, and 9 only.

\&.\e\(dq Not used in OpenBSD.

\&.Sh SYNOPSIS

\&.Nm progname

Line 135 file for a utility

The

\&.Nm

utility processes files ...

\&.\e\(dq .Sh CONTEXT

\&.\e\(dq For section 9 functions only.

\&.\e\(dq .Sh IMPLEMENTATION NOTES

\&.\e\(dq Not used in OpenBSD.

\&.\e\(dq .Sh RETURN VALUES

\&.\e\(dq For sections 2, 3, & 9 only.

\&.\e\(dq For sections 2, 3, and 9 function return values only.

\&.\e\(dq .Sh ENVIRONMENT

\&.\e\(dq For sections 1, 6, 7, & 8 only.

\&.\e\(dq For sections 1, 6, 7, and 8 only.

\&.\e\(dq .Sh FILES

\&.\e\(dq .Sh EXIT STATUS

\&.\e\(dq For sections 1, 6, & 8 only.

\&.\e\(dq For sections 1, 6, and 8 only.

\&.\e\(dq .Sh EXAMPLES

\&.\e\(dq .Sh DIAGNOSTICS

\&.\e\(dq For sections 1, 4, 6, 7, & 8 only.

\&.\e\(dq For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.

\&.\e\(dq .Sh ERRORS

\&.\e\(dq For sections 2, 3, & 9 only.

\&.\e\(dq For sections 2, 3, 4, and 9 errno settings only.

\&.\e\(dq .Sh SEE ALSO

\&.\e\(dq .Xr foobar 1

\&.\e\(dq .Sh STANDARDS

Line 318 macro followed by a non-standard section name, and eac

Line 320 macro followed by a non-standard section name, and eac

several subsections, like in the present

.Nm

manual.

.It Em CONTEXT

This section lists the contexts in which functions can be called in section 9.

The contexts are autoconf, process, or interrupt.

.It Em IMPLEMENTATION NOTES

Implementation-specific notes should be kept here.

This is useful when implementing standard functions that may have side

Line 358 Example usages.

Line 363 Example usages.

This often contains snippets of well-formed, well-tested invocations.

Make sure that examples work properly!

.It Em DIAGNOSTICS

Documents error conditions.

Documents error messages.

This is most useful in section 4 manuals.

In section 4 and 9 manuals, these are usually messages printed by the

kernel to the console and to the kernel log.

In section 1, 6, 7, and 8, these are usually messages printed by

userland programs to the standard error output.

.Pp

Historically, this section was used in place of

.Em EXIT STATUS

for manuals in sections 1, 6, and 8; however, this practise is

Line 369 See

Line 378 See

.Sx \&Bl

.Fl diag .

.It Em ERRORS

Documents error handling in sections 2, 3, and 9.

Documents

.Xr errno 2

settings in sections 2, 3, 4, and 9.

.Pp

See

.Sx \&Er .

Line 377 See

Line 388 See

References other manuals with related topics.

This section should exist for most manuals.

Cross-references should conventionally be ordered first by section, then

alphabetically.

alphabetically (ignoring case).

.Pp

References to other documentation concerning the topic of the manual page,

for example authoritative books or journal articles, may also be

Line 422 in the alphabetical

Line 433 in the alphabetical

.Ss Document preamble and NAME section macros

.Bl -column "Brq, Bro, Brc" description

.It Sx \&Dd Ta document date: Cm $\&Mdocdate$ | Ar month day , year

.It Sx \&Dt Ta document title: Ar TITLE section Op Ar volume | arch

.It Sx \&Dt Ta document title: Ar TITLE section Op Ar arch

.It Sx \&Os Ta operating system version: Op Ar system Op Ar version

.It Sx \&Nm Ta document name (one argument)

.It Sx \&Nd Ta document description (one line)

Line 443 in the alphabetical

Line 454 in the alphabetical

.Op Fl compact

.It Sx \&D1 Ta indented display (one line)

.It Sx \&Dl Ta indented literal display (one line)

.It Sx \&Ql Ta in-line literal display: Ql text

.It Sx \&Bl , \&El Ta list block:

.Fl Ar type

.Op Fl width Ar val

Line 457 in the alphabetical

Line 469 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 477 in the alphabetical

Line 489 in the alphabetical

.Bl -column "Brq, Bro, Brc" description

.It Sx \&Lb Ta function library (one argument)

.It Sx \&In Ta include file (one argument)

.It Sx \&Fd Ta other preprocessor directive (>0 arguments)

.It Sx \&Ft Ta function type (>0 arguments)

.It Sx \&Fo , \&Fc Ta function block: Ar funcname

.It Sx \&Fn Ta function name:

Line 501 in the alphabetical

Line 514 in the alphabetical

.It Sx \&Cd Ta kernel configuration declaration (>0 arguments)

.It Sx \&Ad Ta memory address (>0 arguments)

.It Sx \&Ms Ta mathematical symbol (>0 arguments)

.It Sx \&Tn Ta tradename (>0 arguments)

.El

.Ss Physical markup

.Bl -column "Brq, Bro, Brc" description

Line 517 in the alphabetical

Line 529 in the alphabetical

.It Sx \&Dq , \&Do , \&Dc Ta enclose in typographic double quotes: Dq text

.It Sx \&Qq , \&Qo , \&Qc Ta enclose in typewriter double quotes: Qq text

.It Sx \&Sq , \&So , \&Sc Ta enclose in single quotes: Sq text

.It Sx \&Ql Ta single-quoted literal text: Ql text

.It Sx \&Pq , \&Po , \&Pc Ta enclose in parentheses: Pq text

.It Sx \&Bq , \&Bo , \&Bc Ta enclose in square brackets: Bq text

.It Sx \&Brq , \&Bro , \&Brc Ta enclose in curly braces: Brq text

Line 529 in the alphabetical

Line 540 in the alphabetical

.It Sx \&Ex Fl std Ta standard command exit values: Op Ar utility ...

.It Sx \&Rv Fl std Ta standard function return values: Op Ar function ...

.It Sx \&St Ta reference to a standards document (one argument)

.It Sx \&Ux Ta Ux

.It Sx \&At Ta At

.It Sx \&Bx Ta Bx

.It Sx \&Bsx Ta Bsx

Line 657 for all other author listings.

Line 667 for all other author listings.

.Pp

Examples:

.Dl \&.An -nosplit

.Dl \&.An Kristaps Dzonsons \&Aq kristaps@bsd.lv

.Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv

.Ss \&Ao

Begin a block enclosed by angle brackets.

Does not have any head arguments.

Line 711 for fixed strings to be passed verbatim as arguments,

Line 721 for fixed strings to be passed verbatim as arguments,

.Sx \&Cm .

.Ss \&At

Formats an AT&T version.

Formats an

.At

version.

Accepts one optional argument:

.Pp

.Bl -tag -width "v[1-7] | 32vX" -offset indent -compact

Line 738 See also

Line 750 See also

.Sx \&Dx ,

.Sx \&Fx ,

.Sx \&Nx ,

.Sx \&Ox ,

and

.Sx \&Ux .

.Sx \&Ox .

.Ss \&Bc

Close a

.Sx \&Bo

Line 766 The

Line 777 The

must be one of the following:

.Bl -tag -width 13n -offset indent

.It Fl centered

Produce one output line from each input line, and centre-justify each line.

Produce one output line from each input line, and center-justify each line.

Using this display type is not recommended; many

.Nm

implementations render it poorly.

Line 811 which has no effect;

Line 822 which has no effect;

.Cm right ,

which justifies to the right margin; or

.Cm center ,

which aligns around an imagined centre axis.

which aligns around an imagined center axis.

.It

A macro invocation, which selects a predefined width

associated with that macro.

Line 820 The most popular is the imaginary macro

Line 831 The most popular is the imaginary macro

which resolves to

.Sy 6n .

.It

A width using the syntax described in

A scaling width as described in

.Sx Scaling Widths .

.Xr roff 7 .

.It

An arbitrary string, which indents by the length of this string.

.El

Line 926 The

Line 937 The

.Fl width

and

.Fl offset

arguments accept

arguments accept macro names as described for

.Sx Scaling Widths

.Sx \&Bd

.Fl offset ,

scaling widths as described in

.Xr roff 7 ,

or use the length of the given string.

The

.Fl offset

Line 956 A columnated list.

Line 970 A columnated list.

The

.Fl width

argument has no effect; instead, each argument specifies the width

of one column, using either the

of one column, using either the scaling width syntax described in

.Sx Scaling Widths

.Xr roff 7

syntax or the string length of the argument.

or the string length of the argument.

If the first line of the body of a

.Fl column

list is not an

Line 1089 Examples:

Line 1103 Examples:

See also

.Sx \&Bro .

.Ss \&Bsx

Format the BSD/OS version provided as an argument, or a default value if

Format the

.Bsx

version provided as an argument, or a default value if

no argument is provided.

.Pp

Examples:

Line 1102 See also

Line 1118 See also

.Sx \&Dx ,

.Sx \&Fx ,

.Sx \&Nx ,

.Sx \&Ox ,

and

.Sx \&Ux .

.Sx \&Ox .

.Ss \&Bt

Supported only for compatibility, do not use this in new manuals.

Prints

.Dq is currently in beta test.

.Ss \&Bx

Format the BSD version provided as an argument, or a default value if no

Format the

.Bx

version provided as an argument, or a default value if no

argument is provided.

.Pp

Examples:

Line 1123 See also

Line 1141 See also

.Sx \&Dx ,

.Sx \&Fx ,

.Sx \&Nx ,

.Sx \&Ox ,

and

.Sx \&Ux .

.Sx \&Ox .

.Ss \&Cd

Kernel configuration declaration.

This denotes strings accepted by

Line 1168 See also

Line 1185 See also

and

.Sx \&Dl .

.Ss \&Db

Switch debugging mode.

This macro is obsolete.

Its syntax is as follows:

No replacement is needed.

.Pp

It is ignored by

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

.Xr mandoc 1

.Pp

and groff including its arguments.

This macro is ignored by

It was formerly used to toggle a debugging mode.

.Xr mandoc 1 .

.Ss \&Dc

Close a

.Sx \&Do

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 1210 the special string

Line 1226 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 1228 See also

Line 1247 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 1237 Examples:

Line 1256 Examples:

.Dl \&.Dl % mandoc mdoc.7 \e(ba less

.Pp

See also

.Sx \&Ql ,

.Sx \&Bd

.Fl literal ,

and

.Sx \&D1 .

.Ss \&Do

Line 1271 See also

Line 1292 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 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

.Ar 1

.Cm 1

.Pq utilities ,

.Pq General Commands ,

.Ar 2

.Cm 2

.Pq system calls ,

.Pq System Calls ,

.Ar 3

.Cm 3

.Pq libraries ,

.Pq Library Functions ,

.Ar 3p

.Cm 3p

.Pq Perl libraries ,

.Pq Perl Library ,

.Ar 4

.Cm 4

.Pq devices ,

.Pq Device Drivers ,

.Ar 5

.Cm 5

.Pq file formats ,

.Pq File Formats ,

.Ar 6

.Cm 6

.Pq games ,

.Pq Games ,

.Ar 7

.Cm 7

.Pq miscellaneous ,

.Pq Miscellaneous Information ,

.Ar 8

.Cm 8

.Pq system utilities ,

.Pq System Manager's Manual ,

.Ar 9

.Pq kernel functions ,

.Ar X11

.Pq X Window System ,

.Ar X11R6

.Pq X Window System ,

.Ar unass

.Pq unassociated ,

.Ar local

.Pq local system ,

.Ar draft

.Pq draft manual ,

.Ar paper

.Cm 9

.Pq paper .

.Pq Kernel Developer's Manual .

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

.Dq 1

the empty string if unspecified.

if unspecified.

.It Ar volume

This overrides the volume inferred from

.Ar section .

This field is optional, and if specified, must be one of

.Ar USD

.Pq users' supplementary documents ,

.Ar PS1

.Pq programmers' supplementary documents ,

.Ar AMD

.Pq administrators' supplementary documents ,

.Ar SMM

.Pq system managers' manuals ,

.Ar URM

.Pq users' reference manuals ,

.Ar PRM

.Pq programmers' reference manuals ,

.Ar KM

.Pq kernel manuals ,

.Ar IND

.Pq master index ,

.Ar MMI

.Pq master index ,

.Ar LOCAL

.Pq local manuals ,

.Ar LOC

.Pq local manuals ,

.Ar CON

.Pq contributed manuals .

.It Ar arch

This specifies the machine architecture a manual page applies to,

where relevant, for example

Line 1371 where relevant, for example

Line 1346 where relevant, for example

.Cm i386 ,

.Cm sparc64 .

The list of supported architectures varies by operating system.

The list of valid architectures varies by operating system.

For the full list of all architectures recognized by

.Xr mandoc 1 ,

see the file

.Pa arch.in

in the source distribution.

.El

.Pp

Examples:

.Dl \&.Dt FOO 1

.Dl \&.Dt FOO 4 KM

.Dl \&.Dt FOO 9 i386

.Pp

See also

Line 1401 See also

Line 1370 See also

.Sx \&Er

and

.Sx \&Ev

for special-purpose constants and

for special-purpose constants,

.Sx \&Va

for variable symbols.

for variable symbols, and

.Sx \&Fd

for listing preprocessor variable definitions in the

.Em SYNOPSIS .

.Ss \&Dx

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

Format the

.Dx

version provided as an argument, or a default

value if no argument is provided.

.Pp

Examples:

Line 1418 See also

Line 1392 See also

.Sx \&Bx ,

.Sx \&Fx ,

.Sx \&Nx ,

.Sx \&Ox ,

and

.Sx \&Ux .

.Sx \&Ox .

.Ss \&Ec

Close a scope started by

.Sx \&Eo .

Line 1451 See also

Line 1424 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 1469 See also

Line 1455 See also

and

.Sx \&Sy .

.Ss \&En

This macro is obsolete and not implemented in

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 1496 See also

Line 1488 See also

.Sx \&Dv

for general constants.

.Ss \&Es

This macro is obsolete and not implemented.

This macro is obsolete.

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 1528 arguments are treated as separate utilities.

Line 1527 arguments are treated as separate utilities.

See also

.Sx \&Rv .

.Ss \&Fa

Function argument.

Function argument or parameter.

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 1554 the last argument will also have a trailing comma.

Line 1565 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 1562 See also

Line 1573 See also

End a function context started by

.Sx \&Fo .

.Ss \&Fd

Historically used to document include files.

Preprocessor directive, in particular for listing it in the

This usage has been deprecated in favour of

.Em SYNOPSIS .

Historically, it was also used to document include files.

The latter usage has been deprecated in favour of

.Sx \&In .

Do not use this macro.

.Pp

Its syntax is as follows:

.Bd -ragged -offset indent

.Pf \. Sx \&Fd

.Li # Ns Ar directive

.Op Ar argument ...

.Ed

.Pp

Examples:

.Dl \&.Fd #define sa_handler __sigaction_u.__sa_handler

.Dl \&.Fd #define SIO_MAXNFDS

.Dl \&.Fd #ifdef FS_DEBUG

.Dl \&.Ft void

.Dl \&.Fn dbg_open \(dqconst char *\(dq

.Dl \&.Fd #endif

.Pp

See also

.Sx MANUAL STRUCTURE

.Sx MANUAL STRUCTURE ,

.Sx \&In ,

and

.Sx \&In .

.Sx \&Dv .

.Ss \&Fl

Command-line flag or option.

Used when listing arguments to command-line utilities.

Line 1640 Invocations usually occur in the following context:

Line 1668 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 1659 See also

Line 1687 See also

and

.Sx \&Ft .

.Ss \&Fr

This macro is obsolete and not implemented in

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 1704 See also

Line 1729 See also

.Sx \&Bx ,

.Sx \&Dx ,

.Sx \&Nx ,

.Sx \&Ox ,

and

.Sx \&Ux .

.Sx \&Ox .

.Ss \&Hf

This macro is not implemented in

.Xr mandoc 1 .

Line 1734 is preferred for displaying code; the

Line 1758 is preferred for displaying code; the

.Sx \&Ic

macro is used when referring to specific instructions.

.Ss \&In

The name of an include file.

.Dq include

This macro is most often used in section 2, 3, and 9 manual pages.

file.

.Pp

When invoked as the first macro on an input line in the

.Em SYNOPSIS

section, the argument is displayed in angle brackets

and preceded by

.Dq #include ,

.Qq #include ,

and a blank line is inserted in front if there is a preceding

function declaration.

This is most often used in section 2, 3, and 9 manual pages.

In other sections, it only encloses its argument in angle brackets

and causes no line break.

.Pp

Examples:

.Dl \&.In sys/types.h

Line 1851 section as described in

Line 1876 section as described in

.Pp

Examples:

.Dl \&.Lb libz

.Dl \&.Lb mdoc

.Dl \&.Lb libmandoc

.Ss \&Li

Denotes text that should be in a

.Li literal

Line 1902 Its syntax is as follows:

Line 1927 Its syntax is as follows:

.Pp

Examples:

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

.Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv

.Ss \&Nd

A one line description of the manual's content.

This may only be invoked in the

Line 2023 See also

Line 2049 See also

.Sx \&Bx ,

.Sx \&Dx ,

.Sx \&Fx ,

.Sx \&Ox ,

and

.Sx \&Ux .

.Sx \&Ox .

.Ss \&Oc

Close multi-line

.Sx \&Oo

Line 2054 Examples:

Line 2079 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 2066 Its syntax is as follows:

Line 2091 Its syntax is as follows:

The optional

.Ar system

parameter specifies the relevant operating system or environment.

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

It is suggested to leave it unspecified, in which case

This is the suggested form.

.Xr mandoc 1

uses its

.Fl Ios

argument, or, if that isn't specified either,

.Fa sysname

and

.Fa release

as returned by

.Xr uname 3 .

.Pp

Examples:

.Dl \&.Os

Line 2079 See also

Line 2112 See also

and

.Sx \&Dt .

.Ss \&Ot

This macro is obsolete and not implemented in

This macro is obsolete.

.Xr mandoc 1 .

Use

.Sx \&Ft

instead; with

.Xr mandoc 1 ,

both have the same effect.

.Pp

Historical

.Xr mdoc 7

.Nm

packages described it as

.Dq "old function type (FORTRAN)" .

.Ss \&Ox

Line 2102 See also

Line 2139 See also

.Sx \&Bx ,

.Sx \&Dx ,

.Sx \&Fx ,

.Sx \&Nx ,

and

.Sx \&Ux .

.Sx \&Nx .

.Ss \&Pa

An absolute or relative file system path, or a file or directory name.

If an argument is not provided, the character

Line 2168 See also

Line 2204 See also

Close quoted context opened by

.Sx \&Qo .

.Ss \&Ql

Format a single-quoted literal.

In-line literal display.

This can for example be used for complete command invocations and

for multi-word code fragments when more specific markup is not

appropriate and an indented display is not desired.

While

.Xr mandoc 1

always encloses the arguments in single quotes, other formatters

usually omit the quotes on non-terminal output devices when the

arguments have three or more characters.

.Pp

See also

.Sx \&Qq

.Sx \&Dl

and

.Sx \&Sq .

.Sx \&Bd

.Fl literal .

.Ss \&Qo

Multi-line version of

.Sx \&Qq .

Line 2278 and

Line 2324 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 2287 When switched

Line 2333 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 2324 and

Line 2375 and

.Sx \&Sx .

.Ss \&St

Replace an abbreviation for a standard with the full form.

The following standards are recognised:

The following standards are recognised.

Where multiple lines are given without a blank line in between,

they all refer to the same standard, and using the first form

is recommended.

.Bl -tag -width 1n

.It C language standards

.Pp

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

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

.It \-p1003.1-88

.It \-ansiC

.St -p1003.1-88

.St -ansiC

.It \-p1003.1-90

.It \-ansiC-89

.St -p1003.1-90

.St -ansiC-89

.It \-p1003.1-96

.St -p1003.1-96

.It \-p1003.1-2001

.St -p1003.1-2001

.It \-p1003.1-2004

.St -p1003.1-2004

.It \-p1003.1-2008

.St -p1003.1-2008

.It \-p1003.1

.St -p1003.1

.It \-p1003.1b

.St -p1003.1b

.It \-p1003.1b-93

.St -p1003.1b-93

.It \-p1003.1c-95

.St -p1003.1c-95

.It \-p1003.1g-2000

.St -p1003.1g-2000

.It \-p1003.1i-95

.St -p1003.1i-95

.It \-p1003.2-92

.St -p1003.2-92

.It \-p1003.2a-92

.St -p1003.2a-92

.It \-p1387.2-95

.St -p1387.2-95

.It \-p1003.2

.St -p1003.2

.It \-p1387.2

.St -p1387.2

.It \-isoC

.St -isoC

.It \-isoC-90

.St -isoC-90

.br

The original C standard.

.Pp

.It \-isoC-amd1

.St -isoC-amd1

.Pp

.It \-isoC-tcor1

.St -isoC-tcor1

.Pp

.It \-isoC-tcor2

.St -isoC-tcor2

.Pp

.It \-isoC-99

.St -isoC-99

.br

The second major version of the C language standard.

.Pp

.It \-isoC-2011

.St -isoC-2011

.br

The third major version of the C language standard.

.El

.It POSIX.1 before the Single UNIX Specification

.Pp

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

.It \-p1003.1-88

.St -p1003.1-88

.It \-p1003.1

.St -p1003.1

.br

The original POSIX standard, based on ANSI C.

.Pp

.It \-p1003.1-90

.St -p1003.1-90

.It \-iso9945-1-90

.St -iso9945-1-90

.br

The first update of POSIX.1.

.Pp

.It \-p1003.1b-93

.St -p1003.1b-93

.It \-p1003.1b

.St -p1003.1b

.br

Real-time extensions.

.Pp

.It \-p1003.1c-95

.St -p1003.1c-95

.br

POSIX thread interfaces.

.Pp

.It \-p1003.1i-95

.St -p1003.1i-95

.br

Technical Corrigendum.

.Pp

.It \-p1003.1-96

.St -p1003.1-96

.It \-iso9945-1-96

.St -iso9945-1-96

.It \-iso9945-2-93

.br

.St -iso9945-2-93

Includes POSIX.1-1990, 1b, 1c, and 1i.

.It \-ansiC

.El

.St -ansiC

.It X/Open Portability Guide version 4 and related standards

.It \-ansiC-89

.Pp

.St -ansiC-89

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

.It \-ansiC-99

.St -ansiC-99

.It \-ieee754

.St -ieee754

.It \-iso8802-3

.St -iso8802-3

.It \-iso8601

.St -iso8601

.It \-ieee1275-94

.St -ieee1275-94

.It \-xpg3

.St -xpg3

.br

An XPG4 precursor, published in 1989.

.Pp

.It \-p1003.2

.St -p1003.2

.It \-p1003.2-92

.St -p1003.2-92

.It \-iso9945-2-93

.St -iso9945-2-93

.br

An XCU4 precursor.

.Pp

.It \-p1003.2a-92

.St -p1003.2a-92

.br

Updates to POSIX.2.

.Pp

.It \-xpg4

.St -xpg4

.br

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

.El

.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

.It \-xpg4.3

.br

.St -xpg4.3

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

.It \-xsh4.2

.St -xsh4.2

.Pp

.It \-xcurses4.2

.St -xcurses4.2

.Pp

.It \-p1003.1g-2000

.St -p1003.1g-2000

.br

Networking APIs, including sockets.

.Pp

.It \-svid4

.St -svid4 ,

.br

Published in 1995.

.El

.It Single UNIX Specification version 2 and related standards

.Pp

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

.It \-susv2

.St -susv2

This Standard was published in 1997

and is also called X/Open Portability Guide version 5.

It was used as the basis for UNIX 98 certification.

The following refer to parts of it.

.Pp

.It \-xbd5

.St -xbd5

.It \-xcu5

.Pp

.St -xcu5

.It \-xsh5

.St -xsh5

.Pp

.It \-xcu5

.St -xcu5

.Pp

.It \-xns5

.St -xns5

.It \-xns5.2

.St -xns5.2

.It \-xns5.2d2.0

.El

.St -xns5.2d2.0

.It Single UNIX Specification version 3

.It \-xcurses4.2

.Pp

.St -xcurses4.2

.Bl -tag -width "-p1003.1-2001" -compact

.It \-susv2

.It \-p1003.1-2001

.St -susv2

.St -p1003.1-2001

.It \-susv3

.St -susv3

.It \-svid4

.br

.St -svid4

This standard is based on C99, SUSv2, POSIX.1-1996, 1d, and 1j.

It is also called X/Open Portability Guide version 6.

It is used as the basis for UNIX 03 certification.

.Pp

.It \-p1003.1-2004

.St -p1003.1-2004

.br

The second and last Technical Corrigendum.

.El

.It Single UNIX Specification version 4

.Pp

.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

X/Open Portability Guide version 7.

.Pp

.It \-p1003.1-2013

.St -p1003.1-2013

.br

This is the first Technical Corrigendum.

.El

.It Other standards

.Pp

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

.It \-ieee754

.St -ieee754

.br

Floating-point arithmetic.

.Pp

.It \-iso8601

.St -iso8601

.br

Representation of dates and times, published in 1988.

.Pp

.It \-iso8802-3

.St -iso8802-3

.br

Ethernet local area networks.

.Pp

.It \-ieee1275-94

.St -ieee1275-94

.El

.Ss \&Sx

Reference a section or subsection in the same manual page.

The referenced section or subsection name must be identical to the

Line 2435 See also

Line 2601 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 2452 Table cell separator in

Line 2632 Table cell separator in

lists; can only be used below

.Sx \&It .

.Ss \&Tn

Format a tradename.

Supported only for compatibility, do not use this in new manuals.

.Pp

Even though the macro name

Since this macro is often implemented to use a small caps font,

.Pq Dq tradename

it has historically been used for acronyms (like ASCII) as well.

suggests a semantic function, historic usage is inconsistent, mostly

Such usage is not recommended because it would use the same macro

using it as a presentation-level macro to request a small caps font.

sometimes for semantical annotation, sometimes for physical formatting.

.Pp

Examples:

.Dl \&.Tn IBM

.Ss \&Ud

Supported only for compatibility, do not use this in new manuals.

Prints out

.Dq currently under development.

.Ss \&Ux

Format the UNIX name.

Supported only for compatibility, do not use this in new manuals.

Accepts no argument.

Prints out

.Pp

.Dq Ux .

Examples:

.Dl \&.Ux

.Pp

See also

.Sx \&At ,

.Sx \&Bsx ,

.Sx \&Bx ,

.Sx \&Dx ,

.Sx \&Fx ,

.Sx \&Nx ,

and

.Sx \&Ox .

.Ss \&Va

A variable name.

.Pp

Examples:

.Dl \&.Va foo

.Dl \&.Va const char *bar ;

.Pp

For function arguments and parameters, use

.Sx \&Fa

instead.

For declarations of global variables in the

.Em SYNOPSIS

section, use

.Sx \&Vt .

.Ss \&Vt

A variable type.

.Pp

This is also used for indicating global variables in the

.Em SYNOPSIS

section, in which case a variable name is also specified.

Line 2502 In the former case, this macro starts a new output lin

Line 2676 In the former case, this macro starts a new output lin

and a blank line is inserted in front if there is a preceding

function definition or include directive.

.Pp

Note that this should not be confused with

.Sx \&Ft ,

which is used for function return types.

.Pp

Examples:

.Dl \&.Vt unsigned char

.Dl \&.Vt extern const char * const sys_signame[] \&;

.Pp

For parameters in function prototypes, use

.Sx \&Fa

instead, for function return types

.Sx \&Ft ,

and for variable names outside the

.Em SYNOPSIS

section

.Sx \&Va ,

even when including a type with the name.

See also

.Sx MANUAL STRUCTURE

.Sx MANUAL STRUCTURE .

and

.Sx \&Va .

.Ss \&Xc

Close a scope opened by

.Sx \&Xo .

Line 2530 Link to another manual

Line 2707 Link to another manual

.Pq Qq cross-reference .

Its syntax is as follows:

.Pp

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

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

.Pp

The

Cross reference the

.Ar name

and

.Ar section

are the name and section of the linked manual.

number of another man page;

omitting the section number is rarely useful.

.Ar section

is followed by non-punctuation, an

.Sx \&Ns

is inserted into the token stream.

This behaviour is for compatibility with

GNU troff.

.Pp

Examples:

.Dl \&.Xr mandoc 1

Line 2567 Its syntax is as follows:

Line 2738 Its syntax is as follows:

.Pp

The

.Ar height

argument must be formatted as described in

argument is a scaling width as described in

.Sx Scaling Widths .

.Xr roff 7 .

If unspecified,

.Sx \&sp

asserts a single vertical space.

Line 2737 end of the line.

Line 2908 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 2814 then the macro accepts an arbitrary number of argument

Line 2986 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 2840 then the macro accepts an arbitrary number of argument

Line 3011 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

Line 2962 Manually switching the font using the

Line 3133 Manually switching the font using the

.Ql \ef

font escape sequences is never required.

.Sh COMPATIBILITY

This section documents compatibility between mandoc and other other

This section provides an incomplete list of compatibility issues

troff implementations, at this time limited to GNU troff

between mandoc and GNU troff

.Pq Qq groff .

The term

.Qq historic groff

refers to groff versions before 1.17,

which featured a significant update of the

.Pa doc.tmac

file.

.Pp

Heirloom troff, the other significant troff implementation accepting

\-mdoc, is similar to historic groff.

.Pp

The following problematic behaviour is found in groff:

.ds hist (Historic groff only.)

.Pp

.Bl -dash -compact

.It

Display macros

.Po

.Sx \&Bd ,

.Sx \&Dl ,

and

.Sx \&D1

.Pc

may not be nested.

\*[hist]

.It

.Sx \&At

with unknown arguments produces no output at all.

\*[hist]

Newer groff and mandoc print

.Qq AT&T UNIX

and the arguments.

.It

.Sx \&Bl Fl column

does not recognise trailing punctuation characters when they immediately

precede tabulator characters, but treats them as normal text and

outputs a space before them.

.It

.Sx \&Bd Fl ragged compact

does not start a new line.

\*[hist]

.It

.Sx \&Dd

with non-standard arguments behaves very strangely.

When there are three arguments, they are printed verbatim.

Line 3014 but without any arguments the string

Line 3149 but without any arguments the string

.Dq Epoch

is printed.

.It

.Sx \&Fl

does not print a dash for an empty argument.

\*[hist]

.It

.Sx \&Fn

does not start a new line unless invoked as the line macro in the

.Em SYNOPSIS

section.

\*[hist]

.It

.Sx \&Fo

with

.Pf non- Sx \&Fa

children causes inconsistent spacing between arguments.

In mandoc, a single space is always inserted between arguments.

.It

.Sx \&Ft

in the

.Em SYNOPSIS

causes inconsistent vertical spacing, depending on whether a prior

.Sx \&Fn

has been invoked.

See

.Sx \&Ft

and

.Sx \&Fn

for the normalised behaviour in mandoc.

.It

.Sx \&In

ignores additional arguments and is not treated specially in the

.Em SYNOPSIS .

\*[hist]

.It

.Sx \&It

sometimes requires a

.Fl nested

flag.

\*[hist]

In new groff and mandoc, any list may be nested by default and

.Fl enum

lists will restart the sequence only for the sub-list.

.It

.Sx \&Li

followed by a delimiter is incorrectly used in some manuals

instead of properly quoting that character, which sometimes works with

historic groff.

.It

.Sx \&Lk

only accepts a single link-name argument; the remainder is misformatted.

.It

Line 3072 certain list types.

Line 3160 certain list types.

can only be called by other macros, but not at the beginning of a line.

.It

.Sx \&%C

is not implemented.

is not implemented (up to and including groff-1.22.2).

.It

Historic groff only allows up to eight or nine arguments per macro input

line, depending on the exact situation.

Providing more arguments causes garbled output.

The number of arguments on one input line is not limited with mandoc.

.It

Historic groff has many un-callable macros.

Most of these (excluding some block-level macros) are callable

in new groff and mandoc.

.It

.Sq \(ba

(vertical bar) is not fully supported as a delimiter.

\*[hist]

.It

.Sq \ef

.Pq font face

and

.Sq \ef

.Sq \eF

.Pq font family face

.Sx Text Decoration

escapes behave irregularly when specified within line-macro scopes.

Line 3104 The following features are unimplemented in mandoc:

Line 3179 The following features are unimplemented in mandoc:

.Bl -dash -compact

.It

.Sx \&Bd

.Fl file Ar file .

.Fl file Ar file

is unsupported for security reasons.

.It

.Sx \&Bd

.Fl offset Ar center

.Fl filled

and

does not adjust the right margin, but is an alias for

.Fl offset Ar right .

.Sx \&Bd

Groff does not implement centred and flush-right rendering either,

.Fl ragged .

but produces large indentations.

.It

The

.Sx \&Bd

.Sq \eh

.Fl literal

.Pq horizontal position ,

does not use a literal font, but is an alias for

.Sq \ev

.Sx \&Bd

.Pq vertical position ,

.Fl unfilled .

.Sq \em

.Pq text colour ,

.Sq \eM

.Pq text filling colour ,

.Sq \ez

.Pq zero-length character ,

.Sq \ew

.Pq string length ,

.Sq \ek

.Pq horizontal position marker ,

.Sq \eo

.Pq text overstrike ,

and

.Sq \es

.Pq text size

escape sequences are all discarded in mandoc.

.It

The

.Sx \&Bd

.Sq \ef

.Fl offset Cm center

scaling unit is accepted by mandoc, but rendered as the default unit.

and

.It

.Fl offset Cm right

In quoted literals, groff allows pairwise double-quotes to produce a

don't work.

standalone double-quote in formatted output.

Groff does not implement centered and flush-right rendering either,

This is not supported by mandoc.

but produces large indentations.

.El

.Sh SEE ALSO

.Xr man 1 ,

Line 3166 utility written by Kristaps Dzonsons appeared in

Line 3225 utility written by Kristaps Dzonsons appeared in

The

.Nm

reference was written by

.An Kristaps Dzonsons ,

.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .

.Mt kristaps@bsd.lv .

CVSweb