mandoc/mdoc.7 - diff

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.181 and 1.199

version 1.181, 2011/03/07 01:35:51

version 1.199, 2011/08/16 23:44:58

Line 40 An

.Nm

document follows simple rules: lines beginning with the control

character

.Sq \.

.Sq \&.

are parsed for macros.

Other lines are interpreted within the scope of

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

prior macros:

interpreted within the scope of prior macros:

.Bd -literal -offset indent

\&.Sh Macro lines change control state.

Other lines are interpreted within the current state.

Text lines are interpreted within the current state.

.Ed

.Sh LANGUAGE SYNTAX

.Nm

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

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

.Pp

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

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

with a leading newline.

.Ss Comments

Text following a

.Sq \e\*q ,

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

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

line.

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

.Sq \&.\e\*q ,

is also ignored.

Macro lines with only a control character and optional whitespace are

stripped from input.

.Ss Reserved Characters

Within a macro line, the following characters are reserved:

.Pp

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

.It \&.

.Pq period

.It \&,

.Pq comma

.It \&:

.Pq colon

.It \&;

.Pq semicolon

.It \&(

.Pq left-parenthesis

.It \&)

.Pq right-parenthesis

.It \&[

.Pq left-bracket

.It \&]

.Pq right-bracket

.It \&?

.Pq question

.It \&!

.Pq exclamation

.It \&|

.Pq vertical bar

.El

.Pp

Use of reserved characters is described in

.Sx MACRO SYNTAX .

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

with a non-breaking space

.Pq Sq \e&

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

.Ss Special Characters

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

Special characters may occur in both macro and text lines.

Sequences begin with the escape character

.Sq \e

followed by either an open-parenthesis

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

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

.Pp

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

respectively) may be used instead.

A text decoration is valid within

If a macro opens a font scope after calling

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

.Sq \ef ,

its own scope, such as

such as with

.Sx \&Bf

.Sx \&Bf ,

.Cm \&Sy ,

the

in-scope invocations of

.Sq \ef

are only valid within the font scope of the macro.

mode will be restored upon exiting the

.Sx \&Bf

.Sq \ef

scope.

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

text, it will affect the remainder of the document.

.Pp

Note this form is

.Em not

Line 174 and

Line 137 and

.Pq vertical bar .

.Ss Whitespace

Whitespace consists of the space character.

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

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

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

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

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

within literal contexts.

.Pp

In general, trailing whitespace on input lines is discouraged

for reasons of clarity and portability.

In the rare case that a blank character is needed at the end of an

input line, it may be forced by

.Sq \e\ \e& .

.Pp

In macro lines, whitespace delimits arguments and is discarded.

If arguments are quoted, whitespace within the quotes is retained.

.Ss Quotation

Macro arguments may be quoted with double-quotes to group

Macro arguments may be quoted with double-quotes; in this case,

space-delimited terms or to retain blocks of whitespace.

whitespace within the quotes is retained as part of the argument.

For example,

.Pp

.D1 Pf \. \&Fn strlen "\(dqconst char *s\(dq"

.Pp

renders as

.Sq Fn strlen "const char *s" ,

while

.Pp

.D1 Pf \. \&Fn strlen "const char *s"

.Pp

would produce

.Sq Fn strlen const char *s .

.Pp

A quoted argument begins with a double-quote preceded by whitespace.

The next double-quote not pairwise adjacent to another double-quote

terminates the literal, regardless of surrounding whitespace.

.Pp

In unquoted arguments, space characters can alternatively be included

by preceding them with a backslash

.Pq Sq \e\~ ,

but quoting is usually better for clarity.

.Pp

Note that any quoted text, even if it would cause a macro invocation

when unquoted, is considered literal text.

Thus, the following produces

Line 196 Thus, the following produces

Line 182 Thus, the following produces

\&.Op "Fl a"

.Ed

.Pp

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

In text lines, quotes are regarded as opaque text.

.Ss Scaling Widths

Many macros support scaled widths for their arguments, such as

stipulating a two-inch list indentation with the following:

Line 267 The proper spacing is also intelligently preserved if

Line 253 The proper spacing is also intelligently preserved if

the boundary of a macro line.

For example:

.Pp

.Dl \&Xr mandoc 1 \.

.Dl \&.Xr mandoc 1 \&.

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

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

.Sh MANUAL STRUCTURE

