mandoc/mdoc.7 - diff

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.212 and 1.281

version 1.212, 2011/09/27 21:49:23

version 1.281, 2020/02/13 18:32:56

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 94 document consists of a document prologue followed by o

sections.

.Pp

The prologue, which consists of the

.Sx \&Dd ,

.Ic \&Dd ,

.Sx \&Dt ,

.Ic \&Dt ,

and

.Sx \&Os

.Ic \&Os

macros in that order, is required for every document.

.Pp

The first section (sections are denoted by

.Sx \&Sh )

.Ic \&Sh )

must be the NAME section, consisting of at least one

.Sx \&Nm

.Ic \&Nm

followed by

.Sx \&Nd .

.Ic \&Nd .

.Pp

Following that, convention dictates specifying at least the

.Em SYNOPSIS

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 180 Multiple

Line 182 Multiple

names should be separated by commas.

.Pp

The

.Sx \&Nm

.Ic \&Nm

macro(s) must precede the

.Sx \&Nd

.Ic \&Nd

macro.

.Pp

See

.Sx \&Nm

.Ic \&Nm

and

.Sx \&Nd .

.Ic \&Nd .

.It Em LIBRARY

The name of the library containing the documented material, which is

assumed to be a function in a section 2, 3, or 9 manual.

Line 198 The syntax for this is as follows:

Line 200 The syntax for this is as follows:

.Ed

.Pp

See

.Sx \&Lb .

.Ic \&Lb .

.It Em SYNOPSIS

Documents the utility invocation syntax, function call syntax, or device

configuration.

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

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

.Ed

.Pp

Ordering of

.Sx \&In ,

.Ic \&In ,

.Sx \&Vt ,

.Ic \&Vt ,

.Sx \&Fn ,

.Ic \&Fn ,

and

.Sx \&Fo

.Ic \&Fo

macros should follow C header-file conventions.

.Pp

And for the third, configurations (section 4):

Line 248 Manuals not in these sections generally don't need a

Line 250 Manuals not in these sections generally don't need a

Some macros are displayed differently in the

.Em SYNOPSIS

section, particularly

.Sx \&Nm ,

.Ic \&Nm ,

.Sx \&Cd ,

.Ic \&Cd ,

.Sx \&Fd ,

.Ic \&Fd ,

.Sx \&Fn ,

.Ic \&Fn ,

.Sx \&Fo ,

.Ic \&Fo ,

.Sx \&In ,

.Ic \&In ,

.Sx \&Vt ,

.Ic \&Vt ,

and

.Sx \&Ft .

.Ic \&Ft .

All of these macros are output on their own line.

If two such dissimilar macros are pairwise invoked (except for

.Sx \&Ft

.Ic \&Ft

before

.Sx \&Fo

.Ic \&Fo

.Sx \&Fn ) ,

.Ic \&Fn ) ,

they are separated by a vertical space, unless in the case of

.Sx \&Fo ,

.Ic \&Fo ,

.Sx \&Fn ,

.Ic \&Fn ,

and

.Sx \&Ft ,

.Ic \&Ft ,

which are always separated by vertical space.

.Pp

When text and macros following an

.Sx \&Nm

.Ic \&Nm

macro starting an input line span multiple output lines,

all output lines but the first will be indented to align

with the text immediately following the

.Sx \&Nm

.Ic \&Nm

macro, up to the next

.Sx \&Nm ,

.Ic \&Nm ,

.Sx \&Sh ,

.Ic \&Sh ,

.Sx \&Ss

.Ic \&Ss

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

.It Em DESCRIPTION

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

Line 302 Print verbose information.

Line 304 Print verbose information.

\&.El

.Ed

.Pp

List the options in alphabetical order,

uppercase before lowercase for each letter and

with no regard to whether an option takes an argument.

Put digits in ascending order before all letter options.

.Pp

Manuals not documenting a command won't include the above fragment.

.Pp

Since the

.Em DESCRIPTION

section usually contains most of the text of a manual, longer manuals

often use the

.Sx \&Ss

.Ic \&Ss

macro to form subsections.

In very long manuals, the

.Em DESCRIPTION

may be split into multiple sections, each started by an

.Sx \&Sh

.Ic \&Sh

macro followed by a non-standard section name, and each having

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 327 This section documents the

Line 337 This section documents the

return values of functions in sections 2, 3, and 9.

.Pp

See

.Sx \&Rv .

.Ic \&Rv .

.It Em ENVIRONMENT

Lists the environment variables used by the utility,

and explains the syntax and semantics of their values.

Line 336 The

Line 346 The

manual provides examples of typical content and formatting.

.Pp

See

.Sx \&Ev .

.Ic \&Ev .

.It Em FILES

Documents files used.

It's helpful to document both the file name and a short description of how

the file is used (created, modified, etc.).

.Pp

See

.Sx \&Pa .

.Ic \&Pa .

.It Em EXIT STATUS

This section documents the

command exit status for section 1, 6, and 8 utilities.

Line 352 Historically, this information was described in

Line 362 Historically, this information was described in

a practise that is now discouraged.

.Pp

See

.Sx \&Ex .

.Ic \&Ex .

.It Em EXAMPLES

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

discouraged.

.Pp

See

.Sx \&Bl

.Ic \&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 .

.Ic \&Er .

.It Em SEE ALSO

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

provided in this section.

.Pp

See

.Sx \&Rs

.Ic \&Rs

and

.Sx \&Xr .

.Ic \&Xr .

.It Em STANDARDS

References any standards implemented or used.

If not adhering to any standards, the

Line 394 If not adhering to any standards, the

Line 410 If not adhering to any standards, the

section should be used instead.

.Pp

See

.Sx \&St .

.Ic \&St .

.It Em HISTORY

A brief history of the subject, including where it was first implemented,

and when it was ported to or reimplemented for the operating system at hand.

Line 403 Credits to the person or persons who wrote the code an

Line 419 Credits to the person or persons who wrote the code an

Authors should generally be noted by both name and email address.

.Pp

See

.Sx \&An .

.Ic \&An .

.It Em CAVEATS

Common misuses and misunderstandings should be explained

in this section.

Line 421 in the alphabetical

Line 437 in the alphabetical

.Sx MACRO REFERENCE .

.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 Ic \&Dd Ta document date: Cm $\&Mdocdate$ | Ar month day , year

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

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

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

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

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

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

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

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

.El

.Ss Sections and cross references

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

.It Sx \&Sh Ta section header (one line)

.It Ic \&Sh Ta section header (one line)

.It Sx \&Ss Ta subsection header (one line)

.It Ic \&Ss Ta subsection header (one line)

.It Sx \&Sx Ta internal cross reference to a section or subsection

.It Ic \&Sx Ta internal cross reference to a section or subsection

.It Sx \&Xr Ta cross reference to another manual page: Ar name section

.It Ic \&Xr Ta cross reference to another manual page: Ar name section

.It Sx \&Pp , \&Lp Ta start a text paragraph (no arguments)

.It Ic \&Tg Ta tag the definition of a Ar term Pq <= 1 arguments

.It Ic \&Pp Ta start a text paragraph (no arguments)

.El

.Ss Displays and lists

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

.It Sx \&Bd , \&Ed Ta display block:

.It Ic \&Bd , \&Ed Ta display block:

.Fl Ar type

.Op Fl offset Ar width

.Op Fl compact

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

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

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

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

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

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

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

.Fl Ar type

.Op Fl width Ar val

.Op Fl offset Ar val

.Op Fl compact

.It Sx \&It Ta list item (syntax depends on Fl Ar type )

.It Ic \&It Ta list item (syntax depends on Fl Ar type )

.It Sx \&Ta Ta table cell separator in Sx \&Bl Fl column No lists

.It Ic \&Ta Ta table cell separator in Ic \&Bl Fl column No lists

.It Sx \&Rs , \&%* , \&Re Ta bibliographic block (references)

.It Ic \&Rs , \&%* , \&Re Ta bibliographic block (references)

.El

.Ss Spacing control

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

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

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

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

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

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

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

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

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

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

.It Ic \&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

.El

.Ss Semantic markup for command line utilities:

.Ss Semantic markup for command line utilities

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

.It Sx \&Nm Ta start a SYNOPSIS block with the name of a utility

.It Ic \&Nm Ta start a SYNOPSIS block with the name of a utility

.It Sx \&Fl Ta command line options (flags) (>=0 arguments)

.It Ic \&Fl Ta command line options (flags) (>=0 arguments)

.It Sx \&Cm Ta command modifier (>0 arguments)

.It Ic \&Cm Ta command modifier (>0 arguments)

.It Sx \&Ar Ta command arguments (>=0 arguments)

.It Ic \&Ar Ta command arguments (>=0 arguments)

.It Sx \&Op , \&Oo , \&Oc Ta optional syntax elements (enclosure)

.It Ic \&Op , \&Oo , \&Oc Ta optional syntax elements (enclosure)

.It Sx \&Ic Ta internal or interactive command (>0 arguments)

.It Ic \&Ic Ta internal or interactive command (>0 arguments)

.It Sx \&Ev Ta environmental variable (>0 arguments)

.It Ic \&Ev Ta environmental variable (>0 arguments)

.It Sx \&Pa Ta file system path (>=0 arguments)

.It Ic \&Pa Ta file system path (>=0 arguments)

.El

.Ss Semantic markup for function libraries:

.Ss Semantic markup for function libraries

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

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

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

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

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

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

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

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

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

.It Sx \&Fn Ta function name:

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

.Op Ar functype

.It Ic \&Fn Ta function name: Ar funcname Op Ar argument ...

.Ar funcname

.It Ic \&Fa Ta function argument (>0 arguments)

.Oo

.It Ic \&Vt Ta variable type (>0 arguments)

.Op Ar argtype

.It Ic \&Va Ta variable name (>0 arguments)

.Ar argname

.It Ic \&Dv Ta defined variable or preprocessor constant (>0 arguments)

.Oc

.It Ic \&Er Ta error constant (>0 arguments)

.It Sx \&Fa Ta function argument (>0 arguments)

