mandoc/mdoc.7 - diff

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.71 and 1.93

version 1.71, 2009/10/31 06:50:25

version 1.93, 2010/04/07 19:37:54

Line 31 language is used to format

.Bx

.Ux

manuals. In this reference document, we describe its syntax, structure,

and usage. Our reference implementation is

and usage. Our reference implementation is mandoc; the

.Xr mandoc 1 .

The

.Sx COMPATIBILITY

section describes compatibility with

section describes compatibility with other troff \-mdoc implementations.

.Xr groff 1 .

.Pp

Line 131 and

Line 128 and

.Ss Text Decoration

Terms may be text-decorated using the

.Sq \ef

escape followed by an indicator: B (bold), I, (italic), or P and R

escape followed by an indicator: B (bold), I, (italic), R (Roman), or P

(Roman, or reset). This form is not recommended for

(revert to previous mode):

.Pp

.D1 \efBbold\efR \efIitalic\efP

.Pp

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

respectively) may be used instead. A text decoration is valid within

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

its own scope, such as

.Sx \&Bf

.Cm \&Sy ,

in-scope invocations of

.Sq \ef

are only valid within the font scope of the macro. If

.Sq \ef

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

text, it will affect the remainder of the document.

.Pp

Text may also be sized with the

.Sq \es

escape, whose syntax is one of

.Sq \es+-n

for one-digit numerals;