A well-formed

.Nm

Line 297 sections, although this varies between manual sections

Line 283 sections, although this varies between manual sections

.Pp

The following is a well-formed skeleton

.Nm

file:

file for a utility

.Qq progname :

.Bd -literal -offset indent

\&.Dd $\&Mdocdate$

\&.Dt mdoc 7

\&.Dt PROGNAME section

\&.Os

\&.Sh NAME

\&.Nm foo

\&.Nm progname

\&.Nd a description goes here

\&.Nd one line about what it does

\&.\e\*q .Sh LIBRARY

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

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

\&.Sh SYNOPSIS

\&.Nm foo

\&.Nm progname

\&.Op Fl options

\&.Ar

\&.Sh DESCRIPTION

Line 356 The syntax for this as follows:

Line 343 The syntax for this as follows:

\&.Nd a one line description

.Ed

.Pp

Multiple

.Sq \&Nm

names should be separated by commas.

.Pp

The

.Sx \&Nm

macro(s) must precede the

Line 383 configuration.

Line 374 configuration.

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

generally structured as follows:

.Bd -literal -offset indent

\&.Nm foo

\&.Nm bar

\&.Op Fl v

\&.Op Fl o Ar file

\&.Op Ar

\&.Nm bar

\&.Nm foo

\&.Op Fl v

\&.Op Fl o Ar file

\&.Op Ar

.Ed

.Pp

Commands should be ordered alphabetically.

.Pp

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

.Bd -literal -offset indent

\&.In header.h

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

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

\&.Fn bar "const char *src"

.Ed

.Pp

Ordering of

.Sx \&In ,

.Sx \&Vt ,

.Sx \&Fn ,

and

.Sx \&Fo

macros should follow C header-file conventions.

.Pp

And for the third, configurations (section 4):

.Bd -literal -offset indent

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

Line 451 or

Line 452 or

.Sx \&Ss

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

.It Em DESCRIPTION

This expands upon the brief, one line description in

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

.Em NAME .

.Em NAME :

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

.Bd -literal -offset indent

The

\&.Nm

utility does this, that, and the other.

.Ed

.Pp

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

command), such as:

.Bd -literal -offset indent

The arguments are as follows:

Line 464 Print verbose information.

Line 471 Print verbose information.

.Ed

.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

macro to form subsections.

In very long manuals, the

.Em DESCRIPTION

may be split into multiple sections, each started by an

.Sx \&Sh

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

several subsections, like in the present

.Nm

manual.

.It Em IMPLEMENTATION NOTES

Implementation-specific notes should be kept here.

This is useful when implementing standard functions that may have side

Line 525 This section should exist for most manuals.

Line 547 This section should exist for most manuals.

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

alphabetically.

.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

and

.Sx \&Xr .

.It Em STANDARDS

References any standards implemented or used.

Line 536 section should be used instead.

Line 564 section should be used instead.

See

.Sx \&St .

.It Em HISTORY

A brief history of the subject, including where support first appeared.

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.

.It Em AUTHORS

Credits to the person or persons who wrote the code and/or documentation.

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

Line 580 The

Line 609 The

.Em Callable

column indicates that the macro may also be called by passing its name

as an argument to another macro.

For example,

.Sq \&.Op \&Fl O \&Ar file

produces

.Sq Op Fl O Ar file .

To prevent a macro call and render the macro name literally,

escape it by prepending a zero-width space,

.Sq \e& .

For example,

.Sq \&Op \e&Fl O

produces

.Sq Op \&Fl O .

If a macro is not callable but its name appears as an argument

to another macro, it is interpreted as opaque text.

For example,

Line 601 column, if applicable, describes closure rules.

Line 641 column, if applicable, describes closure rules.

Multi-line scope closed by an explicit closing macro.

All macros contains bodies; only

.Sx \&Bf

contains a head.

and

.Pq optionally

.Sx \&Bl

contain a head.

.Bd -literal -offset indent

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