.It Ic \&Ev Ta environmental variable (>0 arguments)

.It Sx \&Vt Ta variable type (>0 arguments)

.It Sx \&Va Ta variable name (>0 arguments)

.It Sx \&Dv Ta defined variable or preprocessor constant (>0 arguments)

.It Sx \&Er Ta error constant (>0 arguments)

.It Sx \&Ev Ta environmental variable (>0 arguments)

.El

.Ss Various semantic markup:

.Ss Various semantic markup

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

.It Sx \&An Ta author name (>0 arguments)

.It Ic \&An Ta author name (>0 arguments)

.It Sx \&Lk Ta hyperlink: Ar uri Op Ar name

.It Ic \&Lk Ta hyperlink: Ar uri Op Ar display_name

.It Sx \&Mt Ta Do mailto Dc hyperlink: Ar address

.It Ic \&Mt Ta Do mailto Dc hyperlink: Ar localpart Ns @ Ns Ar domain

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

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

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

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

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

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

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

.El

.Ss Physical markup

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

.It Sx \&Em Ta italic font or underline (emphasis) (>0 arguments)

.It Ic \&Em Ta italic font or underline (emphasis) (>0 arguments)

.It Sx \&Sy Ta boldface font (symbolic) (>0 arguments)

.It Ic \&Sy Ta boldface font (symbolic) (>0 arguments)

.It Sx \&Li Ta typewriter font (literal) (>0 arguments)

.It Ic \&No Ta return to roman font (normal) (>0 arguments)

.It Sx \&No Ta return to roman font (normal) (no arguments)

.It Ic \&Bf , \&Ef Ta font block: Fl Ar type | Cm \&Em | \&Li | \&Sy

.It Sx \&Bf , \&Ef Ta font block:

.Op Fl Ar type | Cm \&Em | \&Li | \&Sy

.El

.Ss Physical enclosures

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

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

.It Ic \&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 Ic \&Qq , \&Qo , \&Qc Ta enclose in typewriter double quotes: Qq text

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

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

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

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

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

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

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

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

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

.It Ic \&Aq , \&Ao , \&Ac Ta enclose in angle brackets: Aq text

.It Sx \&Aq , \&Ao , \&Ac Ta enclose in angle brackets: Aq text

.It Ic \&Eo , \&Ec Ta generic enclosure

.It Sx \&Eo , \&Ec Ta generic enclosure

.El

.Ss Text production

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

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

.It Ic \&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 Ic \&Rv Fl std Ta standard function return values: Op Ar function ...

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

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

.It Sx \&Ux Ta Ux

.It Ic \&At Ta At

.It Sx \&At Ta At

.It Ic \&Bx Ta Bx

.It Sx \&Bx Ta Bx

.It Ic \&Bsx Ta Bsx

.It Sx \&Bsx Ta Bsx

.It Ic \&Nx Ta Nx

.It Sx \&Nx Ta Nx

.It Ic \&Fx Ta Fx

.It Sx \&Fx Ta Fx

.It Ic \&Ox Ta Ox

.It Sx \&Ox Ta Ox

.It Ic \&Dx Ta Dx

.It Sx \&Dx Ta Dx

.El

.Sh MACRO REFERENCE

This section is a canonical reference of all macros, arranged

alphabetically.

For the scoping of individual macros, see

.Sx MACRO SYNTAX .

.Ss \&%A

.Bl -tag -width 3n

.It Ic \&%A Ar first_name ... last_name

Author name of an

.Sx \&Rs

.Ic \&Rs

block.

Multiple authors should each be accorded their own

.Sx \%%A

.Ic \%%A

line.

Author names should be ordered with full or abbreviated forename(s)

first, then full surname.

.Ss \&%B

.It Ic \&%B Ar title

Book title of an

.Sx \&Rs

.Ic \&Rs

block.

This macro may also be used in a non-bibliographic context when

referring to book titles.

.Ss \&%C

.It Ic \&%C Ar location

Publication city or location of an

.Sx \&Rs

.Ic \&Rs

block.

.Ss \&%D

.It Ic \&%D Oo Ar month day , Oc Ar year

Publication date of an

.Sx \&Rs

.Ic \&Rs

block.

Recommended formats of arguments are

Provide the full English name of the

.Ar month day , year

.Ar month

or just

and all four digits of the

.Ar year .

.Ss \&%I

.It Ic \&%I Ar name

Publisher or issuer name of an

.Sx \&Rs

.Ic \&Rs

block.

.Ss \&%J

.It Ic \&%J Ar name

Journal name of an

.Sx \&Rs

.Ic \&Rs

block.

.Ss \&%N

.It Ic \&%N Ar number

Issue number (usually for journals) of an

.Sx \&Rs

.Ic \&Rs

block.

.Ss \&%O

.It Ic \&%O Ar line

Optional information of an

.Sx \&Rs

.Ic \&Rs

block.

.Ss \&%P

.It Ic \&%P Ar number

Book or journal page number of an

.Sx \&Rs

.Ic \&Rs

block.

.Ss \&%Q

Conventionally, the argument starts with

.Ql p.\&

for a single page or

.Ql pp.\&

for a range of pages, for example:

.Pp