.Sq \es(+-nn

.Sq \es+-(nn

for two-digit numerals; and

.Sq \es[+-N] ,

.Sq \es+-[N] ,

.Sq \es'+-N' ,

.Sq \es+-'N'

for arbitrary-digit numerals:

.Pp

.D1 \es+1bigger\es-1

.D1 \es[+10]much bigger\es[-10]

.D1 \es+(10much bigger\es-(10

.D1 \es+'100'much much bigger\es-'100'

.Pp

Note these forms are

.Em not

recommended for

.Nm ,

which encourages semantic, not presentation, annotation.

which encourages semantic annotation.

.Ss Predefined Strings

Historically,

.Xr groff 1

also defined a set of package-specific

.Dq predefined strings ,

which, like

.Sx Special Characters ,

demark special output characters and strings by way of input codes.

Predefined strings are escaped with the slash-asterisk,

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

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

.Ss Dates

There are several macros in

.Nm

that require a date argument. The

that require a date argument. The canonical form for dates is the

.Em canonical form

American format:

for dates is the American format:

.Pp

.D1 Cm Month Day , Year

.Pp

Line 226 value is the full month name. The

Line 262 value is the full month name. The

.Cm Year

value is the full four-digit year.

.Pp

The

Reduced form dates are broken-down canonical form dates:

.Em non-canonical form

is the same as the canonical form, but without the comma between the

.Cm Day

and

.Cm Year

field.

.Pp

Lastly,

.D1 Cm Month , Year

.Em reduced form

.D1 Cm Year

dates range from only a

.Cm Year

to the full canonical or non-canonical form.

.Pp

Some examples of valid dates follow:

.Pp

.D1 "May, 2009" Pq reduced form

.D1 "2009" Pq reduced form

.D1 "May 20, 2009" Pq canonical form

.D1 "May 20 2009" Pq non-canonical form

.Ss Scaling Widths

Many macros support scaled widths for their arguments, such as

Line 314 and

Line 340 and

.Sx \&Os

macros, is required for every document.

.Pp

The first section (sections are denoted by

.Sx \&Sh )

must be the NAME section, consisting of at least one

.Sx \&Nm

Line 374 The sections in a

Line 400 The sections in a

.Nm

document are conventionally ordered as they appear above. Sections

should be composed as follows:

.Bl -tag -width Ds -offset Ds

.Bl -ohang -offset Ds

.It NAME

.It Em NAME

Must contain at least one

The name(s) and a short description of the documented material. The

syntax for this as follows:

.Bd -literal -offset indent

\&.Nm name0

\&.Nm name1

\&.Nm name2

\&.Nd a short description

.Ed

.Pp

The

.Sx \&Nm

followed by

macro(s) must precede the

.Sx \&Nd

macro.

.Pp

See

.Sx \&Nm

and

.Sx \&Nd .

The name needs re-stating since one

.Nm

.It Em LIBRARY

documents can be used for more than one utility or function, such as

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

.Xr grep 1

assumed to be a function in a section 2 or 3 manual. The syntax for

also being referenced as

this is as follows:

.Xr egrep 1

.Bd -literal -offset indent

\&.Lb libarm

.Ed

.Pp

See

.Sx \&Lb .

.It Em SYNOPSIS

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

configuration.

.Pp

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

generally structured as follows:

.Bd -literal -offset indent

\&.Nm foo

\&.Op Fl v

\&.Op Fl o Ar file

\&.Op Ar

\&.Nm bar

\&.Op Fl v

\&.Op Fl o Ar file

\&.Op Ar

.Ed

.Pp

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

.Bd -literal -offset indent

\&.Vt extern const char *global;

\&.In header.h

\&.Ft "char *"

\&.Fn foo "const char *src"

\&.Ft "char *"

\&.Fn bar "const char *src"

.Ed

.Pp

And for the third, configurations (section 4):

.Bd -literal -offset indent

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

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

.Ed

.Pp

Manuals not in these sections generally don't need a

.Em SYNOPSIS .

.Pp

See

.Sx \&Op ,

.Sx \&Cd ,

.Sx \&Fn ,

.Sx \&Ft ,

and

.Xr fgrep 1 .

.Sx \&Vt .

.It LIBRARY

.It SYNOPSIS

.It Em DESCRIPTION

.It DESCRIPTION

This expands upon the brief, one-line description in

.It IMPLEMENTATION NOTES

.Em NAME .

.It EXIT STATUS

It usually contains a break-down of the options (if documenting a

.It RETURN VALUES

command), such as:

.It ENVIRONMENT

.Bd -literal -offset indent

.It FILES

The arguments are as follows:

.It EXAMPLES

\&.Bl \-tag \-width Ds

.It DIAGNOSTICS

\&.It Fl v

.It ERRORS

Print verbose information.

.It SEE ALSO

\&.El

.It STANDARDS

.Ed

.It HISTORY

.Pp

.It AUTHORS

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

.It CAVEATS

.It BUGS

.It Em IMPLEMENTATION NOTES

.It SECURITY CONSIDERATIONS

Implementation-specific notes should be kept here. This is useful when

implementing standard functions that may have side effects or notable

algorithmic implications.

.It Em EXIT STATUS

Command exit status for section 1, 6, and 8 manuals. This section is

the dual of

.Em RETURN VALUES ,

which is used for functions. Historically, this information was

described in

.Em DIAGNOSTICS ,

a practise that is now discouraged.

.Pp

See

.Sx \&Ex .

.It Em RETURN VALUES

This section is the dual of

.Em EXIT STATUS ,

which is used for commands. It documents the return values of functions

in sections 2, 3, and 9.

.Pp

See

.Sx \&Rv .

.It Em ENVIRONMENT

Documents any usages of environment variables, e.g.,

.Xr environ 7 .

.Pp

See

.Sx \&Ev .

.It Em FILES

Documents files used. It's helpful to document both the file and a

short description of how the file is used (created, modified, etc.).

.Pp

See

.Sx \&Pa .

.It Em EXAMPLES

Example usages. This often contains snippets of well-formed,

well-tested invocations. Make doubly sure that your examples work

properly!

.It Em DIAGNOSTICS

Documents error conditions. This is most useful in section 4 manuals.

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

.Fl diag .

.It Em ERRORS

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

.Pp

See

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

.Pp

See

.Sx \&Xr .

.It Em STANDARDS

References any standards implemented or used. If not adhering to any

standards, the

.Em HISTORY

section should be used instead.

.Pp

See

.Sx \&St .

.It Em HISTORY

The history of any manual without a

.Em STANDARDS

section should be described in this section.

.It Em AUTHORS

Credits to authors, if applicable, should appear in this section.

Authors should generally be noted by both name and an e-mail address.

.Pp

See

.Sx \&An .

.It Em CAVEATS

Explanations of common misuses and misunderstandings should be explained

in this section.

.It Em BUGS

Extant bugs should be described in this section.

.It Em SECURITY CONSIDERATIONS

Documents any security precautions that operators should consider.

.El

Line 493 All macros have bodies; some

Line 680 All macros have bodies; some

don't have heads; only one

.Po

.Sx \&It Fl column

.Pc

has multiple heads.

.Bd -literal -offset indent

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

Line 580 or end of line.

Line 767 or end of line.

.It Sx \&Ql Ta Yes Ta Yes

.It Sx \&Qq Ta Yes Ta Yes

.It Sx \&Sq Ta Yes Ta Yes

.It Sx \&Vt Ta Yes Ta Yes

.El

.Pp

Note that the

.Sx \&Vt

macro is a

.Sx Block partial-implicit

only when invoked as the first macro

in a SYNOPSIS section line, else it is

.Sx In-line .

.Ss In-line

Line 661 then the macro accepts an arbitrary number of argument

Line 857 then the macro accepts an arbitrary number of argument

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

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

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

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

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

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

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

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

Line 673 then the macro accepts an arbitrary number of argument

Line 869 then the macro accepts an arbitrary number of argument

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

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

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

.It Sx \&Xr Ta Yes Ta Yes Ta >0, <3

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

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

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

.El

.Sh REFERENCE

Line 710 this macro is not implemented in

Line 906 this macro is not implemented in

.Ss \&%D

Publication date of an

.Sx \&Rs

block. This should follow the reduced syntax for

block. This should follow the reduced or canonical form syntax

described in

.Sx Dates .

Canonical or non-canonical form is not necessary since publications are

often referenced only by year, or month and year.

.Ss \&%I

Publisher or issuer name of an

Line 776 Address construct: usually in the context of an comput

Line 971 Address construct: usually in the context of an comput

memory, not a physical (post) address.

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.Ad [0,$]

\&.Ad [0,$]

.D1 \&.Ad 0x00000000

\&.Ad 0x00000000

.Ed

.Ss \&An

Author name. This macro may alternatively accepts the following

Line 800 will cause the first listing also to be split. If not

Line 993 will cause the first listing also to be split. If not

section, the default is not to split.

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.An -nosplit

\&.An -nosplit

.D1 \&.An J. D. Ullman .

\&.An J. E. Hopcraft ,

\&.An J. D. Ullman .

.Ed

.Pp

.Em Remarks :

the effects of

Line 821 Begins a block enclosed by angled brackets. Does not

Line 1011 Begins a block enclosed by angled brackets. Does not

arguments.

.Pp

Examples:

.Bd -literal -offset indent

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

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

.Ed

.Pp

See also

.Sx \&Aq .

Line 837 a function:

Line 1025 a function:

.Ed

.Ss \&Aq

Encloses its arguments in angled brackets.

.Pp

Examples:

.Bd -literal -offset indent

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

\&.Fl -key= Ns Aq Ar val

.Ed

.Pp

.Em Remarks :

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

Line 863 Command arguments. If an argument is not provided, th

Line 1049 Command arguments. If an argument is not provided, th

is used as a default.

.Pp

Examples:

.Bd -literal -offset indent

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

\&.Fl o Ns Ar file1

.D1 \&.Ar

\&.Ar

.D1 \&.Ar arg1 , arg2 .

\&.Ar arg1 , arg2 .

.Ed

.Ss \&At

Formats an AT&T version. Accepts at most one parameter:

Line 883 A system version of

Line 1067 A system version of

Note that these parameters do not begin with a hyphen.

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.At

\&.At

.D1 \&.At V.1

\&.At V.1

.Ed

.Pp

See also

.Sx \&Bsx ,

Line 985 and

Line 1167 and

.Ss \&Bf

.Ss \&Bk

.Ss \&Bl

.\" Begins a list composed of one or more list entries. A list entry is

.\" specified by the

.\" .Sx \&It

.\" macro, which consists of a head and optional body. By default, a list

.\" is preceded by a blank line. A list must specify one of the following

.\" list types:

.\" .Bl -tag -width 12n

.\" .It Fl bullet

.\" A list offset by a bullet. The head of list entries must be empty.

.\" List entry bodies are justified after the bullet.

.\" .It Fl column

.\" A columnated list. The number of columns is specified as arguments to

.\" the

.\" .Sx \&Bl

.\" macro (the deprecated form of following the invocation of

.\" .Fl column

.\" is also accepted). Arguments dictate the width of columns specified in

.\" list entries. List entry bodies must be left empty. Columns specified

.\" in the list entry head are justified to their position in the sequence

.\" of columns.

.\" .It Fl dash

.\" A list offset by a dash (hyphen). The head of list entries must be

.\" empty. List entry bodies are justified past the dash.

.\" .It Fl diag

.\" Like

.\" .Fl inset

.\" lists, but with additional formatting to the head.

.\" .It Fl enum

.\" A list offset by a number indicating list entry position. The head of

.\" list entries must be empty. List entry bodies are justified past the

.\" enumeration.

.\" .It Fl hang

.\" Like

.\" .Fl tag ,

.\" but instead of list bodies justifying to the head on the first line,

.\" they trail the head text.

.\" .It Fl hyphen

.\" Synonym for

.\" .Fl dash .

.\" .It Fl inset

.\" Like

.\" .Fl tag ,

.\" but list entry bodies aren't justified.

.\" .It Fl item

.\" An un-justified list. This produces blocks of text.

.\" .It Fl ohang

.\" List bodies are placed on the line following the head.

.\" .It Fl tag

.\" A list offset by list entry heads. List entry bodies are justified

.\" after the head.

.\" .El

.\" .Pp

.\" More...

.\" .

.Ss \&Bo

Begins a block enclosed by square brackets. Does not have any head

arguments.

Line 993 arguments.

Line 1228 arguments.

Examples:

.Bd -literal -offset indent

\&.Bo 1 ,

\&.Dv BUFSIZ Bc

\&.Dv BUFSIZ \&Bc

.Ed

.Pp

See also

.Sx \&Bq .

.Ss \&Bq

Encloses its arguments in square brackets.

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.Bq 1 , \&Dv BUFSIZ

\&.Bq 1 , Dv BUFSIZ

.Ed

.Pp

.Em Remarks :

this macro is sometimes abused to emulate optional arguments for

Line 1030 arguments.

Line 1263 arguments.

Examples:

.Bd -literal -offset indent

\&.Bro 1 , ... ,

\&.Va n Brc

\&.Va n \&Brc

.Ed

.Pp

See also

Line 1040 See also

Line 1273 See also

Encloses its arguments in curly braces.

.Pp

Examples:

.Bd -literal -offset indent

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

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

.Ed

.Pp

See also

.Sx \&Bro .

Line 1052 Format the BSD/OS version provided as an argument, or

Line 1283 Format the BSD/OS version provided as an argument, or

no argument is provided.

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.Bsx 1.0

\&.Bsx 1.0

.D1 \&.Bsx

\&.Bsx

.Ed

.Pp

See also

.Sx \&At ,

Line 1076 Format the BSD version provided as an argument, or a d

Line 1305 Format the BSD version provided as an argument, or a d

argument is provided.

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.Bx 4.4

\&.Bx 4.4

.D1 \&.Bx

\&.Bx

.Ed

.Pp

See also

.Sx \&At ,

Line 1092 and

Line 1319 and

.Sx \&Ux .

.Ss \&Cd

Configuration declaration (suggested for use only in section four

Configuration declaration. This denotes strings accepted by

manuals). This denotes strings accepted by

.Xr config 8 .

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.Cd device le0 at scode?

\&.Cd device le0 at scode?

.Ed

.Pp

.Em Remarks :

this macro is commonly abused by using quoted literals to retain

Line 1112 Command modifiers. Useful when specifying configurati

Line 1336 Command modifiers. Useful when specifying configurati

keys.

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.Cm ControlPath

\&.Cm ControlPath

.D1 \&.Cm ControlMaster

\&.Cm ControlMaster

.Ed

.Pp

See also

.Sx \&Fl .

Line 1125 One-line indented display. This is formatted by the d

Line 1347 One-line indented display. This is formatted by the d

is useful for simple indented statements. It is followed by a newline.

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.D1 \&Fl abcdefgh

\&.D1 Fl abcdefgh

.Ed

.Pp

See also

.Sx \&Bd

Line 1147 manual. Its calling syntax is as follows:

Line 1367 manual. Its calling syntax is as follows:

.Pp

.D1 \. Ns Sx \&Dd Cm date

.Pp

The

.Cm date

field may be either

.Ar $\&Mdocdate$ ,

which signifies the current manual revision date dictated by

.Xr cvs 1

.Xr cvs 1 ,

or instead a valid canonical date as specified by

.Sx Dates .

If a date does not conform, the current date is used instead.

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.Dd $\&Mdocdate$

\&.Dd $\&Mdocdate$

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

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

.D1 \&.Dd July 21, 2007

\&.Dd July 21, 2007

.Ed

.Pp

See also

.Sx \&Dt

Line 1173 One-line intended display. This is formatted as liter

Line 1392 One-line intended display. This is formatted as liter

useful for commands and invocations. It is followed by a newline.

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.Dl % mandoc mdoc.7 | less

\&.Dl % mandoc mdoc.7 | less

.Ed

.Pp

See also

.Sx \&Bd

Line 1187 Begins a block enclosed by double quotes. Does not ha

Line 1404 Begins a block enclosed by double quotes. Does not ha

arguments.

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.D1 \&Do April is the cruellest month \&Dc \e(em T.S. Eliot

\&.D1 Do April is the cruellest month Dc \e(em T.S. Eliot

.Ed

.Pp

See also

.Sx \&Dq .

.Ss \&Dq

Encloses its arguments in double quotes.

.Pp

Examples:

.Bd -literal -offset indent

.Bd -literal -offset indent -compact

\&.Dq April is the cruellest month

\e(em T.S. Eliot

.Ed

Line 1301 subsequent that. It, too, is optional. It must be on

Line 1516 subsequent that. It, too, is optional. It must be on

.Ar hppa64 ,

.Ar i386 ,

.Ar landisk ,

.Ar loongson ,

.Ar luna88k ,

.Ar mac68k ,

.Ar macppc ,

Line 1319 or

Line 1535 or

.El

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.Dt FOO 1

\&.Dt FOO 1

.D1 \&.Dt FOO 4 KM

\&.Dt FOO 4 KM

.D1 \&.Dt FOO 9 i386

\&.Dt FOO 9 i386

.D1 \&.Dt FOO 9 KM i386

\&.Dt FOO 9 KM i386

.Ed

.Pp

See also

.Sx \&Dd

Line 1335 and

Line 1549 and

Defined variables such as preprocessor constants.

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.Dv BUFSIZ

\&.Dv BUFSIZ

.D1 \&.Dv STDOUT_FILENO

\&.Dv STDOUT_FILENO

.Ed

.Pp

See also

.Sx \&Er .

Line 1348 Format the DragonFly BSD version provided as an argume

Line 1560 Format the DragonFly BSD version provided as an argume

value if no argument is provided.

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.Dx 2.4.1

\&.Dx 2.4.1

.D1 \&.Dx

\&.Dx

.Ed

.Pp

See also

.Sx \&At ,

Line 1368 and

Line 1578 and

.Ss \&Ef

.Ss \&Ek

.Ss \&El

.Ss \&Em

Denotes text that should be emphasised. Note that this is a

presentation term and should not be used for stylistically decorating

technical terms.

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.Em Warnings!

\&.Ed Warnings!

.D1 \&.Em Remarks :

\&.Ed Remarks :

.Ed

.Ss \&En

.Ss \&Eo

.Ss \&Er

Error constants (suggested for use only in section two manuals).

Display error constants.

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.Er EPERM

\&.Er EPERM

.D1 \&.Er ENOENT

\&.Er ENOENT

.Ed

.Pp

See also

.Sx \&Dv .

Line 1400 Environmental variables such as those specified in

Line 1607 Environmental variables such as those specified in

.Xr environ 7 .

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.Ev DISPLAY

\&.Ev DISPLAY

.D1 \&.Ev PATH

\&.Ev PATH

.Ed

.Ss \&Ex

Inserts text regarding a utility's exit values. This macro must have

Line 1420 is provided.

Line 1625 is provided.

.Ss \&Fc

.Ss \&Fd

.Ss \&Fl

Command-line flag. Used when listing arguments to command-line

utilities. Prints a fixed-width hyphen

.Sq \-

directly followed by each argument. If no arguments are provided, a hyphen is

printed followed by a space. If the argument is a macro, a hyphen is

prefixed to the subsequent macro output.

.Pp

Examples:

.D1 \&.Fl a b c

.D1 \&.Fl \&Pf a b

.D1 \&.Fl

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

.Pp

See also

.Sx \&Cm .

.Ss \&Fn

.Ss \&Fo

.Ss \&Fr

Line 1429 Format the FreeBSD version provided as an argument, or

Line 1650 Format the FreeBSD version provided as an argument, or

if no argument is provided.

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.Fx 7.1

\&.Fx 7.1

.D1 \&.Fx

\&.Fx

.Ed

.Pp

See also

.Sx \&At ,

Line 1456 Format a hyperlink. The calling syntax is as follows:

Line 1675 Format a hyperlink. The calling syntax is as follows:

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

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.Lk http://bsd.lv "The BSD.lv Project"

\&.Lk http://bsd.lv "The BSD.lv Project"

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

\&.Lk http://bsd.lv

.Ed

.Pp

See also

.Sx \&Mt .

Line 1476 Format the NetBSD version provided as an argument, or

Line 1693 Format the NetBSD version provided as an argument, or

no argument is provided.

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.Nx 5.01

\&.Nx 5.01

.D1 \&.Nx

\&.Nx

.Ed

.Pp

See also

.Sx \&At ,

Line 1509 unspecified, it defaults to the local operating system

Line 1724 unspecified, it defaults to the local operating system

the suggested form.

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.Os

\&.Os

.D1 \&.Os KTH/CSC/TCS

\&.Os KTH/CSC/TCS

.D1 \&.Os BSD 4.3

\&.Os BSD 4.3

.Ed

.Pp

See also

.Sx \&Dd

Line 1531 Format the OpenBSD version provided as an argument, or

Line 1744 Format the OpenBSD version provided as an argument, or

if no argument is provided.

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.Ox 4.5

\&.Ox 4.5

.D1 \&.Ox

\&.Ox

.Ed

.Pp

See also

.Sx \&At ,

Line 1584 and

Line 1795 and

child macros (at least one must be specified).

.Pp

Examples:

.Bd -literal -offset indent

.Bd -literal -offset indent -compact

\&.Rs

\&.%A J. E. Hopcroft

\&.%A J. D. Ullman

Line 1617 line.

Line 1828 line.

Format the UNIX name. Accepts no argument.

.Pp

Examples:

.Bd -literal -offset indent

.D1 \&.Ux

\&.Ux

.Ed

.Pp

See also

.Sx \&At ,

Line 1633 and

Line 1842 and

.Ss \&Va

.Ss \&Vt

A variable type. This is also used for indicating global variables in the

SYNOPSIS 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 SYNOPSIS section, else it

accepts ordinary

.Sx In-line

syntax.

.Pp

Note that this should not be confused with

.Sx \&Ft ,

which is used for function return types.

.Pp

Examples:

.D1 \&.Vt unsigned char

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

.Pp

See also

.Sx \&Ft

and

.Sx \&Va .

.Ss \&Xc

Close a scope opened by

.Sx \&Xo .

.Ss \&Xo

Open an extension scope. This macro originally existed to extend the

9-argument limit of troff; since this limit has been lifted, the macro

has been deprecated.

.Ss \&Xr

Link to another manual

.Pq Qq cross-reference .

Its calling syntax is

.Pp

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

.Pp

The

.Cm name

and

.Cm section

are the name and section of the linked manual. If

.Cm section

is followed by non-punctuation, an

.Sx \&Ns

is inserted into the token stream. This behaviour is for compatibility

with

.Xr groff 1 .

.Pp

Examples:

.D1 \&.Xr mandoc 1

.D1 \&.Xr mandoc 1 ;

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

.Ss \&br

.Ss \&sp

.Sh COMPATIBILITY

This section documents compatibility with other roff implementations, at

This section documents compatibility between mandoc and other other

this time limited to

troff implementations, at this time limited to GNU troff

.Xr groff 1 .

.Pq Qq groff .

The term

.Qq historic groff

refers to those versions before the

refers to groff versions before the

.Pa doc.tmac

file re-write

.Pq somewhere between 1.15 and 1.19 .

.Pp

Heirloom troff, the other significant troff implementation accepting

\-mdoc, is similar to historic groff.

.Pp

.Bl -dash -compact

.It

Negative scaling units are now truncated to zero instead of creating

The comment syntax

interesting conditions, such as with

.Sq \e."

.Sq \&sp -1i .

is no longer accepted.

Furthermore, the

.It

In groff, the

.Sx \&Pa

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

certain list types. mandoc does.

.It

Historic groff does not print a dash for empty

.Sx \&Fl

arguments. mandoc and newer groff implementations do.

.It

groff behaves irregularly when specifying

.Sq \ef

.Sx Text Decoration

within line-macro scopes. mandoc follows a consistent system.

.It

In mandoc, negative scaling units are truncated to zero; groff would

move to prior lines. Furthermore, the

.Sq f

scaling unit, while accepted, is rendered as the default unit.

.It

In quoted literals, groff allowed pair-wise double-quotes to produce a

standalone double-quote in formatted output. This idiosyncratic

behaviour is no longer applicable.

behaviour is not applicable in mandoc.

.It

Display types

.Sx \&Bd Fl center

.Sx \&Bd

.Fl center

and

.Fl right

are aliases for

.Fl left .

.Fl left

The

in manodc. Furthermore, the

.Fl file Ar file

argument is ignored. Since text is not right-justified,

argument is ignored. Lastly, since text is not right-justified in

mandoc (or even groff),

.Fl ragged

and

.Fl filled

Line 1681 are aliases, as are

Line 1969 are aliases, as are

.Fl literal

and

.Fl unfilled .

.It

Blocks of whitespace are stripped from both macro and free-form text

In mandoc, blocks of whitespace are stripped from both macro and

lines (except when in literal mode), while groff would retain whitespace

free-form text lines (except when in literal mode); groff would retain

in free-form text lines.

whitespace in free-form text lines.

.It

Historic groff has many un-callable macros. Most of these (excluding

some block-level macros) are now callable, conforming to the

some block-level macros) are now callable.

non-historic groff version.

.It

The vertical bar

.Sq \(ba

made historic groff

.Qq go orbital

but is a proper delimiter in this implementation.

but has been a proper delimiter since then.

.It

.Sx \&It Fl nested

is assumed for all lists (it wasn't in historic groff): any list may be

nested and

.Fl enum

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

.It

Some manuals use

.Sx \&Li

incorrectly by following it with a reserved character and expecting the

delimiter to render. This is not supported.

delimiter to render. This is not supported in mandoc.

.It

In groff, the

.Sx \&Fo

macro only produces the first parameter. This is no longer the case.

macro only produces the first parameter. This is not the case in

mandoc.

.It

In groff, the

.Sx \&Cd ,

.Sx \&Er ,

and

.Sx \&Ex

macros were stipulated only to occur in certain manual sections. mandoc

does not have these restrictions.

.El

CVSweb