version 1.142, 2010/07/26 13:45:49 |
version 1.286, 2021/07/29 16:25:20 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2010, 2011, 2013-2020 Ingo Schwarze <schwarze@openbsd.org> |
.\" |
.\" |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" purpose with or without fee is hereby granted, provided that the above |
|
|
.Os |
.Os |
.Sh NAME |
.Sh NAME |
.Nm mdoc |
.Nm mdoc |
.Nd mdoc language reference |
.Nd semantic markup language for formatting manual pages |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm mdoc |
.Nm mdoc |
language is used to format |
language supports authoring of manual pages for the |
.Bx |
.Xr man 1 |
.Ux |
utility by allowing semantic annotations of words, phrases, |
manuals. |
page sections and complete manual pages. |
In this reference document, we describe its syntax, structure, and |
Such annotations are used by formatting tools to achieve a uniform |
usage. |
presentation across all manuals written in |
Our reference implementation is mandoc; the |
.Nm , |
|
and to support hyperlinking if supported by the output medium. |
|
.Pp |
|
This reference document describes the structure of manual pages |
|
and the syntax and usage of the |
|
.Nm |
|
language. |
|
The reference implementation of a parsing and formatting tool is |
|
.Xr mandoc 1 ; |
|
the |
.Sx COMPATIBILITY |
.Sx COMPATIBILITY |
section describes compatibility with other troff \-mdoc implementations. |
section describes compatibility with other implementations. |
.Pp |
.Pp |
An |
In an |
.Nm |
.Nm |
document follows simple rules: lines beginning with the control |
document, lines beginning with the control character |
character |
.Sq \&. |
.Sq \. |
are called |
are parsed for macros. |
.Dq macro lines . |
Other lines are interpreted within the scope of |
The first word is the macro name. |
prior macros: |
It consists of two or three letters. |
|
Most macro names begin with a capital letter. |
|
For a list of available macros, see |
|
.Sx MACRO OVERVIEW . |
|
The words following the macro name are arguments to the macro, optionally |
|
including the names of other, callable macros; see |
|
.Sx MACRO SYNTAX |
|
for details. |
|
.Pp |
|
Lines not beginning with the control character are called |
|
.Dq text lines . |
|
They provide free-form text to be printed; the formatting of the text |
|
depends on the respective processing context: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Sh Macro lines change control state. |
\&.Sh Macro lines change control state. |
Other lines are interpreted within the current state. |
Text lines are interpreted within the current state. |
.Ed |
.Ed |
.Sh LANGUAGE SYNTAX |
|
.Nm |
|
documents may contain only graphable 7-bit ASCII characters, the space |
|
character, and, in certain circumstances, the tab character. |
|
All manuals must have |
|
.Ux |
|
line terminators. |
|
.Ss Comments |
|
Text following a |
|
.Sq \e\*q , |
|
whether in a macro or free-form 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 optionally whitespace are |
|
stripped from input. |
|
.Ss Reserved Characters |
|
Within a macro line, the following characters are reserved: |
|
.Pp |
.Pp |
.Bl -tag -width Ds -offset indent -compact |
Many aspects of the basic syntax of the |
.It \&. |
.Nm |
.Pq period |
language are based on the |
.It \&, |
.Xr roff 7 |
.Pq comma |
language; see the |
.It \&: |
.Em LANGUAGE SYNTAX |
.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. |
|
Sequences begin with the escape character |
|
.Sq \e |
|
followed by either an open-parenthesis |
|
.Sq \&( |
|
for two-character sequences; an open-bracket |
|
.Sq \&[ |
|
for n-character sequences (terminated at a close-bracket |
|
.Sq \&] ) ; |
|
or a single one-character sequence. |
|
See |
|
.Xr mandoc_char 7 |
|
for a complete list. |
|
Examples include |
|
.Sq \e(em |
|
.Pq em-dash |
|
and |
and |
.Sq \ee |
.Em MACRO SYNTAX |
.Pq back-slash . |
sections in the |
.Ss Text Decoration |
.Xr roff 7 |
Terms may be text-decorated using the |
manual for details, in particular regarding |
.Sq \ef |
comments, escape sequences, whitespace, and quoting. |
escape followed by an indicator: B (bold), I, (italic), R (Roman), or P |
However, using |
(revert to previous mode): |
.Xr roff 7 |
.Pp |
requests in |
.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 |
|
Note this form is |
|
.Em not |
|
recommended for |
|
.Nm , |
|
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 , |
|
mark special output characters and strings by way of input codes. |
|
Predefined strings are escaped with the slash-asterisk, |
|
.Sq \e* : |
|
single-character |
|
.Sq \e*X , |
|
two-character |
|
.Sq \e*(XX , |
|
and N-character |
|
.Sq \e*[N] . |
|
See |
|
.Xr mandoc_char 7 |
|
for a complete list. |
|
Examples include |
|
.Sq \e*(Am |
|
.Pq ampersand |
|
and |
|
.Sq \e*(Ba |
|
.Pq vertical bar . |
|
.Ss Whitespace |
|
Whitespace consists of the space character. |
|
In free-form lines, whitespace is preserved within a line; un-escaped |
|
trailing spaces are stripped from input (unless in a literal context). |
|
Blank free-form lines, which may include whitespace, are only permitted |
|
within literal contexts. |
|
.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 |
|
space-delimited terms or to retain blocks of whitespace. |
|
A quoted argument begins with a double-quote preceded by whitespace. |
|
The next double-quote not pair-wise adjacent to another double-quote |
|
terminates the literal, regardless of surrounding whitespace. |
|
.Pp |
|
Note that any quoted text, even if it would cause a macro invocation |
|
when unquoted, is considered literal text. |
|
Thus, the following produces |
|
.Sq Op "Fl a" : |
|
.Bd -literal -offset indent |
|
\&.Op "Fl a" |
|
.Ed |
|
.Pp |
|
In free-form mode, quotes are regarded as opaque text. |
|
.Ss Dates |
|
There are several macros in |
|
.Nm |
.Nm |
that require a date argument. |
documents is discouraged; |
The canonical form for dates is the American format: |
.Xr mandoc 1 |
.Pp |
supports some of them merely for backward compatibility. |
.D1 Cm Month Day , Year |
|
.Pp |
|
The |
|
.Cm Day |
|
value is an optionally zero-padded numeral. |
|
The |
|
.Cm Month |
|
value is the full month name. |
|
The |
|
.Cm Year |
|
value is the full four-digit year. |
|
.Pp |
|
Reduced form dates are broken-down canonical form dates: |
|
.Pp |
|
.D1 Cm Month , Year |
|
.D1 Cm Year |
|
.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 |
|
.Ss Scaling Widths |
|
Many macros support scaled widths for their arguments, such as |
|
stipulating a two-inch list indentation with the following: |
|
.Bd -literal -offset indent |
|
\&.Bl -tag -width 2i |
|
.Ed |
|
.Pp |
|
The syntax for scaled widths is |
|
.Sq Li [+-]?[0-9]*.[0-9]*[:unit:] , |
|
where a decimal must be preceded or proceeded by at least one digit. |
|
Negative numbers, while accepted, are truncated to zero. |
|
The following scaling units are accepted: |
|
.Pp |
|
.Bl -tag -width Ds -offset indent -compact |
|
.It c |
|
centimetre |
|
.It i |
|
inch |
|
.It P |
|
pica (~1/6 inch) |
|
.It p |
|
point (~1/72 inch) |
|
.It f |
|
synonym for |
|
.Sq u |
|
.It v |
|
default vertical span |
|
.It m |
|
width of rendered |
|
.Sq m |
|
.Pq em |
|
character |
|
.It n |
|
width of rendered |
|
.Sq n |
|
.Pq en |
|
character |
|
.It u |
|
default horizontal span |
|
.It M |
|
mini-em (~1/100 em) |
|
.El |
|
.Pp |
|
Using anything other than |
|
.Sq m , |
|
.Sq n , |
|
.Sq u , |
|
or |
|
.Sq v |
|
is necessarily non-portable across output media. |
|
See |
|
.Sx COMPATIBILITY . |
|
.Ss Sentence Spacing |
|
When composing a manual, make sure that your sentences end at the end of |
|
a line. |
|
By doing so, front-ends will be able to apply the proper amount of |
|
spacing after the end of sentence (unescaped) period, exclamation mark, |
|
or question mark followed by zero or more non-sentence closing |
|
delimiters ( |
|
.Ns Sq \&) , |
|
.Sq \&] , |
|
.Sq \&' , |
|
.Sq \&" ) . |
|
.Pp |
|
The proper spacing is also intelligently preserved if a sentence ends at |
|
the boundary of a macro line, e.g., |
|
.Pp |
|
.D1 \&Xr mandoc 1 \. |
|
.D1 \&Fl T \&Ns \&Cm ascii \. |
|
.Sh MANUAL STRUCTURE |
.Sh MANUAL STRUCTURE |
A well-formed |
A well-formed |
.Nm |
.Nm |
Line 299 document consists of a document prologue followed by o |
|
Line 94 document consists of a document prologue followed by o |
|
sections. |
sections. |
.Pp |
.Pp |
The prologue, which consists of the |
The prologue, which consists of the |
.Sx \&Dd , |
.Ic \&Dd , |
.Sx \&Dt , |
.Ic \&Dt , |
and |
and |
.Sx \&Os |
.Ic \&Os |
macros in that order, is required for every document. |
macros in that order, is required for every document. |
.Pp |
.Pp |
The first section (sections are denoted by |
The first section (sections are denoted by |
.Sx \&Sh ) |
.Ic \&Sh ) |
must be the NAME section, consisting of at least one |
must be the NAME section, consisting of at least one |
.Sx \&Nm |
.Ic \&Nm |
followed by |
followed by |
.Sx \&Nd . |
.Ic \&Nd . |
.Pp |
.Pp |
Following that, convention dictates specifying at least the |
Following that, convention dictates specifying at least the |
.Em SYNOPSIS |
.Em SYNOPSIS |
Line 320 sections, although this varies between manual sections |
|
Line 115 sections, although this varies between manual sections |
|
.Pp |
.Pp |
The following is a well-formed skeleton |
The following is a well-formed skeleton |
.Nm |
.Nm |
file: |
file for a utility |
|
.Qq progname : |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Dd $\&Mdocdate$ |
\&.Dd $\&Mdocdate$ |
\&.Dt mdoc 7 |
\&.Dt PROGNAME section |
\&.Os |
\&.Os |
\&.Sh NAME |
\&.Sh NAME |
\&.Nm foo |
\&.Nm progname |
\&.Nd a description goes here |
\&.Nd one line about what it does |
\&.\e\*q The next is for sections 2, 3, & 9 only. |
\&.\e\(dq .Sh LIBRARY |
\&.\e\*q .Sh LIBRARY |
\&.\e\(dq For sections 2, 3, and 9 only. |
|
\&.\e\(dq Not used in OpenBSD. |
\&.Sh SYNOPSIS |
\&.Sh SYNOPSIS |
\&.Nm foo |
\&.Nm progname |
\&.Op Fl options |
\&.Op Fl options |
\&.Ar |
\&.Ar |
\&.Sh DESCRIPTION |
\&.Sh DESCRIPTION |
The |
The |
\&.Nm |
\&.Nm |
utility processes files ... |
utility processes files ... |
\&.\e\*q .Sh IMPLEMENTATION NOTES |
\&.\e\(dq .Sh CONTEXT |
\&.\e\*q The next is for sections 2, 3, & 9 only. |
\&.\e\(dq For section 9 functions only. |
\&.\e\*q .Sh RETURN VALUES |
\&.\e\(dq .Sh IMPLEMENTATION NOTES |
\&.\e\*q The next is for sections 1, 6, 7, & 8 only. |
\&.\e\(dq Not used in OpenBSD. |
\&.\e\*q .Sh ENVIRONMENT |
\&.\e\(dq .Sh RETURN VALUES |
\&.\e\*q .Sh FILES |
\&.\e\(dq For sections 2, 3, and 9 function return values only. |
\&.\e\*q The next is for sections 1 & 8 only. |
\&.\e\(dq .Sh ENVIRONMENT |
\&.\e\*q .Sh EXIT STATUS |
\&.\e\(dq For sections 1, 6, 7, and 8 only. |
\&.\e\*q .Sh EXAMPLES |
\&.\e\(dq .Sh FILES |
\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only. |
\&.\e\(dq .Sh EXIT STATUS |
\&.\e\*q .Sh DIAGNOSTICS |
\&.\e\(dq For sections 1, 6, and 8 only. |
\&.\e\*q The next is for sections 2, 3, & 9 only. |
\&.\e\(dq .Sh EXAMPLES |
\&.\e\*q .Sh ERRORS |
\&.\e\(dq .Sh DIAGNOSTICS |
\&.\e\*q .Sh SEE ALSO |
\&.\e\(dq For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only. |
\&.\e\*q .Xr foobar 1 |
\&.\e\(dq .Sh ERRORS |
\&.\e\*q .Sh STANDARDS |
\&.\e\(dq For sections 2, 3, 4, and 9 errno settings only. |
\&.\e\*q .Sh HISTORY |
\&.\e\(dq .Sh SEE ALSO |
\&.\e\*q .Sh AUTHORS |
\&.\e\(dq .Xr foobar 1 |
\&.\e\*q .Sh CAVEATS |
\&.\e\(dq .Sh STANDARDS |
\&.\e\*q .Sh BUGS |
\&.\e\(dq .Sh HISTORY |
\&.\e\*q .Sh SECURITY CONSIDERATIONS |
\&.\e\(dq .Sh AUTHORS |
|
\&.\e\(dq .Sh CAVEATS |
|
\&.\e\(dq .Sh BUGS |
|
\&.\e\(dq .Sh SECURITY CONSIDERATIONS |
|
\&.\e\(dq Not used in OpenBSD. |
.Ed |
.Ed |
.Pp |
.Pp |
The sections in a |
The sections in an |
.Nm |
.Nm |
document are conventionally ordered as they appear above. |
document are conventionally ordered as they appear above. |
Sections should be composed as follows: |
Sections should be composed as follows: |
.Bl -ohang -offset Ds |
.Bl -ohang -offset Ds |
.It Em NAME |
.It Em NAME |
The name(s) and a one-line description of the documented material. |
The name(s) and a one line description of the documented material. |
The syntax for this as follows: |
The syntax for this as follows: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Nm name0 |
\&.Nm name0 , |
\&.Nm name1 |
\&.Nm name1 , |
\&.Nm name2 |
\&.Nm name2 |
\&.Nd a one-line description |
\&.Nd a one line description |
.Ed |
.Ed |
.Pp |
.Pp |
|
Multiple |
|
.Sq \&Nm |
|
names should be separated by commas. |
|
.Pp |
The |
The |
.Sx \&Nm |
.Ic \&Nm |
macro(s) must precede the |
macro(s) must precede the |
.Sx \&Nd |
.Ic \&Nd |
macro. |
macro. |
.Pp |
.Pp |
See |
See |
.Sx \&Nm |
.Ic \&Nm |
and |
and |
.Sx \&Nd . |
.Ic \&Nd . |
.It Em LIBRARY |
.It Em LIBRARY |
The name of the library containing the documented material, which is |
The name of the library containing the documented material, which is |
assumed to be a function in a section 2, 3, or 9 manual. |
assumed to be a function in a section 2, 3, or 9 manual. |
Line 395 The syntax for this is as follows: |
|
Line 200 The syntax for this is as follows: |
|
.Ed |
.Ed |
.Pp |
.Pp |
See |
See |
.Sx \&Lb . |
.Ic \&Lb . |
.It Em SYNOPSIS |
.It Em SYNOPSIS |
Documents the utility invocation syntax, function call syntax, or device |
Documents the utility invocation syntax, function call syntax, or device |
configuration. |
configuration. |
|
|
For the first, utilities (sections 1, 6, and 8), this is |
For the first, utilities (sections 1, 6, and 8), this is |
generally structured as follows: |
generally structured as follows: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Nm foo |
\&.Nm bar |
\&.Op Fl v |
\&.Op Fl v |
\&.Op Fl o Ar file |
\&.Op Fl o Ar file |
\&.Op Ar |
\&.Op Ar |
\&.Nm bar |
\&.Nm foo |
\&.Op Fl v |
\&.Op Fl v |
\&.Op Fl o Ar file |
\&.Op Fl o Ar file |
\&.Op Ar |
\&.Op Ar |
.Ed |
.Ed |
.Pp |
.Pp |
|
Commands should be ordered alphabetically. |
|
.Pp |
For the second, function calls (sections 2, 3, 9): |
For the second, function calls (sections 2, 3, 9): |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Vt extern const char *global; |
|
\&.In header.h |
\&.In header.h |
|
\&.Vt extern const char *global; |
\&.Ft "char *" |
\&.Ft "char *" |
\&.Fn foo "const char *src" |
\&.Fn foo "const char *src" |
\&.Ft "char *" |
\&.Ft "char *" |
\&.Fn bar "const char *src" |
\&.Fn bar "const char *src" |
.Ed |
.Ed |
.Pp |
.Pp |
|
Ordering of |
|
.Ic \&In , |
|
.Ic \&Vt , |
|
.Ic \&Fn , |
|
and |
|
.Ic \&Fo |
|
macros should follow C header-file conventions. |
|
.Pp |
And for the third, configurations (section 4): |
And for the third, configurations (section 4): |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Cd \*qit* at isa? port 0x2e\*q |
\&.Cd \(dqit* at isa? port 0x2e\(dq |
\&.Cd \*qit* at isa? port 0x4e\*q |
\&.Cd \(dqit* at isa? port 0x4e\(dq |
.Ed |
.Ed |
.Pp |
.Pp |
Manuals not in these sections generally don't need a |
Manuals not in these sections generally don't need a |
Line 435 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 |
Some macros are displayed differently in the |
.Em SYNOPSIS |
.Em SYNOPSIS |
section, particularly |
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 |
and |
.Sx \&Ft . |
.Ic \&Ft . |
All of these macros are output on their own line. |
All of these macros are output on their own line. |
If two such dissimilar macros are pair-wise invoked (except for |
If two such dissimilar macros are pairwise invoked (except for |
.Sx \&Ft |
.Ic \&Ft |
before |
before |
.Sx \&Fo |
.Ic \&Fo |
or |
or |
.Sx \&Fn ) , |
.Ic \&Fn ) , |
they are separated by a vertical space, unless in the case of |
they are separated by a vertical space, unless in the case of |
.Sx \&Fo , |
.Ic \&Fo , |
.Sx \&Fn , |
.Ic \&Fn , |
and |
and |
.Sx \&Ft , |
.Ic \&Ft , |
which are always separated by vertical space. |
which are always separated by vertical space. |
.Pp |
.Pp |
When text and macros following an |
When text and macros following an |
.Sx \&Nm |
.Ic \&Nm |
macro starting an input line span multiple output lines, |
macro starting an input line span multiple output lines, |
all output lines but the first will be indented to align |
all output lines but the first will be indented to align |
with the text immediately following the |
with the text immediately following the |
.Sx \&Nm |
.Ic \&Nm |
macro, up to the next |
macro, up to the next |
.Sx \&Nm , |
.Ic \&Nm , |
.Sx \&Sh , |
.Ic \&Sh , |
or |
or |
.Sx \&Ss |
.Ic \&Ss |
macro or the end of an enclosing block, whichever comes first. |
macro or the end of an enclosing block, whichever comes first. |
.It Em DESCRIPTION |
.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 break-down 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: |
command), such as: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
The arguments are as follows: |
The options are as follows: |
\&.Bl \-tag \-width Ds |
\&.Bl \-tag \-width Ds |
\&.It Fl v |
\&.It Fl v |
Print verbose information. |
Print verbose information. |
\&.El |
\&.El |
.Ed |
.Ed |
.Pp |
.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. |
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 |
|
.Ic \&Ss |
|
macro to form subsections. |
|
In very long manuals, the |
|
.Em DESCRIPTION |
|
may be split into multiple sections, each started by an |
|
.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 |
.It Em IMPLEMENTATION NOTES |
Implementation-specific notes should be kept here. |
Implementation-specific notes should be kept here. |
This is useful when implementing standard functions that may have side |
This is useful when implementing standard functions that may have side |
effects or notable algorithmic implications. |
effects or notable algorithmic implications. |
.It Em RETURN VALUES |
.It Em RETURN VALUES |
This section is the dual of |
This section documents the |
.Em EXIT STATUS , |
return values of functions in sections 2, 3, and 9. |
which is used for commands. |
|
It documents the return values of functions in sections 2, 3, and 9. |
|
.Pp |
.Pp |
See |
See |
.Sx \&Rv . |
.Ic \&Rv . |
.It Em ENVIRONMENT |
.It Em ENVIRONMENT |
Lists the environment variables used by the utility, |
Lists the environment variables used by the utility, |
and explains the syntax and semantics of their values. |
and explains the syntax and semantics of their values. |
|
|
manual provides examples of typical content and formatting. |
manual provides examples of typical content and formatting. |
.Pp |
.Pp |
See |
See |
.Sx \&Ev . |
.Ic \&Ev . |
.It Em FILES |
.It Em FILES |
Documents files used. |
Documents files used. |
It's helpful to document both the file name and a short description of how |
It's helpful to document both the file name and a short description of how |
the file is used (created, modified, etc.). |
the file is used (created, modified, etc.). |
.Pp |
.Pp |
See |
See |
.Sx \&Pa . |
.Ic \&Pa . |
.It Em EXIT STATUS |
.It Em EXIT STATUS |
Command exit status for section 1, 6, and 8 manuals. |
This section documents the |
This section is the dual of |
command exit status for section 1, 6, and 8 utilities. |
.Em RETURN VALUES , |
|
which is used for functions. |
|
Historically, this information was described in |
Historically, this information was described in |
.Em DIAGNOSTICS , |
.Em DIAGNOSTICS , |
a practise that is now discouraged. |
a practise that is now discouraged. |
.Pp |
.Pp |
See |
See |
.Sx \&Ex . |
.Ic \&Ex . |
.It Em EXAMPLES |
.It Em EXAMPLES |
Example usages. |
Example usages. |
This often contains snippets of well-formed, well-tested invocations. |
This often contains snippets of well-formed, well-tested invocations. |
Make doubly sure that your examples work properly! |
Make sure that examples work properly! |
.It Em DIAGNOSTICS |
.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 |
Historically, this section was used in place of |
.Em EXIT STATUS |
.Em EXIT STATUS |
for manuals in sections 1, 6, and 8; however, this practise is |
for manuals in sections 1, 6, and 8; however, this practise is |
discouraged. |
discouraged. |
.Pp |
.Pp |
See |
See |
.Sx \&Bl |
.Ic \&Bl |
.Fl diag . |
.Fl diag . |
.It Em ERRORS |
.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 |
.Pp |
See |
See |
.Sx \&Er . |
.Ic \&Er . |
.It Em SEE ALSO |
.It Em SEE ALSO |
References other manuals with related topics. |
References other manuals with related topics. |
This section should exist for most manuals. |
This section should exist for most manuals. |
Cross-references should conventionally be ordered first by section, then |
Cross-references should conventionally be ordered first by section, then |
alphabetically. |
alphabetically (ignoring case). |
.Pp |
.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 |
See |
.Sx \&Xr . |
.Ic \&Rs |
|
and |
|
.Ic \&Xr . |
.It Em STANDARDS |
.It Em STANDARDS |
References any standards implemented or used. |
References any standards implemented or used. |
If not adhering to any standards, the |
If not adhering to any standards, the |
Line 558 If not adhering to any standards, the |
|
Line 410 If not adhering to any standards, the |
|
section should be used instead. |
section should be used instead. |
.Pp |
.Pp |
See |
See |
.Sx \&St . |
.Ic \&St . |
.It Em HISTORY |
.It Em HISTORY |
The history of any manual without a |
A brief history of the subject, including where it was first implemented, |
.Em STANDARDS |
and when it was ported to or reimplemented for the operating system at hand. |
section should be described in this section. |
|
.It Em AUTHORS |
.It Em AUTHORS |
Credits to authors, if applicable, should appear in this section. |
Credits to the person or persons who wrote the code and/or documentation. |
Authors should generally be noted by both name and email address. |
Authors should generally be noted by both name and email address. |
.Pp |
.Pp |
See |
See |
.Sx \&An . |
.Ic \&An . |
.It Em CAVEATS |
.It Em CAVEATS |
Common misuses and misunderstandings should be explained |
Common misuses and misunderstandings should be explained |
in this section. |
in this section. |
.It Em BUGS |
.It Em BUGS |
Known bugs, limitations and work-arounds should be described |
Known bugs, limitations, and work-arounds should be described |
in this section. |
in this section. |
.It Em SECURITY CONSIDERATIONS |
.It Em SECURITY CONSIDERATIONS |
Documents any security precautions that operators should consider. |
Documents any security precautions that operators should consider. |
.El |
.El |
.Sh MACRO SYNTAX |
.Sh MACRO OVERVIEW |
Macros are one to three three characters in length and begin with a |
This overview is sorted such that macros of similar purpose are listed |
control character, |
together, to help find the best macro for any given purpose. |
.Sq \&. , |
Deprecated macros are not included in the overview, but can be found below |
at the beginning of the line. |
in the alphabetical |
An arbitrary amount of whitespace may sit between the control character |
.Sx MACRO REFERENCE . |
and the macro name. |
.Ss Document preamble and NAME section macros |
Thus, the following are equivalent: |
.Bl -column "Brq, Bro, Brc" description |
.Bd -literal -offset indent |
.It Ic \&Dd Ta document date: Cm $\&Mdocdate$ | Ar month day , year |
\&.Pp |
.It Ic \&Dt Ta document title: Ar TITLE section Op Ar arch |
\&.\ \ \ \&Pp |
.It Ic \&Os Ta operating system version: Op Ar system Op Ar version |
.Ed |
.It Ic \&Nm Ta document name (one argument) |
.Pp |
.It Ic \&Nd Ta document description (one line) |
The syntax of a macro depends on its classification. |
|
In this section, |
|
.Sq \-arg |
|
refers to macro arguments, which may be followed by zero or more |
|
.Sq parm |
|
parameters; |
|
.Sq \&Yo |
|
opens the scope of a macro; and if specified, |
|
.Sq \&Yc |
|
closes it out. |
|
.Pp |
|
The |
|
.Em Callable |
|
column indicates that the macro may be called subsequent to the initial |
|
line-macro. |
|
If a macro is not callable, then its invocation after the initial line |
|
macro is interpreted as opaque text, such that |
|
.Sq \&.Fl \&Sh |
|
produces |
|
.Sq Fl \&Sh . |
|
.Pp |
|
The |
|
.Em Parsed |
|
column indicates whether the macro may be followed by further |
|
(ostensibly callable) macros. |
|
If a macro is not parsed, subsequent macro invocations on the line |
|
will be interpreted as opaque text. |
|
.Pp |
|
The |
|
.Em Scope |
|
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 |
|
contains a head. |
|
.Bd -literal -offset indent |
|
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB |
|
\(lBbody...\(rB |
|
\&.Yc |
|
.Ed |
|
.Pp |
|
.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsedX" "closed by XXX" |
|
.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 Sx \&Bf Ta \&No Ta \&No Ta closed by Sx \&Ef |
|
.It Sx \&Bk Ta \&No Ta \&No Ta closed by Sx \&Ek |
|
.It Sx \&Bl Ta \&No Ta \&No Ta closed by Sx \&El |
|
.It Sx \&Ed Ta \&No Ta \&No Ta opened by Sx \&Bd |
|
.It Sx \&Ef Ta \&No Ta \&No Ta opened by Sx \&Bf |
|
.It Sx \&Ek Ta \&No Ta \&No Ta opened by Sx \&Bk |
|
.It Sx \&El Ta \&No Ta \&No Ta opened by Sx \&Bl |
|
.El |
.El |
.Ss Block full-implicit |
.Ss Sections and cross references |
Multi-line scope closed by end-of-file or implicitly by another macro. |
.Bl -column "Brq, Bro, Brc" description |
All macros have bodies; some |
.It Ic \&Sh Ta section header (one line) |
.Po |
.It Ic \&Ss Ta subsection header (one line) |
.Sx \&It Fl bullet , |
.It Ic \&Sx Ta internal cross reference to a section or subsection |
.Fl hyphen , |
.It Ic \&Xr Ta cross reference to another manual page: Ar name section |
.Fl dash , |
.It Ic \&Tg Ta tag the definition of a Ar term Pq <= 1 arguments |
.Fl enum , |
.It Ic \&Pp Ta start a text paragraph (no arguments) |
.Fl item |
|
.Pc |
|
don't have heads; only one |
|
.Po |
|
.Sx \&It |
|
in |
|
.Sx \&Bl Fl column |
|
.Pc |
|
has multiple heads. |
|
.Bd -literal -offset indent |
|
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB |
|
\(lBbody...\(rB |
|
.Ed |
|
.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 \&Ss Ta \&No Ta \&No Ta closed by Sx \&Sh , Sx \&Ss |
|
.El |
.El |
.Pp |
.Ss Displays and lists |
Note that the |
.Bl -column "Brq, Bro, Brc" description |
.Sx \&Nm |
.It Ic \&Bd , \&Ed Ta display block: |
macro is a |
.Fl Ar type |
.Sx Block full-implicit |
.Op Fl offset Ar width |
macro only when invoked as the first macro |
.Op Fl compact |
in a |
.It Ic \&D1 Ta indented display (one line) |
.Em SYNOPSIS |
.It Ic \&Dl Ta indented literal display (one line) |
section line, else it is |
.It Ic \&Ql Ta in-line literal display: Ql text |
.Sx In-line . |
.It Ic \&Bl , \&El Ta list block: |
.Ss Block partial-explicit |
.Fl Ar type |
Like block full-explicit, but also with single-line scope. |
.Op Fl width Ar val |
Each has at least a body and, in limited circumstances, a head |
.Op Fl offset Ar val |
.Po |
.Op Fl compact |
.Sx \&Fo , |
.It Ic \&It Ta list item (syntax depends on Fl Ar type ) |
.Sx \&Eo |
.It Ic \&Ta Ta table cell separator in Ic \&Bl Fl column No lists |
.Pc |
.It Ic \&Rs , \&%* , \&Re Ta bibliographic block (references) |
and/or tail |
|
.Pq Sx \&Ec . |
|
.Bd -literal -offset indent |
|
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB |
|
\(lBbody...\(rB |
|
\&.Yc \(lBtail...\(rB |
|
|
|
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \ |
|
\(lBbody...\(rB \&Yc \(lBtail...\(rB |
|
.Ed |
|
.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 \&Ac Ta Yes Ta Yes Ta opened by Sx \&Ao |
|
.It Sx \&Ao Ta Yes Ta Yes Ta closed by Sx \&Ac |
|
.It Sx \&Bc Ta Yes Ta Yes Ta closed by Sx \&Bo |
|
.It Sx \&Bo Ta Yes Ta Yes Ta opened by Sx \&Bc |
|
.It Sx \&Brc Ta Yes Ta Yes Ta opened by Sx \&Bro |
|
.It Sx \&Bro Ta Yes Ta Yes Ta closed by Sx \&Brc |
|
.It Sx \&Dc Ta Yes Ta Yes Ta opened by Sx \&Do |
|
.It Sx \&Do Ta Yes Ta Yes Ta closed by Sx \&Dc |
|
.It Sx \&Ec Ta Yes Ta Yes Ta opened by Sx \&Eo |
|
.It Sx \&Eo Ta Yes Ta Yes Ta closed by Sx \&Ec |
|
.It Sx \&Fc Ta Yes Ta Yes Ta opened by Sx \&Fo |
|
.It Sx \&Fo Ta \&No Ta \&No Ta closed by Sx \&Fc |
|
.It Sx \&Oc Ta Yes Ta Yes Ta closed by Sx \&Oo |
|
.It Sx \&Oo Ta Yes Ta Yes Ta opened by Sx \&Oc |
|
.It Sx \&Pc Ta Yes Ta Yes Ta closed by Sx \&Po |
|
.It Sx \&Po Ta Yes Ta Yes Ta opened by Sx \&Pc |
|
.It Sx \&Qc Ta Yes Ta Yes Ta opened by Sx \&Oo |
|
.It Sx \&Qo Ta Yes Ta Yes Ta closed by Sx \&Oc |
|
.It Sx \&Re Ta \&No Ta \&No Ta opened by Sx \&Rs |
|
.It Sx \&Rs Ta \&No Ta \&No Ta closed by Sx \&Re |
|
.It Sx \&Sc Ta Yes Ta Yes Ta opened by Sx \&So |
|
.It Sx \&So Ta Yes Ta Yes Ta closed by Sx \&Sc |
|
.It Sx \&Xc Ta Yes Ta Yes Ta opened by Sx \&Xo |
|
.It Sx \&Xo Ta Yes Ta Yes Ta closed by Sx \&Xc |
|
.El |
.El |
.Ss Block partial-implicit |
.Ss Spacing control |
Like block full-implicit, but with single-line scope closed by |
.Bl -column "Brq, Bro, Brc" description |
.Sx Reserved Characters |
.It Ic \&Pf Ta prefix, no following horizontal space (one argument) |
or end of line. |
.It Ic \&Ns Ta roman font, no preceding horizontal space (no arguments) |
.Bd -literal -offset indent |
.It Ic \&Ap Ta apostrophe without surrounding whitespace (no arguments) |
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB |
.It Ic \&Sm Ta switch horizontal spacing mode: Op Cm on | off |
.Ed |
.It Ic \&Bk , \&Ek Ta keep block: Fl words |
.Pp |
|
.Bl -column "MacroX" "CallableX" "ParsedX" -compact -offset indent |
|
.It Em Macro Ta Em Callable Ta Em Parsed |
|
.It Sx \&Aq Ta Yes Ta Yes |
|
.It Sx \&Bq Ta Yes Ta Yes |
|
.It Sx \&Brq Ta Yes Ta Yes |
|
.It Sx \&D1 Ta \&No Ta \&Yes |
|
.It Sx \&Dl Ta \&No Ta Yes |
|
.It Sx \&Dq Ta Yes Ta Yes |
|
.It Sx \&Op Ta Yes Ta Yes |
|
.It Sx \&Pq Ta Yes Ta Yes |
|
.It Sx \&Ql Ta Yes Ta Yes |
|
.It Sx \&Qq Ta Yes Ta Yes |
|
.It Sx \&Sq Ta Yes Ta Yes |
|
.It Sx \&Vt Ta Yes Ta Yes |
|
.El |
.El |
.Pp |
.Ss Semantic markup for command line utilities |
Note that the |
.Bl -column "Brq, Bro, Brc" description |
.Sx \&Vt |
.It Ic \&Nm Ta start a SYNOPSIS block with the name of a utility |
macro is a |
.It Ic \&Fl Ta command line options (flags) (>=0 arguments) |
.Sx Block partial-implicit |
.It Ic \&Cm Ta command modifier (>0 arguments) |
only when invoked as the first macro |
.It Ic \&Ar Ta command arguments (>=0 arguments) |
in a |
.It Ic \&Op , \&Oo , \&Oc Ta optional syntax elements (enclosure) |
.Em SYNOPSIS |
.It Ic \&Ic Ta internal or interactive command (>0 arguments) |
section line, else it is |
.It Ic \&Ev Ta environmental variable (>0 arguments) |
.Sx In-line . |
.It Ic \&Pa Ta file system path (>=0 arguments) |
.Ss In-line |
|
Closed by |
|
.Sx Reserved Characters , |
|
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 , |
|
then the macro accepts an arbitrary number of arguments. |
|
.Bd -literal -offset indent |
|
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lbres...\(rb |
|
|
|
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc... |
|
|
|
\&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN |
|
.Ed |
|
.Pp |
|
.Bl -column "MacroX" "CallableX" "ParsedX" "Arguments" -compact -offset indent |
|
.It Em Macro Ta Em Callable Ta Em Parsed Ta Em Arguments |
|
.It Sx \&%A Ta \&No Ta \&No Ta >0 |
|
.It Sx \&%B Ta \&No Ta \&No Ta >0 |
|
.It Sx \&%C Ta \&No Ta \&No Ta >0 |
|
.It Sx \&%D Ta \&No Ta \&No Ta >0 |
|
.It Sx \&%I Ta \&No Ta \&No Ta >0 |
|
.It Sx \&%J Ta \&No Ta \&No Ta >0 |
|
.It Sx \&%N Ta \&No Ta \&No Ta >0 |
|
.It Sx \&%O Ta \&No Ta \&No Ta >0 |
|
.It Sx \&%P Ta \&No Ta \&No Ta >0 |
|
.It Sx \&%Q Ta \&No Ta \&No Ta >0 |
|
.It Sx \&%R Ta \&No Ta \&No Ta >0 |
|
.It Sx \&%T Ta \&No Ta \&No Ta >0 |
|
.It Sx \&%U Ta \&No Ta \&No Ta >0 |
|
.It Sx \&%V Ta \&No Ta \&No Ta >0 |
|
.It Sx \&Ad Ta Yes Ta Yes Ta n |
|
.It Sx \&An Ta Yes Ta Yes Ta n |
|
.It Sx \&Ap Ta Yes Ta Yes Ta 0 |
|
.It Sx \&Ar Ta Yes Ta Yes Ta n |
|
.It Sx \&At Ta Yes Ta Yes Ta 1 |
|
.It Sx \&Bsx Ta Yes Ta Yes Ta n |
|
.It Sx \&Bt Ta \&No Ta \&No Ta 0 |
|
.It Sx \&Bx Ta Yes Ta Yes Ta n |
|
.It Sx \&Cd Ta Yes Ta Yes Ta >0 |
|
.It Sx \&Cm Ta Yes Ta Yes Ta n |
|
.It Sx \&Db Ta \&No Ta \&No Ta 1 |
|
.It Sx \&Dd Ta \&No Ta \&No Ta n |
|
.It Sx \&Dt Ta \&No Ta \&No Ta n |
|
.It Sx \&Dv Ta Yes Ta Yes Ta n |
|
.It Sx \&Dx Ta Yes Ta Yes Ta n |
|
.It Sx \&Em Ta Yes Ta Yes Ta >0 |
|
.It Sx \&En Ta \&No Ta \&No Ta 0 |
|
.It Sx \&Er Ta Yes Ta Yes Ta >0 |
|
.It Sx \&Es Ta \&No Ta \&No Ta 0 |
|
.It Sx \&Ev Ta Yes Ta Yes Ta n |
|
.It Sx \&Ex Ta \&No Ta \&No Ta n |
|
.It Sx \&Fa Ta Yes Ta Yes Ta n |
|
.It Sx \&Fd Ta \&No Ta \&No Ta >0 |
|
.It Sx \&Fl Ta Yes Ta Yes Ta n |
|
.It Sx \&Fn Ta Yes Ta Yes Ta >0 |
|
.It Sx \&Fr Ta \&No Ta \&No Ta n |
|
.It Sx \&Ft Ta Yes Ta Yes Ta n |
|
.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 \&Lb Ta \&No Ta \&No Ta 1 |
|
.It Sx \&Li Ta Yes Ta Yes Ta n |
|
.It Sx \&Lk Ta Yes Ta Yes Ta n |
|
.It Sx \&Lp Ta \&No Ta \&No Ta 0 |
|
.It Sx \&Ms Ta Yes Ta Yes Ta >0 |
|
.It Sx \&Mt Ta Yes Ta Yes Ta >0 |
|
.It Sx \&Nm Ta Yes Ta Yes Ta n |
|
.It Sx \&No Ta Yes Ta Yes Ta 0 |
|
.It Sx \&Ns Ta Yes Ta Yes Ta 0 |
|
.It Sx \&Nx Ta Yes Ta Yes Ta n |
|
.It Sx \&Os Ta \&No Ta \&No Ta n |
|
.It Sx \&Ot Ta \&No Ta \&No Ta n |
|
.It Sx \&Ox Ta Yes Ta Yes Ta n |
|
.It Sx \&Pa Ta Yes Ta Yes Ta n |
|
.It Sx \&Pf Ta Yes Ta Yes Ta 1 |
|
.It Sx \&Pp Ta \&No Ta \&No Ta 0 |
|
.It Sx \&Rv Ta \&No Ta \&No Ta n |
|
.It Sx \&Sm Ta \&No Ta \&No Ta 1 |
|
.It Sx \&St Ta \&No Ta Yes Ta 1 |
|
.It Sx \&Sx Ta Yes Ta Yes Ta >0 |
|
.It Sx \&Sy Ta Yes Ta Yes Ta >0 |
|
.It Sx \&Tn Ta Yes Ta Yes Ta >0 |
|
.It Sx \&Ud Ta \&No Ta \&No Ta 0 |
|
.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 |
|
.It Sx \&br Ta \&No Ta \&No Ta 0 |
|
.It Sx \&sp Ta \&No Ta \&No Ta 1 |
|
.El |
.El |
.Sh REFERENCE |
.Ss Semantic markup for function libraries |
|
.Bl -column "Brq, Bro, Brc" description |
|
.It Ic \&Lb Ta function library (one argument) |
|
.It Ic \&In Ta include file (one argument) |
|
.It Ic \&Fd Ta other preprocessor directive (>0 arguments) |
|
.It Ic \&Ft Ta function type (>0 arguments) |
|
.It Ic \&Fo , \&Fc Ta function block: Ar funcname |
|
.It Ic \&Fn Ta function name: Ar funcname Op Ar argument ... |
|
.It Ic \&Fa Ta function argument (>0 arguments) |
|
.It Ic \&Vt Ta variable type (>0 arguments) |
|
.It Ic \&Va Ta variable name (>0 arguments) |
|
.It Ic \&Dv Ta defined variable or preprocessor constant (>0 arguments) |
|
.It Ic \&Er Ta error constant (>0 arguments) |
|
.It Ic \&Ev Ta environmental variable (>0 arguments) |
|
.El |
|
.Ss Various semantic markup |
|
.Bl -column "Brq, Bro, Brc" description |
|
.It Ic \&An Ta author name (>0 arguments) |
|
.It Ic \&Lk Ta hyperlink: Ar uri Op Ar display_name |
|
.It Ic \&Mt Ta Do mailto Dc hyperlink: Ar localpart Ns @ Ns Ar domain |
|
.It Ic \&Cd Ta kernel configuration declaration (>0 arguments) |
|
.It Ic \&Ad Ta memory address (>0 arguments) |
|
.It Ic \&Ms Ta mathematical symbol (>0 arguments) |
|
.El |
|
.Ss Physical markup |
|
.Bl -column "Brq, Bro, Brc" description |
|
.It Ic \&Em Ta italic font or underline (emphasis) (>0 arguments) |
|
.It Ic \&Sy Ta boldface font (symbolic) (>0 arguments) |
|
.It Ic \&No Ta return to roman font (normal) (>0 arguments) |
|
.It Ic \&Bf , \&Ef Ta font block: Fl Ar type | Cm \&Em | \&Li | \&Sy |
|
.El |
|
.Ss Physical enclosures |
|
.Bl -column "Brq, Bro, Brc" description |
|
.It Ic \&Dq , \&Do , \&Dc Ta enclose in typographic double quotes: Dq text |
|
.It Ic \&Qq , \&Qo , \&Qc Ta enclose in typewriter double quotes: Qq text |
|
.It Ic \&Sq , \&So , \&Sc Ta enclose in single quotes: Sq text |
|
.It Ic \&Pq , \&Po , \&Pc Ta enclose in parentheses: Pq text |
|
.It Ic \&Bq , \&Bo , \&Bc Ta enclose in square brackets: Bq text |
|
.It Ic \&Brq , \&Bro , \&Brc Ta enclose in curly braces: Brq text |
|
.It Ic \&Aq , \&Ao , \&Ac Ta enclose in angle brackets: Aq text |
|
.It Ic \&Eo , \&Ec Ta generic enclosure |
|
.El |
|
.Ss Text production |
|
.Bl -column "Brq, Bro, Brc" description |
|
.It Ic \&Ex Fl std Ta standard command exit values: Op Ar utility ... |
|
.It Ic \&Rv Fl std Ta standard function return values: Op Ar function ... |
|
.It Ic \&St Ta reference to a standards document (one argument) |
|
.It Ic \&At Ta At |
|
.It Ic \&Bx Ta Bx |
|
.It Ic \&Bsx Ta Bsx |
|
.It Ic \&Nx Ta Nx |
|
.It Ic \&Fx Ta Fx |
|
.It Ic \&Ox Ta Ox |
|
.It Ic \&Dx Ta Dx |
|
.El |
|
.Sh MACRO REFERENCE |
This section is a canonical reference of all macros, arranged |
This section is a canonical reference of all macros, arranged |
alphabetically. |
alphabetically. |
For the scoping of individual macros, see |
For the scoping of individual macros, see |
.Sx MACRO SYNTAX . |
.Sx MACRO SYNTAX . |
.Ss \&%A |
.Bl -tag -width 3n |
|
.It Ic \&%A Ar first_name ... last_name |
Author name of an |
Author name of an |
.Sx \&Rs |
.Ic \&Rs |
block. |
block. |
Multiple authors should each be accorded their own |
Multiple authors should each be accorded their own |
.Sx \%%A |
.Ic \%%A |
line. |
line. |
Author names should be ordered with full or abbreviated forename(s) |
Author names should be ordered with full or abbreviated forename(s) |
first, then full surname. |
first, then full surname. |
.Ss \&%B |
.It Ic \&%B Ar title |
Book title of an |
Book title of an |
.Sx \&Rs |
.Ic \&Rs |
block. |
block. |
This macro may also be used in a non-bibliographic context when |
This macro may also be used in a non-bibliographic context when |
referring to book titles. |
referring to book titles. |
.Ss \&%C |
.It Ic \&%C Ar location |
Publication city or location of an |
Publication city or location of an |
.Sx \&Rs |
.Ic \&Rs |
block. |
block. |
.Pp |
.It Ic \&%D Oo Ar month day , Oc Ar year |
.Em Remarks : |
|
this macro is not implemented in |
|
.Xr groff 1 . |
|
.Ss \&%D |
|
Publication date of an |
Publication date of an |
.Sx \&Rs |
.Ic \&Rs |
block. |
block. |
This should follow the reduced or canonical form syntax described in |
Provide the full English name of the |
.Sx Dates . |
.Ar month |
.Ss \&%I |
and all four digits of the |
|
.Ar year . |
|
.It Ic \&%I Ar name |
Publisher or issuer name of an |
Publisher or issuer name of an |
.Sx \&Rs |
.Ic \&Rs |
block. |
block. |
.Ss \&%J |
.It Ic \&%J Ar name |
Journal name of an |
Journal name of an |
.Sx \&Rs |
.Ic \&Rs |
block. |
block. |
.Ss \&%N |
.It Ic \&%N Ar number |
Issue number (usually for journals) of an |
Issue number (usually for journals) of an |
.Sx \&Rs |
.Ic \&Rs |
block. |
block. |
.Ss \&%O |
.It Ic \&%O Ar line |
Optional information of an |
Optional information of an |
.Sx \&Rs |
.Ic \&Rs |
block. |
block. |
.Ss \&%P |
.It Ic \&%P Ar number |
Book or journal page number of an |
Book or journal page number of an |
.Sx \&Rs |
.Ic \&Rs |
block. |
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 |
Institutional author (school, government, etc.) of an |
.Sx \&Rs |
.Ic \&Rs |
block. |
block. |
Multiple institutional authors should each be accorded their own |
Multiple institutional authors should each be accorded their own |
.Sx \&%Q |
.Ic \&%Q |
line. |
line. |
.Ss \&%R |
.It Ic \&%R Ar name |
Technical report name of an |
Technical report name of an |
.Sx \&Rs |
.Ic \&Rs |
block. |
block. |
.Ss \&%T |
.It Ic \&%T Ar title |
Article title of an |
Article title of an |
.Sx \&Rs |
.Ic \&Rs |
block. |
block. |
This macro may also be used in a non-bibliographical context when |
This macro may also be used in a non-bibliographical context when |
referring to article titles. |
referring to article titles. |
.Ss \&%U |
.It Ic \&%U Ar protocol Ns :// Ns Ar path |
URI of reference document. |
URI of reference document. |
.Ss \&%V |
.It Ic \&%V Ar number |
Volume number of an |
Volume number of an |
.Sx \&Rs |
.Ic \&Rs |
block. |
block. |
.Ss \&Ac |
.It Ic \&Ac |
Close an |
Close an |
.Sx \&Ao |
.Ic \&Ao |
block. |
block. |
Does not have any tail arguments. |
Does not have any tail arguments. |
.Ss \&Ad |
.It Ic \&Ad Ar address |
Memory address. |
Memory address. |
Do not use this for postal addresses. |
Do not use this for postal addresses. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Ad [0,$] |
.Dl \&.Ad [0,$] |
.D1 \&.Ad 0x00000000 |
.Dl \&.Ad 0x00000000 |
.Ss \&An |
.It Ic \&An Fl split | nosplit | Ar first_name ... last_name |
Author 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. |
Requires either the name of an author or one of the following arguments: |
Requires either the name of an author or one of the following arguments: |
.Pp |
.Pp |
.Bl -tag -width "-nosplitX" -offset indent -compact |
.Bl -tag -width "-nosplitX" -offset indent -compact |
.It Fl split |
.It Fl split |
Start a new output line before each subsequent invocation of |
Start a new output line before each subsequent invocation of |
.Sx \&An . |
.Ic \&An . |
.It Fl nosplit |
.It Fl nosplit |
The opposite of |
The opposite of |
.Fl split . |
.Fl split . |
Line 973 for the first author listing and |
|
Line 670 for the first author listing and |
|
for all other author listings. |
for all other author listings. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.An -nosplit |
.Dl \&.An -nosplit |
.D1 \&.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. |
Begin a block enclosed by angle brackets. |
Does not have any head arguments. |
Does not have any head arguments. |
.Pp |
This macro is almost never useful. |
Examples: |
See |
.D1 \&.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. |
Inserts an apostrophe without any surrounding whitespace. |
This is generally used as a grammatical device when referring to the verb |
This is generally used as a grammatical device when referring to the verb |
form of a function. |
form of a function. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Fn execve \&Ap d |
.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 |
.Pp |
Examples: |
Occasionally, it is used for names of characters and keys, for example: |
.D1 \&.Fl -key= \&Ns \&Aq \&Ar val |
.Bd -literal -offset indent |
|
Press the |
|
\&.Aq escape |
|
key to ... |
|
.Ed |
.Pp |
.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 |
|
in |
|
.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 , |
or |
or |
.Sx \&Mt , |
.Ic \&Eo |
or to note pre-processor |
as needed. |
.Dq Li #include |
|
statements, which should use |
|
.Sx \&In . |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&Ao . |
.Ic \&Ao . |
.Ss \&Ar |
.It Ic \&Ar Op Ar placeholder ... |
Command arguments. |
Command arguments. |
If an argument is not provided, the string |
If an argument is not provided, the string |
.Dq file ...\& |
.Dq file ...\& |
is used as a default. |
is used as a default. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Fl o \&Ns \&Ar file1 |
.Dl ".Fl o Ar file" |
.D1 \&.Ar |
.Dl ".Ar" |
.D1 \&.Ar arg1 , arg2 . |
.Dl ".Ar arg1 , arg2 ." |
.Ss \&At |
.Pp |
Formats an AT&T version. |
The arguments to the |
|
.Ic \&Ar |
|
macro are names and placeholders for command arguments; |
|
for fixed strings to be passed verbatim as arguments, use |
|
.Ic \&Fl |
|
or |
|
.Ic \&Cm . |
|
.It Ic \&At Op Ar version |
|
Formats an |
|
.At |
|
version. |
Accepts one optional argument: |
Accepts one optional argument: |
.Pp |
.Pp |
.Bl -tag -width "v[1-7] | 32vX" -offset indent -compact |
.Bl -tag -width "v[1-7] | 32vX" -offset indent -compact |
.It Cm v[1-7] | 32v |
.It Cm v[1-7] | 32v |
A version of |
A version of |
.At . |
.At . |
.It Cm V[.[1-4]]? |
.It Cm III |
|
.At III . |
|
.It Cm V | V.[1-4] |
A version of |
A version of |
.At V . |
.At V . |
.El |
.El |
|
|
Note that these arguments do not begin with a hyphen. |
Note that these arguments do not begin with a hyphen. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.At |
.Dl \&.At |
.D1 \&.At V.1 |
.Dl \&.At III |
|
.Dl \&.At V.1 |
.Pp |
.Pp |
See also |
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 |
and |
.Sx \&Ux . |
.Ic \&Ox . |
.Ss \&Bc |
.It Ic \&Bc |
Close a |
Close a |
.Sx \&Bo |
.Ic \&Bo |
block. |
block. |
Does not have any tail arguments. |
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. |
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 |
Display blocks are used to select a different indentation and |
justification than the one used by the surrounding text. |
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. |
By default, a display block is preceded by a vertical space. |
.Pp |
.Pp |
The |
The |
|
|
must be one of the following: |
must be one of the following: |
.Bl -tag -width 13n -offset indent |
.Bl -tag -width 13n -offset indent |
.It Fl centered |
.It Fl centered |
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 |
Using this display type is not recommended; many |
.Nm |
.Nm |
implementations render it poorly. |
implementations render it poorly. |
.It Fl filled |
.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 |
.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. |
Preserve white space as it appears in the input. |
|
Always use a constant-width font. |
|
Use this for displaying source code. |
.It Fl ragged |
.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 |
.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 |
.El |
.Pp |
.Pp |
The |
The |
Line 1101 which may be one of the following: |
|
Line 833 which may be one of the following: |
|
.It |
.It |
One of the pre-defined strings |
One of the pre-defined strings |
.Cm indent , |
.Cm indent , |
the width of standard indentation; |
the width of a standard indentation (six constant width characters); |
.Cm indent-two , |
.Cm indent-two , |
twice |
twice |
.Cm indent ; |
.Cm indent ; |
Line 1110 which has no effect; |
|
Line 842 which has no effect; |
|
.Cm right , |
.Cm right , |
which justifies to the right margin; or |
which justifies to the right margin; or |
.Cm center , |
.Cm center , |
which aligns around an imagined centre axis. |
which aligns around an imagined center axis. |
.It |
.It |
A macro invocation, which selects a predefined width |
A macro invocation, which selects a predefined width |
associated with that macro. |
associated with that macro. |
Line 1119 The most popular is the imaginary macro |
|
Line 851 The most popular is the imaginary macro |
|
which resolves to |
which resolves to |
.Sy 6n . |
.Sy 6n . |
.It |
.It |
A width using the syntax described in |
A scaling width as described in |
.Sx Scaling Widths . |
.Xr roff 7 . |
.It |
.It |
An arbitrary string, which indents by the length of this string. |
An arbitrary string, which indents by the length of this string. |
.El |
.El |
|
|
.Ed |
.Ed |
.Pp |
.Pp |
See also |
See also |
.Sx \&D1 |
.Ic \&D1 |
and |
and |
.Sx \&Dl . |
.Ic \&Dl . |
.Ss \&Bf |
.It Ic \&Bf Fl emphasis | literal | symbolic | Cm \&Em | \&Li | \&Sy |
Change the font mode for a scoped block of text. |
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 |
The |
.Fl emphasis |
.Fl emphasis |
and |
and |
|
|
argument are equivalent, as are |
argument are equivalent, as are |
.Fl symbolic |
.Fl symbolic |
and |
and |
.Cm \&Sy, |
.Cm \&Sy , |
and |
and |
.Fl literal |
.Fl literal |
and |
and |
|
|
Without an argument, this macro does nothing. |
Without an argument, this macro does nothing. |
The font mode continues until broken by a new font mode in a nested |
The font mode continues until broken by a new font mode in a nested |
scope or |
scope or |
.Sx \&Ef |
.Ic \&Ef |
is encountered. |
is encountered. |
.Pp |
.Pp |
See also |
See also |
.Sx \&Li , |
.Ic \&Li , |
.Sx \&Ef , |
.Ic \&Ef , |
.Sx \&Em , |
.Ic \&Em , |
and |
and |
.Sx \&Sy . |
.Ic \&Sy . |
.Ss \&Bk |
.It Ic \&Bk Fl words |
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. |
The syntax is as follows: |
Line breaks in text lines are unaffected. |
.Pp |
.Pp |
.D1 Pf \. Sx \&Bk Fl words |
|
.Pp |
|
The |
The |
.Fl words |
.Fl words |
argument is required; additional arguments are ignored. |
argument is required; additional arguments are ignored. |
.Pp |
.Pp |
The following example will not break within each |
The following example will not break within each |
.Sx \&Op |
.Ic \&Op |
macro line: |
macro line: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.Bk \-words |
\&.Bk \-words |
|
|
.Pp |
.Pp |
Be careful in using over-long lines within a keep block! |
Be careful in using over-long lines within a keep block! |
Doing so will clobber the right margin. |
Doing so will clobber the right margin. |
.Ss \&Bl |
.It Xo |
Begin a list. |
.Ic \&Bl |
Lists consist of items started by 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 |
.Fl Ns Ar type |
.Op Fl width Ar val |
.Op Fl width Ar val |
.Op Fl offset Ar val |
.Op Fl offset Ar val |
.Op Fl compact |
.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 |
.Pp |
The list |
The list |
.Ar type |
.Ar type |
|
|
.Fl width |
.Fl width |
and |
and |
.Fl offset |
.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. |
or use the length of the given string. |
The |
The |
.Fl offset |
.Fl offset |
|
|
A columnated list. |
A columnated list. |
The |
The |
.Fl width |
.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 |
If the first line of the body of a |
.Fl column |
.Fl column |
list is not an |
list is not an |
.Sx \&It |
.Ic \&It |
macro line, |
macro line, |
.Sx \&It |
.Ic \&It |
contexts spanning one input line each are implied until an |
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 |
macro line is encountered, at which point items start being interpreted as |
described in the |
described in the |
.Sx \&It |
.Ic \&It |
documentation. |
documentation. |
.It Fl dash |
.It Fl dash |
Like |
Like |
Line 1277 except that dashes are used in place of bullets. |
|
Line 997 except that dashes are used in place of bullets. |
|
Like |
Like |
.Fl inset , |
.Fl inset , |
except that item heads are not parsed for macro invocations. |
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 |
.It Fl enum |
A numbered list. |
A numbered list. |
|
No item heads can be specified. |
Formatted like |
Formatted like |
.Fl bullet , |
.Fl bullet , |
except that cardinal numbers are used in place of bullets, |
except that cardinal numbers are used in place of bullets, |
Line 1319 this head on the same output line. |
|
Line 1042 this head on the same output line. |
|
Otherwise, the body starts on the output line following the head. |
Otherwise, the body starts on the output line following the head. |
.El |
.El |
.Pp |
.Pp |
|
Lists may be nested within lists and displays. |
|
Nesting of |
|
.Fl column |
|
and |
|
.Fl enum |
|
lists may not be portable. |
|
.Pp |
See also |
See also |
.Sx \&El |
.Ic \&El |
and |
and |
.Sx \&It . |
.Ic \&It . |
.Ss \&Bo |
.It Ic \&Bo Ar block |
Begin a block enclosed by square brackets. |
Begin a block enclosed by square brackets. |
Does not have any head arguments. |
Does not have any head arguments. |
.Pp |
.Pp |
|
|
.Ed |
.Ed |
.Pp |
.Pp |
See also |
See also |
.Sx \&Bq . |
.Ic \&Bq . |
.Ss \&Bq |
.It Ic \&Bq Ar line |
Encloses its arguments in square brackets. |
Encloses its arguments in square brackets. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Bq 1 , \&Dv BUFSIZ |
.Dl \&.Bq 1 , \&Dv BUFSIZ |
.Pp |
.Pp |
.Em Remarks : |
.Em Remarks : |
this macro is sometimes abused to emulate optional arguments for |
this macro is sometimes abused to emulate optional arguments for |
commands; the correct macros to use for this purpose are |
commands; the correct macros to use for this purpose are |
.Sx \&Op , |
.Ic \&Op , |
.Sx \&Oo , |
.Ic \&Oo , |
and |
and |
.Sx \&Oc . |
.Ic \&Oc . |
.Pp |
.Pp |
See also |
See also |
.Sx \&Bo . |
.Ic \&Bo . |
.Ss \&Brc |
.It Ic \&Brc |
Close a |
Close a |
.Sx \&Bro |
.Ic \&Bro |
block. |
block. |
Does not have any tail arguments. |
Does not have any tail arguments. |
.Ss \&Bro |
.It Ic \&Bro Ar block |
Begin a block enclosed by curly braces. |
Begin a block enclosed by curly braces. |
Does not have any head arguments. |
Does not have any head arguments. |
.Pp |
.Pp |
|
|
.Ed |
.Ed |
.Pp |
.Pp |
See also |
See also |
.Sx \&Brq . |
.Ic \&Brq . |
.Ss \&Brq |
.It Ic \&Brq Ar line |
Encloses its arguments in curly braces. |
Encloses its arguments in curly braces. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Brq 1 , ... , \&Va n |
.Dl \&.Brq 1 , ... , \&Va n |
.Pp |
.Pp |
See also |
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. |
no argument is provided. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Bsx 1.0 |
.Dl \&.Bsx 1.0 |
.D1 \&.Bsx |
.Dl \&.Bsx |
.Pp |
.Pp |
See also |
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 |
and |
.Sx \&Ux . |
.Ic \&Ox . |
.Ss \&Bt |
.It Ic \&Bt |
|
Supported only for compatibility, do not use this in new manuals. |
Prints |
Prints |
.Dq is currently in beta test. |
.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. |
argument is provided. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Bx 4.4 |
.Dl \&.Bx 4.3 Tahoe |
.D1 \&.Bx |
.Dl \&.Bx 4.4 |
|
.Dl \&.Bx |
.Pp |
.Pp |
See also |
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 |
and |
.Sx \&Ux . |
.Ic \&Ox . |
.Ss \&Cd |
.It Ic \&Cd Ar line |
Kernel configuration declaration. |
Kernel configuration declaration. |
This denotes strings accepted by |
This denotes strings accepted by |
.Xr config 8 . |
.Xr config 8 . |
|
It is most often used in section 4 manual pages. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Cd device le0 at scode? |
.Dl \&.Cd device le0 at scode? |
.Pp |
.Pp |
.Em Remarks : |
.Em Remarks : |
this macro is commonly abused by using quoted literals to retain |
this macro is commonly abused by using quoted literals to retain |
whitespace and align consecutive |
whitespace and align consecutive |
.Sx \&Cd |
.Ic \&Cd |
declarations. |
declarations. |
This practise is discouraged. |
This practise is discouraged. |
.Ss \&Cm |
.It Ic \&Cm Ar keyword ... |
Command modifiers. |
Command modifiers. |
Useful when specifying configuration options or keys. |
Typically used for fixed strings passed as arguments to interactive |
|
commands, to commands in interpreted scripts, or to configuration |
|
file directives, unless |
|
.Ic \&Fl |
|
is more appropriate. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Cm ControlPath |
.Dl ".Nm mt Fl f Ar device Cm rewind" |
.D1 \&.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 ".Ic set Fl o Cm vi" |
.Sx \&Fl . |
.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. |
One-line indented display. |
This is formatted by the default rules and is useful for simple indented |
This is formatted by the default rules and is useful for simple indented |
statements. |
statements. |
It is followed by a newline. |
It is followed by a newline. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.D1 \&Fl abcdefgh |
.Dl \&.D1 \&Fl abcdefgh |
.Pp |
.Pp |
See also |
See also |
.Sx \&Bd |
.Ic \&Bd |
and |
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 |
Close a |
.Sx \&Do |
.Ic \&Do |
block. |
block. |
Does not have any tail arguments. |
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 |
This is the mandatory first macro of any |
.Nm |
.Nm |
manual. |
manual. |
Its syntax is as follows: |
|
.Pp |
.Pp |
.D1 Pf \. Sx \&Dd Op Ar date |
|
.Pp |
|
The |
The |
.Ar date |
.Ar month |
may be either |
is the full English month name, the |
.Ar $\&Mdocdate$ , |
.Ar day |
which signifies the current manual revision date dictated by |
is an integer number, and the |
|
.Ar year |
|
is the full four-digit year. |
|
.Pp |
|
Other arguments are not portable; the |
|
.Xr mandoc 1 |
|
utility handles them as follows: |
|
.Bl -dash -offset 3n -compact |
|
.It |
|
To have the date automatically filled in by the |
|
.Ox |
|
version of |
.Xr cvs 1 , |
.Xr cvs 1 , |
or instead a valid canonical date as specified by |
the special string |
.Sx Dates . |
.Dq $\&Mdocdate$ |
If a date does not conform or is empty, the current date is used. |
can be given as an argument. |
|
.It |
|
The traditional, purely numeric |
|
.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 |
|
If no date string is given, the current date is used. |
|
.El |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Dd $\&Mdocdate$ |
.Dl \&.Dd $\&Mdocdate$ |
.D1 \&.Dd $\&Mdocdate: July 21 2007$ |
.Dl \&.Dd $\&Mdocdate: July 2 2018$ |
.D1 \&.Dd July 21, 2007 |
.Dl \&.Dd July 2, 2018 |
.Pp |
.Pp |
See also |
See also |
.Sx \&Dt |
.Ic \&Dt |
and |
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 |
This is formatted as literal text and is useful for commands and |
invocations. |
invocations. |
It is followed by a newline. |
It is followed by a newline. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Dl % mandoc mdoc.7 \e(ba less |
.Dl \&.Dl % mandoc mdoc.7 \e(ba less |
.Pp |
.Pp |
See also |
See also |
.Sx \&Bd |
.Ic \&Ql , |
|
.Ic \&Bd Fl literal , |
and |
and |
.Sx \&D1 . |
.Ic \&D1 . |
.Ss \&Do |
.It Ic \&Do Ar block |
Begin a block enclosed by double quotes. |
Begin a block enclosed by double quotes. |
Does not have any head arguments. |
Does not have any head arguments. |
.Pp |
.Pp |
Line 1517 April is the cruellest month |
|
Line 1277 April is the cruellest month |
|
.Ed |
.Ed |
.Pp |
.Pp |
See also |
See also |
.Sx \&Dq . |
.Ic \&Dq . |
.Ss \&Dq |
.It Ic \&Dq Ar line |
Encloses its arguments in |
Encloses its arguments in |
.Dq typographic |
.Dq typographic |
double-quotes. |
double-quotes. |
|
|
.Ed |
.Ed |
.Pp |
.Pp |
See also |
See also |
.Sx \&Qq , |
.Ic \&Qq , |
.Sx \&Sq , |
.Ic \&Sq , |
and |
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 |
This is the mandatory second macro of any |
.Nm |
.Nm |
file. |
file. |
Its syntax is as follows: |
|
.Bd -ragged -offset indent |
|
.Pf \. Sx \&Dt |
|
.Oo |
|
.Ar title |
|
.Oo |
|
.Ar section |
|
.Op Ar volume | arch |
|
.Oc |
|
.Oc |
|
.Ed |
|
.Pp |
.Pp |
Its arguments are as follows: |
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 |
The document's title (name), defaulting to |
.Dq UNKNOWN |
.Dq UNTITLED |
if unspecified. |
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 |
.It Ar section |
The manual section. |
The manual section. |
This may be one of |
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 , |
|
or |
or |
.Ar paper |
.Cm 9 |
.Pq paper . |
.Pq Kernel Developer's Manual . |
It should correspond to the manual's filename suffix and defaults to |
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 , |
|
or |
|
.Ar CON |
|
.Pq contributed manuals . |
|
.It Ar arch |
.It Ar arch |
This specifies a specific relevant architecture. |
This specifies the machine architecture a manual page applies to, |
If |
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 mvme68k , |
|
.Ar mvme88k , |
|
.Ar mvmeppc , |
|
.Ar pmax , |
|
.Ar sgi , |
|
.Ar socppc , |
|
.Ar sparc , |
|
.Ar sparc64 , |
|
.Ar sun3 , |
|
.Ar vax , |
|
or |
or |
.Ar zaurus . |
.Cm sparc64 . |
|
The list of valid architectures varies by operating system. |
.El |
.El |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Dt FOO 1 |
.Dl \&.Dt FOO 1 |
.D1 \&.Dt FOO 4 KM |
.Dl \&.Dt FOO 9 i386 |
.D1 \&.Dt FOO 9 i386 |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&Dd |
.Ic \&Dd |
and |
and |
.Sx \&Os . |
.Ic \&Os . |
.Ss \&Dv |
.It Ic \&Dv Ar identifier ... |
Defined variables such as preprocessor constants. |
Defined variables such as preprocessor constants, constant symbols, |
|
enumeration values, and so on. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Dv BUFSIZ |
.Dl \&.Dv NULL |
.D1 \&.Dv STDOUT_FILENO |
.Dl \&.Dv BUFSIZ |
|
.Dl \&.Dv STDOUT_FILENO |
.Pp |
.Pp |
See also |
See also |
.Sx \&Er . |
.Ic \&Er |
.Ss \&Dx |
and |
Format the DragonFly BSD version provided as an argument, or a default |
.Ic \&Ev |
|
for special-purpose constants, |
|
.Ic \&Va |
|
for variable symbols, and |
|
.Ic \&Fd |
|
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. |
value if no argument is provided. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Dx 2.4.1 |
.Dl \&.Dx 2.4.1 |
.D1 \&.Dx |
.Dl \&.Dx |
.Pp |
.Pp |
See also |
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 |
and |
.Sx \&Ux . |
.Ic \&Ox . |
.Ss \&Ec |
.It Ic \&Ec Op Ar closing_delimiter |
Close a scope started by |
Close a scope started by |
.Sx \&Eo . |
.Ic \&Eo . |
Its syntax is as follows: |
|
.Pp |
.Pp |
.D1 Pf \. Sx \&Ec Op Ar TERM |
|
.Pp |
|
The |
The |
.Ar TERM |
.Ar closing_delimiter |
argument is used as the enclosure tail, for example, specifying \e(rq |
argument is used as the enclosure tail, for example, specifying \e(rq |
will emulate |
will emulate |
.Sx \&Dc . |
.Ic \&Dc . |
.Ss \&Ed |
.It Ic \&Ed |
End a display context started by |
End a display context started by |
.Sx \&Bd . |
.Ic \&Bd . |
.Ss \&Ef |
.It Ic \&Ef |
End a font mode context started by |
End a font mode context started by |
.Sx \&Bf . |
.Ic \&Bf . |
.Ss \&Ek |
.It Ic \&Ek |
End a keep context started by |
End a keep context started by |
.Sx \&Bk . |
.Ic \&Bk . |
.Ss \&El |
.It Ic \&El |
End a list context started by |
End a list context started by |
.Sx \&Bl . |
.Ic \&Bl . |
.Pp |
|
See also |
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 |
and |
.Sx \&It . |
.Ic \&Ar |
.Ss \&Em |
are preferred, respectively. |
Denotes text that should be emphasised. |
|
Note that this is a presentation term and should not be used for |
|
stylistically decorating technical terms. |
|
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Em Warnings! |
.Bd -literal -compact -offset indent |
.D1 \&.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 |
.Pp |
See also |
See also |
.Sx \&Bf , |
.Ic \&No , |
.Sx \&Sy , |
.Ic \&Ql , |
and |
and |
.Sx \&Li . |
.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 |
.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 |
The |
.Ar TERM |
.Ar opening_delimiter |
argument is used as the enclosure head, for example, specifying \e(lq |
argument is used as the enclosure head, for example, specifying \e(lq |
will emulate |
will emulate |
.Sx \&Do . |
.Ic \&Do . |
.Ss \&Er |
.It Ic \&Er Ar identifier ... |
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 |
.Pp |
Examples: |
Examples: |
.D1 \&.Er EPERM |
.Dl \&.Er EPERM |
.D1 \&.Er ENOENT |
.Dl \&.Er ENOENT |
.Pp |
.Pp |
See also |
See also |
.Sx \&Dv . |
.Ic \&Dv |
.Ss \&Es |
for general constants. |
This macro is obsolete and not implemented. |
.It Ic \&Es Ar opening_delimiter closing_delimiter |
.Ss \&Ev |
This macro is obsolete. |
|
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 |
Environmental variables such as those specified in |
.Xr environ 7 . |
.Xr environ 7 . |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Ev DISPLAY |
.Dl \&.Ev DISPLAY |
.D1 \&.Ev PATH |
.Dl \&.Ev PATH |
.Ss \&Ex |
|
Insert a standard sentence regarding exit values. |
|
Its syntax is as follows: |
|
.Pp |
.Pp |
.D1 Pf \. Sx \&Ex Fl std Op Ar utility |
See also |
|
.Ic \&Dv |
|
for general constants. |
|
.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. |
.Pp |
.Pp |
When |
If |
.Ar utility |
.Ar utility |
is not specified, the document's name set by |
is not specified, the document's name set by |
.Sx \&Nm |
.Ic \&Nm |
is used. |
is used. |
|
Multiple |
|
.Ar utility |
|
arguments are treated as separate utilities. |
.Pp |
.Pp |
See also |
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 |
.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 |
Most often, the |
.Sx \&Fa |
.Ic \&Fa |
macro is used in the |
macro is used in the |
.Em SYNOPSIS |
.Em SYNOPSIS |
within |
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 |
If invoked with multiple arguments, the arguments are separated by a |
comma. |
comma. |
Furthermore, if the following macro is another |
Furthermore, if the following macro is another |
.Sx \&Fa , |
.Ic \&Fa , |
the last argument will also have a trailing comma. |
the last argument will also have a trailing comma. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Fa \(dqconst char *p\(dq |
.Dl \&.Fa \(dqconst char *p\(dq |
.D1 \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq |
.Dl \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq |
.D1 \&.Fa foo |
.Dl \&.Fa \(dqchar *\(dq size_t |
.Pp |
.Pp |
See also |
See also |
.Sx \&Fo . |
.Ic \&Fo . |
.Ss \&Fc |
.It Ic \&Fc |
End a function context started by |
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 |
.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 |
See also |
.Sx MANUAL STRUCTURE |
.Sx MANUAL STRUCTURE , |
|
.Ic \&In , |
and |
and |
.Sx \&In . |
.Ic \&Dv . |
.Ss \&Fl |
.It Ic \&Fl Op Ar word ... |
Command-line flag. |
Command-line flag or option. |
Used when listing arguments to command-line utilities. |
Used when listing arguments to command-line utilities. |
Prints a fixed-width hyphen |
For each argument, prints an ASCII hyphen-minus character |
.Sq \- |
.Sq \- , |
directly followed by each argument. |
immediately followed by the argument. |
If no arguments are provided, a hyphen is printed followed by a space. |
If no arguments are provided, a hyphen-minus is printed followed by a space. |
If the argument is a macro, a hyphen is prefixed to the subsequent macro |
If the argument is a macro, a hyphen-minus is prefixed |
output. |
to the subsequent macro output. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Fl a b c |
.Dl ".Nm du Op Fl H | L | P" |
.D1 \&.Fl \&Pf a b |
.Dl ".Nm ls Op Fl 1AaCcdFfgHhikLlmnopqRrSsTtux" |
.D1 \&.Fl |
.Dl ".Nm route Cm add Fl inet Ar destination gateway" |
.D1 \&.Op \&Fl o \&Ns \&Ar file |
.Dl ".Nm locate.updatedb Op Fl \e-fcodes Ns = Ns Ar dbfile" |
|
.Dl ".Nm aucat Fl o Fl" |
|
.Dl ".Nm kill Fl Ar signal_number" |
.Pp |
.Pp |
|
For GNU-sytle long options, escaping the additional hyphen-minus is not |
|
strictly required, but may be safer with future versions of GNU troff; see |
|
.Xr mandoc_char 7 |
|
for details. |
|
.Pp |
See also |
See also |
.Sx \&Cm . |
.Ic \&Cm . |
.Ss \&Fn |
.It Ic \&Fn Ar funcname Op Ar argument ... |
A function name. |
A function name. |
Its syntax is as follows: |
|
.Bd -ragged -offset indent |
|
.Pf \. Ns Sx \&Fn |
|
.Op Cm functype |
|
.Cm funcname |
|
.Op Oo Cm argtype Oc Cm argname |
|
.Ed |
|
.Pp |
.Pp |
Function arguments are surrounded in parenthesis and |
Function arguments are surrounded in parenthesis and |
are delimited by commas. |
are delimited by commas. |
If no arguments are specified, blank parenthesis are output. |
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 |
.Pp |
Examples: |
Examples: |
.D1 \&.Fn "int funcname" "int arg0" "int arg1" |
.Dl \&.Fn \(dqint funcname\(dq \(dqint arg0\(dq \(dqint arg1\(dq |
.D1 \&.Fn funcname "int arg0" |
.Dl \&.Fn funcname \(dqint arg0\(dq |
.D1 \&.Fn funcname arg0 |
.Dl \&.Fn funcname arg0 |
.Bd -literal -offset indent -compact |
.Bd -literal -offset indent |
\&.Ft functype |
\&.Ft functype |
\&.Fn funcname |
\&.Fn funcname |
.Ed |
.Ed |
.Pp |
.Pp |
|
When referring to a function documented in another manual page, use |
|
.Ic \&Xr |
|
instead. |
See also |
See also |
.Sx MANUAL STRUCTURE |
.Sx MANUAL STRUCTURE , |
|
.Ic \&Fo , |
and |
and |
.Sx \&Ft . |
.Ic \&Ft . |
.Ss \&Fo |
.It Ic \&Fo Ar funcname |
Begin a function block. |
Begin a function block. |
This is a multi-line version of |
This is a multi-line version of |
.Sx \&Fn . |
.Ic \&Fn . |
Its syntax is as follows: |
|
.Pp |
.Pp |
.D1 Pf \. Sx \&Fo Cm funcname |
|
.Pp |
|
Invocations usually occur in the following context: |
Invocations usually occur in the following context: |
.Bd -ragged -offset indent |
.Bd -ragged -offset indent |
.Pf \. Sx \&Ft Cm functype |
.Pf \. Ic \&Ft Ar functype |
.br |
.br |
.Pf \. Sx \&Fo Cm funcname |
.Pf \. Ic \&Fo Ar funcname |
.br |
.br |
.Pf \. Sx \&Fa Oo Cm argtype Oc Cm argname |
.Pf \. Ic \&Fa Qq Ar argtype Ar argname |
.br |
.br |
\.\.\. |
\&.\.\. |
.br |
.br |
.Pf \. Sx \&Fc |
.Pf \. Ic \&Fc |
.Ed |
.Ed |
.Pp |
.Pp |
A |
A |
.Sx \&Fo |
.Ic \&Fo |
scope is closed by |
scope is closed by |
|
.Ic \&Fc . |
.Pp |
.Pp |
See also |
See also |
.Sx MANUAL STRUCTURE , |
.Sx MANUAL STRUCTURE , |
.Sx \&Fa , |
.Ic \&Fa , |
.Sx \&Fc , |
.Ic \&Fc , |
and |
and |
.Sx \&Ft . |
.Ic \&Ft . |
.Ss \&Ft |
.It Ic \&Fr Ar number |
|
This macro is obsolete. |
|
No replacement markup is needed. |
|
.Pp |
|
It was used to show numerical function return values in an italic font. |
|
.It Ic \&Ft Ar functype |
A function type. |
A function type. |
Its syntax is as follows: |
|
.Pp |
.Pp |
.D1 Pf \. Sx \&Ft Cm functype |
In the |
|
.Em SYNOPSIS |
|
section, a new output line is started after this macro. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Ft int |
.Dl \&.Ft int |
.Bd -literal -offset indent -compact |
.Bd -literal -offset indent -compact |
\&.Ft functype |
\&.Ft functype |
\&.Fn funcname |
\&.Fn funcname |
|
|
.Pp |
.Pp |
See also |
See also |
.Sx MANUAL STRUCTURE , |
.Sx MANUAL STRUCTURE , |
.Sx \&Fn , |
.Ic \&Fn , |
and |
and |
.Sx \&Fo . |
.Ic \&Fo . |
.Ss \&Fx |
.It Ic \&Fx Op Ar version |
Format the FreeBSD version provided as an argument, or a default value |
Format the |
|
.Fx |
|
version provided as an argument, or a default value |
if no argument is provided. |
if no argument is provided. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Fx 7.1 |
.Dl \&.Fx 7.1 |
.D1 \&.Fx |
.Dl \&.Fx |
.Pp |
.Pp |
See also |
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 |
and |
.Sx \&Ux . |
.Ic \&Ox . |
.Ss \&Hf |
.It Ic \&Hf Ar filename |
This macro is obsolete and not implemented. |
This macro is not implemented in |
.Ss \&Ic |
.Xr mandoc 1 . |
Designate an internal or interactive command. |
It was used to include the contents of a (header) file literally. |
This is similar to |
.It Ic \&Ic Ar keyword ... |
.Sx \&Cm |
Internal or interactive command, or configuration instruction |
but used for instructions rather than values. |
in a configuration file. |
|
See also |
|
.Ic \&Cm . |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Ic hash |
.Dl \&.Ic :wq |
.D1 \&.Ic alias |
.Dl \&.Ic hash |
|
.Dl \&.Ic alias |
.Pp |
.Pp |
Note that using |
Note that using |
.Sx \&Bd No Fl literal |
.Ic \&Ql , |
|
.Ic \&Dl , |
or |
or |
.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 |
An |
The name of an include file. |
.Dq include |
This macro is most often used in section 2, 3, and 9 manual pages. |
file. |
.Pp |
In the |
When invoked as the first macro on an input line in the |
.Em SYNOPSIS |
.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 , |
.Qq #include , |
the arguments is enclosed in angle brackets. |
and a blank line is inserted in front if there is a preceding |
|
function declaration. |
|
In other sections, it only encloses its argument in angle brackets |
|
and causes no line break. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.In sys/types |
.Dl \&.In sys/types.h |
.Pp |
.Pp |
See also |
See also |
.Sx MANUAL STRUCTURE . |
.Sx MANUAL STRUCTURE . |
.Ss \&It |
.It Ic \&It Op Ar head |
A list item. |
A list item. |
The syntax of this macro depends on the list type. |
The syntax of this macro depends on the list type. |
.Pp |
.Pp |
|
|
.Fl diag |
.Fl diag |
have the following syntax: |
have the following syntax: |
.Pp |
.Pp |
.D1 Pf \. Sx \&It Cm args |
.D1 Pf \. Ic \&It Ar args |
.Pp |
.Pp |
Lists of type |
Lists of type |
.Fl bullet , |
.Fl bullet , |
|
|
.Fl item |
.Fl item |
have the following syntax: |
have the following syntax: |
.Pp |
.Pp |
.D1 Pf \. Sx \&It |
.D1 Pf \. Ic \&It |
.Pp |
.Pp |
with subsequent lines interpreted within the scope of the |
with subsequent lines interpreted within the scope of the |
.Sx \&It |
.Ic \&It |
until either a closing |
until either a closing |
.Sx \&El |
.Ic \&El |
or another |
or another |
.Sx \&It . |
.Ic \&It . |
.Pp |
.Pp |
The |
The |
.Fl tag |
.Fl tag |
list has the following syntax: |
list has the following syntax: |
.Pp |
.Pp |
.D1 Pf \. Sx \&It Op Cm args |
.D1 Pf \. Ic \&It Op Cm args |
.Pp |
.Pp |
Subsequent lines are interpreted as with |
Subsequent lines are interpreted as with |
.Fl bullet |
.Fl bullet |
|
|
list is the most complicated. |
list is the most complicated. |
Its syntax is as follows: |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 Pf \. Sx \&It Op Cm args |
.D1 Pf \. Ic \&It Ar cell Op Ic \&Ta Ar cell ... |
|
.D1 Pf \. Ic \&It Ar cell Op <TAB> Ar cell ... |
.Pp |
.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 the special |
delimited by tabs or the special |
.Ic \&Ta |
.Sq \&Ta |
block macro or by literal tab characters. |
pseudo-macro. |
|
Lines subsequent the |
|
.Sx \&It |
|
are interpreted within the scope of the last phrase. |
|
Calling the pseudo-macro |
|
.Sq \&Ta |
|
will open a new phrase scope (this must occur on a macro line to be |
|
interpreted as a macro). |
|
Note that the tab phrase delimiter may only be used within the |
|
.Sx \&It |
|
line itself. |
|
Subsequent this, only the |
|
.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 |
.Pp |
.D1 .It \(dqcol1 ; <TAB> col2 ;\(dq \&; |
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 |
.Pp |
will preserve the semicolon whitespace except for the last. |
The tab cell delimiter may only be used within the |
|
.Ic \&It |
|
line itself; on following lines, only the |
|
.Ic \&Ta |
|
macro can be used to delimit cells, and portability requires that |
|
.Ic \&Ta |
|
is called by other macros: some parsers do not recognize it when |
|
it appears as the first macro on a line. |
.Pp |
.Pp |
|
Note that quoted strings may span tab-delimited cells on an |
|
.Ic \&It |
|
line. |
|
For example, |
|
.Pp |
|
.Dl .It \(dqcol1 ,\& <TAB> col2 ,\(dq \&; |
|
.Pp |
|
will preserve the whitespace before both commas, |
|
but not the whitespace before the semicolon. |
|
.Pp |
See also |
See also |
.Sx \&Bl . |
.Ic \&Bl . |
.Ss \&Lb |
.It Ic \&Lb Cm lib Ns Ar name |
Specify a library. |
Specify a library. |
The syntax is as follows: |
|
.Pp |
.Pp |
.D1 Pf \. Sx \&Lb Cm library |
|
.Pp |
|
The |
The |
.Cm library |
.Ar name |
parameter may be a system library, such as |
parameter may be a system library, such as |
.Cm libz |
.Cm z |
or |
or |
.Cm libpam , |
.Cm pam , |
in which case a small library description is printed next to the linker |
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 |
invocation; or a custom library, in which case the library name is |
printed in quotes. |
printed in quotes. |
Line 2081 section as described in |
|
Line 1839 section as described in |
|
.Sx MANUAL STRUCTURE . |
.Sx MANUAL STRUCTURE . |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Lb libz |
.Dl \&.Lb libz |
.D1 \&.Lb mdoc |
.Dl \&.Lb libmandoc |
.Ss \&Li |
.It Ic \&Li Ar word ... |
Denotes text that should be in a literal font mode. |
Request a typewriter (literal) font. |
Note that this is a presentation term and should not be used for |
Deprecated because on terminal output devices, this is usually |
stylistically decorating technical terms. |
indistinguishable from normal text. |
.Pp |
For literal displays, use |
See also |
.Ic \&Ql Pq in-line , |
.Sx \&Bf , |
.Ic \&Dl Pq single line , |
.Sx \&Sy , |
or |
and |
.Ic \&Bd Fl literal Pq multi-line |
.Sx \&Em . |
instead. |
.Ss \&Lk |
.It Ic \&Lk Ar uri Op Ar display_name |
Format a hyperlink. |
Format a hyperlink. |
Its syntax is as follows: |
|
.Pp |
.Pp |
.D1 Pf \. Sx \&Lk Cm uri Op Cm name |
|
.Pp |
|
Examples: |
Examples: |
.D1 \&.Lk http://bsd.lv "The BSD.lv Project" |
.Dl \&.Lk https://bsd.lv \(dqThe BSD.lv Project\(dq |
.D1 \&.Lk http://bsd.lv |
.Dl \&.Lk https://bsd.lv |
.Pp |
.Pp |
See also |
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. |
Display a mathematical symbol. |
Its syntax is as follows: |
|
.Pp |
.Pp |
.D1 Pf \. Sx \&Ms Cm symbol |
|
.Pp |
|
Examples: |
Examples: |
.D1 \&.Ms sigma |
.Dl \&.Ms sigma |
.D1 \&.Ms aleph |
.Dl \&.Ms aleph |
.Ss \&Mt |
.It Ic \&Mt Ar localpart Ns @ Ns Ar domain |
Format a |
Format a |
.Dq mailto: |
.Dq mailto: |
hyperlink. |
hyperlink. |
Its syntax is as follows: |
|
.Pp |
.Pp |
.D1 Pf \. Sx \&Mt Cm address |
|
.Pp |
|
Examples: |
Examples: |
.D1 \&.Mt discuss@manpages.bsd.lv |
.Dl \&.Mt discuss@manpages.bsd.lv |
.Ss \&Nd |
.Dl \&.An Kristaps Dzonsons \&Aq \&Mt kristaps@bsd.lv |
A one-line description of the manual's content. |
.It Ic \&Nd Ar line |
This may only be invoked in the |
A one line description of the manual's content. |
.Em SYNOPSIS |
This is the mandatory last macro of the |
section subsequent the |
.Em NAME |
.Sx \&Nm |
section and not appropriate for other sections. |
macro. |
|
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Sx \&Nd mdoc language reference |
.Dl Pf . Ic \&Nd mdoc language reference |
.D1 \&.Sx \&Nd format and display UNIX manuals |
.Dl Pf . Ic \&Nd format and display UNIX manuals |
.Pp |
.Pp |
The |
The |
.Sx \&Nd |
.Ic \&Nd |
macro technically accepts child macros and terminates with a subsequent |
macro technically accepts child macros and terminates with a subsequent |
.Sx \&Sh |
.Ic \&Sh |
invocation. |
invocation. |
Do not assume this behaviour: some |
Do not assume this behaviour: some |
.Xr whatis 1 |
.Xr whatis 1 |
Line 2150 database generators are not smart enough to parse more |
|
Line 1898 database generators are not smart enough to parse more |
|
arguments and will display macros verbatim. |
arguments and will display macros verbatim. |
.Pp |
.Pp |
See also |
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, |
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 |
and 8 pages \(em of an additional command or feature documented in |
the manual page. |
the manual page. |
When first invoked, the |
When first invoked, the |
.Sx \&Nm |
.Ic \&Nm |
macro expects a single argument, the name of the manual page. |
macro expects a single argument, the name of the manual page. |
Usually, the first invocation happens in the |
Usually, the first invocation happens in the |
.Em NAME |
.Em NAME |
Line 2164 section of the page. |
|
Line 1912 section of the page. |
|
The specified name will be remembered and used whenever the macro is |
The specified name will be remembered and used whenever the macro is |
called again without arguments later in the page. |
called again without arguments later in the page. |
The |
The |
.Sx \&Nm |
.Ic \&Nm |
macro uses |
macro uses |
.Sx Block full-implicit |
.Sx Block full-implicit |
semantics when invoked as the first macro on an input line in the |
semantics when invoked as the first macro on an input line in the |
|
|
In the |
In the |
.Em SYNOPSIS |
.Em SYNOPSIS |
of section 2, 3 and 9 manual pages, use the |
of section 2, 3 and 9 manual pages, use the |
.Sx \&Fn |
.Ic \&Fn |
macro rather than |
macro rather than |
.Sx \&Nm |
.Ic \&Nm |
to mark up the name of the manual page. |
to mark up the name of the manual page. |
.Ss \&No |
.It Ic \&No Ar word ... |
A |
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 |
|
.Ic \&Em |
|
or |
|
.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 |
.Pp |
Examples: |
Examples: |
.D1 \&.Sx \&Fl ab \&No cd \&Fl ef |
.Dl ".Em italic , Sy bold , No and roman" |
.Ss \&Ns |
.Bd -literal -offset indent |
Suppress a space. |
\&.Sm off |
Following invocation, text is interpreted as free-form text until a |
\&.Cm :C No / Ar pattern No / Ar replacement No / |
macro is encountered. |
\&.Sm on |
|
.Ed |
.Pp |
.Pp |
|
See also |
|
.Ic \&Em , |
|
.Ic \&Ql , |
|
and |
|
.Ic \&Sy . |
|
.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 |
|
.Ic \&No |
|
macro. |
|
.Pp |
|
This has no effect when invoked at the start of a macro line. |
|
.Pp |
Examples: |
Examples: |
.D1 \&.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 |
.Pp |
See also |
See also |
.Sx \&No |
.Ic \&No |
and |
and |
.Sx \&Sm . |
.Ic \&Sm . |
.Ss \&Nx |
.It Ic \&Nx Op Ar version |
Format the NetBSD version provided as an argument, or a default value if |
Format the |
|
.Nx |
|
version provided as an argument, or a default value if |
no argument is provided. |
no argument is provided. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Nx 5.01 |
.Dl \&.Nx 5.01 |
.D1 \&.Nx |
.Dl \&.Nx |
.Pp |
.Pp |
See also |
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 |
and |
.Sx \&Ux . |
.Ic \&Ox . |
.Ss \&Oc |
.It Ic \&Oc |
Close multi-line |
Close multi-line |
.Sx \&Oo |
.Ic \&Oo |
context. |
context. |
.Ss \&Oo |
.It Ic \&Oo Ar block |
Multi-line version of |
Multi-line version of |
.Sx \&Op . |
.Ic \&Op . |
.Pp |
.Pp |
Examples: |
Examples: |
.Bd -literal -offset indent -compact |
.Bd -literal -offset indent -compact |
|
|
\&.Op Fl flag Ns Ar value |
\&.Op Fl flag Ns Ar value |
\&.Oc |
\&.Oc |
.Ed |
.Ed |
.Ss \&Op |
.It Ic \&Op Ar line |
Command-line option. |
Optional part of a command line. |
Used when listing options to command-line utilities. |
|
Prints the argument(s) in brackets. |
Prints the argument(s) in brackets. |
|
This is most often used in the |
|
.Em SYNOPSIS |
|
section of section 1 and 8 manual pages. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Op \&Fl a \&Ar b |
.Dl \&.Op \&Fl a \&Ar b |
.D1 \&.Op \&Ar a | b |
.Dl \&.Op \&Ar a | b |
.Pp |
.Pp |
See also |
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 |
This is the mandatory third macro of |
any |
any |
.Nm |
.Nm |
file. |
file. |
Its syntax is as follows: |
|
.Pp |
.Pp |
.D1 Pf \. Sx \&Os Op Cm system |
|
.Pp |
|
The optional |
The optional |
.Cm system |
.Ar system |
parameter specifies the relevant operating system or environment. |
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 |
.Pp |
Examples: |
Examples: |
.D1 \&.Os |
.Dl \&.Os |
.D1 \&.Os KTH/CSC/TCS |
.Dl \&.Os KTH/CSC/TCS |
.D1 \&.Os BSD 4.3 |
.Dl \&.Os BSD 4.3 |
.Pp |
.Pp |
See also |
See also |
.Sx \&Dd |
.Ic \&Dd |
and |
and |
.Sx \&Dt . |
.Ic \&Dt . |
.Ss \&Ot |
.It Ic \&Ot Ar functype |
Unknown usage. |
This macro is obsolete. |
|
Use |
|
.Ic \&Ft |
|
instead; with |
|
.Xr mandoc 1 , |
|
both have the same effect. |
.Pp |
.Pp |
.Em Remarks : |
Historical |
this macro has been deprecated. |
.Nm |
.Ss \&Ox |
packages described it as |
Format the OpenBSD version provided as an argument, or a default value |
.Dq "old function type (FORTRAN)" . |
|
.It Ic \&Ox Op Ar version |
|
Format the |
|
.Ox |
|
version provided as an argument, or a default value |
if no argument is provided. |
if no argument is provided. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Ox 4.5 |
.Dl \&.Ox 4.5 |
.D1 \&.Ox |
.Dl \&.Ox |
.Pp |
.Pp |
See also |
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 |
and |
.Sx \&Ux . |
.Ic \&Nx . |
.Ss \&Pa |
.It Ic \&Pa Ar name ... |
A file-system path. |
An absolute or relative file system path, or a file or directory name. |
|
If an argument is not provided, the character |
|
.Sq \(ti |
|
is used as a default. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Pa /usr/bin/mandoc |
.Dl \&.Pa /usr/bin/mandoc |
.D1 \&.Pa /usr/share/man/man7/mdoc.7 |
.Dl \&.Pa /usr/share/man/man7/mdoc.7 |
.Pp |
.Pp |
See also |
See also |
.Sx \&Lk . |
.Ic \&Lk . |
.Ss \&Pc |
.It Ic \&Pc |
Close parenthesised context opened by |
Close parenthesised context opened by |
.Sx \&Po . |
.Ic \&Po . |
.Ss \&Pf |
.It Ic \&Pf Ar prefix macro Op Ar argument ... |
Removes the space |
Removes the space between its argument and the following macro. |
.Pq Dq prefix |
It is equivalent to: |
between its arguments. |
|
Its syntax is as follows: |
|
.Pp |
.Pp |
.D1 Pf \. \&Pf Cm prefix suffix |
.D1 Ic \&No Pf \e& Ar prefix Ic \&Ns Ar macro Op Ar argument ... |
.Pp |
.Pp |
The |
The |
.Cm suffix |
.Ar prefix |
argument may be a macro. |
argument is not parsed for macro names or delimiters, |
|
but used verbatim as if it were escaped. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Pf \e. \&Sx \&Pf \&Cm prefix suffix |
.Dl ".Pf $ Ar variable_name" |
.Ss \&Po |
.Dl ".Pf . Ar macro_name" |
|
.Dl ".Pf 0x Ar hex_digits" |
|
.Pp |
|
See also |
|
.Ic \&Ns |
|
and |
|
.Ic \&Sm . |
|
.It Ic \&Po Ar block |
Multi-line version of |
Multi-line version of |
.Sx \&Pq . |
.Ic \&Pq . |
.Ss \&Pp |
.It Ic \&Pp |
Break a paragraph. |
Break a paragraph. |
This will assert vertical space between prior and subsequent macros |
This will assert vertical space between prior and subsequent macros |
and/or text. |
and/or text. |
.Ss \&Pq |
.Pp |
|
Paragraph breaks are not needed before or after |
|
.Ic \&Sh |
|
or |
|
.Ic \&Ss |
|
macros or before displays |
|
.Pq Ic \&Bd Ar line |
|
or lists |
|
.Pq Ic \&Bl |
|
unless the |
|
.Fl compact |
|
flag is given. |
|
.It Ic \&Pq Ar line |
Parenthesised enclosure. |
Parenthesised enclosure. |
.Pp |
.Pp |
See also |
See also |
.Sx \&Po . |
.Ic \&Po . |
.Ss \&Qc |
.It Ic \&Qc |
Close quoted context opened by |
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 |
See also |
.Sx \&Qq |
.Ic \&Dl |
and |
and |
.Sx \&Sq . |
.Ic \&Bd |
.Ss \&Qo |
.Fl literal . |
|
.It Ic \&Qo Ar block |
Multi-line version of |
Multi-line version of |
.Sx \&Qq . |
.Ic \&Qq . |
.Ss \&Qq |
.It Ic \&Qq Ar line |
Encloses its arguments in |
Encloses its arguments in |
.Dq typewriter |
.Qq typewriter |
double-quotes. |
double-quotes. |
Consider using |
Consider using |
.Sx \&Dq . |
.Ic \&Dq . |
.Pp |
.Pp |
See also |
See also |
.Sx \&Dq , |
.Ic \&Dq , |
.Sx \&Sq , |
.Ic \&Sq , |
and |
and |
.Sx \&Qo . |
.Ic \&Qo . |
.Ss \&Re |
.It Ic \&Re |
Close an |
Close an |
.Sx \&Rs |
.Ic \&Rs |
block. |
block. |
Does not have any tail arguments. |
Does not have any tail arguments. |
.Ss \&Rs |
.It Ic \&Rs |
Begin a bibliographic |
Begin a bibliographic |
.Pq Dq reference |
.Pq Dq reference |
block. |
block. |
Does not have any head arguments. |
Does not have any head arguments. |
The block macro may only contain |
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 |
and |
.Sx \&%V |
.Ic \&%V |
child macros (at least one must be specified). |
child macros (at least one must be specified). |
.Pp |
.Pp |
Examples: |
Examples: |
|
|
\&.%A J. D. Ullman |
\&.%A J. D. Ullman |
\&.%B Introduction to Automata Theory, Languages, and Computation |
\&.%B Introduction to Automata Theory, Languages, and Computation |
\&.%I Addison-Wesley |
\&.%I Addison-Wesley |
\&.%C Reading, Massachusettes |
\&.%C Reading, Massachusetts |
\&.%D 1979 |
\&.%D 1979 |
\&.Re |
\&.Re |
.Ed |
.Ed |
.Pp |
.Pp |
If an |
If an |
.Sx \&Rs |
.Ic \&Rs |
block is used within a SEE ALSO section, a vertical space is asserted |
block is used within a SEE ALSO section, a vertical space is asserted |
before the rendered output, else the block continues on the current |
before the rendered output, else the block continues on the current |
line. |
line. |
.Ss \&Rv |
.It Ic \&Rv Fl std Op Ar function ... |
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 . |
.Pp |
If |
If |
.Ar function |
.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 |
.Ic \&Nm |
is provided. |
is used. |
|
Multiple |
|
.Ar function |
|
arguments are treated as separate functions. |
.Pp |
.Pp |
See also |
See also |
.Sx \&Ex . |
.Ic \&Ex . |
.Ss \&Sc |
.It Ic \&Sc |
Close single-quoted context opened by |
Close single-quoted context opened by |
.Sx \&So . |
.Ic \&So . |
.Ss \&Sh |
.It Ic \&Sh Ar TITLE LINE |
Begin a new section. |
Begin a new section. |
For a list of conventional manual sections, see |
For a list of conventional manual sections, see |
.Sx MANUAL STRUCTURE . |
.Sx MANUAL STRUCTURE . |
Line 2428 These sections should be used unless it's absolutely n |
|
Line 2244 These sections should be used unless it's absolutely n |
|
custom sections be used. |
custom sections be used. |
.Pp |
.Pp |
Section names should be unique so that they may be keyed by |
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 |
|
.Ic \&Sx . |
.Pp |
.Pp |
See also |
See also |
.Sx \&Pp , |
.Ic \&Pp , |
.Sx \&Ss , |
.Ic \&Ss , |
and |
and |
.Sx \&Sx . |
.Ic \&Sx . |
.Ss \&Sm |
.It Ic \&Sm Op Cm on | off |
Switches the spacing mode for output generated from macros. |
Switches the spacing mode for output generated from macros. |
Its syntax is as follows: |
|
.Pp |
.Pp |
.D1 Pf \. Sx \&Sm Cm on | off |
|
.Pp |
|
By default, spacing is |
By default, spacing is |
.Cm on . |
.Cm on . |
When switched |
When switched |
.Cm off , |
.Cm off , |
no white space is inserted between macro arguments and between the |
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. |
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 |
Multi-line version of |
.Sx \&Sq . |
.Ic \&Sq . |
.Ss \&Sq |
.It Ic \&Sq Ar line |
Encloses its arguments in |
Encloses its arguments in |
.Dq typewriter |
.Sq typewriter |
single-quotes. |
single-quotes. |
.Pp |
.Pp |
See also |
See also |
.Sx \&Dq , |
.Ic \&Dq , |
.Sx \&Qq , |
.Ic \&Qq , |
and |
and |
.Sx \&So . |
.Ic \&So . |
.Ss \&Ss |
.It Ic \&Ss Ar Title line |
Begin a new sub-section. |
Begin a new subsection. |
Unlike with |
Unlike with |
.Sx \&Sh , |
.Ic \&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 |
.Pp |
Sub-section names should be unique so that they may be keyed by |
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 |
|
.Ic \&Sx . |
.Pp |
.Pp |
See also |
See also |
.Sx \&Pp , |
.Ic \&Pp , |
.Sx \&Sh , |
.Ic \&Sh , |
and |
and |
.Sx \&Sx . |
.Ic \&Sx . |
.Ss \&St |
.It Ic \&St Fl Ns Ar abbreviation |
Replace an abbreviation for a standard with the full form. |
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 |
.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 |
.It \-isoC |
.St -isoC |
.St -isoC |
.It \-isoC-90 |
.It \-isoC-90 |
.St -isoC-90 |
.St -isoC-90 |
|
.br |
|
The original C standard. |
|
.Pp |
.It \-isoC-amd1 |
.It \-isoC-amd1 |
.St -isoC-amd1 |
.St -isoC-amd1 |
|
.Pp |
.It \-isoC-tcor1 |
.It \-isoC-tcor1 |
.St -isoC-tcor1 |
.St -isoC-tcor1 |
|
.Pp |
.It \-isoC-tcor2 |
.It \-isoC-tcor2 |
.St -isoC-tcor2 |
.St -isoC-tcor2 |
|
.Pp |
.It \-isoC-99 |
.It \-isoC-99 |
.St -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 |
.It \-iso9945-1-90 |
.St -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 |
.It \-iso9945-1-96 |
.St -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 \-ieee1275-94 |
|
.St -ieee1275-94 |
|
.It \-xpg3 |
.It \-xpg3 |
.St -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 |
.It \-xpg4 |
.St -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 |
.It \-xpg4.2 |
.St -xpg4.2 |
.St -xpg4.2 |
.St -xpg4.3 |
.br |
|
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 |
.It \-xbd5 |
.St -xbd5 |
.St -xbd5 |
.It \-xcu5 |
.Pp |
.St -xcu5 |
|
.It \-xsh5 |
.It \-xsh5 |
.St -xsh5 |
.St -xsh5 |
|
.Pp |
|
.It \-xcu5 |
|
.St -xcu5 |
|
.Pp |
.It \-xns5 |
.It \-xns5 |
.St -xns5 |
.St -xns5 |
.It \-xns5.2 |
.It \-xns5.2 |
.St -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 |
.It \-susv3 |
.St -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 |
.El |
.Ss \&Sx |
.It Single UNIX Specification version 4 |
Reference a section or sub-section. |
.Pp |
The referenced section or sub-section name must be identical to the |
.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 |
|
.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. |
enclosed argument, including whitespace. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Sx MANUAL STRUCTURE |
.Dl \&.Sx MANUAL STRUCTURE |
.Ss \&Sy |
|
Format enclosed arguments in symbolic |
|
.Pq Dq boldface . |
|
Note that this is a presentation term and should not be used for |
|
stylistically decorating technical terms. |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&Bf , |
.Ic \&Sh |
.Sx \&Li , |
|
and |
and |
.Sx \&Em . |
.Ic \&Ss . |
.Ss \&Tn |
.It Ic \&Sy Ar word ... |
Format a tradename. |
Request a boldface font. |
.Pp |
.Pp |
Examples: |
This is most often used to indicate importance or seriousness (not to be |
.D1 \&.Tn IBM |
confused with stress emphasis, see |
.Ss \&Ud |
.Ic \&Em ) . |
Prints out |
When none of the semantic macros fit, it is also adequate for syntax |
.Dq currently under development. |
elements that have to be given or that appear verbatim. |
.Ss \&Ux |
|
Format the UNIX name. |
|
Accepts no argument. |
|
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Ux |
.Bd -literal -compact -offset indent |
|
\&.Sy Warning : |
|
If |
|
\&.Sy s |
|
appears in the owner permissions, set-user-ID mode is set. |
|
This utility replaces the former |
|
\&.Sy dumpdir |
|
program. |
|
.Ed |
.Pp |
.Pp |
See also |
See also |
.Sx \&At , |
.Ic \&Em , |
.Sx \&Bsx , |
.Ic \&No , |
.Sx \&Bx , |
|
.Sx \&Dx , |
|
.Sx \&Fx , |
|
.Sx \&Nx , |
|
and |
and |
.Sx \&Ox . |
.Ic \&Ql . |
.Ss \&Va |
.It Ic \&Ta |
|
Table cell separator in |
|
.Ic \&Bl Fl column |
|
lists; can only be used below |
|
.Ic \&It . |
|
.It Ic \&Tg Op Ar term |
|
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 |
|
When viewing terminal output with |
|
.Xr less 1 , |
|
the interactive |
|
.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 |
|
In most cases, adding a |
|
.Ic \&Tg |
|
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. |
|
.It Ic \&Ux |
|
Supported only for compatibility, do not use this in new manuals. |
|
Prints out |
|
.Dq Ux . |
|
.It Ic \&Va Oo Ar type Oc Ar identifier ... |
A variable name. |
A variable name. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Va foo |
.Dl \&.Va foo |
.D1 \&.Va const char *bar ; |
.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. |
A variable type. |
|
.Pp |
This is also used for indicating global variables in the |
This is also used for indicating global variables in the |
.Em SYNOPSIS |
.Em SYNOPSIS |
section, in which case a variable name is also specified. |
section, in which case a variable name is also specified. |
Note that it accepts |
Note that it accepts |
.Sx Block partial-implicit |
.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 |
.Em SYNOPSIS |
section, else it accepts ordinary |
section, else it accepts ordinary |
.Sx In-line |
.Sx In-line |
syntax. |
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 |
.Pp |
Note that this should not be confused with |
|
.Sx \&Ft , |
|
which is used for function return types. |
|
.Pp |
|
Examples: |
Examples: |
.D1 \&.Vt unsigned char |
.Dl \&.Vt unsigned char |
.D1 \&.Vt extern const char * const sys_signame[] \&; |
.Dl \&.Vt extern const char * const sys_signame[] \&; |
.Pp |
.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 |
See also |
.Sx MANUAL STRUCTURE |
.Sx MANUAL STRUCTURE . |
and |
.It Ic \&Xc |
.Sx \&Va . |
|
.Ss \&Xc |
|
Close a scope opened by |
Close a scope opened by |
.Sx \&Xo . |
.Ic \&Xo . |
.Ss \&Xo |
.It Ic \&Xo Ar block |
Open an extension scope. |
Extend the header of an |
This macro originally existed to extend the 9-argument limit of troff; |
.Ic \&It |
since this limit has been lifted, the macro has been deprecated. |
macro or the body of a partial-implicit block macro |
.Ss \&Xr |
beyond the end of the input line. |
|
This macro originally existed to work around the 9-argument limit |
|
of historic |
|
.Xr roff 7 . |
|
.It Ic \&Xr Ar name section |
Link to another manual |
Link to another manual |
.Pq Qq cross-reference . |
.Pq Qq cross-reference . |
Its syntax is as follows: |
|
.Pp |
.Pp |
.D1 Pf \. Sx \&Xr Cm name section |
Cross reference the |
.Pp |
.Ar name |
The |
|
.Cm name |
|
and |
and |
.Cm section |
.Ar section |
are the name and section of the linked manual. |
number of another man page. |
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 |
.Pp |
Examples: |
Examples: |
.D1 \&.Xr mandoc 1 |
.Dl \&.Xr mandoc 1 |
.D1 \&.Xr mandoc 1 \&; |
.Dl \&.Xr mandoc 1 \&; |
.D1 \&.Xr mandoc 1 \&Ns s behaviour |
.Dl \&.Xr mandoc 1 \&Ns s behaviour |
.Ss \&br |
.El |
Emits a line-break. |
.Sh MACRO SYNTAX |
This macro should not be used; it is implemented for compatibility with |
The syntax of a macro depends on its classification. |
historical manuals. |
In this section, |
|
.Sq \-arg |
|
refers to macro arguments, which may be followed by zero or more |
|
.Sq parm |
|
parameters; |
|
.Sq \&Yo |
|
opens the scope of a macro; and if specified, |
|
.Sq \&Yc |
|
closes it out. |
.Pp |
.Pp |
Consider using |
The |
.Sx \&Pp |
.Em Callable |
in the event of natural paragraph breaks. |
column indicates that the macro may also be called by passing its name |
.Ss \&sp |
as an argument to another macro. |
Emits vertical space. |
For example, |
This macro should not be used; it is implemented for compatibility with |
.Sq \&.Op \&Fl O \&Ar file |
historical manuals. |
produces |
Its syntax is as follows: |
.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, |
|
.Sq \&.Fl \&Sh |
|
produces |
|
.Sq Fl \&Sh . |
.Pp |
.Pp |
.D1 Pf \. Sx \&sp Op Cm height |
The |
|
.Em Parsed |
|
column indicates whether the macro may call other macros by receiving |
|
their names as arguments. |
|
If a macro is not parsed but the name of another macro appears |
|
as an argument, it is interpreted as opaque text. |
.Pp |
.Pp |
The |
The |
.Cm height |
.Em Scope |
argument must be formatted as described in |
column, if applicable, describes closure rules. |
.Sx Scaling Widths . |
.Ss Block full-explicit |
If unspecified, |
Multi-line scope closed by an explicit closing macro. |
.Sx \&sp |
All macros contains bodies; only |
asserts a single vertical space. |
.Ic \&Bf |
|
and |
|
.Pq optionally |
|
.Ic \&Bl |
|
contain a head. |
|
.Bd -literal -offset indent |
|
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB |
|
\(lBbody...\(rB |
|
\&.Yc |
|
.Ed |
|
.Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXX" -offset indent |
|
.It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope |
|
.It Ic \&Bd Ta \&No Ta \&No Ta closed by Ic \&Ed |
|
.It Ic \&Bf Ta \&No Ta \&No Ta closed by Ic \&Ef |
|
.It Ic \&Bk Ta \&No Ta \&No Ta closed by Ic \&Ek |
|
.It Ic \&Bl Ta \&No Ta \&No Ta closed by Ic \&El |
|
.It Ic \&Ed Ta \&No Ta \&No Ta opened by Ic \&Bd |
|
.It Ic \&Ef Ta \&No Ta \&No Ta opened by Ic \&Bf |
|
.It Ic \&Ek Ta \&No Ta \&No Ta opened by Ic \&Bk |
|
.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 |
|
.Ic \&It Fl bullet , |
|
.Fl hyphen , |
|
.Fl dash , |
|
.Fl enum , |
|
.Fl item |
|
.Pc |
|
don't have heads; only one |
|
.Po |
|
.Ic \&It |
|
in |
|
.Ic \&Bl Fl column |
|
.Pc |
|
has multiple heads. |
|
.Bd -literal -offset indent |
|
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB |
|
\(lBbody...\(rB |
|
.Ed |
|
.Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXXXXXXXXX" -offset indent |
|
.It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope |
|
.It Ic \&It Ta \&No Ta Yes Ta closed by Ic \&It , Ic \&El |
|
.It Ic \&Nd Ta \&No Ta \&No Ta closed by Ic \&Sh |
|
.It Ic \&Nm Ta \&No Ta Yes Ta closed by Ic \&Nm , Ic \&Sh , Ic \&Ss |
|
.It Ic \&Sh Ta \&No Ta Yes Ta closed by Ic \&Sh |
|
.It Ic \&Ss Ta \&No Ta Yes Ta closed by Ic \&Sh , Ic \&Ss |
|
.El |
|
.Pp |
|
Note that the |
|
.Ic \&Nm |
|
macro is a |
|
.Sx Block full-implicit |
|
macro only when invoked as the first macro |
|
in a |
|
.Em SYNOPSIS |
|
section line, else it is |
|
.Sx In-line . |
|
.Ss Block partial-explicit |
|
Like block full-explicit, but also with single-line scope. |
|
Each has at least a body and, in limited circumstances, a head |
|
.Po |
|
.Ic \&Fo , |
|
.Ic \&Eo |
|
.Pc |
|
and/or tail |
|
.Pq Ic \&Ec . |
|
.Bd -literal -offset indent |
|
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB |
|
\(lBbody...\(rB |
|
\&.Yc \(lBtail...\(rB |
|
|
|
\&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \ |
|
\(lBbody...\(rB \&Yc \(lBtail...\(rB |
|
.Ed |
|
.Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -offset indent |
|
.It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope |
|
.It Ic \&Ac Ta Yes Ta Yes Ta opened by Ic \&Ao |
|
.It Ic \&Ao Ta Yes Ta Yes Ta closed by Ic \&Ac |
|
.It Ic \&Bc Ta Yes Ta Yes Ta closed by Ic \&Bo |
|
.It Ic \&Bo Ta Yes Ta Yes Ta opened by Ic \&Bc |
|
.It Ic \&Brc Ta Yes Ta Yes Ta opened by Ic \&Bro |
|
.It Ic \&Bro Ta Yes Ta Yes Ta closed by Ic \&Brc |
|
.It Ic \&Dc Ta Yes Ta Yes Ta opened by Ic \&Do |
|
.It Ic \&Do Ta Yes Ta Yes Ta closed by Ic \&Dc |
|
.It Ic \&Ec Ta Yes Ta Yes Ta opened by Ic \&Eo |
|
.It Ic \&Eo Ta Yes Ta Yes Ta closed by Ic \&Ec |
|
.It Ic \&Fc Ta Yes Ta Yes Ta opened by Ic \&Fo |
|
.It Ic \&Fo Ta \&No Ta \&No Ta closed by Ic \&Fc |
|
.It Ic \&Oc Ta Yes Ta Yes Ta closed by Ic \&Oo |
|
.It Ic \&Oo Ta Yes Ta Yes Ta opened by Ic \&Oc |
|
.It Ic \&Pc Ta Yes Ta Yes Ta closed by Ic \&Po |
|
.It Ic \&Po Ta Yes Ta Yes Ta opened by Ic \&Pc |
|
.It Ic \&Qc Ta Yes Ta Yes Ta opened by Ic \&Oo |
|
.It Ic \&Qo Ta Yes Ta Yes Ta closed by Ic \&Oc |
|
.It Ic \&Re Ta \&No Ta \&No Ta opened by Ic \&Rs |
|
.It Ic \&Rs Ta \&No Ta \&No Ta closed by Ic \&Re |
|
.It Ic \&Sc Ta Yes Ta Yes Ta opened by Ic \&So |
|
.It Ic \&So Ta Yes Ta Yes Ta closed by Ic \&Sc |
|
.It Ic \&Xc Ta Yes Ta Yes Ta opened by Ic \&Xo |
|
.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 |
|
end of the line. |
|
.Bd -literal -offset indent |
|
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB |
|
.Ed |
|
.Bl -column "MacroX" "CallableX" "ParsedX" -offset indent |
|
.It Em Macro Ta Em Callable Ta Em Parsed |
|
.It Ic \&Aq Ta Yes Ta Yes |
|
.It Ic \&Bq Ta Yes Ta Yes |
|
.It Ic \&Brq Ta Yes Ta Yes |
|
.It Ic \&D1 Ta \&No Ta \&Yes |
|
.It Ic \&Dl Ta \&No Ta Yes |
|
.It Ic \&Dq Ta Yes Ta Yes |
|
.It Ic \&En Ta Yes Ta Yes |
|
.It Ic \&Op Ta Yes Ta Yes |
|
.It Ic \&Pq Ta Yes Ta Yes |
|
.It Ic \&Ql Ta Yes Ta Yes |
|
.It Ic \&Qq Ta Yes Ta Yes |
|
.It Ic \&Sq Ta Yes Ta Yes |
|
.It Ic \&Vt Ta Yes Ta Yes |
|
.El |
|
.Pp |
|
Note that the |
|
.Ic \&Vt |
|
macro is a |
|
.Sx Block partial-implicit |
|
only when invoked as the first macro |
|
in a |
|
.Em SYNOPSIS |
|
section line, else it is |
|
.Sx In-line . |
|
.Ss Special block macro |
|
The |
|
.Ic \&Ta |
|
macro can only be used below |
|
.Ic \&It |
|
in |
|
.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 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, |
|
and/or subsequent macros. |
|
In-line macros have only text children. |
|
If a number (or inequality) of arguments is |
|
.Pq n , |
|
then the macro accepts an arbitrary number of arguments. |
|
.Bd -literal -offset indent |
|
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB \(lBres...\(rB |
|
|
|
\&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBargs...\(rB Yc... |
|
|
|
\&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN |
|
.Ed |
|
.Bl -column "MacroX" "CallableX" "ParsedX" "Arguments" -offset indent |
|
.It Em Macro Ta Em Callable Ta Em Parsed Ta Em Arguments |
|
.It Ic \&%A Ta \&No Ta \&No Ta >0 |
|
.It Ic \&%B Ta \&No Ta \&No Ta >0 |
|
.It Ic \&%C Ta \&No Ta \&No Ta >0 |
|
.It Ic \&%D Ta \&No Ta \&No Ta >0 |
|
.It Ic \&%I Ta \&No Ta \&No Ta >0 |
|
.It Ic \&%J Ta \&No Ta \&No Ta >0 |
|
.It Ic \&%N Ta \&No Ta \&No Ta >0 |
|
.It Ic \&%O Ta \&No Ta \&No Ta >0 |
|
.It Ic \&%P Ta \&No Ta \&No Ta >0 |
|
.It Ic \&%Q Ta \&No Ta \&No Ta >0 |
|
.It Ic \&%R Ta \&No Ta \&No Ta >0 |
|
.It Ic \&%T Ta \&No Ta \&No Ta >0 |
|
.It Ic \&%U Ta \&No Ta \&No Ta >0 |
|
.It Ic \&%V Ta \&No Ta \&No Ta >0 |
|
.It Ic \&Ad Ta Yes Ta Yes Ta >0 |
|
.It Ic \&An Ta Yes Ta Yes Ta >0 |
|
.It Ic \&Ap Ta Yes Ta Yes Ta 0 |
|
.It Ic \&Ar Ta Yes Ta Yes Ta n |
|
.It Ic \&At Ta Yes Ta Yes Ta 1 |
|
.It Ic \&Bsx Ta Yes Ta Yes Ta n |
|
.It Ic \&Bt Ta \&No Ta \&No Ta 0 |
|
.It Ic \&Bx Ta Yes Ta Yes Ta n |
|
.It Ic \&Cd Ta Yes Ta Yes Ta >0 |
|
.It Ic \&Cm Ta Yes Ta Yes Ta >0 |
|
.It Ic \&Db Ta \&No Ta \&No Ta 1 |
|
.It Ic \&Dd Ta \&No Ta \&No Ta n |
|
.It Ic \&Dt Ta \&No Ta \&No Ta n |
|
.It Ic \&Dv Ta Yes Ta Yes Ta >0 |
|
.It Ic \&Dx Ta Yes Ta Yes Ta n |
|
.It Ic \&Em Ta Yes Ta Yes Ta >0 |
|
.It Ic \&Er Ta Yes Ta Yes Ta >0 |
|
.It Ic \&Es Ta Yes Ta Yes Ta 2 |
|
.It Ic \&Ev Ta Yes Ta Yes Ta >0 |
|
.It Ic \&Ex Ta \&No Ta \&No Ta n |
|
.It Ic \&Fa Ta Yes Ta Yes Ta >0 |
|
.It Ic \&Fd Ta \&No Ta \&No Ta >0 |
|
.It Ic \&Fl Ta Yes Ta Yes Ta n |
|
.It Ic \&Fn Ta Yes Ta Yes Ta >0 |
|
.It Ic \&Fr Ta Yes Ta Yes Ta >0 |
|
.It Ic \&Ft Ta Yes Ta Yes Ta >0 |
|
.It Ic \&Fx Ta Yes Ta Yes Ta n |
|
.It Ic \&Hf Ta \&No Ta \&No Ta n |
|
.It Ic \&Ic Ta Yes Ta Yes Ta >0 |
|
.It Ic \&In Ta \&No Ta \&No Ta 1 |
|
.It Ic \&Lb Ta \&No Ta \&No Ta 1 |
|
.It Ic \&Li Ta Yes Ta Yes Ta >0 |
|
.It Ic \&Lk Ta Yes Ta Yes Ta >0 |
|
.It Ic \&Lp Ta \&No Ta \&No Ta 0 |
|
.It Ic \&Ms Ta Yes Ta Yes Ta >0 |
|
.It Ic \&Mt Ta Yes Ta Yes Ta >0 |
|
.It Ic \&Nm Ta Yes Ta Yes Ta n |
|
.It Ic \&No Ta Yes Ta Yes Ta >0 |
|
.It Ic \&Ns Ta Yes Ta Yes Ta 0 |
|
.It Ic \&Nx Ta Yes Ta Yes Ta n |
|
.It Ic \&Os Ta \&No Ta \&No Ta n |
|
.It Ic \&Ot Ta Yes Ta Yes Ta >0 |
|
.It Ic \&Ox Ta Yes Ta Yes Ta n |
|
.It Ic \&Pa Ta Yes Ta Yes Ta n |
|
.It Ic \&Pf Ta Yes Ta Yes Ta 1 |
|
.It Ic \&Pp Ta \&No Ta \&No Ta 0 |
|
.It Ic \&Rv Ta \&No Ta \&No Ta n |
|
.It Ic \&Sm Ta \&No Ta \&No Ta <2 |
|
.It Ic \&St Ta \&No Ta Yes Ta 1 |
|
.It Ic \&Sx Ta Yes Ta Yes Ta >0 |
|
.It Ic \&Sy Ta Yes Ta Yes Ta >0 |
|
.It Ic \&Tg Ta \&No Ta \&No Ta <2 |
|
.It Ic \&Tn Ta Yes Ta Yes Ta >0 |
|
.It Ic \&Ud Ta \&No Ta \&No Ta 0 |
|
.It Ic \&Ux Ta Yes Ta Yes Ta n |
|
.It Ic \&Va Ta Yes Ta Yes Ta n |
|
.It Ic \&Vt Ta Yes Ta Yes Ta >0 |
|
.It Ic \&Xr Ta Yes Ta Yes Ta 2 |
|
.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. |
|
Spacing is suppressed after opening delimiters |
|
and before closing delimiters. |
|
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, which does not suppress spacing: |
|
.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. |
|
.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 |
|
In |
|
.Nm |
|
documents, usage of semantic markup is recommended in order to have |
|
proper fonts automatically selected; only when no fitting semantic markup |
|
is available, consider falling back to |
|
.Sx Physical markup |
|
macros. |
|
Whenever any |
|
.Nm |
|
macro switches the |
|
.Xr roff 7 |
|
font mode, it will automatically restore the previous font when exiting |
|
its scope. |
|
Manually switching the font using the |
|
.Xr roff 7 |
|
.Ql \ef |
|
font escape sequences is never required. |
.Sh COMPATIBILITY |
.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 . |
.Pq Qq groff . |
The term |
|
.Qq historic groff |
|
refers to groff versions before the |
|
.Pa doc.tmac |
|
file re-write |
|
.Pq somewhere between 1.15 and 1.19 . |
|
.Pp |
.Pp |
Heirloom troff, the other significant troff implementation accepting |
The following problematic behaviour is found in groff: |
\-mdoc, is similar to historic groff. |
|
.Pp |
.Pp |
.Bl -dash -compact |
.Bl -dash -compact |
.It |
.It |
An empty |
.Ic \&Pa |
.Sq \&Dd |
does not format its arguments when used in the FILES section under |
macro in groff prints |
|
.Dq Epoch . |
|
In mandoc, it resolves to the current date. |
|
.It |
|
The \es (font size), \em (font colour), and \eM (font filling colour) |
|
font decoration escapes are all discarded in mandoc. |
|
.It |
|
Old groff fails to assert a newline before |
|
.Sx \&Bd Fl ragged compact . |
|
.It |
|
groff behaves inconsistently when encountering |
|
.Pf non- Sx \&Fa |
|
children of |
|
.Sx \&Fo |
|
regarding spacing between arguments. |
|
In mandoc, this is not the case: each argument is consistently followed |
|
by a single space and the trailing |
|
.Sq \&) |
|
suppresses prior spacing. |
|
.It |
|
groff behaves inconsistently when encountering |
|
.Sx \&Ft |
|
and |
|
.Sx \&Fn |
|
in the |
|
.Em SYNOPSIS : |
|
at times newline(s) are suppressed depending on whether a prior |
|
.Sx \&Fn |
|
has been invoked. |
|
In mandoc, this is not the case. |
|
See |
|
.Sx \&Ft |
|
and |
|
.Sx \&Fn |
|
for the normalised behaviour. |
|
.It |
|
Historic groff does not break before an |
|
.Sx \&Fn |
|
when not invoked as the line macro in the |
|
.Em SYNOPSIS |
|
section. |
|
.It |
|
Historic groff formats the |
|
.Sx \&In |
|
badly: trailing arguments are trashed and |
|
.Em SYNOPSIS |
|
is not specially treated. |
|
.It |
|
groff does not accept the |
|
.Sq \&Ta |
|
pseudo-macro as a line macro. |
|
mandoc does. |
|
.It |
|
The comment syntax |
|
.Sq \e\." |
|
is no longer accepted. |
|
.It |
|
In groff, the |
|
.Sx \&Pa |
|
macro does not format its arguments when used in the FILES section under |
|
certain list types. |
certain list types. |
mandoc does. |
|
.It |
.It |
Historic groff does not print a dash for empty |
.Ic \&Ta |
.Sx \&Fl |
can only be called by other macros, but not at the beginning of a line. |
arguments. |
|
mandoc and newer groff implementations do. |
|
.It |
.It |
groff behaves irregularly when specifying |
|
.Sq \ef |
.Sq \ef |
|
.Pq font face |
|
and |
|
.Sq \eF |
|
.Pq font family face |
.Sx Text Decoration |
.Sx Text Decoration |
within line-macro scopes. |
escapes behave irregularly when specified within line-macro scopes. |
mandoc follows a consistent system. |
|
.It |
.It |
In mandoc, negative scaling units are truncated to zero; groff would |
Negative scaling units return to prior lines. |
move to prior lines. |
Instead, mandoc truncates them to zero. |
Furthermore, the |
.El |
.Sq f |
.Pp |
scaling unit, while accepted, is rendered as the default unit. |
The following features are unimplemented in mandoc: |
|
.Pp |
|
.Bl -dash -compact |
.It |
.It |
In quoted literals, groff allowed pair-wise double-quotes to produce a |
.Ic \&Bd Fl file Ar file |
standalone double-quote in formatted output. |
is unsupported for security reasons. |
This idiosyncratic behaviour is not applicable in mandoc. |
|
.It |
.It |
Display offsets |
.Ic \&Bd |
.Sx \&Bd |
|
.Fl offset Ar center |
|
and |
|
.Fl offset Ar right |
|
are disregarded in mandoc. |
|
Furthermore, troff specifies a |
|
.Fl file Ar file |
|
argument that is not supported in mandoc. |
|
Lastly, since text is not right-justified in mandoc (or even groff), |
|
.Fl ragged |
|
and |
|
.Fl filled |
.Fl filled |
are aliases, as are |
does not adjust the right margin, but is an alias for |
|
.Ic \&Bd |
|
.Fl ragged . |
|
.It |
|
.Ic \&Bd |
.Fl literal |
.Fl literal |
and |
does not use a literal font, but is an alias for |
|
.Ic \&Bd |
.Fl unfilled . |
.Fl unfilled . |
.It |
.It |
Historic groff has many un-callable macros. |
.Ic \&Bd |
Most of these (excluding some block-level macros) are now callable. |
.Fl offset Cm center |
.It |
|
The vertical bar |
|
.Sq \(ba |
|
made historic groff |
|
.Qq go orbital |
|
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 in mandoc. |
|
.It |
|
In groff, the |
|
.Sx \&Cd , |
|
.Sx \&Er , |
|
.Sx \&Ex , |
|
and |
and |
.Sx \&Rv |
.Fl offset Cm right |
macros were stipulated only to occur in certain manual sections. |
don't work. |
mandoc does not have these restrictions. |
Groff does not implement centered and flush-right rendering either, |
.It |
but produces large indentations. |
Newer groff and mandoc print |
|
.Qq AT&T UNIX |
|
prior to unknown arguments of |
|
.Sx \&At ; |
|
older groff did nothing. |
|
.El |
.El |
.Sh SEE ALSO |
.Sh SEE ALSO |
|
.Xr man 1 , |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
.Xr mandoc_char 7 |
.Xr eqn 7 , |
|
.Xr man 7 , |
|
.Xr mandoc_char 7 , |
|
.Xr roff 7 , |
|
.Xr tbl 7 |
|
.Pp |
|
The web page |
|
.Lk https://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. |
|
.Pp |
|
The manual page |
|
.Lk https://man.voidlinux.org/groff_mdoc "groff_mdoc(7)" |
|
contained in the |
|
.Dq groff |
|
package documents exactly the same language in a somewhat different style. |
|
.Sh HISTORY |
|
The |
|
.Nm |
|
language first appeared as a troff macro package in |
|
.Bx 4.4 . |
|
It was later significantly updated by Werner Lemberg and Ruslan Ermilov |
|
in groff-1.17. |
|
The standalone implementation that is part of the |
|
.Xr mandoc 1 |
|
utility written by Kristaps Dzonsons appeared in |
|
.Ox 4.6 . |
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |
.Nm |
.Nm |
reference was written by |
reference was written by |
.An Kristaps Dzonsons Aq kristaps@bsd.lv . |
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . |