mandoc/mdoc.7 - diff

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.234 and 1.252

version 1.234, 2014/08/08 16:38:06

version 1.252, 2015/02/23 13:31:04

Line 388 See

References other manuals with related topics.

This section should exist for most manuals.

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

alphabetically.

alphabetically (ignoring case).

.Pp

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

for example authoritative books or journal articles, may also be

Line 433 in the alphabetical

.Ss Document preamble and NAME section macros

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

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

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

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

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

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

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

Line 454 in the alphabetical

.Op Fl compact

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

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

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

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

.Fl Ar type

.Op Fl width Ar val

Line 528 in the alphabetical

Line 529 in the alphabetical

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

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

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

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

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

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

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

Line 777 The

must be one of the following:

.Bl -tag -width 13n -offset indent

.It Fl centered

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

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

Using this display type is not recommended; many

.Nm

implementations render it poorly.

Line 822 which has no effect;

.Cm right ,

which justifies to the right margin; or

.Cm center ,

which aligns around an imagined centre axis.

which aligns around an imagined center axis.

.It

A macro invocation, which selects a predefined width

associated with that macro.

Line 937 The

.Fl width

and

.Fl offset

arguments accept scaling widths as described in

arguments accept macro names as described for

.Xr roff 7

.Sx \&Bd

.Fl offset ,

scaling widths as described in

.Xr roff 7 ,

or use the length of the given string.

The

.Fl offset

Line 1182 See also

Line 1185 See also

and

.Sx \&Dl .

.Ss \&Db

Switch debugging mode.

This macro is obsolete.

Its syntax is as follows:

No replacement is needed.

.Pp

It is ignored by

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

.Xr mandoc 1

.Pp

and groff including its arguments.

This macro is ignored by

It was formerly used to toggle a debugging mode.

.Xr mandoc 1 .

.Ss \&Dc

Close a

.Sx \&Do

Line 1245 See also

Line 1247 See also

and

.Sx \&Os .

.Ss \&Dl

One-line intended display.

One-line indented display.

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

invocations.

It is followed by a newline.

Line 1254 Examples:

Line 1256 Examples:

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

.Pp

See also

.Sx \&Ql ,

.Sx \&Bd

.Fl literal ,

and

.Sx \&D1 .

.Ss \&Do

Line 1297 Its syntax is as follows:

Line 1301 Its syntax is as follows:

.Pf \. Sx \&Dt

.Ar TITLE

.Ar section

.Op Ar volume | arch

.Op Ar arch

.Ed

.Pp

Its arguments are as follows:

Line 1312 it should by convention be all caps.

Line 1316 it should by convention be all caps.

The manual section.

This may be one of

.Cm 1

.Pq utilities ,

.Pq General Commands ,

.Cm 2

.Pq system calls ,

.Pq System Calls ,

.Cm 3

.Pq libraries ,

.Pq Library Functions ,

.Cm 3p

.Pq Perl libraries ,

.Pq Perl Library ,

.Cm 4

.Pq devices ,

.Pq Device Drivers ,

.Cm 5

.Pq file formats ,

.Pq File Formats ,

.Cm 6

.Pq games ,

.Pq Games ,

.Cm 7

.Pq miscellaneous ,

.Pq Miscellaneous Information ,

.Cm 8

.Pq system utilities ,

.Pq System Manager's Manual ,

.Cm 9

.Pq kernel functions ,

.Cm X11

.Pq X Window System ,

.Cm X11R6

.Pq X Window System ,

.Cm unass

.Pq unassociated ,

.Cm local

.Pq local system ,

.Cm draft

.Pq draft manual ,

.Cm paper

.Cm 9

.Pq paper .

.Pq Kernel Developer's Manual .

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

the empty string if unspecified.

.It Ar volume

This overrides the volume inferred from

.Ar section .

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

.Cm USD

.Pq users' supplementary documents ,

.Cm PS1

.Pq programmers' supplementary documents ,

.Cm AMD

.Pq administrators' supplementary documents ,

.Cm SMM

.Pq system managers' manuals ,

.Cm URM

.Pq users' reference manuals ,

.Cm PRM

.Pq programmers' reference manuals ,

.Cm KM

.Pq kernel manuals ,

.Cm IND

.Pq master index ,

.Cm MMI

.Pq master index ,

.Cm LOCAL

.Pq local manuals ,

.Cm LOC

.Pq local manuals ,

.Cm CON

.Pq contributed manuals .

.It Ar arch

This specifies the machine architecture a manual page applies to,

where relevant, for example

Line 1383 where relevant, for example

Line 1346 where relevant, for example

.Cm i386 ,

.Cm sparc64 .

The list of supported architectures varies by operating system.

The list of valid architectures varies by operating system.

For the full list of all architectures recognized by

.Xr mandoc 1 ,

see the file

.Pa arch.in

in the source distribution.

.El

.Pp

Examples:

.Dl \&.Dt FOO 1

.Dl \&.Dt FOO 4 KM

.Dl \&.Dt FOO 9 i386

.Pp

See also

Line 1467 See also

Line 1424 See also

