| version 1.1, 2009/03/23 16:02:56 |
version 1.26, 2009/08/17 11:03: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 |
.\" SECTION |
| .Sh NAME |
.Sh NAME |
|
|
| .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 |
.\" PARAGRAPH |
| Line 45 language, instead. |
|
| Line 43 language, instead. |
|
| 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 |
.\" 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. |
| |
.Pp |
| |
The |
| |
.Sq \ec |
| |
escape is common in historical |
| |
.Nm |
| |
documents; if encountered at the end of a word, it ensures that the |
| |
subsequent word isn't off-set by whitespace. |
| .\" SUB-SECTION |
.\" 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 charater and |
| |
optionally whitespace are stripped from input. |
| |
.\" SUB-SECTION |
| .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 . |
| |
.\" SUB-SECTION---------------------- |
| |
.Ss Text Decoration |
| |
Terms may be text-decorated using the |
| |
.Sq \ef |
| |
escape followed by an indicator: B (bold), I, (italic), or P and R |
| |
(Roman, or reset). |
| |
.\" SUB-SECTION---------------------- |
| |
.Ss Whitespace |
| |
Unless specifically escaped, consecutive blocks of whitespace are pruned |
| |
from input. These are later re-added, if applicable, by a front-end |
| |
utility such as |
| |
.Xr mandoc 1 . |
| |
.\" SECTION |
| |
.Sh MANUAL STRUCTURE |
| |
Each |
| |
.Nm |
| |
document must contain contains at least the |
| |
.Sq \&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 |
.Pp |
| Characters may alternatively be escaped by a slash-asterisk, |
Beyond |
| .Sq \\* , |
.Sq \&TH , |
| with the same combinations as described above. This form is deprecated. |
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 "13 Aug 2009" |
| |
\&. |
| |
\&.SH NAME |
| |
foo \e- a description goes here |
| |
\&. |
| |
\&.SH SYNOPSIS |
| |
\efBfoo\efR [\efB\e-options\efR] arguments... |
| |
\&. |
| |
\&.SH DESCRIPTION |
| |
The \efBfoo\efR utility does... |
| |
\&. |
| |
\&.\e\*q .SH RETURN VALUES |
| |
\&.\e\*q .SH ENVIRONMENT |
| |
\&.\e\*q .SH FILES |
| |
\&.\e\*q .SH EXAMPLES |
| |
\&.\e\*q .SH DIAGNOSTICS |
| |
\&.\e\*q .SH ERRORS |
| |
\&.\e\*q .SH SEE ALSO |
| |
\&.\e\*q \efBbar\efR(1) |
| |
\&.\e\*q .SH STANDARDS |
| |
\&.\e\*q .SH HISTORY |
| |
\&.\e\*q .SH AUTHORS |
| |
\&.\e\*q .SH CAVEATS |
| |
\&.\e\*q .SH BUGS |
| |
.Ed |
| |
.\" SECTION |
| |
.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, |
| |
.Sq \&.PP |
| |
and |
| |
.Sq \&.\ \ \ \&PP |
| |
are equivalent. |
| .Pp |
.Pp |
| The following is a table of all available escapes. |
The |
| .Pp |
.Nm |
| Grammatic: |
macros are classified by scope: line scope or block scope. Line-scoped |
| .Bl -tag -width 12n -offset "XXXX" -compact |
macros are only scoped to the current line (and, in some situations, |
| .It \\(em |
the subsequent line). Block macros are scoped to the current line and |
| .Pq em-dash |
subsequent lines until closed by another block macro. |
| .It \\(en |
.\" SUBSECTION |
| .Pq en-dash |
.Ss Line Macros |
| .It \e- |
Line-macros are scoped to the current line, with the body consisting of |
| .Pq hyphen |
zero or more arguments. If a macro is next-line scoped and the line |
| .It \\\\ |
arguments are empty, the next line is used instead. Thus: |
| .Pq back-slash |
.Bd -literal -offset indent |
| .It \e' |
\&.RI |
| .Pq apostrophe |
foo |
| .It \e` |
.Ed |
| .Pq back-tick |
|
| .It \\ |
|
| .Pq space |
|
| .It \\. |
|
| .Pq period |
|
| .It \\(r! |
|
| .Pq upside-down exclamation |
|
| .It \\(r? |
|
| .Pq upside-down question |
|
| .El |
|
| .\" PARAGRAPH |
.\" PARAGRAPH |
| .Pp |
.Pp |
| Enclosures: |
is equivalent to |
| .Bl -tag -width 12n -offset "XXXX" -compact |
.Sq \&.RI foo . |
| .It \\(lh |
|
| .Pq left hand |
|
| .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 |
.\" PARAGRAPH |
| .Pp |
Consecutive next-line invocations are disallowed. |
| Indicatives: |
.Bd -literal -offset indent |
| .Bl -tag -width 12n -offset "XXXX" -compact |
\&.YO \(lBbody...\(rB |
| .It \\(<- |
\(lBbody...\(rB |
| .Pq left arrow |
.Ed |
| .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 |
.\" PARAGRAPH |
| .Pp |
.Pp |
| Mathematical: |
.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" |
| .Bl -tag -width 12n -offset "XXXX" -compact |
.It Em Macro Ta Em Arguments Ta Em Scope |
| .It \\(es |
.It \&B Ta n Ta next-line |
| .Pq empty set |
.It \&BI Ta n Ta current |
| .It \\(ca |
.It \&BR Ta n Ta current |
| .Pq intersection |
.It \&I Ta n Ta next-line |
| .It \\(cu |
.It \&IB Ta n Ta current |
| .Pq union |
.It \&IR Ta n Ta current |
| .It \\(gr |
.It \&R Ta n Ta next-line |
| .Pq gradient |
.It \&RB Ta n Ta current |
| .It \\(pd |
.It \&RI Ta n Ta current |
| .Pq partial differential |
.It \&SB Ta n Ta next-line |
| .It \\(ap |
.It \&SM Ta n Ta next-line |
| .Pq similarity |
.It \&TH Ta >1, <6 Ta current |
| .It \\(=) |
.It \&br Ta 0 Ta current |
| .Pq proper superset |
.It \&fi Ta 0 Ta current |
| .It \\((= |
.It \&i Ta n Ta current |
| .Pq proper subset |
.It \&na Ta 0 Ta current |
| .It \\(eq |
.It \&nf Ta 0 Ta current |
| .Pq equals |
.It \&r Ta 0 Ta current |
| .It \\(di |
.It \&sp Ta 1 Ta current |
| .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 |
.El |
| .\" PARAGRAPH |
.\" PARAGRAPH |
| .Pp |
.Pp |
| Ligatures: |
The lower-case |
| .Bl -tag -width 12n -offset "XXXX" -compact |
.Sq \&br , |
| .It \\(ss |
.Sq \&fi , |
| .Pq German eszett |
.Sq \&i , |
| .It \\(AE |
.Sq \&na , |
| .Pq upper-case AE |
.Sq \&nf , |
| .It \\(ae |
.Sq \&r , |
| .Pq lower-case AE |
and |
| .It \\(OE |
.Sq \&sp |
| .Pq upper-case OE |
macros aren't historically part of |
| .It \\(oe |
.Nm |
| .Pq lower-case OE |
and should not be used. They're included for compatibility. |
| .It \\(ff |
.\" SUBSECTION |
| .Pq ff ligature |
.Ss Block Macros |
| .It \\(fi |
Block macros are comprised of a head and body. The head is scoped to |
| .Pq fi ligature |
the current line and, in one circumstance, the next line; the body is |
| .It \\(fl |
scoped to subsequent lines and is closed out by a subsequent block macro |
| .Pq fl ligature |
invocation. |
| .It \\(Fi |
.Bd -literal -offset indent |
| .Pq ffi ligature |
\&.YO \(lBhead...\(rB |
| .It \\(Fl |
\(lBhead...\(rB |
| .Pq ffl ligature |
\(lBbody...\(rB |
| .El |
.Ed |
| .\" PARAGRAPH |
.\" PARAGRAPH |
| .Pp |
.Pp |
| Diacritics and letters: |
If a block macro is next-line scoped, it may only be followed by in-line |
| .Bl -tag -width 12n -offset "XXXX" -compact |
macros (excluding |
| .It \\(ga |
.Sq na , |
| .Pq grave accent |
.Sq sp , |
| .It \\(aa |
.Sq nf , |
| .Pq accute accent |
.Sq fi , |
| .It \\(a" |
and |
| .Pq umlaut accent |
.Sq TH ) . |
| .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 |
.\" PARAGRAPH |
| .Pp |
.Pp |
| Monetary: |
.Bl -column "MacroX" "Arguments" "ScopeXXXX" -compact -offset indent |
| .Bl -tag -width 12n -offset "XXXX" -compact |
.It Em Macro Ta Em Arguments Ta Em Scope |
| .It \\(Cs |
.It \&HP Ta <2 Ta current |
| .Pq Scandinavian |
.It \&IP Ta <3 Ta current |
| .It \\(Do |
.It \&LP Ta 0 Ta current |
| .Pq dollar |
.It \&P Ta 0 Ta current |
| .It \\(Po |
.It \&PP Ta 0 Ta current |
| .Pq pound |
.It \&SH Ta >0 Ta current |
| .It \\(Ye |
.It \&SS Ta >0 Ta current |
| .Pq yen |
.It \&TP Ta n Ta next-line |
| .It \\(Fn |
|
| .Pq florin |
|
| .It \\(ct |
|
| .Pq cent |
|
| .El |
.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 |
.\" SECTION |
| .Sh STRUCTURE |
.Sh REFERENCE |
| Macros are case in-sensitive and one to three three characters in |
This section is a canonical reference to all macros, arranged |
| length. All follow the same structural rules: |
alphabetically. For the scoping of individual macros, see |
| .Bd -literal -offset XXXX |
.Sx MACRO SYNTAX . |
| \&.Yo \(lBbody...\(rB |
.\" SUBSECTION |
| |
.Ss Terms |
| |
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. |
| |
.\" SUBSECTION |
| |
.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 \&HP |
| |
Begin a paragraph whose initial output line is left-justified, but |
| |
subsequent output lines are indented. |
| |
.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 |
.Ed |
| .Pp |
.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). |
| |
.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. |
| |
.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 \&RI |
| |
Text is rendered alternately in roman (the default font) and italics. |
| |
Whitespace between arguments is omitted in output. |
| |
.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. |
| |
.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. |
| |
.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 |
The |
| .Dq body |
.Va source |
| consists of zero or more arguments to the macro. |
string specifies the organisation providing the utility. The |
| .\" PARAGRAPH |
.Va volume |
| .Sh MACROS |
replaces the default rendered volume as dictated by the manual section. |
| This section contains a complete list of all |
.It \&TP |
| .Nm |
Begin a paragraph where the head, if exceeding the indentation width, is |
| macros, arranged alphabetically, with the number of arguments. |
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 |
.Pp |
| .Bl -column "MacroX" "Arguments" -compact -offset XXXX |
The indentation width may be set as follows: |
| .It Em Macro Ta Em Arguments |
.Bd -literal -offset indent |
| .It \&.TH Ta >0 |
\&.TP [width] |
| .It \&.SH Ta n |
.Ed |
| .It \&.SS Ta n |
.Pp |
| .It \&.TP Ta n |
Where |
| .It \&.LP Ta n |
.Va width |
| .It \&.PP Ta n |
must be a properly-formed numeric width. If unspecified or improperly |
| .It \&.P Ta n |
formed, the default indentation width is used. |
| .It \&.IP Ta n |
.It \&br |
| .It \&.HP Ta n |
Breaks the current line. Consecutive invocations have no further effect. |
| .It \&.SM Ta n |
.It \&fi |
| .It \&.SB Ta n |
End literal mode begun by |
| .It \&.BI Ta n |
.Sq \&nf . |
| .It \&.IB Ta n |
.It \&i |
| .It \&.BR Ta n |
Italicise arguments. If no arguments are specified, all subsequent text |
| .It \&.RB Ta n |
is italicised. |
| .It \&.R Ta n |
.It \&na |
| .It \&.B Ta n |
No alignment to the right margin. |
| .It \&.I Ta n |
.It \&nf |
| .It \&.IR Ta n |
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 |
.El |
| .\" SECTION |
.\" SECTION |
| |
.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 |
| |
.\" SECTION |
| .Sh SEE ALSO |
.Sh SEE ALSO |
| .Xr mandoc 1 |
.Xr mandoc 1 , |
| |
.Xr mandoc_char 7 |
| .\" SECTION |
.\" SECTION |
| .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 |
.\" SECTION |
| .Sh CAVEATS |
.Sh CAVEATS |
| Do not use this language. Use |
Do not use this language. Use |
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to man.7 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc