version 1.1, 2009/03/23 16:02:56 |
version 1.58, 2010/03/25 07:28:16 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org> |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se> |
.\" |
.\" |
.\" 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 |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" above copyright notice and this permission notice appear in all |
.\" copyright notice and this permission notice appear in all copies. |
.\" copies. |
|
.\" |
.\" |
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL |
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
.\" WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED |
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE |
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
.\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL |
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
.\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR |
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER |
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR |
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
.\" PERFORMANCE OF THIS SOFTWARE. |
.\" |
.\" |
|
.Dd $Mdocdate$ |
.Dd $Mdocdate$ |
.Dt man 7 |
.Dt MAN 7 |
.Os |
.Os |
.\" SECTION |
. |
|
. |
.Sh NAME |
.Sh NAME |
.Nm man |
.Nm man |
.Nd man language reference |
.Nd man language reference |
.\" SECTION |
. |
|
. |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm man |
.Nm man |
language was historically used to format |
language was historically used to format |
.Ux |
.Ux |
manuals. In this reference document, we describe the syntax and |
manuals. This reference document describes its syntax, structure, and |
structure of the |
usage. |
.Nm |
. |
language. |
|
.Pp |
.Pp |
.Em \&Do not |
.Bf -emphasis |
use |
Do not use |
.Nm |
.Nm |
to write your manuals. Use the |
to write your manuals. |
|
.Ef |
|
Use the |
.Xr mdoc 7 |
.Xr mdoc 7 |
language, instead. |
language, instead. |
.\" PARAGRAPH |
. |
.Pp |
.Pp |
An |
An |
.Nm |
.Nm |
document follows simple rules: lines beginning with the control |
document follows simple rules: lines beginning with the control |
character |
character |
.Sq \. |
.Sq \&. |
are parsed for macros. Other lines are interpreted within the scope of |
are parsed for macros. Other lines are interpreted within the scope of |
prior macros: |
prior macros: |
.Bd -literal -offset XXX |
.Bd -literal -offset indent |
\&.SH Macro lines change control state. |
\&.SH Macro lines change control state. |
Other lines are interpreted within the current state. |
Other lines are interpreted within the current state. |
.Ed |
.Ed |
.\" PARAGRAPH |
. |
.Pp |
. |
Macros are character sequences whose structural rules are described |
|
later in this document. |
|
.\" SECTION |
|
.Sh INPUT ENCODING |
.Sh INPUT ENCODING |
.Nm |
.Nm |
documents may contain only graphable 7-bit ASCII characters and the |
documents may contain only graphable 7-bit ASCII characters, the |
space character |
space character, and the tabs character. All manuals must have |
.Sq \ . |
.Ux |
All manuals must have |
line termination. |
.Sq \en |
. |
line termination. |
|
.Pp |
.Pp |
Blank lines are acceptable; where found, the output will also assert a |
Blank lines are acceptable; where found, the output will assert a |
vertical space. |
vertical space. |
.\" SUB-SECTION |
. |
|
. |
|
.Ss Comments |
|
Text following a |
|
.Sq \e\*" , |
|
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" , |
|
is also ignored. Macro lines with only a control character and |
|
optionally whitespace are stripped from input. |
|
. |
|
. |
.Ss Special Characters |
.Ss Special Characters |
Special character sequences begin with the escape character |
Special characters may occur in both macro and free-form lines. |
.Sq \\ |
Sequences begin with the escape character |
followed by either an open-parenthesis |
.Sq \e |
|
followed by either an open-parenthesis |
.Sq \&( |
.Sq \&( |
for two-character sequences; an open-bracket |
for two-character sequences; an open-bracket |
.Sq \&[ |
.Sq \&[ |
for n-character sequences (terminated at a close-bracket |
for n-character sequences (terminated at a close-bracket |
.Sq \&] ) ; |
.Sq \&] ) ; |
or a single one-character sequence. |
or a single one-character sequence. See |
|
.Xr mandoc_char 7 |
|
for a complete list. Examples include |
|
.Sq \e(em |
|
.Pq em-dash |
|
and |
|
.Sq \ee |
|
.Pq back-slash . |
|
. |
|
. |
|
.Ss Text Decoration |
|
Terms may be text-decorated using the |
|
.Sq \ef |
|
escape followed by an indicator: B (bold), I, (italic), R (Roman), or P |
|
(revert to previous mode): |
.Pp |
.Pp |
Characters may alternatively be escaped by a slash-asterisk, |
.D1 \efBbold\efR \efIitalic\efP |
.Sq \\* , |
|
with the same combinations as described above. This form is deprecated. |
|
.Pp |
.Pp |
The following is a table of all available escapes. |
A numerical representation 3, 2, or 1 (bold, italic, and Roman, |
|
respectively) may be used instead. A text decoration is only valid, if |
|
specified in free-form text, until the next macro invocation; if |
|
specified within a macro, it's only valid until the macro closes scope. |
|
Note that macros like |
|
.Sx \&BR |
|
open and close a font scope with each argument. |
.Pp |
.Pp |
Grammatic: |
Text may also be sized with the |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Sq \es |
.It \\(em |
escape, whose syntax is one of |
.Pq em-dash |
.Sq \es+-n |
.It \\(en |
for one-digit numerals; |
.Pq en-dash |
.Sq \es(+-nn |
.It \e- |
or |
.Pq hyphen |
.Sq \es+-(nn |
.It \\\\ |
for two-digit numerals; and |
.Pq back-slash |
.Sq \es[+-N] , |
.It \e' |
.Sq \es+-[N] , |
.Pq apostrophe |
.Sq \es'+-N' , |
.It \e` |
or |
.Pq back-tick |
.Sq \es+-'N' |
.It \\ |
for arbitrary-digit numerals: |
.Pq space |
|
.It \\. |
|
.Pq period |
|
.It \\(r! |
|
.Pq upside-down exclamation |
|
.It \\(r? |
|
.Pq upside-down question |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
.Pp |
Enclosures: |
.D1 \es+1bigger\es-1 |
.Bl -tag -width 12n -offset "XXXX" -compact |
.D1 \es[+10]much bigger\es[-10] |
.It \\(lh |
.D1 \es+(10much bigger\es-(10 |
.Pq left hand |
.D1 \es+'100'much much bigger\es-'100' |
.It \\(rh |
|
.Pq right hand |
|
.It \\(Fo |
|
.Pq left guillemet |
|
.It \\(Fc |
|
.Pq right guillemet |
|
.It \\(fo |
|
.Pq left guilsing |
|
.It \\(fc |
|
.Pq right guilsing |
|
.It \\(rC |
|
.Pq right brace |
|
.It \\(lC |
|
.Pq left brace |
|
.It \\(ra |
|
.Pq right angle |
|
.It \\(la |
|
.Pq left angle |
|
.It \\(rB |
|
.Pq right bracket |
|
.It \\(lB |
|
.Pq left bracket |
|
.It \\q |
|
.Pq double-quote |
|
.It \\(lq |
|
.Pq left double-quote |
|
.It \\(Lq |
|
.Pq left double-quote, deprecated |
|
.It \\(rq |
|
.Pq right double-quote |
|
.It \\(Rq |
|
.Pq right double-quote, deprecated |
|
.It \\(oq |
|
.Pq left single-quote |
|
.It \\(aq |
|
.Pq right single-quote |
|
.It \\(Bq |
|
.Pq right low double-quote |
|
.It \\(bq |
|
.Pq right low single-quote |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
.Pp |
Indicatives: |
Both |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Sq \es |
.It \\(<- |
and |
.Pq left arrow |
.Sq \ef |
.It \\(-> |
attributes are forgotten when entering or exiting a macro block. |
.Pq right arrow |
. |
.It \\(ua |
. |
.Pq up arrow |
.Ss Whitespace |
.It \\(da |
Unless specifically escaped, consecutive blocks of whitespace are pruned |
.Pq down arrow |
from input. These are later re-added, if applicable, by a front-end |
.It \\(<> |
utility such as |
.Pq left-right arrow |
.Xr mandoc 1 . |
.It \\(lA |
. |
.Pq left double-arrow |
. |
.It \\(rA |
.Ss Dates |
.Pq right double-arrow |
The |
.It \\(uA |
.Sx \&TH |
.Pq up double-arrow |
macro is the only |
.It \\(dA |
.Nm |
.Pq down double-arrow |
macro that requires a date. The form for this date is the ISO-8601 |
.It \\(hA |
standard |
.Pq left-right double-arrow |
.Cm YYYY-MM-DD . |
.El |
. |
.\" PARAGRAPH |
. |
|
.Ss Scaling Widths |
|
Many macros support scaled widths for their arguments, such as |
|
stipulating a two-inch paragraph indentation with the following: |
|
.Bd -literal -offset indent |
|
\&.HP 2i |
|
.Ed |
|
. |
.Pp |
.Pp |
Mathematical: |
The syntax for scaled widths is |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Sq Li [+-]?[0-9]*.[0-9]*[:unit:]? , |
.It \\(es |
where a decimal must be preceded or proceeded by at least one digit. |
.Pq empty set |
Negative numbers, while accepted, are truncated to zero. The following |
.It \\(ca |
scaling units are accepted: |
.Pq intersection |
. |
.It \\(cu |
.Pp |
.Pq union |
.Bl -tag -width Ds -offset indent -compact |
.It \\(gr |
.It c |
.Pq gradient |
centimetre |
.It \\(pd |
.It i |
.Pq partial differential |
inch |
.It \\(ap |
.It P |
.Pq similarity |
pica (~1/6 inch) |
.It \\(=) |
.It p |
.Pq proper superset |
point (~1/72 inch) |
.It \\((= |
.It f |
.Pq proper subset |
synonym for |
.It \\(eq |
.Sq u |
.Pq equals |
.It v |
.It \\(di |
default vertical span |
.Pq division |
.It m |
.It \\(mu |
width of rendered |
.Pq multiplication |
.Sq m |
.It \\(pl |
.Pq em |
.Pq addition |
character |
.It \\(nm |
.It n |
.Pq not element |
width of rendered |
.It \\(mo |
.Sq n |
.Pq element |
.Pq en |
.It \\(Im |
character |
.Pq imaginary |
.It u |
.It \\(Re |
default horizontal span |
.Pq real |
.It M |
.It \\(Ah |
mini-em (~1/100 em) |
.Pq aleph |
|
.It \\(te |
|
.Pq existential quantifier |
|
.It \\(fa |
|
.Pq universal quantifier |
|
.It \\(AN |
|
.Pq logical AND |
|
.It \\(OR |
|
.Pq logical OR |
|
.It \\(no |
|
.Pq logical NOT |
|
.It \\(st |
|
.Pq such that |
|
.It \\(tf |
|
.Pq therefore |
|
.It \\(~~ |
|
.Pq approximate |
|
.It \\(~= |
|
.Pq approximately equals |
|
.It \\(=~ |
|
.Pq congruent |
|
.It \\(Gt |
|
.Pq greater-than, deprecated |
|
.It \\(Lt |
|
.Pq less-than, deprecated |
|
.It \\(<= |
|
.Pq less-than-equal |
|
.It \\(Le |
|
.Pq less-than-equal, deprecated |
|
.It \\(>= |
|
.Pq greater-than-equal |
|
.It \\(Ge |
|
.Pq greater-than-equal |
|
.It \\(== |
|
.Pq equal |
|
.It \\(!= |
|
.Pq not equal |
|
.It \\(Ne |
|
.Pq not equal, deprecated |
|
.It \\(if |
|
.Pq infinity |
|
.It \\(If |
|
.Pq infinity, deprecated |
|
.It \\(na |
|
.Pq NaN , an extension |
|
.It \\(Na |
|
.Pq NaN, deprecated |
|
.It \\(+- |
|
.Pq plus-minus |
|
.It \\(Pm |
|
.Pq plus-minus, deprecated |
|
.It \\(** |
|
.Pq asterisk |
|
.El |
.El |
.\" PARAGRAPH |
|
.Pp |
.Pp |
Ligatures: |
Using anything other than |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Sq m , |
.It \\(ss |
.Sq n , |
.Pq German eszett |
.Sq u , |
.It \\(AE |
or |
.Pq upper-case AE |
.Sq v |
.It \\(ae |
is necessarily non-portable across output media. |
.Pq lower-case AE |
. |
.It \\(OE |
.Pp |
.Pq upper-case OE |
If a scaling unit is not provided, the numerical value is interpreted |
.It \\(oe |
under the default rules of |
.Pq lower-case OE |
.Sq v |
.It \\(ff |
for vertical spaces and |
.Pq ff ligature |
.Sq u |
.It \\(fi |
for horizontal ones. |
.Pq fi ligature |
.Em Note : |
.It \\(fl |
this differs from |
.Pq fl ligature |
.Xr mdoc 7 , |
.It \\(Fi |
which, if a unit is not provided, will instead interpret the string as |
.Pq ffi ligature |
literal text. |
.It \\(Fl |
. |
.Pq ffl ligature |
. |
|
.Sh MANUAL STRUCTURE |
|
Each |
|
.Nm |
|
document must contain contains at least the |
|
.Sx \&TH |
|
macro describing the document's section and title. It may occur |
|
anywhere in the document, although conventionally, it appears as the |
|
first macro. |
|
. |
|
.Pp |
|
Beyond |
|
.Sx \&TH , |
|
at least one macro or text node must appear in the document. Documents |
|
are generally structured as follows: |
|
.Bd -literal -offset indent |
|
\&.TH FOO 1 2009-10-10 |
|
\&. |
|
\&.SH NAME |
|
\efBfoo\efR \e(en a description goes here |
|
\&.\e\*q The next is for sections 2 & 3 only. |
|
\&.\e\*q .SH LIBRARY |
|
\&. |
|
\&.SH SYNOPSIS |
|
\efBfoo\efR [\efB\e-options\efR] arguments... |
|
\&. |
|
\&.SH DESCRIPTION |
|
The \efBfoo\efR utility processes files... |
|
\&. |
|
\&.\e\*q .SH IMPLEMENTATION NOTES |
|
\&.\e\*q The next is for sections 1 & 8 only. |
|
\&.\e\*q .SH EXIT STATUS |
|
\&.\e\*q The next is for sections 2, 3, & 9 only. |
|
\&.\e\*q .SH RETURN VALUES |
|
\&.\e\*q The next is for sections 1, 6, 7, & 8 only. |
|
\&.\e\*q .SH ENVIRONMENT |
|
\&.\e\*q .SH FILES |
|
\&.\e\*q .SH EXAMPLES |
|
\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only. |
|
\&.\e\*q .SH DIAGNOSTICS |
|
\&.\e\*q The next is for sections 2, 3, & 9 only. |
|
\&.\e\*q .SH ERRORS |
|
\&.\e\*q .SH SEE ALSO |
|
\&.\e\*q .BR foo ( 1 ) |
|
\&.\e\*q .SH STANDARDS |
|
\&.\e\*q .SH HISTORY |
|
\&.\e\*q .SH AUTHORS |
|
\&.\e\*q .SH CAVEATS |
|
\&.\e\*q .SH BUGS |
|
\&.\e\*q .SH SECURITY CONSIDERATIONS |
|
.Ed |
|
.Pp |
|
The sections in a |
|
.Nm |
|
document are conventionally ordered as they appear above. Sections |
|
should be composed as follows: |
|
.Bl -ohang -offset indent |
|
.It Em NAME |
|
The name(s) and a short description of the documented material. The |
|
syntax for this is generally as follows: |
|
.Pp |
|
.D1 \efBname\efR \e(en description |
|
.It Em LIBRARY |
|
The name of the library containing the documented material, which is |
|
assumed to be a function in a section 2 or 3 manual. For functions in |
|
the C library, this may be as follows: |
|
.Pp |
|
.D1 Standard C Library (libc, -lc) |
|
.It Em SYNOPSIS |
|
Documents the utility invocation syntax, function call syntax, or device |
|
configuration. |
|
.Pp |
|
For the first, utilities (sections 1, 6, and 8), this is |
|
generally structured as follows: |
|
.Pp |
|
.D1 \efBname\efR [-\efBab\efR] [-\efBc\efR\efIarg\efR] \efBpath\efR... |
|
.Pp |
|
For the second, function calls (sections 2, 3, 9): |
|
.Pp |
|
.D1 \&.B char *name(char *\efIarg\efR); |
|
.Pp |
|
And for the third, configurations (section 4): |
|
.Pp |
|
.D1 \&.B name* at cardbus ? function ? |
|
.Pp |
|
Manuals not in these sections generally don't need a |
|
.Em SYNOPSIS . |
|
.It Em DESCRIPTION |
|
This expands upon the brief, one-line description in |
|
.Em NAME . |
|
It usually contains a break-down of the options (if documenting a |
|
command). |
|
.It Em IMPLEMENTATION NOTES |
|
Implementation-specific notes should be kept here. This is useful when |
|
implementing standard functions that may have side effects or notable |
|
algorithmic implications. |
|
.It Em EXIT STATUS |
|
Command exit status for section 1, 6, and 8 manuals. This section is |
|
the dual of |
|
.Em RETURN VALUES , |
|
which is used for functions. Historically, this information was |
|
described in |
|
.Em DIAGNOSTICS , |
|
a practise that is now discouraged. |
|
. |
|
.It Em RETURN VALUES |
|
This section is the dual of |
|
.Em EXIT STATUS , |
|
which is used for commands. It documents the return values of functions |
|
in sections 2, 3, and 9. |
|
. |
|
.It Em ENVIRONMENT |
|
Documents any usages of environment variables, e.g., |
|
.Xr environ 7 . |
|
. |
|
.It Em FILES |
|
Documents files used. It's helpful to document both the file and a |
|
short description of how the file is used (created, modified, etc.). |
|
. |
|
.It Em EXAMPLES |
|
Example usages. This often contains snippets of well-formed, |
|
well-tested invocations. Make doubly sure that your examples work |
|
properly! |
|
. |
|
.It Em DIAGNOSTICS |
|
Documents error conditions. This is most useful in section 4 manuals. |
|
Historically, this section was used in place of |
|
.Em EXIT STATUS |
|
for manuals in sections 1, 6, and 8; however, this practise is |
|
discouraged. |
|
. |
|
.It Em ERRORS |
|
Documents error handling in sections 2, 3, and 9. |
|
. |
|
.It Em SEE ALSO |
|
References other manuals with related topics. This section should exist |
|
for most manuals. |
|
.Pp |
|
.D1 \&.BR bar \&( 1 \&), |
|
.Pp |
|
Cross-references should conventionally be ordered |
|
first by section, then alphabetically. |
|
. |
|
.It Em STANDARDS |
|
References any standards implemented or used, such as |
|
.Pp |
|
.D1 IEEE Std 1003.2 (\e(lqPOSIX.2\e(rq) |
|
.Pp |
|
If not adhering to any standards, the |
|
.Em HISTORY |
|
section should be used. |
|
. |
|
.It Em HISTORY |
|
The history of any manual without a |
|
.Em STANDARDS |
|
section should be described in this section. |
|
. |
|
.It Em AUTHORS |
|
Credits to authors, if applicable, should appear in this section. |
|
Authors should generally be noted by both name and an e-mail address. |
|
. |
|
.It Em CAVEATS |
|
Explanations of common misuses and misunderstandings should be explained |
|
in this section. |
|
. |
|
.It Em BUGS |
|
Extant bugs should be described in this section. |
|
. |
|
.It Em SECURITY CONSIDERATIONS |
|
Documents any security precautions that operators should consider. |
|
. |
.El |
.El |
.\" PARAGRAPH |
. |
|
. |
|
.Sh MACRO SYNTAX |
|
Macros are one to three three characters in length and begin with a |
|
control character , |
|
.Sq \&. , |
|
at the beginning of the line. An arbitrary amount of whitespace may |
|
sit between the control character and the macro name. Thus, the |
|
following are equivalent: |
|
.Bd -literal -offset indent |
|
\&.PP |
|
\&.\ \ \ PP |
|
.Ed |
|
. |
.Pp |
.Pp |
Diacritics and letters: |
The |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Nm |
.It \\(ga |
macros are classified by scope: line scope or block scope. Line |
.Pq grave accent |
macros are only scoped to the current line (and, in some situations, |
.It \\(aa |
the subsequent line). Block macros are scoped to the current line and |
.Pq accute accent |
subsequent lines until closed by another block macro. |
.It \\(a" |
. |
.Pq umlaut accent |
. |
.It \\(ad |
.Ss Line Macros |
.Pq dieresis accent |
Line macros are generally scoped to the current line, with the body |
.It \\(a~ |
consisting of zero or more arguments. If a macro is scoped to the next |
.Pq tilde accent |
line and the line arguments are empty, the next line, which must be |
.It \\(a^ |
text, is used instead. Thus: |
.Pq circumflex accent |
.Bd -literal -offset indent |
.It \\(ac |
\&.I |
.Pq cedilla accent |
foo |
.It \\(ad |
.Ed |
.Pq dieresis accent |
. |
.It \\(ah |
.Pp |
.Pq caron accent |
is equivalent to |
.It \\(ao |
.Sq \&.I foo . |
.Pq ring accent |
If next-line macros are invoked consecutively, only the last is used. |
.It \\(ho |
If a next-line macro is followed by a non-next-line macro, an error is |
.Pq hook accent |
raised (unless in the case of |
.It \\(ab |
.Sx \&br , |
.Pq breve accent |
.Sx \&sp , |
.It \\(a- |
.Sx \&Sp , |
.Pq macron accent |
or |
.It \\(-D |
.Sx \&na ) . |
.Pq upper-case eth |
.Pp |
.It \\(Sd |
The syntax is as follows: |
.Pq lower-case eth |
.Bd -literal -offset indent |
.It \\(TP |
\&.YO \(lBbody...\(rB |
.Pq upper-case thorn |
\(lBbody...\(rB |
.It \\(Tp |
.Ed |
.Pq lower-case thorn |
. |
.It \\('A |
.Pp |
.Pq upper-case acute A |
.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX" |
.It \\('E |
.It Em Macro Ta Em Arguments Ta Em Scope Ta Em Notes |
.Pq upper-case acute E |
.It Sx \&B Ta n Ta next-line Ta \& |
.It \\('I |
.It Sx \&BI Ta n Ta current Ta \& |
.Pq upper-case acute I |
.It Sx \&BR Ta n Ta current Ta \& |
.It \\('O |
.It Sx \&DT Ta 0 Ta current Ta \& |
.Pq upper-case acute O |
.It Sx \&I Ta n Ta next-line Ta \& |
.It \\('U |
.It Sx \&IB Ta n Ta current Ta \& |
.Pq upper-case acute U |
.It Sx \&IR Ta n Ta current Ta \& |
.It \\('a |
.\" .It Sx \&PD Ta n Ta current Ta compat |
.Pq lower-case acute a |
.It Sx \&R Ta n Ta next-line Ta \& |
.It \\('e |
.It Sx \&RB Ta n Ta current Ta \& |
.Pq lower-case acute e |
.It Sx \&RI Ta n Ta current Ta \& |
.It \\('i |
.It Sx \&SB Ta n Ta next-line Ta \& |
.Pq lower-case acute i |
.It Sx \&SM Ta n Ta next-line Ta \& |
.It \\('o |
.It Sx \&TH Ta >1, <6 Ta current Ta \& |
.Pq lower-case acute o |
.\" .It Sx \&UC Ta n Ta current Ta compat |
.It \\('u |
.It Sx \&br Ta 0 Ta current Ta compat |
.Pq lower-case acute u |
.It Sx \&fi Ta 0 Ta current Ta compat |
.It \\(`A |
.It Sx \&i Ta n Ta current Ta compat |
.Pq upper-case grave A |
.It Sx \&na Ta 0 Ta current Ta compat |
.It \\(`E |
.It Sx \&nf Ta 0 Ta current Ta compat |
.Pq upper-case grave E |
.It Sx \&r Ta 0 Ta current Ta compat |
.It \\(`I |
.It Sx \&sp Ta 1 Ta current Ta compat |
.Pq upper-case grave I |
.\" .It Sx \&Sp Ta 0 Ta current Ta compat |
.It \\(`O |
.\" .It Sx \&Vb Ta <1 Ta current Ta compat |
.Pq upper-case grave O |
.\" .It Sx \&Ve Ta 0 Ta current Ta compat |
.It \\(`U |
|
.Pq upper-case grave U |
|
.It \\(`a |
|
.Pq lower-case grave a |
|
.It \\(`e |
|
.Pq lower-case grave e |
|
.It \\(`i |
|
.Pq lower-case grave i |
|
.It \\(`o |
|
.Pq lower-case grave o |
|
.It \\(`u |
|
.Pq lower-case grave u |
|
.It \\(~A |
|
.Pq upper-case tilde A |
|
.It \\(~N |
|
.Pq upper-case tilde N |
|
.It \\(~O |
|
.Pq upper-case tilde O |
|
.It \\(~a |
|
.Pq lower-case tilde a |
|
.It \\(~n |
|
.Pq lower-case tilde n |
|
.It \\(~o |
|
.Pq lower-case tilde o |
|
.It \\(:A |
|
.Pq upper-case dieresis A |
|
.It \\(:E |
|
.Pq upper-case dieresis E |
|
.It \\(:I |
|
.Pq upper-case dieresis I |
|
.It \\(:O |
|
.Pq upper-case dieresis O |
|
.It \\(:U |
|
.Pq upper-case dieresis U |
|
.It \\(:a |
|
.Pq lower-case dieresis a |
|
.It \\(:e |
|
.Pq lower-case dieresis e |
|
.It \\(:i |
|
.Pq lower-case dieresis i |
|
.It \\(:o |
|
.Pq lower-case dieresis o |
|
.It \\(:u |
|
.Pq lower-case dieresis u |
|
.It \\(:y |
|
.Pq lower-case dieresis y |
|
.It \\(^A |
|
.Pq upper-case circumflex A |
|
.It \\(^E |
|
.Pq upper-case circumflex E |
|
.It \\(^I |
|
.Pq upper-case circumflex I |
|
.It \\(^O |
|
.Pq upper-case circumflex O |
|
.It \\(^U |
|
.Pq upper-case circumflex U |
|
.It \\(^a |
|
.Pq lower-case circumflex a |
|
.It \\(^e |
|
.Pq lower-case circumflex e |
|
.It \\(^i |
|
.Pq lower-case circumflex i |
|
.It \\(^o |
|
.Pq lower-case circumflex o |
|
.It \\(^u |
|
.Pq lower-case circumflex u |
|
.It \\(,C |
|
.Pq upper-case cedilla C |
|
.It \\(,c |
|
.Pq lower-case cedilla c |
|
.It \\(/L |
|
.Pq upper-case stroke L |
|
.It \\(/l |
|
.Pq lower-case stroke l |
|
.It \\(/O |
|
.Pq upper-case stroke O |
|
.It \\(/o |
|
.Pq lower-case stroke o |
|
.It \\(oA |
|
.Pq upper-case ring A |
|
.It \\(oa |
|
.Pq lower-case ring a |
|
.El |
.El |
.\" PARAGRAPH |
. |
.Pp |
.Pp |
Monetary: |
Macros marked as |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Qq compat |
.It \\(Cs |
are included for compatibility with the significant corpus of existing |
.Pq Scandinavian |
manuals that mix dialects of roff. These macros should not be used for |
.It \\(Do |
portable |
.Pq dollar |
.Nm |
.It \\(Po |
manuals. |
.Pq pound |
. |
.It \\(Ye |
. |
.Pq yen |
.Ss Block Macros |
.It \\(Fn |
Block macros are comprised of a head and body. Like for in-line macros, |
.Pq florin |
the head is scoped to the current line and, in one circumstance, the |
.It \\(ct |
next line (the next-line stipulations as in |
.Pq cent |
.Sx Line Macros |
|
apply here as well). |
|
.Pp |
|
The syntax is as follows: |
|
.Bd -literal -offset indent |
|
\&.YO \(lBhead...\(rB |
|
\(lBhead...\(rB |
|
\(lBbody...\(rB |
|
.Ed |
|
. |
|
.Pp |
|
The closure of body scope may be to the section, where a macro is closed |
|
by |
|
.Sx \&SH ; |
|
sub-section, closed by a section or |
|
.Sx \&SS ; |
|
part, closed by a section, sub-section, or |
|
.Sx \&RE ; |
|
or paragraph, closed by a section, sub-section, part, |
|
.Sx \&HP , |
|
.Sx \&IP , |
|
.Sx \&LP , |
|
.Sx \&P , |
|
.Sx \&PP , |
|
or |
|
.Sx \&TP . |
|
No closure refers to an explicit block closing macro. |
|
. |
|
.Pp |
|
As a rule, block macros may not be nested; thus, calling a block macro |
|
while another block macro scope is open, and the open scope is not |
|
implicitly closed, is syntactically incorrect. |
|
. |
|
.Pp |
|
.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" "compatX" |
|
.It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope Ta Em Notes |
|
.It Sx \&HP Ta <2 Ta current Ta paragraph Ta \& |
|
.It Sx \&IP Ta <3 Ta current Ta paragraph Ta \& |
|
.It Sx \&LP Ta 0 Ta current Ta paragraph Ta \& |
|
.It Sx \&P Ta 0 Ta current Ta paragraph Ta \& |
|
.It Sx \&PP Ta 0 Ta current Ta paragraph Ta \& |
|
.It Sx \&RE Ta 0 Ta current Ta none Ta compat |
|
.It Sx \&RS Ta 1 Ta current Ta part Ta compat |
|
.It Sx \&SH Ta >0 Ta next-line Ta section Ta \& |
|
.It Sx \&SS Ta >0 Ta next-line Ta sub-section Ta \& |
|
.It Sx \&TP Ta n Ta next-line Ta paragraph Ta \& |
.El |
.El |
.\" PARAGRAPH |
|
.Pp |
.Pp |
Special symbols: |
. |
.Bl -tag -width 12n -offset "XXXX" -compact |
Macros marked |
.It \\(de |
.Qq compat |
.Pq degree |
are as mentioned in |
.It \\(ps |
.Sx Line Macros . |
.Pq paragraph |
. |
.It \\(sc |
.Pp |
.Pq section |
If a block macro is next-line scoped, it may only be followed by in-line |
.It \\(dg |
macros for decorating text. |
.Pq dagger |
. |
.It \\(dd |
. |
.Pq double dagger |
.Sh REFERENCE |
.It \\(ci |
This section is a canonical reference to all macros, arranged |
.Pq circle |
alphabetically. For the scoping of individual macros, see |
.It \\(ba |
.Sx MACRO SYNTAX . |
.Pq bar |
. |
.It \\(bb |
. |
.Pq broken bar |
.Ss \&B |
.It \\(Ba |
Text is rendered in bold face. |
.Pq bar, deprecated |
.Pp |
.It \\(co |
See also |
.Pq copyright |
.Sx \&I , |
.It \\(rg |
.Sx \&R , |
.Pq registered |
.Sx \&b , |
.It \\(tm |
.Sx \&i , |
.Pq trademarked |
and |
.It \\& |
.Sx \&r . |
.Pq non-breaking space |
. |
.It \\e |
. |
.Pq escape |
.Ss \&BI |
.It \\(Am |
Text is rendered alternately in bold face and italic. Thus, |
.Pq ampersand, deprecated |
.Sq .BI this word and that |
.El |
causes |
.\" SECTION |
.Sq this |
.Sh STRUCTURE |
and |
Macros are case in-sensitive and one to three three characters in |
.Sq and |
length. All follow the same structural rules: |
to render in bold face, while |
.Bd -literal -offset XXXX |
.Sq word |
\&.Yo \(lBbody...\(rB |
and |
|
.Sq that |
|
render in italics. Whitespace between arguments is omitted in output. |
|
.Pp |
|
Examples: |
|
.Pp |
|
.D1 \&.BI bold italic bold italic |
|
.Pp |
|
The output of this example will be emboldened |
|
.Dq bold |
|
and italicised |
|
.Dq italic , |
|
with spaces stripped between arguments. |
|
.Pp |
|
See also |
|
.Sx \&IB , |
|
.Sx \&BR , |
|
.Sx \&RB , |
|
.Sx \&RI , |
|
and |
|
.Sx \&IR . |
|
. |
|
. |
|
.Ss \&BR |
|
Text is rendered alternately in bold face and roman (the default font). |
|
Whitespace between arguments is omitted in output. |
|
.Pp |
|
See |
|
.Sx \&BI |
|
for an equivalent example. |
|
.Pp |
|
See also |
|
.Sx \&BI , |
|
.Sx \&IB , |
|
.Sx \&RB , |
|
.Sx \&RI , |
|
and |
|
.Sx \&IR . |
|
. |
|
. |
|
.Ss \&DT |
|
Has no effect. Included for compatibility. |
|
. |
|
. |
|
.Ss \&HP |
|
Begin a paragraph whose initial output line is left-justified, but |
|
subsequent output lines are indented, with the following syntax: |
|
.Bd -filled -offset indent |
|
.Pf \. Sx \&HP |
|
.Op Cm width |
.Ed |
.Ed |
.Pp |
.Pp |
The |
The |
.Dq body |
.Cm width |
consists of zero or more arguments to the macro. |
argument must conform to |
.\" PARAGRAPH |
.Sx Scaling Widths . |
.Sh MACROS |
If specified, it's saved for later paragraph left-margins; if unspecified, the |
This section contains a complete list of all |
saved or default width is used. |
|
.Pp |
|
See also |
|
.Sx \&IP , |
|
.Sx \&LP , |
|
.Sx \&P , |
|
.Sx \&PP , |
|
and |
|
.Sx \&TP . |
|
. |
|
. |
|
.Ss \&I |
|
Text is rendered in italics. |
|
.Pp |
|
See also |
|
.Sx \&B , |
|
.Sx \&R , |
|
.Sx \&b , |
|
.Sx \&i , |
|
and |
|
.Sx \&r . |
|
. |
|
. |
|
.Ss \&IB |
|
Text is rendered alternately in italics and bold face. Whitespace |
|
between arguments is omitted in output. |
|
.Pp |
|
See |
|
.Sx \&BI |
|
for an equivalent example. |
|
.Pp |
|
See also |
|
.Sx \&BI , |
|
.Sx \&BR , |
|
.Sx \&RB , |
|
.Sx \&RI , |
|
and |
|
.Sx \&IR . |
|
. |
|
. |
|
.Ss \&IP |
|
Begin an indented paragraph with the following syntax: |
|
.Bd -filled -offset indent |
|
.Pf \. Sx \&IP |
|
.Op Cm head Op Cm width |
|
.Ed |
|
.Pp |
|
The |
|
.Cm width |
|
argument defines the width of the left margin and is defined by |
|
.Sx Scaling Widths , |
|
It's saved for later paragraph left-margins; if unspecified, the saved or |
|
default width is used. |
|
.Pp |
|
The |
|
.Cm head |
|
argument is used as a leading term, flushed to the left margin. This is |
|
useful for bulleted paragraphs and so on. |
|
.Pp |
|
See also |
|
.Sx \&HP , |
|
.Sx \&LP , |
|
.Sx \&P , |
|
.Sx \&PP , |
|
and |
|
.Sx \&TP . |
|
. |
|
. |
|
.Ss \&IR |
|
Text is rendered alternately in italics and roman (the default font). |
|
Whitespace between arguments is omitted in output. |
|
.Pp |
|
See |
|
.Sx \&BI |
|
for an equivalent example. |
|
.Pp |
|
See also |
|
.Sx \&BI , |
|
.Sx \&IB , |
|
.Sx \&BR , |
|
.Sx \&RB , |
|
and |
|
.Sx \&RI . |
|
. |
|
. |
|
.Ss \&LP |
|
Begin an undecorated paragraph. The scope of a paragraph is closed by a |
|
subsequent paragraph, sub-section, section, or end of file. The saved |
|
paragraph left-margin width is re-set to the default. |
|
.Pp |
|
See also |
|
.Sx \&HP , |
|
.Sx \&IP , |
|
.Sx \&P , |
|
.Sx \&PP , |
|
and |
|
.Sx \&TP . |
|
. |
|
. |
|
.Ss \&P |
|
Synonym for |
|
.Sx \&LP . |
|
.Pp |
|
See also |
|
.Sx \&HP , |
|
.Sx \&IP , |
|
.Sx \&LP , |
|
.Sx \&PP , |
|
and |
|
.Sx \&TP . |
|
. |
|
. |
|
.Ss \&PP |
|
Synonym for |
|
.Sx \&LP . |
|
.Pp |
|
See also |
|
.Sx \&HP , |
|
.Sx \&IP , |
|
.Sx \&LP , |
|
.Sx \&P , |
|
and |
|
.Sx \&TP . |
|
. |
|
. |
|
.Ss \&R |
|
Text is rendered in roman (the default font). |
|
.Pp |
|
See also |
|
.Sx \&I , |
|
.Sx \&B , |
|
.Sx \&b , |
|
.Sx \&i , |
|
and |
|
.Sx \&r . |
|
. |
|
. |
|
.Ss \&RB |
|
Text is rendered alternately in roman (the default font) and bold face. |
|
Whitespace between arguments is omitted in output. |
|
.Pp |
|
See |
|
.Sx \&BI |
|
for an equivalent example. |
|
.Pp |
|
See also |
|
.Sx \&BI , |
|
.Sx \&IB , |
|
.Sx \&BR , |
|
.Sx \&RI , |
|
and |
|
.Sx \&IR . |
|
. |
|
. |
|
.Ss \&RE |
|
Explicitly close out the scope of a prior |
|
.Sx \&RS . |
|
. |
|
. |
|
.Ss \&RI |
|
Text is rendered alternately in roman (the default font) and italics. |
|
Whitespace between arguments is omitted in output. |
|
.Pp |
|
See |
|
.Sx \&BI |
|
for an equivalent example. |
|
.Pp |
|
See also |
|
.Sx \&BI , |
|
.Sx \&IB , |
|
.Sx \&BR , |
|
.Sx \&RB , |
|
and |
|
.Sx \&IR . |
|
. |
|
. |
|
.Ss \&RS |
|
Begin a part setting the left margin. The left margin controls the |
|
offset, following an initial indentation, to un-indented text such as |
|
that of |
|
.Sx \&PP . |
|
This has the following syntax: |
|
.Bd -filled -offset indent |
|
.Pf \. Sx \&Rs |
|
.Op Cm width |
|
.Ed |
|
.Pp |
|
The |
|
.Cm width |
|
argument must conform to |
|
.Sx Scaling Widths . |
|
If not specified, the saved or default width is used. |
|
. |
|
. |
|
.Ss \&SB |
|
Text is rendered in small size (one point smaller than the default font) |
|
bold face. |
|
. |
|
. |
|
.Ss \&SH |
|
Begin a section. The scope of a section is only closed by another |
|
section or the end of file. The paragraph left-margin width is re-set |
|
to the default. |
|
. |
|
. |
|
.Ss \&SM |
|
Text is rendered in small size (one point smaller than the default |
|
font). |
|
. |
|
. |
|
.Ss \&SS |
|
Begin a sub-section. The scope of a sub-section is closed by a |
|
subsequent sub-section, section, or end of file. The paragraph |
|
left-margin width is re-set to the default. |
|
. |
|
. |
|
.Ss \&TH |
|
Sets the title of the manual page with the following syntax: |
|
.Bd -filled -offset indent |
|
.Pf \. Sx \&TH |
|
.Cm title section |
|
.Op Cm date Op Cm source Op Cm volume |
|
.Ed |
|
.Pp |
|
At least the upper-case document title |
|
.Cm title |
|
and numeric manual section |
|
.Cm section |
|
arguments must be provided. The |
|
.Cm date |
|
argument should be formatted as described in |
|
.Sx Dates : |
|
if it does not conform, the current date is used instead. The |
|
.Cm source |
|
string specifies the organisation providing the utility. The |
|
.Cm volume |
|
string replaces the default rendered volume, which is dictated by the |
|
manual section. |
|
.Pp |
|
Examples: |
|
.Pp |
|
.D1 \&.TH CVS 5 "1992-02-12" GNU |
|
. |
|
. |
|
.Ss \&TP |
|
Begin a paragraph where the head, if exceeding the indentation width, is |
|
followed by a newline; if not, the body follows on the same line after a |
|
buffer to the indentation width. Subsequent output lines are indented. |
|
The syntax is as follows: |
|
.Bd -filled -offset indent |
|
.Pf \. Sx \&TP |
|
.Op Cm width |
|
.Ed |
|
.Pp |
|
The |
|
.Cm width |
|
argument must conform to |
|
.Sx Scaling Widths . |
|
If specified, it's saved for later paragraph left-margins; if |
|
unspecified, the saved or default width is used. |
|
.Pp |
|
See also |
|
.Sx \&HP , |
|
.Sx \&IP , |
|
.Sx \&LP , |
|
.Sx \&P , |
|
and |
|
.Sx \&PP . |
|
.\" . |
|
.\" . |
|
.\" .Ss \&PD |
|
.\" Has no effect. Included for compatibility. |
|
.\" . |
|
.\" . |
|
.\" .Ss \&UC |
|
.\" Has no effect. Included for compatibility. |
|
. |
|
. |
|
.Ss \&br |
|
Breaks the current line. Consecutive invocations have no further effect. |
|
.Pp |
|
See also |
|
.Sx \&sp . |
|
. |
|
. |
|
.Ss \&fi |
|
End literal mode begun by |
|
.Sx \&nf . |
|
. |
|
. |
|
.Ss \&i |
|
Italicise arguments. Synonym for |
|
.Sx \&I . |
|
.Pp |
|
See also |
|
.Sx \&B , |
|
.Sx \&I , |
|
.Sx \&R . |
|
.Sx \&b , |
|
and |
|
.Sx \&r . |
|
. |
|
. |
|
.Ss \&na |
|
Don't align to the right margin. |
|
. |
|
. |
|
.Ss \&nf |
|
Begin literal mode: all subsequent free-form lines have their end of |
|
line boundaries preserved. May be ended by |
|
.Sx \&fi . |
|
. |
|
. |
|
.Ss \&r |
|
Fonts and styles (bold face, italics) reset to roman (default font). |
|
.Pp |
|
See also |
|
.Sx \&B , |
|
.Sx \&I , |
|
.Sx \&R , |
|
.Sx \&b , |
|
and |
|
.Sx \&i . |
|
. |
|
. |
|
.Ss \&sp |
|
Insert vertical spaces into output with the following syntax: |
|
.Bd -filled -offset indent |
|
.Pf \. Sx \&sp |
|
.Op Cm height |
|
.Ed |
|
.Pp |
|
Insert |
|
.Cm height |
|
spaces, which must conform to |
|
.Sx Scaling Widths . |
|
If 0, this is equivalent to the |
|
.Sx \&br |
|
macro. Defaults to 1, if unspecified. |
|
.Pp |
|
See also |
|
.Sx \&br . |
|
. |
|
.\" .Ss \&Sp |
|
.\" A synonym for |
|
.\" .Sx \&sp |
|
.\" .Cm 0.5v . |
|
.\" . |
|
.\" .Ss \&Vb |
|
.\" A synonym for |
|
.\" .Sx \&nf . |
|
.\" Accepts an argument (the height of the formatted space) which is |
|
.\" disregarded. |
|
.\" . |
|
.\" .Ss \&Ve |
|
.\" A synonym for |
|
.\" .Sx \&fi . |
|
.\" . |
|
. |
|
.Sh COMPATIBILITY |
|
This section documents areas of questionable portability between |
|
implementations of the |
.Nm |
.Nm |
macros, arranged alphabetically, with the number of arguments. |
language. |
.Pp |
.Pp |
.Bl -column "MacroX" "Arguments" -compact -offset XXXX |
.Bl -dash -compact |
.It Em Macro Ta Em Arguments |
.It |
.It \&.TH Ta >0 |
In quoted literals, GNU troff allowed pair-wise double-quotes to produce |
.It \&.SH Ta n |
a standalone double-quote in formatted output. It is not known whether |
.It \&.SS Ta n |
this behaviour is exhibited by other formatters. |
.It \&.TP Ta n |
.It |
.It \&.LP Ta n |
Blocks of whitespace are stripped from macro and free-form text lines |
.It \&.PP Ta n |
(except when in literal mode) in mandoc. This is not the case for GNU |
.It \&.P Ta n |
troff: for maximum portability, whitespace sensitive blocks should be |
.It \&.IP Ta n |
enclosed in literal contexts. |
.It \&.HP Ta n |
.It |
.It \&.SM Ta n |
The |
.It \&.SB Ta n |
.Sx \&sp |
.It \&.BI Ta n |
macro does not accept negative values in mandoc. In GNU troff, this |
.It \&.IB Ta n |
would result in strange behaviour. |
.It \&.BR Ta n |
|
.It \&.RB Ta n |
|
.It \&.R Ta n |
|
.It \&.B Ta n |
|
.It \&.I Ta n |
|
.It \&.IR Ta n |
|
.El |
.El |
.\" SECTION |
. |
|
. |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mandoc 1 |
.Xr mandoc 1 , |
.\" SECTION |
.Xr mandoc_char 7 |
|
. |
|
. |
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |
.Nm |
.Nm |
utility was written by |
reference was written by |
.An Kristaps Dzonsons Aq kristaps@openbsd.org . |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
.\" SECTION |
. |
|
. |
.Sh CAVEATS |
.Sh CAVEATS |
Do not use this language. Use |
Do not use this language. Use |
.Xr mdoc 7 , |
.Xr mdoc 7 , |
instead. |
instead. |
|
. |