version 1.1, 2009/03/23 16:02:56 |
version 1.31, 2009/08/20 11:51:07 |
|
|
.\" $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 |
. Pp |
language. |
. Bf -emphasis |
.Pp |
Do not use |
.Em \&Do not |
. Nm |
use |
to write your manuals. |
.Nm |
. Ef |
to write your manuals. Use the |
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 |
. Pp |
line termination. |
Blank lines are acceptable; where found, the output will assert a |
.Pp |
|
Blank lines are acceptable; where found, the output will also assert a |
|
vertical space. |
vertical space. |
.\" SUB-SECTION |
. Pp |
.Ss Special Characters |
The |
Special character sequences begin with the escape character |
. Sq \ec |
.Sq \\ |
escape is common in historical |
followed by either an open-parenthesis |
. Nm |
.Sq \&( |
documents; if encountered at the end of a word, it ensures that the |
|
subsequent word isn't off-set by whitespace. |
|
. |
|
. |
|
. 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 charater and |
|
optionally whitespace are stripped from input. |
|
. |
|
. |
|
. 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 |
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 |
.Pp |
. Xr mandoc_char 7 |
Characters may alternatively be escaped by a slash-asterisk, |
for a complete list. Examples include |
.Sq \\* , |
. Sq \e(em |
with the same combinations as described above. This form is deprecated. |
. Pq em-dash |
.Pp |
and |
The following is a table of all available escapes. |
. Sq \ee |
.Pp |
. Pq back-slash . |
Grammatic: |
. |
.Bl -tag -width 12n -offset "XXXX" -compact |
. |
.It \\(em |
. Ss Text Decoration |
.Pq em-dash |
Terms may be text-decorated using the |
.It \\(en |
. Sq \ef |
.Pq en-dash |
escape followed by an indicator: B (bold), I, (italic), or P and R |
.It \e- |
(Roman, or reset). |
.Pq hyphen |
. |
.It \\\\ |
. |
.Pq back-slash |
. Ss Whitespace |
.It \e' |
Unless specifically escaped, consecutive blocks of whitespace are pruned |
.Pq apostrophe |
from input. These are later re-added, if applicable, by a front-end |
.It \e` |
utility such as |
.Pq back-tick |
. Xr mandoc 1 . |
.It \\ |
. |
.Pq space |
. |
.It \\. |
.Sh MANUAL STRUCTURE |
.Pq period |
Each |
.It \\(r! |
. Nm |
.Pq upside-down exclamation |
document must contain contains at least the |
.It \\(r? |
. Sq TH |
.Pq upside-down question |
macro describing the document's section and title. It may occur |
.El |
anywhere in the document, although conventionally, it appears as the |
.\" PARAGRAPH |
first macro. |
.Pp |
. Pp |
Enclosures: |
Beyond |
.Bl -tag -width 12n -offset "XXXX" -compact |
. Sq TH , |
.It \\(lh |
at least one macro or text node must appear in the document. Documents |
.Pq left hand |
are generally structured as follows: |
.It \\(rh |
. Bd -literal -offset indent |
.Pq right hand |
\&.TH FOO 1 "13 Aug 2009" |
.It \\(Fo |
\&. |
.Pq left guillemet |
\&.SH NAME |
.It \\(Fc |
\efBfoo\efR \e(en a description goes here |
.Pq right guillemet |
\&. |
.It \\(fo |
\&.SH SYNOPSIS |
.Pq left guilsing |
\efBfoo\efR [\efB\e-options\efR] arguments... |
.It \\(fc |
\&. |
.Pq right guilsing |
\&.SH DESCRIPTION |
.It \\(rC |
The \efBfoo\efR utility does... |
.Pq right brace |
\&. |
.It \\(lC |
\&.\e\*q .SH RETURN VALUES |
.Pq left brace |
\&.\e\*q .SH ENVIRONMENT |
.It \\(ra |
\&.\e\*q .SH FILES |
.Pq right angle |
\&.\e\*q .SH EXAMPLES |
.It \\(la |
\&.\e\*q .SH DIAGNOSTICS |
.Pq left angle |
\&.\e\*q .SH ERRORS |
.It \\(rB |
\&.\e\*q .SH SEE ALSO |
.Pq right bracket |
\&.\e\*q \efBbar\efR(1) |
.It \\(lB |
\&.\e\*q .SH STANDARDS |
.Pq left bracket |
\&.\e\*q .SH HISTORY |
.It \\q |
\&.\e\*q .SH AUTHORS |
.Pq double-quote |
\&.\e\*q .SH CAVEATS |
.It \\(lq |
\&.\e\*q .SH BUGS |
.Pq left double-quote |
. Ed |
.It \\(Lq |
. |
.Pq left double-quote, deprecated |
. |
.It \\(rq |
.Sh MACRO SYNTAX |
.Pq right double-quote |
Macros are one to three three characters in length and begin with a |
.It \\(Rq |
control character , |
.Pq right double-quote, deprecated |
. Sq \&. , |
.It \\(oq |
at the beginning of the line. An arbitrary amount of whitespace may |
.Pq left single-quote |
sit between the control character and the macro name. Thus, |
.It \\(aq |
. Sq .PP |
.Pq right single-quote |
and |
.It \\(Bq |
. Sq \&.\ \ \ PP |
.Pq right low double-quote |
are equivalent. |
.It \\(bq |
. Pp |
.Pq right low single-quote |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
|
Indicatives: |
|
.Bl -tag -width 12n -offset "XXXX" -compact |
|
.It \\(<- |
|
.Pq left arrow |
|
.It \\(-> |
|
.Pq right arrow |
|
.It \\(ua |
|
.Pq up arrow |
|
.It \\(da |
|
.Pq down arrow |
|
.It \\(<> |
|
.Pq left-right arrow |
|
.It \\(lA |
|
.Pq left double-arrow |
|
.It \\(rA |
|
.Pq right double-arrow |
|
.It \\(uA |
|
.Pq up double-arrow |
|
.It \\(dA |
|
.Pq down double-arrow |
|
.It \\(hA |
|
.Pq left-right double-arrow |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
|
Mathematical: |
|
.Bl -tag -width 12n -offset "XXXX" -compact |
|
.It \\(es |
|
.Pq empty set |
|
.It \\(ca |
|
.Pq intersection |
|
.It \\(cu |
|
.Pq union |
|
.It \\(gr |
|
.Pq gradient |
|
.It \\(pd |
|
.Pq partial differential |
|
.It \\(ap |
|
.Pq similarity |
|
.It \\(=) |
|
.Pq proper superset |
|
.It \\((= |
|
.Pq proper subset |
|
.It \\(eq |
|
.Pq equals |
|
.It \\(di |
|
.Pq division |
|
.It \\(mu |
|
.Pq multiplication |
|
.It \\(pl |
|
.Pq addition |
|
.It \\(nm |
|
.Pq not element |
|
.It \\(mo |
|
.Pq element |
|
.It \\(Im |
|
.Pq imaginary |
|
.It \\(Re |
|
.Pq real |
|
.It \\(Ah |
|
.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 |
|
.\" PARAGRAPH |
|
.Pp |
|
Ligatures: |
|
.Bl -tag -width 12n -offset "XXXX" -compact |
|
.It \\(ss |
|
.Pq German eszett |
|
.It \\(AE |
|
.Pq upper-case AE |
|
.It \\(ae |
|
.Pq lower-case AE |
|
.It \\(OE |
|
.Pq upper-case OE |
|
.It \\(oe |
|
.Pq lower-case OE |
|
.It \\(ff |
|
.Pq ff ligature |
|
.It \\(fi |
|
.Pq fi ligature |
|
.It \\(fl |
|
.Pq fl ligature |
|
.It \\(Fi |
|
.Pq ffi ligature |
|
.It \\(Fl |
|
.Pq ffl ligature |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
|
Diacritics and letters: |
|
.Bl -tag -width 12n -offset "XXXX" -compact |
|
.It \\(ga |
|
.Pq grave accent |
|
.It \\(aa |
|
.Pq accute accent |
|
.It \\(a" |
|
.Pq umlaut accent |
|
.It \\(ad |
|
.Pq dieresis accent |
|
.It \\(a~ |
|
.Pq tilde accent |
|
.It \\(a^ |
|
.Pq circumflex accent |
|
.It \\(ac |
|
.Pq cedilla accent |
|
.It \\(ad |
|
.Pq dieresis accent |
|
.It \\(ah |
|
.Pq caron accent |
|
.It \\(ao |
|
.Pq ring accent |
|
.It \\(ho |
|
.Pq hook accent |
|
.It \\(ab |
|
.Pq breve accent |
|
.It \\(a- |
|
.Pq macron accent |
|
.It \\(-D |
|
.Pq upper-case eth |
|
.It \\(Sd |
|
.Pq lower-case eth |
|
.It \\(TP |
|
.Pq upper-case thorn |
|
.It \\(Tp |
|
.Pq lower-case thorn |
|
.It \\('A |
|
.Pq upper-case acute A |
|
.It \\('E |
|
.Pq upper-case acute E |
|
.It \\('I |
|
.Pq upper-case acute I |
|
.It \\('O |
|
.Pq upper-case acute O |
|
.It \\('U |
|
.Pq upper-case acute U |
|
.It \\('a |
|
.Pq lower-case acute a |
|
.It \\('e |
|
.Pq lower-case acute e |
|
.It \\('i |
|
.Pq lower-case acute i |
|
.It \\('o |
|
.Pq lower-case acute o |
|
.It \\('u |
|
.Pq lower-case acute u |
|
.It \\(`A |
|
.Pq upper-case grave A |
|
.It \\(`E |
|
.Pq upper-case grave E |
|
.It \\(`I |
|
.Pq upper-case grave I |
|
.It \\(`O |
|
.Pq upper-case grave O |
|
.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 |
|
.\" PARAGRAPH |
|
.Pp |
|
Monetary: |
|
.Bl -tag -width 12n -offset "XXXX" -compact |
|
.It \\(Cs |
|
.Pq Scandinavian |
|
.It \\(Do |
|
.Pq dollar |
|
.It \\(Po |
|
.Pq pound |
|
.It \\(Ye |
|
.Pq yen |
|
.It \\(Fn |
|
.Pq florin |
|
.It \\(ct |
|
.Pq cent |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
|
Special symbols: |
|
.Bl -tag -width 12n -offset "XXXX" -compact |
|
.It \\(de |
|
.Pq degree |
|
.It \\(ps |
|
.Pq paragraph |
|
.It \\(sc |
|
.Pq section |
|
.It \\(dg |
|
.Pq dagger |
|
.It \\(dd |
|
.Pq double dagger |
|
.It \\(ci |
|
.Pq circle |
|
.It \\(ba |
|
.Pq bar |
|
.It \\(bb |
|
.Pq broken bar |
|
.It \\(Ba |
|
.Pq bar, deprecated |
|
.It \\(co |
|
.Pq copyright |
|
.It \\(rg |
|
.Pq registered |
|
.It \\(tm |
|
.Pq trademarked |
|
.It \\& |
|
.Pq non-breaking space |
|
.It \\e |
|
.Pq escape |
|
.It \\(Am |
|
.Pq ampersand, deprecated |
|
.El |
|
.\" SECTION |
|
.Sh STRUCTURE |
|
Macros are case in-sensitive and one to three three characters in |
|
length. All follow the same structural rules: |
|
.Bd -literal -offset XXXX |
|
\&.Yo \(lBbody...\(rB |
|
.Ed |
|
.Pp |
|
The |
The |
.Dq body |
. Nm |
consists of zero or more arguments to the macro. |
macros are classified by scope: line scope or block scope. Line |
|
macros are only scoped to the current line (and, in some situations, |
|
the subsequent line). Block macros are scoped to the current line and |
|
subsequent lines until closed by another block macro. |
|
. |
|
. |
|
. Ss Line Macros |
|
Line macros are generally scoped to the current line, with the body |
|
consisting of zero or more arguments. If a macro is scoped to the next |
|
line and the line arguments are empty, the next line is used instead, |
|
else the general syntax is used. Thus: |
|
. Bd -literal -offset indent |
|
\&.I |
|
foo |
|
. Ed |
|
. Pp |
|
is equivalent to |
|
. Sq \&.I foo . |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Sh MACROS |
Consecutive next-line scope invocations are disallowed. |
This section contains a complete list of all |
. Bd -literal -offset indent |
.Nm |
\&.YO \(lBbody...\(rB |
macros, arranged alphabetically, with the number of arguments. |
\(lBbody...\(rB |
.Pp |
. Ed |
.Bl -column "MacroX" "Arguments" -compact -offset XXXX |
. Pp |
.It Em Macro Ta Em Arguments |
It is considered an error when next-line scope is open at the end of |
.It \&.TH Ta >0 |
file. |
.It \&.SH Ta n |
. Pp |
.It \&.SS Ta n |
. Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" |
.It \&.TP Ta n |
. It Em Macro Ta Em Arguments Ta Em Scope |
.It \&.LP Ta n |
. It B Ta n Ta next-line |
.It \&.PP Ta n |
. It BI Ta n Ta current |
.It \&.P Ta n |
. It BR Ta n Ta current |
.It \&.IP Ta n |
. It DT Ta 0 Ta current |
.It \&.HP Ta n |
. It I Ta n Ta next-line |
.It \&.SM Ta n |
. It IB Ta n Ta current |
.It \&.SB Ta n |
. It IR Ta n Ta current |
.It \&.BI Ta n |
. It R Ta n Ta next-line |
.It \&.IB Ta n |
. It RB Ta n Ta current |
.It \&.BR Ta n |
. It RI Ta n Ta current |
.It \&.RB Ta n |
. It SB Ta n Ta next-line |
.It \&.R Ta n |
. It SM Ta n Ta next-line |
.It \&.B Ta n |
. It TH Ta >1, <6 Ta current |
.It \&.I Ta n |
. It br Ta 0 Ta current |
.It \&.IR Ta n |
. It fi Ta 0 Ta current |
.El |
. It i Ta n Ta current |
.\" SECTION |
. It na Ta 0 Ta current |
|
. It nf Ta 0 Ta current |
|
. It r Ta 0 Ta current |
|
. It sp Ta 1 Ta current |
|
. El |
|
. Pp |
|
The |
|
. Sq RS , |
|
. Sq RE , |
|
. Sq br , |
|
. Sq fi , |
|
. Sq i , |
|
. Sq na , |
|
. Sq nf , |
|
. Sq r , |
|
and |
|
. Sq sp |
|
macros aren't historically part of |
|
. Nm |
|
and should not be used. They're included for compatibility. |
|
. |
|
. |
|
. Ss Block Macros |
|
Block macros are comprised of a head and body. Like for in-line macros, |
|
the head is scoped to the current line and, in one circumstance, the |
|
next line; the body is scoped to subsequent lines and is closed out by a |
|
subsequent block macro invocation. |
|
. 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 |
|
. Sq SH ; |
|
sub-section, closed by a section or |
|
. Sq SS ; |
|
part, closed by a section, sub-section, or |
|
. Sq RE ; |
|
or paragraph, closed by a section, sub-section, part, |
|
. Sq HP , |
|
. Sq IP , |
|
. Sq LP , |
|
. Sq P , |
|
. Sq PP , |
|
or |
|
. Sq TP . |
|
No closure refers to an explicit block closing macro. |
|
. Pp |
|
It is considered an error when part or next-line scope is open at the |
|
end of file. |
|
. Pp |
|
. Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" -compact -offset indent |
|
. It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope |
|
. It HP Ta <2 Ta current Ta paragraph |
|
. It IP Ta <3 Ta current Ta paragraph |
|
. It LP Ta 0 Ta current Ta paragraph |
|
. It P Ta 0 Ta current Ta paragraph |
|
. It PP Ta 0 Ta current Ta paragraph |
|
. It RE Ta 0 Ta current Ta none |
|
. It RS Ta 1 Ta current Ta part |
|
. It SH Ta >0 Ta current Ta section |
|
. It SS Ta >0 Ta current Ta sub-section |
|
. It TP Ta n Ta next-line Ta paragraph |
|
. El |
|
. Pp |
|
If a block macro is next-line scoped, it may only be followed by in-line |
|
macros (excluding |
|
. Sq DT , |
|
. Sq TH , |
|
. Sq br , |
|
. Sq na , |
|
. Sq sp , |
|
. Sq nf , |
|
and |
|
. Sq fi ) . |
|
. |
|
. |
|
.Sh REFERENCE |
|
This section is a canonical reference to all macros, arranged |
|
alphabetically. For the scoping of individual macros, see |
|
. Sx MACRO SYNTAX . |
|
. |
|
. |
|
. Ss Definitions |
|
In this reference, a numerical width may be either a standalone natural |
|
number (such as 3, 4, 10, etc.) or a natural number followed by a width |
|
multiplier |
|
. Qq n , |
|
corresponding to the width of the formatted letter n, or |
|
. Qq m , |
|
corresponding to the width of the formatted letter m. The latter is the |
|
default, if unspecified. Thus, |
|
. Bd -literal -offset indent |
|
\&.HP 12n |
|
. Ed |
|
. Pp |
|
indicates an offset of 12 |
|
. Qq n |
|
. Ns -sized |
|
letters. |
|
. |
|
. |
|
. Ss Macro Reference |
|
. Bl -tag -width Ds |
|
. It B |
|
Text is rendered in bold face. |
|
. It BI |
|
Text is rendered alternately in bold face and italic. Thus, |
|
. Sq .BI this word and that |
|
causes |
|
. Sq this |
|
and |
|
. Sq and |
|
to render in bold face, while |
|
. Sq word |
|
and |
|
. Sq that |
|
render in italics. Whitespace between arguments is omitted in output. |
|
. It BR |
|
Text is rendered alternately in bold face and roman (the default font). |
|
Whitespace between arguments is omitted in output. |
|
. It DT |
|
Re-set the tab spacing to 0.5 inches. |
|
. It HP |
|
Begin a paragraph whose initial output line is left-justified, but |
|
subsequent output lines are indented, with the following syntax: |
|
. Bd -literal -offset indent |
|
\&.HP [width] |
|
. Ed |
|
. Pp |
|
If |
|
. Va width |
|
is specified, it's saved for later paragraph left-margins; if |
|
unspecified, the saved or default width is used. |
|
. It I |
|
Text is rendered in italics. |
|
. It IB |
|
Text is rendered alternately in italics and bold face. Whitespace |
|
between arguments is omitted in output. |
|
. It IP |
|
Begin a paragraph with the following syntax: |
|
. Bd -literal -offset indent |
|
\&.IP [head [width]] |
|
. Ed |
|
. Pp |
|
This follows the behaviour of the |
|
. Sq TP |
|
except for the macro syntax (all arguments on the line, instead of |
|
having next-line scope). If |
|
. Va width |
|
is specified, it's saved for later paragraph left-margins; if |
|
unspecified, the saved or default width is used. |
|
. It IR |
|
Text is rendered alternately in italics and roman (the default font). |
|
Whitespace between arguments is omitted in output. |
|
. It LP, P, PP |
|
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. |
|
. It R |
|
Text is rendered in roman (the default font). |
|
. It RB |
|
Text is rendered alternately in roman (the default font) and bold face. |
|
Whitespace between arguments is omitted in output. |
|
. It RE |
|
Explicitly close out the scope of a prior |
|
. Sq RS . |
|
. It RI |
|
Text is rendered alternately in roman (the default font) and italics. |
|
Whitespace between arguments is omitted in output. |
|
. It 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 |
|
. Sq PP . |
|
The width may be specified as following: |
|
. Bd -literal -offset indent |
|
\&.RS [width] |
|
. Ed |
|
. Pp |
|
If |
|
. Va width |
|
is not specified, the saved or default width is used. |
|
. It SB |
|
Text is rendered in small size (one point smaller than the default font) |
|
bold face. |
|
. It 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. |
|
. It SM |
|
Text is rendered in small size (one point smaller than the default |
|
font). |
|
. It 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. |
|
. It TH |
|
Sets the title of the manual page with the following syntax: |
|
. Bd -literal -offset indent |
|
\&.TH title section [date [source [volume]]] |
|
. Ed |
|
. Pp |
|
At least the |
|
. Va title |
|
and |
|
. Va section |
|
arguments must be provided. The |
|
. Va date |
|
argument should be formatted as |
|
. Qq %b [%d] %Y |
|
format, described in |
|
. Xr strptime 3 . |
|
The |
|
. Va source |
|
string specifies the organisation providing the utility. The |
|
. Va volume |
|
replaces the default rendered volume as dictated by the manual section. |
|
. It 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. |
|
. Pp |
|
The indentation width may be set as follows: |
|
. Bd -literal -offset indent |
|
\&.TP [width] |
|
. Ed |
|
. Pp |
|
Where |
|
. Va width |
|
must be a properly-formed numeric width. If |
|
. Va width |
|
is specified, it's saved for later paragraph left-margins; if |
|
unspecified, the saved or default width is used. |
|
. It br |
|
Breaks the current line. Consecutive invocations have no further effect. |
|
. It fi |
|
End literal mode begun by |
|
. Sq nf . |
|
. It i |
|
Italicise arguments. If no arguments are specified, all subsequent text |
|
is italicised. |
|
. It na |
|
Don't alignment the right margin. |
|
. It nf |
|
Begin literal mode: all subsequent free-form lines have their end of |
|
line boundaries preserved. May be ended by |
|
. Sq fi . |
|
. It r |
|
Fonts and styles (bold face, italics) reset to roman (default font). |
|
. It sp |
|
Insert n spaces, where n is the macro's positive numeric argument. If |
|
0, this is equivalent to the |
|
. Sq br |
|
macro. |
|
. El |
|
. |
|
. |
|
.Sh COMPATIBILITY |
|
This section documents compatibility with other roff implementations, at |
|
this time limited to |
|
. Xr groff 1 . |
|
. Bl -hyphen |
|
. It |
|
In quoted literals, groff allowed pair-wise double-quotes to produce a |
|
standalone double-quote in formatted output. This idiosyncratic |
|
behaviour is no longer applicable. |
|
. It |
|
The |
|
. Sq sp |
|
macro does not accept negative numbers. |
|
. It |
|
Blocks of whitespace are stripped from both macro and free-form text |
|
lines (except when in literal mode), while groff would retain whitespace |
|
in free-form text lines. |
|
. El |
|
. |
|
. |
.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. |
|
. |