and

.Sx \&It .

.Ss \&Em

Denotes text that should be

Request an italic font.

.Em emphasised .

If the output device does not provide that, underline.

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

stylistically decorating technical terms.

Depending on the output device, this is usually represented

using an italic font or underlined characters.

.Pp

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

importance, see

.Sx \&Sy ) .

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

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

that for syntax elements,

.Sx \&Sy

and

.Sx \&Ar

are preferred, respectively.

.Pp

Examples:

.Dl \&.Em Warnings!

.Bd -literal -compact -offset indent

.Dl \&.Em Remarks :

Selected lines are those

\&.Em not

matching any of the specified patterns.

Some of the functions use a

\&.Em hold space

to save the pattern space for subsequent retrieval.

.Ed

.Pp

See also

.Sx \&Bf ,

Line 1557 arguments are treated as separate utilities.

Line 1527 arguments are treated as separate utilities.

See also

.Sx \&Rv .

.Ss \&Fa

Function argument.

Function argument or parameter.

Its syntax is as follows:

.Bd -ragged -offset indent

.Pf \. Sx \&Fa

Line 1788 is preferred for displaying code; the

Line 1758 is preferred for displaying code; the

.Sx \&Ic

macro is used when referring to specific instructions.

.Ss \&In

The name of an include file.

.Dq include

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

file.

.Pp

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

.Em SYNOPSIS

section, the argument is displayed in angle brackets

and preceded by

.Dq #include ,

.Qq #include ,

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

function declaration.

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

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

and causes no line break.

.Pp

Examples:

.Dl \&.In sys/types.h

Line 1959 Examples:

Line 1930 Examples:

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

.Ss \&Nd

A one line description of the manual's content.

This may only be invoked in the

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

Line 2120 Its syntax is as follows:

Line 2089 Its syntax is as follows:

The optional

.Ar system

parameter specifies the relevant operating system or environment.

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

It is suggested to leave it unspecified, in which case

This is the suggested form.

.Xr mandoc 1

uses its

.Fl Ios

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

.Fa sysname

and

.Fa release

as returned by

.Xr uname 3 .

.Pp

Examples:

.Dl \&.Os

Line 2225 See also

Line 2202 See also

Close quoted context opened by

.Sx \&Qo .

.Ss \&Ql

Format a single-quoted literal.

In-line literal display.

This can for example be used for complete command invocations and

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

appropriate and an indented display is not desired.

While

.Xr mandoc 1

always encloses the arguments in single quotes, other formatters

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

arguments have three or more characters.

.Pp

See also

.Sx \&Qq

.Sx \&Dl

and

.Sx \&Sq .

.Sx \&Bd

.Fl literal .

.Ss \&Qo

Multi-line version of

.Sx \&Qq .

Line 2416 The original C standard.

Line 2403 The original C standard.

.Pp

.It \-isoC-99

.St -isoC-99

.It \-ansiC-99

.St -ansiC-99

.br

The second major version of the C language standard.

.Pp

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

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

.It Single UNIX Specification version 1 and related standards

.Pp

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

.It \-susv1

.St -susv1

.It \-xpg4.2

.St -xpg4.2

.br

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

This standard was published in 1994.

It was used as the basis for UNIX 95 certification.

The following three refer to parts of it.

.Pp

Line 2515 The following three refer to parts of it.

Line 2502 The following three refer to parts of it.

.br

Networking APIs, including sockets.

.Pp

.It \-xpg4.3

.St -xpg4.3

.Pp

.It \-svid4

.St -svid4 ,

.br

Line 2544 The following refer to parts of it.

Line 2528 The following refer to parts of it.

.Pp

.It \-xns5

.St -xns5

.It \-xns5.2d2.0

.St -xns5.2d2.0

.It \-xns5.2

.St -xns5.2

.Pp

.It \-p1387.2

.St -p1387.2

.It \-p1387.2-95

.St -p1387.2-95

.br

POSIX software administration.

.El

.It Single UNIX Specification version 3 and related standards

.It Single UNIX Specification version 3

.Pp

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

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

.It \-p1003.1d-99

.St -p1003.1d-99

.br

Additional real-time extensions.

.Pp

.It \-p1003.1j-2000

.St -p1003.1j-2000

.br

Advanced real-time extensions.

.Pp

.It \-p1003.1q-2000

.St -p1003.1q-2000

.br

Amendment 7: Tracing [C Language].

.Pp

.It \-p1003.1-2001

.St -p1003.1-2001

.It \-susv3

Line 2593 The second and last Technical Corrigendum.

Line 2553 The second and last Technical Corrigendum.

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

.It \-p1003.1-2008

.St -p1003.1-2008

.It \-susv4

.St -susv4

.br

This standard is also called SUSv4 and

This standard is also called

X/Open Portability Guide version 7.

.Pp

.It \-p1003.1-2013

Line 2637 See also

Line 2599 See also

and

.Sx \&Ss .

.Ss \&Sy

Format enclosed arguments in symbolic

Request a boldface font.

.Pq Dq boldface .

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

stylistically decorating technical terms.