.Dl .%P pp. 42\e(en47

.It Ic \&%Q Ar name

Institutional author (school, government, etc.) of an

.Sx \&Rs

.Ic \&Rs

block.

Multiple institutional authors should each be accorded their own

.Sx \&%Q

.Ic \&%Q

line.

.Ss \&%R

.It Ic \&%R Ar name

Technical report name of an

.Sx \&Rs

.Ic \&Rs

block.

.Ss \&%T

.It Ic \&%T Ar title

Article title of an

.Sx \&Rs

.Ic \&Rs

block.

This macro may also be used in a non-bibliographical context when

referring to article titles.

.Ss \&%U

.It Ic \&%U Ar protocol Ns :// Ns Ar path

URI of reference document.

.Ss \&%V

.It Ic \&%V Ar number

Volume number of an

.Sx \&Rs

.Ic \&Rs

block.

.Ss \&Ac

.It Ic \&Ac

Close an

.Sx \&Ao

.Ic \&Ao

block.

Does not have any tail arguments.

.Ss \&Ad

.It Ic \&Ad Ar address

Memory address.

Do not use this for postal addresses.

.Pp

Examples:

.Dl \&.Ad [0,$]

.Dl \&.Ad 0x00000000

.Ss \&An

.It Ic \&An Fl split | nosplit | Ar first_name ... last_name

Author name.

Can be used both for the authors of the program, function, or driver

documented in the manual, or for the authors of the manual itself.

Line 634 Requires either the name of an author or one of the fo

Line 648 Requires either the name of an author or one of the fo

.Bl -tag -width "-nosplitX" -offset indent -compact

.It Fl split

Start a new output line before each subsequent invocation of

.Sx \&An .

.Ic \&An .

.It Fl nosplit

The opposite of

.Fl split .

Line 657 for all other author listings.

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

.It Ic \&Ao Ar block

Begin a block enclosed by angle brackets.

Does not have any head arguments.

.Pp

This macro is almost never useful.

Examples:

See

.Dl \&.Fl -key= \&Ns \&Ao \&Ar val \&Ac

.Ic \&Aq

.Pp

for more details.

See also

.It Ic \&Ap

.Sx \&Aq .

.Ss \&Ap

Inserts an apostrophe without any surrounding whitespace.

This is generally used as a grammatical device when referring to the verb

form of a function.

.Pp

Examples:

.Dl \&.Fn execve \&Ap d

.Ss \&Aq

.It Ic \&Aq Ar line

Encloses its arguments in angle brackets.

Enclose the rest of the input line in angle brackets.

The only important use case is for email addresses.

See

.Ic \&Mt

for an example.

.Pp

Examples:

Occasionally, it is used for names of characters and keys, for example:

.Dl \&.Fl -key= \&Ns \&Aq \&Ar val

.Bd -literal -offset indent

Press the

\&.Aq escape

key to ...

.Ed

.Pp

.Em Remarks :

For URIs, use

this macro is often abused for rendering URIs, which should instead use

.Ic \&Lk

.Sx \&Lk

instead, and

.Ic \&In

for

.Dq #include

directives.

Never wrap

.Ic \&Ar

.Ic \&Aq .

.Pp

Since

.Ic \&Aq

usually renders with non-ASCII characters in non-ASCII output modes,

do not use it where the ASCII characters

.Sq <

and

.Sq >

are required as syntax elements.

Instead, use these characters directly in such cases, combining them

with the macros

.Ic \&Pf ,

.Ic \&Ns ,

.Sx \&Mt ,

.Ic \&Eo

or to note pre-processor

as needed.

.Dq Li #include

statements, which should use

.Sx \&In .

.Pp

See also

.Sx \&Ao .

.Ic \&Ao .

.Ss \&Ar

.It Ic \&Ar Op Ar placeholder ...

Command arguments.

If an argument is not provided, the string

.Dq file ...\&

Line 704 Examples:

Line 742 Examples:

.Dl ".Ar arg1 , arg2 ."

.Pp

The arguments to the

.Sx \&Ar

.Ic \&Ar

macro are names and placeholders for command arguments;

for fixed strings to be passed verbatim as arguments, use

.Sx \&Fl

.Ic \&Fl

.Sx \&Cm .

.Ic \&Cm .

.Ss \&At

.It Ic \&At Op Ar version

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 720 A version of

Line 760 A version of

.At .

.It Cm III

.At III .

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

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

A version of

.At V .

.El

Line 733 Examples:

Line 773 Examples:

.Dl \&.At V.1

.Pp

See also

.Sx \&Bsx ,

.Ic \&Bsx ,

.Sx \&Bx ,

.Ic \&Bx ,

.Sx \&Dx ,

.Ic \&Dx ,

.Sx \&Fx ,

.Ic \&Fx ,

.Sx \&Nx ,

.Ic \&Nx ,

.Sx \&Ox ,

and

.Sx \&Ux .

.Ic \&Ox .

.Ss \&Bc

.It Ic \&Bc

Close a

.Sx \&Bo

.Ic \&Bo

block.

Does not have any tail arguments.

.Ss \&Bd

.It Ic \&Bd Fl Ns Ar type Oo Fl offset Ar width Oc Op Fl compact

Begin a display block.

Its syntax is as follows:

.Bd -ragged -offset indent

.Pf \. Sx \&Bd

.Fl Ns Ar type

.Op Fl offset Ar width

.Op Fl compact

.Ed

.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 text lines.

Line 766 The

Line 797 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 842 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 851 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 841 Examples:

Line 872 Examples:

.Ed

.Pp

See also

.Sx \&D1

.Ic \&D1

and

.Sx \&Dl .

.Ic \&Dl .

.Ss \&Bf

Change the font mode for a scoped block of text.

Its syntax is as follows:

.Bd -ragged -offset indent

.Pf \. Sx \&Bf

.Oo

.Fl emphasis | literal | symbolic |

.Cm \&Em | \&Li | \&Sy

.Oc

.Ed

.Pp

The

.Fl emphasis

and

Line 870 and

Line 892 and

Without an argument, this macro does nothing.

The font mode continues until broken by a new font mode in a nested

scope or

.Sx \&Ef

.Ic \&Ef

is encountered.

.Pp

See also

.Sx \&Li ,

.Ic \&Li ,

.Sx \&Ef ,

.Ic \&Ef ,

.Sx \&Em ,

.Ic \&Em ,

and

.Sx \&Sy .

.Ic \&Sy .

.Ss \&Bk

.It Ic \&Bk Fl words

For each macro, keep its output together on the same 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

.D1 Pf \. Sx \&Bk Fl words

.Pp

The

.Fl words

argument is required; additional arguments are ignored.

.Pp

The following example will not break within each

.Sx \&Op

.Ic \&Op

macro line:

.Bd -literal -offset indent

\&.Bk \-words

Line 904 macro line:

Line 923 macro line:

.Pp

Be careful in using over-long lines within a keep block!

Doing so will clobber the right margin.

.Ss \&Bl

.It Xo

Begin a list.

.Ic \&Bl

Lists consist of items specified using the

.Sx \&It

macro, containing a head or a body or both.

The list syntax is as follows:

.Bd -ragged -offset indent

.Pf \. Sx \&Bl

.Fl Ns Ar type

.Op Fl width Ar val

.Op Fl offset Ar val

.Op Fl compact

.Op HEAD ...

.Op Ar col ...

.Ed

.Xc

Begin a list.

Lists consist of items specified using the

.Ic \&It

macro, containing a head or a body or both.

.Pp

The list

.Ar type

Line 926 The

Line 943 The

.Fl width

and

.Fl offset

arguments accept

arguments accept macro names as described for

.Sx Scaling Widths

.Ic \&Bd

.Fl offset ,

scaling widths as described in

.Xr roff 7 ,

or use the length of the given string.

The

.Fl offset

Line 955 argument.

Line 975 argument.

A columnated list.

The

.Fl width

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

argument has no effect; instead, the string length of each argument

of one column, using either the

specifies the width of one column.

.Sx Scaling Widths

syntax or the string length of the argument.

If the first line of the body of a

.Fl column

list is not an

.Sx \&It

.Ic \&It

macro line,

.Sx \&It

.Ic \&It

contexts spanning one input line each are implied until an

.Sx \&It

.Ic \&It

macro line is encountered, at which point items start being interpreted as

described in the

.Sx \&It

.Ic \&It

documentation.

.It Fl dash

Line 1032 and

Line 1050 and

lists may not be portable.

.Pp

See also

.Sx \&El

.Ic \&El

and

.Sx \&It .

.Ic \&It .

.Ss \&Bo

.It Ic \&Bo Ar block

Begin a block enclosed by square brackets.

Does not have any head arguments.

.Pp

Line 1046 Examples:

Line 1064 Examples:

.Ed

.Pp

See also

.Sx \&Bq .

.Ic \&Bq .

.Ss \&Bq

.It Ic \&Bq Ar line

Encloses its arguments in square brackets.

.Pp

Examples:

Line 1056 Examples:

Line 1074 Examples:

.Em Remarks :

this macro is sometimes abused to emulate optional arguments for

commands; the correct macros to use for this purpose are

.Sx \&Op ,

.Ic \&Op ,

.Sx \&Oo ,

.Ic \&Oo ,

and

.Sx \&Oc .

.Ic \&Oc .

.Pp

See also

.Sx \&Bo .

.Ic \&Bo .

.Ss \&Brc

.It Ic \&Brc

Close a

.Sx \&Bro

.Ic \&Bro

block.

Does not have any tail arguments.

.Ss \&Bro

.It Ic \&Bro Ar block

Begin a block enclosed by curly braces.

Does not have any head arguments.

.Pp

Line 1079 Examples:

Line 1097 Examples:

.Ed

.Pp

See also

.Sx \&Brq .

.Ic \&Brq .

.Ss \&Brq

.It Ic \&Brq Ar line

Encloses its arguments in curly braces.

.Pp

Examples:

.Dl \&.Brq 1 , ... , \&Va n

.Pp

See also

.Sx \&Bro .

.Ic \&Bro .

.Ss \&Bsx

.It Ic \&Bsx Op Ar version

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 1097 Examples:

Line 1117 Examples:

.Dl \&.Bsx

.Pp

See also

.Sx \&At ,

.Ic \&At ,

.Sx \&Bx ,

.Ic \&Bx ,

.Sx \&Dx ,

.Ic \&Dx ,

.Sx \&Fx ,

.Ic \&Fx ,

.Sx \&Nx ,

.Ic \&Nx ,

.Sx \&Ox ,

and

.Sx \&Ux .

.Ic \&Ox .

.Ss \&Bt

.It Ic \&Bt

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

Prints

.Dq is currently in beta test.

.Ss \&Bx

.It Ic \&Bx Op Ar version Op Ar variant

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 1118 Examples:

Line 1140 Examples:

.Dl \&.Bx

.Pp

See also

.Sx \&At ,

.Ic \&At ,

.Sx \&Bsx ,

.Ic \&Bsx ,

.Sx \&Dx ,

.Ic \&Dx ,

.Sx \&Fx ,

.Ic \&Fx ,

.Sx \&Nx ,

.Ic \&Nx ,

.Sx \&Ox ,

and

.Sx \&Ux .

.Ic \&Ox .

.Ss \&Cd

.It Ic \&Cd Ar line

Kernel configuration declaration.

This denotes strings accepted by

.Xr config 8 .

Line 1138 Examples:

Line 1159 Examples:

.Em Remarks :

this macro is commonly abused by using quoted literals to retain

whitespace and align consecutive

.Sx \&Cd

.Ic \&Cd

declarations.

This practise is discouraged.

.Ss \&Cm

.It Ic \&Cm Ar keyword ...

Command modifiers.

Typically used for fixed strings passed as arguments, unless

Typically used for fixed strings passed as arguments to interactive

.Sx \&Fl

commands, to commands in interpreted scripts, or to configuration

file directives, unless

.Ic \&Fl

is more appropriate.

Also useful when specifying configuration options or keys.

.Pp

Examples:

.Dl ".Nm mt Fl f Ar device Cm rewind"

.Dl ".Nm ps Fl o Cm pid , Ns Cm command"

.Dl ".Nm dd Cm if= Ns Ar file1 Cm of= Ns Ar file2"

.Dl ".Cm IdentityFile Pa ~/.ssh/id_rsa"

.Dl ".Ic set Fl o Cm vi"

.Dl ".Cm LogLevel Dv DEBUG"

.Dl ".Ic lookup Cm file bind"

.Ss \&D1

.Dl ".Ic permit Ar identity Op Cm as Ar target"

.It Ic \&D1 Ar line

One-line indented display.

This is formatted by the default rules and is useful for simple indented

statements.

Line 1164 Examples:

Line 1187 Examples:

.Dl \&.D1 \&Fl abcdefgh

.Pp

See also

.Sx \&Bd

.Ic \&Bd

and

.Sx \&Dl .

.Ic \&Dl .

.Ss \&Db

.It Ic \&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 .

.It Ic \&Dc

.Ss \&Dc

Close a

.Sx \&Do

.Ic \&Do

block.

Does not have any tail arguments.

.Ss \&Dd

.It Ic \&Dd Cm $\&Mdocdate$ | Ar month day , year

Document date.

Document date for display in the page footer,

by convention the date of the last change.

This is the mandatory first macro of any

.Nm

manual.

Its syntax is as follows:

.Pp

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

.Pp

The

.Ar month

is the full English month name, the

.Ar day

is an optionally zero-padded numeral, and the

is an integer number, and the

.Ar year

is the full four-digit year.

.Pp

Line 1210 the special string

Line 1230 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 1220 If no date string is given, the current date is used.

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

.Pp

Examples:

.Dl \&.Dd $\&Mdocdate$

.Dl \&.Dd $\&Mdocdate: July 21 2007$

.Dl \&.Dd $\&Mdocdate: July 2 2018$

.Dl \&.Dd July 21, 2007

.Dl \&.Dd July 2, 2018

.Pp

See also

.Sx \&Dt

.Ic \&Dt

and

.Sx \&Os .

.Ic \&Os .

.Ss \&Dl

.It Ic \&Dl Ar line

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 1260 Examples:

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

.Pp

See also

.Sx \&Bd

.Ic \&Ql ,

.Ic \&Bd Fl literal ,

and

.Sx \&D1 .

.Ic \&D1 .

.Ss \&Do

.It Ic \&Do Ar block

Begin a block enclosed by double quotes.

Does not have any head arguments.

.Pp

Line 1253 April is the cruellest month

Line 1277 April is the cruellest month

.Ed

.Pp

See also

.Sx \&Dq .

.Ic \&Dq .

.Ss \&Dq

.It Ic \&Dq Ar line

Encloses its arguments in

.Dq typographic

double-quotes.

Line 1266 Examples:

Line 1290 Examples:

.Ed

.Pp

See also

.Sx \&Qq ,

.Ic \&Qq ,

.Sx \&Sq ,

.Ic \&Sq ,

and

.Sx \&Do .

.Ic \&Do .

.Ss \&Dt

.It Ic \&Dt Ar TITLE section Op Ar arch

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

.Oo

.Ar section

.Op Ar volume | 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 a specific relevant architecture.

This specifies the machine architecture a manual page applies to,

where relevant, for example

.Ar volume

.Cm alpha ,

is not provided, it may be used in its place, else it may be used

.Cm amd64 ,

subsequent that.

.Cm i386 ,

It, too, is optional.

It must be one of

.Ar alpha ,

.Ar amd64 ,

.Ar amiga ,

.Ar arc ,

.Ar arm ,

.Ar armish ,

.Ar aviion ,

.Ar hp300 ,

.Ar hppa ,

.Ar hppa64 ,

.Ar i386 ,

.Ar landisk ,

.Ar loongson ,

.Ar luna88k ,

.Ar mac68k ,

.Ar macppc ,

.Ar mips64 ,

.Ar mvme68k ,

.Ar mvme88k ,

.Ar mvmeppc ,

.Ar pmax ,

.Ar sgi ,

.Ar socppc ,

.Ar sparc ,

.Ar sparc64 ,

.Ar sun3 ,

.Ar vax ,

.Ar zaurus .

.Cm sparc64 .

The list of valid architectures varies by operating system.

.El

.Pp

Examples:

.Dl \&.Dt FOO 1

.Dl \&.Dt FOO 4 KM

.Dl \&.Dt FOO 9 i386

.Pp

See also

.Sx \&Dd

.Ic \&Dd

and

.Sx \&Os .

.Ic \&Os .

.Ss \&Dv

.It Ic \&Dv Ar identifier ...

Defined variables such as preprocessor constants, constant symbols,

enumeration values, and so on.

.Pp

Line 1420 Examples:

Line 1363 Examples:

.Dl \&.Dv STDOUT_FILENO

.Pp

See also

.Sx \&Er

.Ic \&Er

and

.Sx \&Ev

.Ic \&Ev

for special-purpose constants and

for special-purpose constants,

.Sx \&Va

.Ic \&Va

for variable symbols.

for variable symbols, and

.Ss \&Dx

.Ic \&Fd

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

for listing preprocessor variable definitions in the

.Em SYNOPSIS .

.It Ic \&Dx Op Ar version

Format the

.Dx

version provided as an argument, or a default

value if no argument is provided.

.Pp

Examples:

Line 1435 Examples:

Line 1383 Examples:

.Dl \&.Dx

.Pp

See also

.Sx \&At ,

.Ic \&At ,

.Sx \&Bsx ,

.Ic \&Bsx ,

.Sx \&Bx ,

.Ic \&Bx ,

.Sx \&Fx ,

.Ic \&Fx ,

.Sx \&Nx ,

.Ic \&Nx ,

.Sx \&Ox ,

and

.Sx \&Ux .

.Ic \&Ox .

.Ss \&Ec

.It Ic \&Ec Op Ar closing_delimiter

Close a scope started by

.Sx \&Eo .

.Ic \&Eo .

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&Ec Op Ar TERM

.Pp

The

.Ar TERM

.Ar closing_delimiter

argument is used as the enclosure tail, for example, specifying \e(rq

will emulate

.Sx \&Dc .

.Ic \&Dc .

.Ss \&Ed

.It Ic \&Ed

End a display context started by

.Sx \&Bd .

.Ic \&Bd .

.Ss \&Ef

.It Ic \&Ef

End a font mode context started by

.Sx \&Bf .

.Ic \&Bf .

.Ss \&Ek

.It Ic \&Ek

End a keep context started by

.Sx \&Bk .

.Ic \&Bk .

.Ss \&El

.It Ic \&El

End a list context started by

.Sx \&Bl .

.Ic \&Bl .

.Pp

See also

.Sx \&Bl

.Ic \&It .

.It Ic \&Em Ar word ...

Request an italic font.

If the output device does not provide that, underline.

.Pp

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

importance, see

.Ic \&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,

.Ic \&Sy

and

.Sx \&It .

.Ic \&Ar

.Ss \&Em

are preferred, respectively.

Denotes text that should be

.Em emphasised .

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

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 ,

.Ic \&No ,

.Sx \&Li ,

.Ic \&Ql ,

.Sx \&No ,

and

.Sx \&Sy .

.Ic \&Sy .

.Ss \&En

.It Ic \&En Ar word ...

This macro is obsolete and not implemented in

This macro is obsolete.

.Xr mandoc 1 .

Use

.Ss \&Eo

.Ic \&Eo

An arbitrary enclosure.

or any of the other enclosure macros.

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&Eo Op Ar TERM

It encloses its argument in the delimiters specified by the last

.Pp

.Ic \&Es

macro.

.It Ic \&Eo Op Ar opening_delimiter

An arbitrary enclosure.

The

.Ar TERM

.Ar opening_delimiter

argument is used as the enclosure head, for example, specifying \e(lq

will emulate

.Sx \&Do .

.Ic \&Do .

.Ss \&Er

.It Ic \&Er Ar identifier ...

Error constants for definitions of the

.Va errno

libc global variable.

Line 1515 Examples:

Line 1470 Examples:

.Dl \&.Er ENOENT

.Pp

See also

.Sx \&Dv

.Ic \&Dv

for general constants.

.Ss \&Es

.It Ic \&Es Ar opening_delimiter closing_delimiter

This macro is obsolete and not implemented.

This macro is obsolete.

.Ss \&Ev

Use

.Ic \&Eo

or any of the other enclosure macros.

.Pp

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

.Ic \&En

macros.

.It Ic \&Ev Ar identifier ...

Environmental variables such as those specified in

.Xr environ 7 .

.Pp

Line 1528 Examples:

Line 1490 Examples:

.Dl \&.Ev PATH

.Pp

See also

.Sx \&Dv

.Ic \&Dv

for general constants.

.Ss \&Ex

.It Ic \&Ex Fl std Op Ar utility ...

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

and >0 on failure.

This is most often used in section 1, 6, and 8 manual pages.

Its syntax is as follows:

.Pp

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

.Pp

.Ar utility

is not specified, the document's name set by

.Sx \&Nm

.Ic \&Nm

is used.

Multiple

.Ar utility

arguments are treated as separate utilities.

.Pp

See also

.Sx \&Rv .

.Ic \&Rv .

.Ss \&Fa

.It Ic \&Fa Ar argument ...

Function argument.

Function argument or parameter.

Its syntax is as follows:

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

.Bd -ragged -offset indent

.Em SYNOPSIS

.Pf \. Sx \&Fa

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

.Op Cm argtype

or a type alone (for function prototypes).

.Cm argname

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

.Ed

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

given in a single argument to the

.Ic \&Fa

macro.

.Pp

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

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

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

.Pp

Most often, the

.Sx \&Fa

.Ic \&Fa

macro is used in the

.Em SYNOPSIS

within

.Sx \&Fo

.Ic \&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

.Sx \&Fa ,

.Ic \&Fa ,

the last argument will also have a trailing comma.

.Pp

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 .

.Ic \&Fo .

.Ss \&Fc

.It Ic \&Fc

End a function context started by

.Sx \&Fo .

.Ic \&Fo .

.Ss \&Fd

.It Ic \&Fd Pf # Ar directive Op Ar argument ...

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 .

.Sx \&In .

Historically, it was also used to document include files.

Do not use this macro.

The latter usage has been deprecated in favour of

.Ic \&In .

.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 ,

.Ic \&In ,

and

.Sx \&In .

.Ic \&Dv .

.Ss \&Fl

.It Ic \&Fl Op Ar word ...

Command-line flag or option.

Used when listing arguments to command-line utilities.

Prints a fixed-width hyphen

Line 1611 Examples:

Line 1583 Examples:

.Dl ".Fl o Fl"

.Pp

See also

.Sx \&Cm .

.Ic \&Cm .

.Ss \&Fn

.It Ic \&Fn Ar funcname Op Ar argument ...

A function name.

Its syntax is as follows:

.Bd -ragged -offset indent

.Pf \. Ns Sx \&Fn

.Op Ar functype

.Ar funcname

.Op Oo Ar argtype Oc Ar argname

.Ed

.Pp

Function arguments are surrounded in parenthesis and

are delimited by commas.

Line 1634 Examples:

Line 1599 Examples:

.Dl \&.Fn \(dqint funcname\(dq \(dqint arg0\(dq \(dqint arg1\(dq

.Dl \&.Fn funcname \(dqint arg0\(dq

.Dl \&.Fn funcname arg0

.Pp

.Bd -literal -offset indent

.Bd -literal -offset indent -compact

\&.Ft functype

\&.Fn funcname

.Ed

.Pp

When referring to a function documented in another manual page, use

.Sx \&Xr

.Ic \&Xr

instead.

See also

.Sx MANUAL STRUCTURE ,

.Sx \&Fo ,

.Ic \&Fo ,

and

.Sx \&Ft .

.Ic \&Ft .

.Ss \&Fo

.It Ic \&Fo Ar funcname

Begin a function block.

This is a multi-line version of

.Sx \&Fn .

.Ic \&Fn .

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&Fo Ar funcname

.Pp

Invocations usually occur in the following context:

.Bd -ragged -offset indent

.Pf \. Sx \&Ft Ar functype

.Pf \. Ic \&Ft Ar functype

.br

.Pf \. Sx \&Fo Ar funcname

.Pf \. Ic \&Fo Ar funcname

.br

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

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

.br

\&.\.\.

.br

.Pf \. Sx \&Fc

.Pf \. Ic \&Fc

.Ed

.Pp

.Sx \&Fo

.Ic \&Fo

scope is closed by

.Sx \&Fc .

.Ic \&Fc .

.Pp

See also

.Sx MANUAL STRUCTURE ,

.Sx \&Fa ,

.Ic \&Fa ,

.Sx \&Fc ,

.Ic \&Fc ,

and

.Sx \&Ft .

.Ic \&Ft .

.Ss \&Fr

.It Ic \&Fr Ar number

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:

.It Ic \&Ft Ar functype

.Pp

.Dl Pf . Sx \&Fr Ar value

.Ss \&Ft

A function type.

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&Ft Ar functype

.Pp

In the

.Em SYNOPSIS

section, a new output line is started after this macro.

Line 1707 Examples:

Line 1662 Examples:

.Pp

See also

.Sx MANUAL STRUCTURE ,

.Sx \&Fn ,

.Ic \&Fn ,

and

.Sx \&Fo .

.Ic \&Fo .

.Ss \&Fx

.It Ic \&Fx Op Ar version

Format the

.Fx

version provided as an argument, or a default value

Line 1721 Examples:

Line 1676 Examples:

.Dl \&.Fx

.Pp

See also

.Sx \&At ,

.Ic \&At ,

.Sx \&Bsx ,

.Ic \&Bsx ,

.Sx \&Bx ,

.Ic \&Bx ,

.Sx \&Dx ,

.Ic \&Dx ,

.Sx \&Nx ,

.Ic \&Nx ,

.Sx \&Ox ,

and

.Sx \&Ux .

.Ic \&Ox .

.Ss \&Hf

.It Ic \&Hf Ar filename

This macro is not implemented in

.Xr mandoc 1 .

.Pp

It was used to include the contents of a (header) file literally.

The syntax was:

.It Ic \&Ic Ar keyword ...

Internal or interactive command, or configuration instruction

in a configuration file.

See also

.Ic \&Cm .

.Pp

.Dl Pf . Sx \&Hf Ar filename

.Ss \&Ic

Designate an internal or interactive command.

This is similar to

.Sx \&Cm

but used for instructions rather than values.

.Pp

Examples:

.Dl \&.Ic :wq

.Dl \&.Ic hash

.Dl \&.Ic alias

.Pp

Note that using

.Sx \&Bd Fl literal

.Ic \&Ql ,

.Ic \&Dl ,

.Sx \&D1

.Ic \&Bd Fl literal

is preferred for displaying code; the

is preferred for displaying code samples; the

.Sx \&Ic

.Ic \&Ic

macro is used when referring to specific instructions.

macro is used when referring to an individual command name.

.Ss \&In

.It Ic \&In Ar filename

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

.Pp

See also

.Sx MANUAL STRUCTURE .

.Ss \&It

.It Ic \&It Op Ar head

A list item.

The syntax of this macro depends on the list type.

.Pp

Line 1786 and

Line 1738 and

.Fl diag

have the following syntax:

.Pp

.D1 Pf \. Sx \&It Ar args

.D1 Pf \. Ic \&It Ar args

.Pp

Lists of type

.Fl bullet ,

Line 1797 and

Line 1749 and

.Fl item

have the following syntax:

.Pp

.D1 Pf \. Sx \&It

.D1 Pf \. Ic \&It

.Pp

with subsequent lines interpreted within the scope of the

.Sx \&It

.Ic \&It

until either a closing

.Sx \&El

.Ic \&El

or another

.Sx \&It .

.Ic \&It .

.Pp

The

.Fl tag

list has the following syntax:

.Pp

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

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

.Pp

Subsequent lines are interpreted as with

.Fl bullet

Line 1823 The

Line 1775 The

list is the most complicated.

Its syntax is as follows:

.Pp

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

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

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

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

.Pp

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

representing a complete table line.

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

Cells within the line are delimited by the special

.Sx \&Ta

.Ic \&Ta

block macro.

block macro or by literal tab characters.

.Pp

Using literal tabs is strongly discouraged because they are very

hard to use correctly and

.Nm

code using them is very hard to read.

In particular, a blank character is syntactically significant

before and after the literal tab character.

If a word precedes or follows the tab without an intervening blank,

that word is never interpreted as a macro call, but always output

literally.

.Pp

The tab cell delimiter may only be used within the

.Sx \&It

.Ic \&It

line itself; on following lines, only the

.Sx \&Ta

.Ic \&Ta

macro can be used to delimit cells, and

macro can be used to delimit cells, and portability requires that

.Sx \&Ta

.Ic \&Ta

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

is called by other macros: some parsers do not recognize it when

not as the first macro on a line.

it appears as the first macro on a line.

.Pp

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

.Sx \&It

.Ic \&It

line.

For example,

.Pp

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

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

.Pp

will preserve the semicolon whitespace except for the last.

will preserve the whitespace before both commas,

but not the whitespace before the semicolon.

.Pp

See also

.Sx \&Bl .

.Ic \&Bl .

.Ss \&Lb

.It Ic \&Lb Cm lib Ns Ar name

Specify a library.

The syntax is as follows:

.Pp

.D1 Pf \. Sx \&Lb Ar library

.Pp

The

.Ar library

.Ar name

parameter may be a system library, such as

.Cm libz

.Cm z

.Cm libpam ,

.Cm pam ,

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 1873 section as described in

Line 1834 section as described in

.Pp

Examples:

.Dl \&.Lb libz

.Dl \&.Lb mdoc

.Dl \&.Lb libmandoc

.Ss \&Li

.It Ic \&Li Ar word ...

Denotes text that should be in a

Request a typewriter (literal) font.

.Li literal

Deprecated because on terminal output devices, this is usually

font mode.

indistinguishable from normal text.

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

For literal displays, use

stylistically decorating technical terms.

.Ic \&Ql Pq in-line ,

.Pp

.Ic \&Dl Pq single line ,

On terminal output devices, this is often indistinguishable from

normal text.

.Ic \&Bd Fl literal Pq multi-line

.Pp

instead.

See also

.It Ic \&Lk Ar uri Op Ar display_name

.Sx \&Bf ,

.Sx \&Em ,

.Sx \&No ,

and

.Sx \&Sy .

.Ss \&Lk

Format a hyperlink.

Its syntax is as follows:

.Pp

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

.Pp

Examples:

.Dl \&.Lk http://bsd.lv \(dqThe BSD.lv Project\(dq

.Dl \&.Lk http://bsd.lv

.Pp

See also

.Sx \&Mt .

.Ic \&Mt .

.Ss \&Lp

.It Ic \&Lp

Synonym for

Deprecated synonym for

.Sx \&Pp .

.Ic \&Pp .

.Ss \&Ms

.It Ic \&Ms Ar name

Display a mathematical symbol.

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&Ms Ar symbol

.Pp

Examples:

.Dl \&.Ms sigma

.Dl \&.Ms aleph

.Ss \&Mt

.It Ic \&Mt Ar localpart Ns @ Ns Ar domain

Format a

.Dq mailto:

hyperlink.

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&Mt Ar address

.Pp

Examples:

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

.Ss \&Nd

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

.It Ic \&Nd Ar line

A one line description of the manual's content.

This may only be invoked in the

This is the mandatory last macro of the

.Em SYNOPSIS

.Em NAME

section subsequent the

section and not appropriate for other sections.

.Sx \&Nm

macro.

.Pp

Examples:

.Dl Pf . Sx \&Nd mdoc language reference

.Dl Pf . Ic \&Nd mdoc language reference

.Dl Pf . Sx \&Nd format and display UNIX manuals

.Dl Pf . Ic \&Nd format and display UNIX manuals

.Pp

The

.Sx \&Nd

.Ic \&Nd

macro technically accepts child macros and terminates with a subsequent

.Sx \&Sh

.Ic \&Sh

invocation.

Do not assume this behaviour: some

.Xr whatis 1

Line 1947 database generators are not smart enough to parse more

Line 1892 database generators are not smart enough to parse more

arguments and will display macros verbatim.

.Pp

See also

.Sx \&Nm .

.Ic \&Nm .

.Ss \&Nm

.It Ic \&Nm Op Ar name

The name of the manual page, or \(em in particular in section 1, 6,

and 8 pages \(em of an additional command or feature documented in

the manual page.

When first invoked, the

.Sx \&Nm

.Ic \&Nm

macro expects a single argument, the name of the manual page.

Usually, the first invocation happens in the

.Em NAME

Line 1961 section of the page.

Line 1906 section of the page.

The specified name will be remembered and used whenever the macro is

called again without arguments later in the page.

The

.Sx \&Nm

.Ic \&Nm

macro uses

.Sx Block full-implicit

semantics when invoked as the first macro on an input line in the

Line 1981 Examples:

Line 1926 Examples:

In the

.Em SYNOPSIS

of section 2, 3 and 9 manual pages, use the

.Sx \&Fn

.Ic \&Fn

macro rather than

.Sx \&Nm

.Ic \&Nm

to mark up the name of the manual page.

.Ss \&No

.It Ic \&No Ar word ...

Normal text.

Closes the scope of any preceding in-line macro.

When used after physical formatting macros like

.Sx \&Em

.Ic \&Em

.Sx \&Sy ,

.Ic \&Sy ,

switches back to the standard font face and weight.

Can also be used to embed plain text strings in macro lines

using semantic annotation macros.

.Pp

Examples:

.Dl ".Em italic , Sy bold , No and roman"

.Pp

.Bd -literal -offset indent

.Bd -literal -offset indent -compact

\&.Sm off

\&.Cm :C No / Ar pattern No / Ar replacement No /

\&.Sm on

.Ed

.Pp

See also

.Sx \&Em ,

.Ic \&Em ,

.Sx \&Li ,

.Ic \&Ql ,

and

.Sx \&Sy .

.Ic \&Sy .

.Ss \&Ns

.It Ic \&Ns

Suppress a space between the output of the preceding macro

and the following text or macro.

Following invocation, input is interpreted as normal text

just like after an

.Sx \&No

.Ic \&No

macro.

.Pp

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

Line 2026 Examples:

Line 1970 Examples:

.Dl ".Fl o Ns Ar output"

.Pp

See also

.Sx \&No

.Ic \&No

and

.Sx \&Sm .

.Ic \&Sm .

.Ss \&Nx

.It Ic \&Nx Op Ar version

Format the

.Nx

version provided as an argument, or a default value if

Line 2040 Examples:

Line 1984 Examples:

.Dl \&.Nx

.Pp

See also

.Sx \&At ,

.Ic \&At ,

.Sx \&Bsx ,

.Ic \&Bsx ,

.Sx \&Bx ,

.Ic \&Bx ,

.Sx \&Dx ,

.Ic \&Dx ,

.Sx \&Fx ,

.Ic \&Fx ,

.Sx \&Ox ,

and

.Sx \&Ux .

.Ic \&Ox .

.Ss \&Oc

.It Ic \&Oc

Close multi-line

.Sx \&Oo

.Ic \&Oo

context.

.Ss \&Oo

.It Ic \&Oo Ar block

Multi-line version of

.Sx \&Op .

.Ic \&Op .

.Pp

Examples:

.Bd -literal -offset indent -compact

Line 2062 Examples:

Line 2005 Examples:

\&.Op Fl flag Ns Ar value

\&.Oc

.Ed

.Ss \&Op

.It Ic \&Op Ar line

Optional part of a command line.

Prints the argument(s) in brackets.

This is most often used in the

Line 2074 Examples:

Line 2017 Examples:

.Dl \&.Op \&Ar a | b

.Pp

See also

.Sx \&Oo .

.Ic \&Oo .

.Ss \&Os

.It Ic \&Os Op Ar system Op Ar version

Document operating system version.

Operating system version for display in the page footer.

This is the mandatory third macro of

any

.Nm

file.

Its syntax is as follows:

.Pp

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

.Pp

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 2097 Examples:

Line 2045 Examples:

.Dl \&.Os BSD 4.3

.Pp

See also

.Sx \&Dd

.Ic \&Dd

and

.Sx \&Dt .

.Ic \&Dt .

.Ss \&Ot

.It Ic \&Ot Ar functype

This macro is obsolete and not implemented in

This macro is obsolete.

.Xr mandoc 1 .

Use

.Ic \&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

.It Ic \&Ox Op Ar version

Format the

.Ox

version provided as an argument, or a default value

Line 2119 Examples:

Line 2071 Examples:

.Dl \&.Ox

.Pp

See also

.Sx \&At ,

.Ic \&At ,

.Sx \&Bsx ,

.Ic \&Bsx ,

.Sx \&Bx ,

.Ic \&Bx ,

.Sx \&Dx ,

.Ic \&Dx ,

.Sx \&Fx ,

.Ic \&Fx ,

.Sx \&Nx ,

and

.Sx \&Ux .

.Ic \&Nx .

.Ss \&Pa

.It Ic \&Pa Ar name ...

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

If an argument is not provided, the character

.Sq \(ti

Line 2138 Examples:

Line 2089 Examples:

.Dl \&.Pa /usr/share/man/man7/mdoc.7

.Pp

See also

.Sx \&Lk .

.Ic \&Lk .

.Ss \&Pc

.It Ic \&Pc

Close parenthesised context opened by

.Sx \&Po .

.Ic \&Po .

.Ss \&Pf

.It Ic \&Pf Ar prefix macro Op Ar argument ...

Removes the space between its argument

Removes the space between its argument and the following macro.

.Pq Dq prefix

It is equivalent to:

and the following macro.

Its syntax is as follows:

.Pp

.D1 .Pf Ar prefix macro arguments ...

.D1 Ic \&No Pf \e& Ar prefix Ic \&Ns Ar macro Op Ar argument ...

.Pp

This is equivalent to:

The

.Ar prefix

argument is not parsed for macro names or delimiters,

but used verbatim as if it were escaped.

.Pp

.D1 .No Ar prefix No \&Ns Ar macro arguments ...

.Pp

Examples:

.Dl ".Pf $ Ar variable_name"

.Dl ".Pf . Ar macro_name"

.Dl ".Pf 0x Ar hex_digits"

.Pp

See also

.Sx \&Ns

.Ic \&Ns

and

.Sx \&Sm .

.Ic \&Sm .

.Ss \&Po

.It Ic \&Po Ar block

Multi-line version of

.Sx \&Pq .

.Ic \&Pq .

.Ss \&Pp

.It Ic \&Pp

Break a paragraph.

This will assert vertical space between prior and subsequent macros

and/or text.

.Pp

Paragraph breaks are not needed before or after

.Sx \&Sh

.Ic \&Sh

.Sx \&Ss

.Ic \&Ss

macros or before displays

.Pq Sx \&Bd

.Pq Ic \&Bd Ar line

or lists

.Pq Sx \&Bl

.Pq Ic \&Bl

unless the

.Fl compact

flag is given.

.Ss \&Pq

.It Ic \&Pq Ar line

Parenthesised enclosure.

.Pp

See also

.Sx \&Po .

.Ic \&Po .

.Ss \&Qc

.It Ic \&Qc

Close quoted context opened by

.Sx \&Qo .

.Ic \&Qo .

.Ss \&Ql

.It Ic \&Ql Ar line

Format a single-quoted literal.

In-line literal display.

This can be used for complete command invocations and for multi-word

code examples when an indented display is not desired.

.Pp

See also

.Sx \&Qq

.Ic \&Dl

and

.Sx \&Sq .

.Ic \&Bd

.Ss \&Qo

.Fl literal .

.It Ic \&Qo Ar block

Multi-line version of

.Sx \&Qq .

.Ic \&Qq .

.Ss \&Qq

.It Ic \&Qq Ar line

Encloses its arguments in

.Qq typewriter

double-quotes.

Consider using

.Sx \&Dq .

.Ic \&Dq .

.Pp

See also

.Sx \&Dq ,

.Ic \&Dq ,

.Sx \&Sq ,

.Ic \&Sq ,

and

.Sx \&Qo .

.Ic \&Qo .

.Ss \&Re

.It Ic \&Re

Close an

.Sx \&Rs

.Ic \&Rs

block.

Does not have any tail arguments.

.Ss \&Rs

.It Ic \&Rs

Begin a bibliographic

.Pq Dq reference

block.

Does not have any head arguments.

The block macro may only contain

.Sx \&%A ,

.Ic \&%A ,

.Sx \&%B ,

.Ic \&%B ,

.Sx \&%C ,

.Ic \&%C ,

.Sx \&%D ,

.Ic \&%D ,

.Sx \&%I ,

.Ic \&%I ,

.Sx \&%J ,

.Ic \&%J ,

.Sx \&%N ,

.Ic \&%N ,

.Sx \&%O ,

.Ic \&%O ,

.Sx \&%P ,

.Ic \&%P ,

.Sx \&%Q ,

.Ic \&%Q ,

.Sx \&%R ,

.Ic \&%R ,

.Sx \&%T ,

.Ic \&%T ,

.Sx \&%U ,

.Ic \&%U ,

and

.Sx \&%V

.Ic \&%V

child macros (at least one must be specified).

.Pp

Examples:

Line 2245 Examples:

Line 2200 Examples:

\&.%A J. D. Ullman

\&.%B Introduction to Automata Theory, Languages, and Computation

\&.%I Addison-Wesley

\&.%C Reading, Massachusettes

\&.%C Reading, Massachusetts

\&.%D 1979

\&.Re

.Ed

.Pp

If an

.Sx \&Rs

.Ic \&Rs

block is used within a SEE ALSO section, a vertical space is asserted

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

line.

.Ss \&Rv

.It Ic \&Rv Fl std Op Ar function ...

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

on success and \-1 on error, with the

.Va errno

libc global variable set on error.

Its syntax is as follows:

.Pp

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

.Pp

.Ar function

is not specified, the document's name set by

.Sx \&Nm

.Ic \&Nm

is used.

Multiple

.Ar function

arguments are treated as separate functions.

.Pp

See also

.Sx \&Ex .

.Ic \&Ex .

.Ss \&Sc

.It Ic \&Sc

Close single-quoted context opened by

.Sx \&So .

.Ic \&So .

.Ss \&Sh

.It Ic \&Sh Ar TITLE LINE

Begin a new section.

For a list of conventional manual sections, see

.Sx MANUAL STRUCTURE .

Line 2286 These sections should be used unless it's absolutely n

Line 2238 These sections should be used unless it's absolutely n

custom sections be used.

.Pp

Section names should be unique so that they may be keyed by

.Sx \&Sx .

.Ic \&Sx .

Although this macro is parsed, it should not consist of child node or it

may not be linked with

.Sx \&Sx .

.Ic \&Sx .

.Pp

See also

.Sx \&Pp ,

.Ic \&Pp ,

.Sx \&Ss ,

.Ic \&Ss ,

and

.Sx \&Sx .

.Ic \&Sx .

.Ss \&Sm

.It Ic \&Sm Op Cm on | off

Switches the spacing mode for output generated from macros.

Its syntax is as follows:

.Pp

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

.Pp

By default, spacing is

.Cm on .

When switched

Line 2309 When switched

Line 2258 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.

.Ss \&So

.Pp

When called without an argument, the

.Ic \&Sm

macro toggles the spacing mode.

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

.It Ic \&So Ar block

Multi-line version of

.Sx \&Sq .

.Ic \&Sq .

.Ss \&Sq

.It Ic \&Sq Ar line

Encloses its arguments in

.Sq typewriter

single-quotes.

.Pp

See also

.Sx \&Dq ,

.Ic \&Dq ,

.Sx \&Qq ,

.Ic \&Qq ,

and

.Sx \&So .

.Ic \&So .

.Ss \&Ss

.It Ic \&Ss Ar Title line

Begin a new subsection.

Unlike with

.Sx \&Sh ,

.Ic \&Sh ,

there is no convention for the naming of subsections.

Except

.Em DESCRIPTION ,

Line 2334 the conventional sections described in

Line 2288 the conventional sections described in

rarely have subsections.

.Pp

Sub-section names should be unique so that they may be keyed by

.Sx \&Sx .

.Ic \&Sx .

Although this macro is parsed, it should not consist of child node or it

may not be linked with

.Sx \&Sx .

.Ic \&Sx .

.Pp

See also

.Sx \&Pp ,

.Ic \&Pp ,

.Sx \&Sh ,

.Ic \&Sh ,

and

.Sx \&Sx .

.Ic \&Sx .

.Ss \&St

.It Ic \&St Fl Ns Ar abbreviation

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

.Ss \&Sx

.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.

.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

.It Ic \&Sx Ar Title line

Reference a section or subsection in the same manual page.

The referenced section or subsection name must be identical to the

enclosed argument, including whitespace.

Line 2453 Examples:

Line 2517 Examples:

.Dl \&.Sx MANUAL STRUCTURE

.Pp

See also

.Sx \&Sh

.Ic \&Sh

and

.Sx \&Ss .

.Ic \&Ss .

.Ss \&Sy

.It Ic \&Sy Ar word ...

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

.Ic \&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 ,

.Ic \&Em ,

.Sx \&Em ,

.Ic \&No ,

.Sx \&Li ,

and

.Sx \&No .

.Ic \&Ql .

.Ss \&Ta

.It Ic \&Ta

Table cell separator in

.Sx \&Bl Fl column

.Ic \&Bl Fl column

lists; can only be used below

.Sx \&It .

.Ic \&It .

.Ss \&Tn

.It Ic \&Tg Op Ar term

Format a tradename.

Announce that the next input line starts a definition of the

.Ar term .

This macro must appear alone on its own input line.

The argument defaults to the first argument of the first macro

on the next line.

The argument may not contain whitespace characters, not even when it is quoted.

This macro is a

.Xr mandoc 1

extension and is typically ignored by other formatters.

.Pp

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

When viewing terminal output with

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

.Xr less 1 ,

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

the interactive

sometimes for semantical annotation, sometimes for physical formatting.

.Ic :t

command can be used to go to the definition of the

.Ar term

as described for the

.Ev MANPAGER

variable in

.Xr man 1 ;

when producing HTML output, a fragment identifier

.Pq Ic id No attribute

is generated, to be used for deep linking to this place of the document.

.Pp

Examples:

In most cases, adding a

.Dl \&.Tn IBM

.Ic \&Tg

.Ss \&Ud

macro would be redundant because

.Xr mandoc 1

is able to automatically tag most definitions.

This macro is intended for cases where automatic tagging of a

.Ar term

is unsatisfactory, for example if a definition is not tagged

automatically (false negative) or if places are tagged that do

not define the

.Ar term

(false positives).

When there is at least one

.Ic \&Tg

macro for a

.Ar term ,

no other places are automatically marked as definitions of that

.Ar term .

.It Ic \&Tn Ar word ...

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

Even though the macro name

.Pq Dq tradename

suggests a semantic function, historic usage is inconsistent, mostly

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

.It Ic \&Ud

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

Prints out

.Dq currently under development.

.Ss \&Ux

.It Ic \&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:

.It Ic \&Va Oo Ar type Oc Ar identifier ...

.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 ;

.Ss \&Vt

.Pp

For function arguments and parameters, use

.Ic \&Fa

instead.

For declarations of global variables in the

.Em SYNOPSIS

section, use

.Ic \&Vt .

.It Ic \&Vt Ar type Op Ar identifier

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 2524 In the former case, this macro starts a new output lin

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

.Ic \&Fa

instead, for function return types

.Ic \&Ft ,

and for variable names outside the

.Em SYNOPSIS

section

.Ic \&Va ,

even when including a type with the name.

See also

.Sx MANUAL STRUCTURE

.Sx MANUAL STRUCTURE .

and

.It Ic \&Xc

.Sx \&Va .

.Ss \&Xc

Close a scope opened by

.Sx \&Xo .

.Ic \&Xo .

.Ss \&Xo

.It Ic \&Xo Ar block

Extend the header of an

.Sx \&It

.Ic \&It

macro or the body of a partial-implicit block macro

beyond the end of the input line.

This macro originally existed to work around the 9-argument limit

of historic

.Xr roff 7 .

.Ss \&Xr

.It Ic \&Xr Ar name section

Link to another manual

.Pq Qq cross-reference .

Its syntax is as follows:

.Pp

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

Cross reference the

.Pp

The

.Ar name

and

.Ar section

are the name and section of the linked manual.

number of another man page.

.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

.Dl \&.Xr mandoc 1 \&;

.Dl \&.Xr mandoc 1 \&Ns s behaviour

.Ss \&br

.El

Emits a line-break.

This macro should not be used; it is implemented for compatibility with

historical manuals.

.Pp

Consider using

.Sx \&Pp

in the event of natural paragraph breaks.

.Ss \&sp

Emits vertical space.

This macro should not be used; it is implemented for compatibility with

historical manuals.

Its syntax is as follows:

.Pp

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

.Pp

The

.Ar height

argument must be formatted as described in

.Sx Scaling Widths .

If unspecified,

.Sx \&sp

asserts a single vertical space.

.Sh MACRO SYNTAX

The syntax of a macro depends on its classification.

In this section,

Line 2641 column, if applicable, describes closure rules.

Line 2726 column, if applicable, describes closure rules.

.Ss Block full-explicit

Multi-line scope closed by an explicit closing macro.

All macros contains bodies; only

.Sx \&Bf

.Ic \s&Bf

and

.Pq optionally

.Sx \&Bl

.Ic \&Bl

contain a head.

.Bd -literal -offset indent

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

Line 2653 contain a head.

Line 2738 contain a head.

.Ed

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

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

.It Sx \&Bd Ta \&No Ta \&No Ta closed by Sx \&Ed

.It Ic \&Bd Ta \&No Ta \&No Ta closed by Ic \&Ed

.It Sx \&Bf Ta \&No Ta \&No Ta closed by Sx \&Ef

.It Ic \&Bf Ta \&No Ta \&No Ta closed by Ic \&Ef

.It Sx \&Bk Ta \&No Ta \&No Ta closed by Sx \&Ek

.It Ic \&Bk Ta \&No Ta \&No Ta closed by Ic \&Ek

.It Sx \&Bl Ta \&No Ta \&No Ta closed by Sx \&El

.It Ic \&Bl Ta \&No Ta \&No Ta closed by Ic \&El

.It Sx \&Ed Ta \&No Ta \&No Ta opened by Sx \&Bd

.It Ic \&Ed Ta \&No Ta \&No Ta opened by Ic \&Bd

.It Sx \&Ef Ta \&No Ta \&No Ta opened by Sx \&Bf

.It Ic \&Ef Ta \&No Ta \&No Ta opened by Ic \&Bf

.It Sx \&Ek Ta \&No Ta \&No Ta opened by Sx \&Bk

.It Ic \&Ek Ta \&No Ta \&No Ta opened by Ic \&Bk

.It Sx \&El Ta \&No Ta \&No Ta opened by Sx \&Bl

.It Ic \&El Ta \&No Ta \&No Ta opened by Ic \&Bl

.El

.Ss Block full-implicit

Multi-line scope closed by end-of-file or implicitly by another macro.

All macros have bodies; some

.Po

.Sx \&It Fl bullet ,

.Ic \&It Fl bullet ,

.Fl hyphen ,

.Fl dash ,

.Fl enum ,

Line 2674 All macros have bodies; some

Line 2759 All macros have bodies; some

.Pc

don't have heads; only one

.Po

.Sx \&It

.Ic \&It

.Sx \&Bl Fl column

.Ic \&Bl Fl column

.Pc

has multiple heads.

.Bd -literal -offset indent

Line 2685 has multiple heads.

Line 2770 has multiple heads.

.Ed

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

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

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

.It Ic \&It Ta \&No Ta Yes Ta closed by Ic \&It , Ic \&El

.It Sx \&Nd Ta \&No Ta \&No Ta closed by Sx \&Sh

.It Ic \&Nd Ta \&No Ta \&No Ta closed by Ic \&Sh

.It Sx \&Nm Ta \&No Ta Yes Ta closed by Sx \&Nm , Sx \&Sh , Sx \&Ss

.It Ic \&Nm Ta \&No Ta Yes Ta closed by Ic \&Nm , Ic \&Sh , Ic \&Ss

.It Sx \&Sh Ta \&No Ta Yes Ta closed by Sx \&Sh

.It Ic \&Sh Ta \&No Ta Yes Ta closed by Ic \&Sh

.It Sx \&Ss Ta \&No Ta Yes Ta closed by Sx \&Sh , Sx \&Ss

.It Ic \&Ss Ta \&No Ta Yes Ta closed by Ic \&Sh , Ic \&Ss

.El

.Pp

Note that the

.Sx \&Nm

.Ic \&Nm

macro is a

.Sx Block full-implicit

macro only when invoked as the first macro

Line 2705 section line, else it is

Line 2790 section line, else it is

Like block full-explicit, but also with single-line scope.

Each has at least a body and, in limited circumstances, a head

.Po

.Sx \&Fo ,

.Ic \&Fo ,

.Sx \&Eo

.Ic \&Eo

.Pc

and/or tail

.Pq Sx \&Ec .

.Pq Ic \&Ec .

.Bd -literal -offset indent

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

\(lBbody...\(rB

Line 2720 and/or tail

Line 2805 and/or tail

.Ed

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

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

.It Sx \&Ac Ta Yes Ta Yes Ta opened by Sx \&Ao

.It Ic \&Ac Ta Yes Ta Yes Ta opened by Ic \&Ao

.It Sx \&Ao Ta Yes Ta Yes Ta closed by Sx \&Ac

.It Ic \&Ao Ta Yes Ta Yes Ta closed by Ic \&Ac

.It Sx \&Bc Ta Yes Ta Yes Ta closed by Sx \&Bo

.It Ic \&Bc Ta Yes Ta Yes Ta closed by Ic \&Bo

.It Sx \&Bo Ta Yes Ta Yes Ta opened by Sx \&Bc

.It Ic \&Bo Ta Yes Ta Yes Ta opened by Ic \&Bc

.It Sx \&Brc Ta Yes Ta Yes Ta opened by Sx \&Bro

.It Ic \&Brc Ta Yes Ta Yes Ta opened by Ic \&Bro

.It Sx \&Bro Ta Yes Ta Yes Ta closed by Sx \&Brc

.It Ic \&Bro Ta Yes Ta Yes Ta closed by Ic \&Brc

.It Sx \&Dc Ta Yes Ta Yes Ta opened by Sx \&Do

.It Ic \&Dc Ta Yes Ta Yes Ta opened by Ic \&Do

.It Sx \&Do Ta Yes Ta Yes Ta closed by Sx \&Dc

.It Ic \&Do Ta Yes Ta Yes Ta closed by Ic \&Dc

.It Sx \&Ec Ta Yes Ta Yes Ta opened by Sx \&Eo

.It Ic \&Ec Ta Yes Ta Yes Ta opened by Ic \&Eo

.It Sx \&Eo Ta Yes Ta Yes Ta closed by Sx \&Ec

.It Ic \&Eo Ta Yes Ta Yes Ta closed by Ic \&Ec

.It Sx \&Fc Ta Yes Ta Yes Ta opened by Sx \&Fo

.It Ic \&Fc Ta Yes Ta Yes Ta opened by Ic \&Fo

.It Sx \&Fo Ta \&No Ta \&No Ta closed by Sx \&Fc

.It Ic \&Fo Ta \&No Ta \&No Ta closed by Ic \&Fc

.It Sx \&Oc Ta Yes Ta Yes Ta closed by Sx \&Oo

.It Ic \&Oc Ta Yes Ta Yes Ta closed by Ic \&Oo

.It Sx \&Oo Ta Yes Ta Yes Ta opened by Sx \&Oc

.It Ic \&Oo Ta Yes Ta Yes Ta opened by Ic \&Oc

.It Sx \&Pc Ta Yes Ta Yes Ta closed by Sx \&Po

.It Ic \&Pc Ta Yes Ta Yes Ta closed by Ic \&Po

.It Sx \&Po Ta Yes Ta Yes Ta opened by Sx \&Pc

.It Ic \&Po Ta Yes Ta Yes Ta opened by Ic \&Pc

.It Sx \&Qc Ta Yes Ta Yes Ta opened by Sx \&Oo

.It Ic \&Qc Ta Yes Ta Yes Ta opened by Ic \&Oo

.It Sx \&Qo Ta Yes Ta Yes Ta closed by Sx \&Oc

.It Ic \&Qo Ta Yes Ta Yes Ta closed by Ic \&Oc

.It Sx \&Re Ta \&No Ta \&No Ta opened by Sx \&Rs

.It Ic \&Re Ta \&No Ta \&No Ta opened by Ic \&Rs

.It Sx \&Rs Ta \&No Ta \&No Ta closed by Sx \&Re

.It Ic \&Rs Ta \&No Ta \&No Ta closed by Ic \&Re

.It Sx \&Sc Ta Yes Ta Yes Ta opened by Sx \&So

.It Ic \&Sc Ta Yes Ta Yes Ta opened by Ic \&So

.It Sx \&So Ta Yes Ta Yes Ta closed by Sx \&Sc

.It Ic \&So Ta Yes Ta Yes Ta closed by Ic \&Sc

.It Sx \&Xc Ta Yes Ta Yes Ta opened by Sx \&Xo

.It Ic \&Xc Ta Yes Ta Yes Ta opened by Ic \&Xo

.It Sx \&Xo Ta Yes Ta Yes Ta closed by Sx \&Xc

.It Ic \&Xo Ta Yes Ta Yes Ta closed by Ic \&Xc

.El

.Ss Block partial-implicit

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

Line 2753 end of the line.

Line 2838 end of the line.

.Ed

.Bl -column "MacroX" "CallableX" "ParsedX" -offset indent

.It Em Macro Ta Em Callable Ta Em Parsed

.It Sx \&Aq Ta Yes Ta Yes

.It Ic \&Aq Ta Yes Ta Yes

.It Sx \&Bq Ta Yes Ta Yes

.It Ic \&Bq Ta Yes Ta Yes

.It Sx \&Brq Ta Yes Ta Yes

.It Ic \&Brq Ta Yes Ta Yes

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

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

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

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

.It Sx \&Dq Ta Yes Ta Yes

.It Ic \&Dq Ta Yes Ta Yes

.It Sx \&Op Ta Yes Ta Yes

.It Ic \&En Ta Yes Ta Yes

.It Sx \&Pq Ta Yes Ta Yes

.It Ic \&Op Ta Yes Ta Yes

.It Sx \&Ql Ta Yes Ta Yes

.It Ic \&Pq Ta Yes Ta Yes

.It Sx \&Qq Ta Yes Ta Yes

.It Ic \&Ql Ta Yes Ta Yes

.It Sx \&Sq Ta Yes Ta Yes

.It Ic \&Qq Ta Yes Ta Yes

.It Sx \&Vt Ta Yes Ta Yes

.It Ic \&Sq Ta Yes Ta Yes

.It Ic \&Vt Ta Yes Ta Yes

.El

.Pp

Note that the

.Sx \&Vt

.Ic \&Vt

macro is a

.Sx Block partial-implicit

only when invoked as the first macro

Line 2778 section line, else it is

Line 2864 section line, else it is

.Sx In-line .

.Ss Special block macro

The

.Sx \&Ta

.Ic \&Ta

macro can only be used below

.Sx \&It

.Ic \&It

.Sx \&Bl Fl column

.Ic \&Bl Fl column

lists.

It delimits blocks representing table cells;

these blocks have bodies, but no heads.

.Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -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

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

.El

.Ss In-line

Closed by the end of the line, fixed argument lengths,

Line 2806 then the macro accepts an arbitrary number of argument

Line 2892 then the macro accepts an arbitrary number of argument

.Ed

.Bl -column "MacroX" "CallableX" "ParsedX" "Arguments" -offset indent

.It Em Macro Ta Em Callable Ta Em Parsed Ta Em Arguments

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

.It Ic \&%A Ta \&No Ta \&No Ta >0

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

.It Ic \&%B Ta \&No Ta \&No Ta >0

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

.It Ic \&%C Ta \&No Ta \&No Ta >0

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

.It Ic \&%D Ta \&No Ta \&No Ta >0

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

.It Ic \&%I Ta \&No Ta \&No Ta >0

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

.It Ic \&%J Ta \&No Ta \&No Ta >0

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

.It Ic \&%N Ta \&No Ta \&No Ta >0

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

.It Ic \&%O Ta \&No Ta \&No Ta >0

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

.It Ic \&%P Ta \&No Ta \&No Ta >0

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

.It Ic \&%Q Ta \&No Ta \&No Ta >0

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

.It Ic \&%R Ta \&No Ta \&No Ta >0

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

.It Ic \&Bsx Ta Yes Ta Yes Ta n

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

.It Ic \&Es Ta Yes Ta Yes Ta 2

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

.It Ic \&Nm Ta Yes Ta Yes Ta n

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

.It Ic \&Tg Ta \&No Ta \&No Ta <2

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

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

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

.It Ic \&Ud Ta \&No Ta \&No Ta 0

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

.It Ic \&Ux Ta Yes Ta Yes Ta n

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

.It Ic \&Va Ta Yes Ta Yes Ta n

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

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

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

.It Ic \&Xr Ta Yes Ta Yes Ta 2

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

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

.El

.Ss Delimiters

When a macro argument consists of one single input character

Line 2897 For many macros, when the leading arguments are openin

Line 2981 For many macros, when the leading arguments are openin

these delimiters are put before the macro scope,

and when the trailing arguments are closing delimiters,

these delimiters are put after the macro scope.

Spacing is suppressed after opening delimiters

and before closing delimiters.

For example,

.Pp

.D1 Pf \. \&Aq "( [ word ] ) ."

Line 2938 exclamation mark

Line 3024 exclamation mark

Note that even a period preceded by a backslash

.Pq Sq \e.\&

gets this special handling; use

.Sq \e&.

.Sq \e&.\&

to prevent that.

.Pp

Many in-line macros interrupt their scope when they encounter

Line 2953 renders as:

Line 3039 renders as:

.D1 Fl a ( b | c \*(Ba d ) e

.Pp

This applies to both opening and closing delimiters,

and also to the middle delimiter:

and also to the middle delimiter, which does not suppress spacing:

.Pp

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

.It \&|

Line 2965 in the same way as a plain

Line 3051 in the same way as a plain

.Sq \&|

character.

Using this predefined string is not recommended in new manuals.

.Pp

Appending a zero-width space

.Pq Sq \e&

to the end of an input line is also useful to prevent the interpretation

of a trailing period, exclamation or question mark as the end of a

sentence, for example when an abbreviation happens to occur

at the end of a text or macro input line.

.Ss Font handling

.Nm

Line 2984 Manually switching the font using the

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

.Ic \&Pa

.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.

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.

\*[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

.Sx \&Pa

does not format its arguments when used in the FILES section under

certain list types.

.It

.Sx \&Ta

.Ic \&Ta

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

.It

.Sx \&%C

is not implemented.

.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 3125 The following features are unimplemented in mandoc:

Line 3108 The following features are unimplemented in mandoc:

.Pp

.Bl -dash -compact

.It

.Sx \&Bd

.Ic \&Bd Fl file Ar file

.Fl file Ar file .

is unsupported for security reasons.

.It

.Sx \&Bd

.Ic \&Bd

.Fl offset Ar center

.Fl filled

and

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

.Fl offset Ar right .

.Ic \&Bd

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

.Fl ragged .

but produces large indentations.

.It

The

.Ic \&Bd

.Sq \eh

.Fl literal

.Pq horizontal position ,

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

.Sq \ev

.Ic \&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

.Ic \&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 3173 This is not supported by mandoc.

Line 3139 This is not supported by mandoc.

.Xr mandoc_char 7 ,

.Xr roff 7 ,

.Xr tbl 7

.Pp

The web page

.Lk http://mandoc.bsd.lv/mdoc/ "extended documentation for the mdoc language"

provides a few tutorial-style pages for beginners, an extensive style

guide for advanced authors, and an alphabetic index helping to choose

the best macros for various kinds of content.

.Sh HISTORY

The

.Nm

Line 3188 utility written by Kristaps Dzonsons appeared in

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