\(lBbody...\(rB

Line 643 has multiple heads.

Line 686 has multiple heads.

.Pp

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

.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 Sx \&Nd Ta \&No Ta \&No Ta closed by Sx \&Sh

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

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

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

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

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

.El

.Pp

Note that the

Line 705 and/or tail

Line 748 and/or tail

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

.El

.Ss Block partial-implicit

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

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

.Sx Reserved Characters

end of the line.

or end of line.

.Bd -literal -offset indent

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

.Ed

Line 737 in a

Line 779 in a

.Em SYNOPSIS

section line, else it is

.Sx In-line .

.Ss Special block macro

The

.Sx \&Ta

macro can only be used below

.Sx \&It

.Sx \&Bl Fl column

lists.

It delimits blocks representing table cells;

these blocks have bodies, but no heads.

.Pp

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

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

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

.El

.Ss In-line

Closed by

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

.Sx Reserved Characters ,

and/or subsequent macros.

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

In-line macros have only text children.

If a number (or inequality) of arguments is

.Pq n ,

Line 799 then the macro accepts an arbitrary number of argument

Line 855 then the macro accepts an arbitrary number of argument

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

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

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

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

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

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

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

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

Line 830 then the macro accepts an arbitrary number of argument

Line 886 then the macro accepts an arbitrary number of argument

.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

considered as a delimiter, the argument gets special handling.

This does not apply when delimiters appear in arguments containing

more than one character.

Consequently, to prevent special handling and just handle it

like any other argument, a delimiter can be escaped by prepending

a zero-width space

.Pq Sq \e& .

In text lines, delimiters never need escaping, but may be used

as normal punctuation.

.Pp

For many macros, when the leading arguments are opening delimiters,

these delimiters are put before the macro scope,

and when the trailing arguments are closing delimiters,

these delimiters are put after the macro scope.

For example,

.Pp

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

.Pp

renders as:

.Pp

.D1 Aq ( [ word ] ) .

.Pp

Opening delimiters are:

.Pp

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

.It \&(

left parenthesis

.It \&[

left bracket

.El

.Pp

Closing delimiters are:

.Pp

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

.It \&.

period

.It \&,

comma

.It \&:

colon

.It \&;

semicolon

.It \&)

right parenthesis

.It \&]

right bracket

.It \&?

question mark

.It \&!

exclamation mark

.El

.Pp

Note that even a period preceded by a backslash

.Pq Sq \e.\&

gets this special handling; use

.Sq \e&.

to prevent that.

.Pp

Many in-line macros interrupt their scope when they encounter

delimiters, and resume their scope when more arguments follow that

are not delimiters.

For example,

.Pp

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

.Pp

renders as:

.Pp

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

.Pp

This applies to both opening and closing delimiters,

and also to the middle delimiter:

.Pp

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

.It \&|

vertical bar

.El

.Pp

As a special case, the predefined string \e*(Ba is handled and rendered

in the same way as a plain

.Sq \&|

character.

Using this predefined string is not recommended in new manuals.

.Sh REFERENCE

This section is a canonical reference of all macros, arranged

alphabetically.

Line 919 Examples:

Line 1059 Examples:

.Dl \&.Ad 0x00000000

.Ss \&An

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.

Requires either the name of an author or one of the following arguments:

.Pp

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

Line 989 If an argument is not provided, the string

Line 1131 If an argument is not provided, the string

is used as a default.

.Pp

Examples:

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

.Dl ".Fl o Ar file"

.Dl \&.Ar

.Dl ".Ar"

.Dl \&.Ar arg1 , arg2 .

.Dl ".Ar arg1 , arg2 ."

.Pp

The arguments to the

.Sx \&Ar

macro are names and placeholders for command arguments;

for fixed strings to be passed verbatim as arguments, use

.Sx \&Fl

.Sx \&Cm .

.Ss \&At

Formats an AT&T version.

Accepts one optional argument:

Line 1000 Accepts one optional argument:

Line 1150 Accepts one optional argument:

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

A version of

.At .

.It Cm III

.At III .

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

A version of

.At V .

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

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

.Pp

Examples:

.Dl \&.At

.Dl \&.At III

.Dl \&.At V.1

.Pp

See also

Line 1037 Its syntax is as follows:

Line 1190 Its syntax is as follows:

.Pp

Display blocks are used to select a different indentation and

justification than the one used by the surrounding text.

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

They may contain both macro lines and text lines.

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

.Pp

The

Line 1045 The

Line 1198 The

must be one of the following:

.Bl -tag -width 13n -offset indent

.It Fl centered

Centre-justify each line.

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

Using this display type is not recommended; many

.Nm

implementations render it poorly.

.It Fl filled

Left- and right-justify the block.

Change the positions of line breaks to fill each line, and left- and

right-justify the resulting block.

.It Fl literal

Do not justify the block at all.

Produce one output line from each input line,

and do not justify the block at all.

Preserve white space as it appears in the input.

Always use a constant-width font.

Use this for displaying source code.

.It Fl ragged

Only left-justify the block.

Change the positions of line breaks to fill each line, and left-justify

the resulting block.

.It Fl unfilled

An alias for

The same as

.Fl literal .

.Fl literal ,

but using the same font as for normal text, which is a variable width font

if supported by the output device.

.El

.Pp

The

Line 1074 which may be one of the following:

Line 1234 which may be one of the following:

.It

One of the pre-defined strings

.Cm indent ,

the width of standard indentation;

the width of a standard indentation (six constant width characters);

.Cm indent-two ,

twice

.Cm indent ;

Line 1152 See also

Line 1312 See also

and

.Sx \&Sy .

.Ss \&Bk

Keep the output generated from each macro input line together

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

on one single output line.

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

Line breaks in free-form text lines are unaffected.

whichever comes first.

Line breaks in text lines are unaffected.

The syntax is as follows:

.Pp

.D1 Pf \. Sx \&Bk Fl words

Line 1250 except that dashes are used in place of bullets.

Line 1411 except that dashes are used in place of bullets.

.Fl inset ,

except that item heads are not parsed for macro invocations.

.\" but with additional formatting to the head.

Most often used in the

.Em DIAGNOSTICS

section with error constants in the item heads.

.It Fl enum

A numbered list.

No item heads can be specified.

Formatted like

.Fl bullet ,

except that cardinal numbers are used in place of bullets,

Line 1292 this head on the same output line.

Line 1456 this head on the same output line.

Otherwise, the body starts on the output line following the head.

.El

.Pp

Lists may be nested within lists and displays.

Nesting of

.Fl column

and

.Fl enum

lists may not be portable.

.Pp

See also

.Sx \&El

and

Line 1368 and

Line 1539 and

.Sx \&Ux .

.Ss \&Bt

Prints

.Dq is currently in beta test .

.Dq is currently in beta test.

.Ss \&Bx

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

argument is provided.

.Pp

Examples:

.Dl \&.Bx 4.3 Tahoe

.Dl \&.Bx 4.4

.Dl \&.Bx

.Pp

Line 1390 and

Line 1562 and

Kernel configuration declaration.

This denotes strings accepted by

.Xr config 8 .

It is most often used in section 4 manual pages.

.Pp

Examples:

.Dl \&.Cd device le0 at scode?

Line 1402 declarations.

Line 1575 declarations.

This practise is discouraged.

.Ss \&Cm

Command modifiers.

Useful when specifying configuration options or keys.

Typically used for fixed strings passed as arguments, unless

.Sx \&Fl

is more appropriate.

Also useful when specifying configuration options or keys.

.Pp

Examples:

.Dl \&.Cm ControlPath

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

.Dl \&.Cm ControlMaster

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

.Pp

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

See also

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

.Sx \&Fl .

.Dl ".Cm LogLevel Dv DEBUG"

.Ss \&D1

One-line indented display.

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

Line 1667 See also

Line 1843 See also

and

.Sx \&Os .

.Ss \&Dv

Defined variables such as preprocessor constants.

Defined variables such as preprocessor constants, constant symbols,

enumeration values, and so on.

.Pp

Examples:

.Dl \&.Dv NULL

.Dl \&.Dv BUFSIZ

.Dl \&.Dv STDOUT_FILENO

.Pp

See also

.Sx \&Er .

.Sx \&Er

and

.Sx \&Ev

for special-purpose constants and

.Sx \&Va

for variable symbols.

.Ss \&Dx

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

value if no argument is provided.

Line 1722 See also

Line 1905 See also

and

.Sx \&It .

.Ss \&Em

Denotes text that should be emphasised.

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!

Line 1732 Examples:

Line 1918 Examples:

.Pp

See also

.Sx \&Bf ,

.Sx \&Sy ,

.Sx \&Li ,

.Sx \&No ,

and

.Sx \&Li .

.Sx \&Sy .

.Ss \&En

This macro is obsolete and not implemented in

.Xr mandoc 1 .

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

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

will emulate

.Sx \&Do .

.Ss \&Er

Display error constants.

Error constants for definitions of the

.Va errno

libc global variable.

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

.Pp

Examples:

.Dl \&.Er EPERM

.Dl \&.Er ENOENT

.Pp

See also

.Sx \&Dv .

.Sx \&Dv

for general constants.

.Ss \&Es

This macro is obsolete and not implemented.

.Ss \&Ev

Line 1767 Environmental variables such as those specified in

Line 1958 Environmental variables such as those specified in

Examples:

.Dl \&.Ev DISPLAY

.Dl \&.Ev PATH

.Pp

See also

.Sx \&Dv

for general constants.

.Ss \&Ex

Insert a standard sentence regarding exit values.

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

and >0 on failure.

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

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

.Pp

When

.Ar utility

is not specified, the document's name set by

.Sx \&Nm

is used.

Multiple

.Ar utility

arguments are treated as separate utilities.

.Pp

See also

.Sx \&Rv .

Line 1826 See also

Line 2026 See also

and

.Sx \&In .

.Ss \&Fl

Command-line flag.

Command-line flag or option.

Used when listing arguments to command-line utilities.

Prints a fixed-width hyphen

.Sq \-

Line 1836 If the argument is a macro, a hyphen is prefixed to th

Line 2036 If the argument is a macro, a hyphen is prefixed to th

output.

.Pp

Examples:

.Dl \&.Fl a b c

.Dl ".Fl R Op Fl H | L | P"

.Dl \&.Fl \&Pf a b

.Dl ".Op Fl 1AaCcdFfgHhikLlmnopqRrSsTtux"

.Dl \&.Fl

.Dl ".Fl type Cm d Fl name Pa CVS"

.Dl \&.Op \&Fl o \&Ns \&Ar file

.Dl ".Fl Ar signal_number"

.Dl ".Fl o Fl"

.Pp

See also

.Sx \&Cm .

Line 1848 A function name.

Line 2049 A function name.

Its syntax is as follows:

.Bd -ragged -offset indent

.Pf \. Ns Sx \&Fn

.Op Cm functype

.Op Ar functype

.Cm funcname

.Ar funcname

.Op Oo Cm argtype Oc Cm argname

.Op Oo Ar argtype Oc Ar argname

.Ed

.Pp

Function arguments are surrounded in parenthesis and

are delimited by commas.

If no arguments are specified, blank parenthesis are output.

In the

.Em SYNOPSIS

section, this macro starts a new output line,

and a blank line is automatically inserted between function definitions.

.Pp

Examples:

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

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

.Dl \&.Fn funcname "int arg0"

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

.Dl \&.Fn funcname arg0

.Pp

.Bd -literal -offset indent -compact

\&.Ft functype

\&.Fn funcname

Line 1870 When referring to a function documented in another man

Line 2076 When referring to a function documented in another man

.Sx \&Xr

instead.

See also

.Sx MANUAL STRUCTURE

.Sx MANUAL STRUCTURE ,

.Sx \&Fo ,

and

.Sx \&Ft .

.Ss \&Fo

Line 1879 This is a multi-line version of

Line 2086 This is a multi-line version of

.Sx \&Fn .

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&Fo Cm funcname

.D1 Pf \. Sx \&Fo Ar funcname

.Pp

Invocations usually occur in the following context:

.Bd -ragged -offset indent

.Pf \. Sx \&Ft Cm functype

.Pf \. Sx \&Ft Ar functype

.br

.Pf \. Sx \&Fo Cm funcname

.Pf \. Sx \&Fo Ar funcname

.br

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

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

.br

\.\.\.

\&.\.\.

.br

.Pf \. Sx \&Fc

.Ed

Line 1897 Invocations usually occur in the following context:

Line 2104 Invocations usually occur in the following context:

.Sx \&Fo

scope is closed by

.Sx \&Fc .

.Pp

See also

.Sx MANUAL STRUCTURE ,

Line 1904 See also

Line 2112 See also

.Sx \&Fc ,

and

.Sx \&Ft .

.Ss \&Fr

This macro is obsolete and not implemented in

.Xr mandoc 1 .

.Pp

It was used to show function return values.

The syntax was:

.Pp

.Dl Pf . Sx \&Fr Ar value

.Ss \&Ft

A function type.

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&Ft Cm functype

.D1 Pf \. Sx \&Ft Ar functype

.Pp

In the

.Em SYNOPSIS

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

.Pp

Examples:

.Dl \&.Ft int

.Bd -literal -offset indent -compact

Line 1942 See also

Line 2162 See also

and

.Sx \&Ux .

.Ss \&Hf

This macro is obsolete and not implemented.

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:

.Pp

.Dl Pf . Sx \&Hf Ar filename

.Ss \&Ic

Designate an internal or interactive command.

This is similar to

Line 1950 This is similar to

Line 2176 This is similar to

but used for instructions rather than values.

.Pp

Examples:

.Dl \&.Ic :wq

.Dl \&.Ic hash

.Dl \&.Ic alias

.Pp

Line 1964 macro is used when referring to specific instructions.

Line 2191 macro is used when referring to specific instructions.

.Dq include

file.

In the

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

.Em SYNOPSIS

section (only if invoked as the line macro), the first argument is

section, the argument is displayed in angle brackets

preceded by

and preceded by

.Dq #include ,

the arguments is enclosed in angle brackets.

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.

.Pp

Examples:

.Dl \&.In sys/types

.Dl \&.In sys/types.h

.Pp

See also

.Sx MANUAL STRUCTURE .

Line 1989 and

Line 2218 and

.Fl diag

have the following syntax:

.Pp

.D1 Pf \. Sx \&It Cm args

.D1 Pf \. Sx \&It Ar args

.Pp

Lists of type

.Fl bullet ,

Line 2026 The

Line 2255 The

list is the most complicated.

Its syntax is as follows:

.Pp

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

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

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

.Pp

The

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

.Cm args

representing a complete table line.

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

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

delimited by tabs or the special

.Sx \&Ta

.Sq \&Ta

block macro.

pseudo-macro.

The tab cell delimiter may only be used within the

Lines subsequent the

.Sx \&It

are interpreted within the scope of the last phrase.

line itself; on following lines, only the

Calling the pseudo-macro

.Sx \&Ta

.Sq \&Ta

macro can be used to delimit cells, and

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

.Sx \&Ta

interpreted as a macro).

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

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

not as the first macro on a line.

.Pp

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

.Sx \&It

line itself.

line.

Subsequent this, only the

For example,

.Sq \&Ta

pseudo-macro may be used to delimit phrases.

Furthermore, note that quoted sections propagate over tab-delimited

phrases on an

.Sx \&It ,

for example,

.Pp

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

.Pp

Line 2062 See also

Line 2287 See also

Specify a library.

The syntax is as follows:

.Pp

.D1 Pf \. Sx \&Lb Cm library

.D1 Pf \. Sx \&Lb Ar library

.Pp

The

.Cm library

.Ar library

parameter may be a system library, such as

.Cm libz

Line 2082 Examples:

Line 2307 Examples:

.Dl \&.Lb libz

.Dl \&.Lb mdoc

.Ss \&Li

Denotes text that should be in a literal font mode.

Denotes text that should be in a

.Li literal

font mode.

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

stylistically decorating technical terms.

.Pp

On terminal output devices, this is often indistinguishable from

normal text.

.Pp

See also

.Sx \&Bf ,

.Sx \&Sy ,

.Sx \&Em ,

.Sx \&No ,

and

.Sx \&Em .

.Sx \&Sy .

.Ss \&Lk

Format a hyperlink.

Its syntax is as follows:

.Pp

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

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

.Pp

Examples:

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

Line 2110 Synonym for

Line 2341 Synonym for

Display a mathematical symbol.

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&Ms Cm symbol

.D1 Pf \. Sx \&Ms Ar symbol

.Pp

Examples:

.Dl \&.Ms sigma

Line 2121 Format a

Line 2352 Format a

hyperlink.

Its syntax is as follows:

.Pp

.D1 Pf \. Sx \&Mt Cm address

.D1 Pf \. Sx \&Mt Ar address

.Pp

Examples:

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

Line 2134 section subsequent the

Line 2365 section subsequent the

macro.

.Pp

Examples:

.Dl \&.Sx \&Nd mdoc language reference

.Dl Pf . Sx \&Nd mdoc language reference

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

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

.Pp

The

.Sx \&Nd

Line 2187 macro rather than

Line 2418 macro rather than

.Sx \&Nm

to mark up the name of the manual page.

.Ss \&No

Normal text.

.Dq noop

Closes the scope of any preceding in-line macro.

macro used to terminate prior macro contexts.

When used after physical formatting macros like

.Sx \&Em

.Sx \&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 \&.Sx \&Fl ab \&No cd \&Fl ef

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

.Pp

.Bd -literal -offset indent -compact

\&.Sm off

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

\&.Sm on

.Ed

.Pp

See also

.Sx \&Em ,

.Sx \&Li ,

and

.Sx \&Sy .

.Ss \&Ns

Suppress a space.

Suppress a space between the output of the preceding macro

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

and the following text or macro.

macro is encountered.

Following invocation, input is interpreted as normal text

just like after an

.Sx \&No

macro.

.Pp

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

.Pp

Examples:

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

.Dl ".Ar name Ns = Ns Ar value"

.Dl ".Cm :M Ns Ar pattern"

.Dl ".Fl o Ns Ar output"

.Pp

See also

.Sx \&No

Line 2241 Examples:

Line 2495 Examples:

\&.Oc

.Ed

.Ss \&Op

Command-line option.

Optional part of a command line.

Used when listing options to command-line utilities.

Prints the argument(s) in brackets.

This is most often used in the

.Em SYNOPSIS

section of section 1 and 8 manual pages.

.Pp

Examples:

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

Line 2259 any

Line 2515 any

file.

Its syntax is as follows:

.Pp

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

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

.Pp

The optional

.Cm system

.Ar system

parameter specifies the relevant operating system or environment.

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

This is the suggested form.

Line 2277 See also

Line 2533 See also

and

.Sx \&Dt .

.Ss \&Ot

Unknown usage.

This macro is obsolete and not implemented in

.Xr mandoc 1 .

.Pp

.Em Remarks :

Historical

this macro has been deprecated.

.Xr mdoc 7

packages described it as

.Dq "old function type (FORTRAN)" .

.Ss \&Ox

Format the

.Ox

Line 2301 See also

Line 2560 See also

and

.Sx \&Ux .

.Ss \&Pa

A file-system path.

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

If an argument is not provided, the string

If an argument is not provided, the character

.Dq \(ti

.Sq \(ti

is used as a default.

.Pp

Examples:

Line 2316 See also

Line 2575 See also

Close parenthesised context opened by

.Sx \&Po .

.Ss \&Pf

Removes the space

Removes the space between its argument

.Pq Dq prefix

between its arguments.

and the following macro.

Its syntax is as follows:

.Pp

.D1 Pf \. \&Pf Cm prefix suffix

.D1 .Pf Ar prefix macro arguments ...

.Pp

The

This is equivalent to:

.Cm suffix

argument may be a macro.

.Pp

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

.Pp

Examples:

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

.Dl ".Pf $ Ar variable_name"

.Dl ".Pf 0x Ar hex_digits"

.Pp

See also

.Sx \&Ns

and

.Sx \&Sm .

.Ss \&Po

Multi-line version of

.Sx \&Pq .

Line 2336 Multi-line version of

Line 2601 Multi-line version of

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

.Sx \&Ss

macros or before displays

.Pq Sx \&Bd

or lists

.Pq Sx \&Bl

unless the

.Fl compact

flag is given.

.Ss \&Pq

Parenthesised enclosure.

.Pp

Line 2355 Multi-line version of

Line 2632 Multi-line version of

.Sx \&Qq .

.Ss \&Qq

Encloses its arguments in

.Dq typewriter

.Qq typewriter

double-quotes.

Consider using

.Sx \&Dq .

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

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

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

line.

.Ss \&Rv

Inserts text regarding a function call's return value.

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

This macro must consist of the

on success and \-1 on error, with the

.Fl std

.Va errno

argument followed by an optional

libc global variable set on error.

.Ar function .

Its syntax is as follows:

.Pp

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

.Pp

.Ar function

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

is not specified, the document's name set by

.Sx \&Nm

is provided.

is used.

Multiple

.Ar function

arguments are treated as separate functions.

.Pp

See also

.Sx \&Ex .

Line 2436 custom sections be used.

Line 2719 custom sections be used.

.Pp

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

.Sx \&Sx .

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

may not be linked with

.Sx \&Sx .

.Pp

See also

.Sx \&Pp ,

Line 2453 By default, spacing is

Line 2739 By default, spacing is

When switched

.Cm off ,

no white space is inserted between macro arguments and between the

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

output generated from adjacent macros, but text lines

still get normal spacing between words and sentences.

.Ss \&So

Multi-line version of

.Sx \&Sq .

.Ss \&Sq

Encloses its arguments in

.Dq typewriter

.Sq typewriter

single-quotes.

.Pp

See also

Line 2469 See also

Line 2755 See also

and

.Sx \&So .

.Ss \&Ss

Begin a new sub-section.

Begin a new subsection.

Unlike with

.Sx \&Sh ,

there's no convention for sub-sections.

there is no convention for the naming of subsections.

Conventional sections, as described in

Except

.Sx MANUAL STRUCTURE ,

.Em DESCRIPTION ,

rarely have sub-sections.

the conventional sections described in

.Sx MANUAL STRUCTURE

rarely have subsections.

.Pp

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

.Sx \&Sx .

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

may not be linked with

.Sx \&Sx .

.Pp

See also

.Sx \&Pp ,

Line 2560 The following standards are recognised:

Line 2851 The following standards are recognised:

.St -xpg4

.It \-xpg4.2

.St -xpg4.2

.It \-xpg4.3

.St -xpg4.3

.It \-xbd5

.St -xbd5

Line 2583 The following standards are recognised:

Line 2875 The following standards are recognised:

.St -svid4

.El

.Ss \&Sx

Reference a section or sub-section.

Reference a section or subsection in the same manual page.

The referenced section or sub-section name must be identical to the

The referenced section or subsection name must be identical to the

enclosed argument, including whitespace.

.Pp

Examples:

Line 2602 stylistically decorating technical terms.

Line 2894 stylistically decorating technical terms.

.Pp

See also

.Sx \&Bf ,

.Sx \&Em ,

.Sx \&Li ,

and

.Sx \&Em .

.Sx \&No .

.Ss \&Ta

Table cell separator in

.Sx \&Bl Fl column

lists; can only be used below

.Sx \&It .

.Ss \&Tn

Format a tradename.

.Pp

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

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

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

sometimes for semantical annotation, sometimes for physical formatting.

.Pp

Examples:

.Dl \&.Tn IBM

.Ss \&Ud

Prints out

.Dq currently under development .

.Dq currently under development.

.Ss \&Ux

Format the UNIX name.

Accepts no argument.

Line 2642 This is also used for indicating global variables in t

Line 2945 This is also used for indicating global variables in t

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

Note that it accepts

.Sx Block partial-implicit

syntax when invoked as the first macro in the

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

.Em SYNOPSIS

section, else it accepts ordinary

.Sx In-line

syntax.

In the former case, this macro starts a new output line,

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 ,

Line 2676 Link to another manual

Line 2982 Link to another manual

.Pq Qq cross-reference .

Its syntax is as follows:

.Pp

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

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

.Pp

The

.Cm name

.Ar name

and

.Cm section

.Ar section

are the name and section of the linked manual.

.Cm section

.Ar section

is followed by non-punctuation, an

.Sx \&Ns

is inserted into the token stream.

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

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

historical manuals.

Its syntax is as follows:

.Pp

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

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

.Pp

The

.Cm height

.Ar height

argument must be formatted as described in

.Sx Scaling Widths .

If unspecified,

Line 2754 Newer groff and mandoc print

Line 3060 Newer groff and mandoc print

.Qq AT&T UNIX

and the arguments.

.It

.Sx \&Bd Fl column

.Sx \&Bl Fl column

does not recognize trailing punctuation characters when they immediately

precede tabulator characters, but treats them as normal text and

outputs a space before them.

Line 2814 In new groff and mandoc, any list may be nested by def

Line 3120 In new groff and mandoc, any list may be nested by def

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

.It

.Sx \&Li

followed by a reserved character is incorrectly used in some manuals

followed by a delimiter is incorrectly used in some manuals

instead of properly quoting that character, which sometimes works with

historic groff.

.It

Line 2905 This is not supported by mandoc.

Line 3211 This is not supported by mandoc.

.Xr mandoc 1 ,

.Xr eqn 7 ,

.Xr man 7 ,

.Xr mandoc_char 7

.Xr mandoc_char 7 ,

.Xr roff 7 ,

.Xr tbl 7

.Sh HISTORY

CVSweb