.Pp

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

confused with stress emphasis, see

.Sx \&Em ) .

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

elements that have to be given or that appear verbatim.

.Pp

Examples:

.Bd -literal -compact -offset indent

\&.Sy Warning :

\&.Sy s

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

This utility replaces the former

\&.Sy dumpdir

program.

.Ed

.Pp

See also

.Sx \&Bf ,

.Sx \&Em ,

Line 2673 A variable name.

Line 2649 A variable name.

Examples:

.Dl \&.Va foo

.Dl \&.Va const char *bar ;

.Pp

For function arguments and parameters, use

.Sx \&Fa

instead.

For declarations of global variables in the

.Em SYNOPSIS

section, use

.Sx \&Vt .

.Ss \&Vt

A variable type.

.Pp

This is also used for indicating global variables in the

.Em SYNOPSIS

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

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

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

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

function definition or include directive.

.Pp

Note that this should not be confused with

.Sx \&Ft ,

which is used for function return types.

.Pp

Examples:

.Dl \&.Vt unsigned char

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

.Pp

For parameters in function prototypes, use

.Sx \&Fa

instead, for function return types

.Sx \&Ft ,

and for variable names outside the

.Em SYNOPSIS

section

.Sx \&Va ,

even when including a type with the name.

See also

.Sx MANUAL STRUCTURE

.Sx MANUAL STRUCTURE .

and

.Sx \&Va .

.Ss \&Xc

Close a scope opened by

.Sx \&Xo .

Line 3144 Manually switching the font using the

Line 3132 Manually switching the font using the

font escape sequences is never required.

.Sh COMPATIBILITY

This section provides an incomplete list of compatibility issues

between mandoc and other troff implementations, at this time limited

between mandoc and GNU troff

to GNU troff

.Pq Qq groff .

The term

.Qq historic groff

refers to groff versions before 1.17,

which featured a significant update of the

.Pa doc.tmac

file.

.Pp

Heirloom troff, the other significant troff implementation accepting

\-mdoc, is similar to historic groff.

.Pp

The following problematic behaviour is found in groff:

.ds hist (Historic groff only.)

.Pp

.Bl -dash -compact

.It

Display macros

.Po

.Sx \&Bd ,

.Sx \&Dl ,

and

.Sx \&D1

.Pc

may not be nested.

\*[hist]

.It

.Sx \&At

with unknown arguments produces no output at all.

\*[hist]

Newer groff and mandoc print

.Qq AT&T UNIX

and the arguments.

.It

.Sx \&Bl Fl column

does not recognise trailing punctuation characters when they immediately

precede tabulator characters, but treats them as normal text and

outputs a space before them.

.It

.Sx \&Bd Fl ragged compact

does not start a new line.

\*[hist]

.It

.Sx \&Dd

with non-standard arguments behaves very strangely.

When there are three arguments, they are printed verbatim.

Line 3196 but without any arguments the string

Line 3147 but without any arguments the string

.Dq Epoch

is printed.

.It

.Sx \&Fl

does not print a dash for an empty argument.

\*[hist]

.It

.Sx \&Fn

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

.Em SYNOPSIS

section.

\*[hist]

.It

.Sx \&Fo

with

.Pf non- Sx \&Fa

children causes inconsistent spacing between arguments.

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

.It

.Sx \&Ft

in the

.Em SYNOPSIS

causes inconsistent vertical spacing, depending on whether a prior

.Sx \&Fn

has been invoked.

See

.Sx \&Ft

and

.Sx \&Fn

for the normalised behaviour in mandoc.

.It

.Sx \&In

ignores additional arguments and is not treated specially in the

.Em SYNOPSIS .

\*[hist]

.It

.Sx \&It

sometimes requires a

.Fl nested

flag.

\*[hist]

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

.Fl enum

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

.It

.Sx \&Li

followed by a delimiter is incorrectly used in some manuals

instead of properly quoting that character, which sometimes works with

historic groff.

.It

.Sx \&Lk

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

.It

Line 3256 can only be called by other macros, but not at the beg

Line 3160 can only be called by other macros, but not at the beg

.Sx \&%C

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

.It

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

line, depending on the exact situation.

Providing more arguments causes garbled output.

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

.It

Historic groff has many un-callable macros.

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

in new groff and mandoc.

.It

.Sq \(ba

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

\*[hist]

.It

.Sq \ef

.Pq font face

and

Line 3286 The following features are unimplemented in mandoc:

Line 3177 The following features are unimplemented in mandoc:

.Bl -dash -compact

.It

.Sx \&Bd

.Fl file Ar file .

.Fl file Ar file

is unsupported for security reasons.

.It

.Sx \&Bd

.Fl filled

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

.Sx \&Bd

.Fl ragged .

.It

.Sx \&Bd

.Fl literal

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

.Sx \&Bd

.Fl unfilled .

.It

.Sx \&Bd

.Fl offset Cm center

and

.Fl offset Cm right .

.Fl offset Cm right

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

don't work.

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

but produces large indentations.

.El

.Sh SEE ALSO

CVSweb