version 1.1, 2009/03/23 16:02:56 |
version 1.145, 2020/02/18 17:31:28 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org> |
.\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
|
.\" Copyright (c) 2011-2015, 2017-2020 Ingo Schwarze <schwarze@openbsd.org> |
|
.\" Copyright (c) 2017 Anthony Bentley <bentley@openbsd.org> |
|
.\" Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.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 |
.\" 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 legacy formatting language for manual pages |
.\" SECTION |
|
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm man |
.Nm man |
language was historically used to format |
language was the standard formatting language for |
.Ux |
.At |
manuals. In this reference document, we describe the syntax and |
manual pages from 1979 to 1989. |
structure of the |
Do not use it to write new manual pages: it is a purely presentational |
.Nm |
language and lacks support for semantic markup. |
language. |
Use the |
.Pp |
|
.Em \&Do not |
|
use |
|
.Nm |
|
to write your manuals. Use the |
|
.Xr mdoc 7 |
.Xr mdoc 7 |
language, instead. |
language, instead. |
.\" PARAGRAPH |
|
.Pp |
.Pp |
An |
In a |
.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. Other lines are interpreted within the scope of |
.Dq macro lines . |
prior macros: |
The first word is the macro name. |
.Bd -literal -offset XXX |
It usually consists of two capital letters. |
|
For a list of portable macros, see |
|
.Sx MACRO OVERVIEW . |
|
The words following the macro name are arguments to the macro. |
|
.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 |
\&.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 |
.\" PARAGRAPH |
|
.Pp |
.Pp |
Macros are character sequences whose structural rules are described |
Many aspects of the basic syntax of the |
later in this document. |
|
.\" SECTION |
|
.Sh INPUT ENCODING |
|
.Nm |
.Nm |
documents may contain only graphable 7-bit ASCII characters and the |
language are based on the |
space character |
.Xr roff 7 |
.Sq \ . |
language; see the |
All manuals must have |
.Em LANGUAGE SYNTAX |
.Sq \en |
and |
line termination. |
.Em MACRO SYNTAX |
|
sections in the |
|
.Xr roff 7 |
|
manual for details, in particular regarding |
|
comments, escape sequences, whitespace, and quoting. |
.Pp |
.Pp |
Blank lines are acceptable; where found, the output will also assert a |
Each |
vertical space. |
.Nm |
.\" SUB-SECTION |
document starts with the |
.Ss Special Characters |
.Ic TH |
Special character sequences begin with the escape character |
macro specifying the document's name and section, followed by the |
.Sq \\ |
.Sx NAME |
followed by either an open-parenthesis |
section formatted as follows: |
.Sq \&( |
.Bd -literal -offset indent |
for two-character sequences; an open-bracket |
\&.TH PROGNAME 1 1979-01-10 |
.Sq \&[ |
\&.SH NAME |
for n-character sequences (terminated at a close-bracket |
\efBprogname\efR \e(en one line about what it does |
.Sq \&] ) ; |
.Ed |
or a single one-character sequence. |
.Sh MACRO OVERVIEW |
|
This overview is sorted such that macros of similar purpose are listed |
|
together. |
|
Deprecated and non-portable macros are not included in the overview, |
|
but can be found in the alphabetical reference below. |
|
.Ss Page header and footer meta-data |
|
.Bl -column "RS, RE" description |
|
.It Ic TH Ta set the title: Ar name section date Op Ar source Op Ar volume |
|
.It Ic AT Ta display AT&T UNIX version in the page footer (<= 1 argument) |
|
.It Ic UC Ta display BSD version in the page footer (<= 1 argument) |
|
.El |
|
.Ss Sections and paragraphs |
|
.Bl -column "RS, RE" description |
|
.It Ic SH Ta section header (one line) |
|
.It Ic SS Ta subsection header (one line) |
|
.It Ic PP Ta start an undecorated paragraph (no arguments) |
|
.It Ic RS , RE Ta reset the left margin: Op Ar width |
|
.It Ic IP Ta indented paragraph: Op Ar head Op Ar width |
|
.It Ic TP Ta tagged paragraph: Op Ar width |
|
.It Ic PD Ta set vertical paragraph distance: Op Ar height |
|
.It Ic in Ta additional indent: Op Ar width |
|
.El |
|
.Ss Physical markup |
|
.Bl -column "RS, RE" description |
|
.It Ic B Ta boldface font |
|
.It Ic I Ta italic font |
|
.It Ic SB Ta small boldface font |
|
.It Ic SM Ta small roman font |
|
.It Ic BI Ta alternate between boldface and italic fonts |
|
.It Ic BR Ta alternate between boldface and roman fonts |
|
.It Ic IB Ta alternate between italic and boldface fonts |
|
.It Ic IR Ta alternate between italic and roman fonts |
|
.It Ic RB Ta alternate between roman and boldface fonts |
|
.It Ic RI Ta alternate between roman and italic fonts |
|
.El |
|
.Sh MACRO REFERENCE |
|
This section is a canonical reference to all macros, arranged |
|
alphabetically. |
|
For the scoping of individual macros, see |
|
.Sx MACRO SYNTAX . |
|
.Bl -tag -width 3n |
|
.It Ic AT |
|
Sets the volume for the footer for compatibility with man pages from |
|
.At |
|
releases. |
|
The optional arguments specify which release it is from. |
|
This macro is an extension that first appeared in |
|
.Bx 4.3 . |
|
.It Ic B |
|
Text is rendered in bold face. |
|
.It Ic 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. |
.Pp |
.Pp |
Characters may alternatively be escaped by a slash-asterisk, |
Example: |
.Sq \\* , |
|
with the same combinations as described above. This form is deprecated. |
|
.Pp |
.Pp |
The following is a table of all available escapes. |
.Dl \&.BI bold italic bold italic |
|
.It Ic BR |
|
Text is rendered alternately in bold face and roman (the default font). |
|
Whitespace between arguments is omitted in output. |
|
See also |
|
.Ic BI . |
|
.It Ic DT |
|
Restore the default tabulator positions. |
|
They are at intervals of 0.5 inches. |
|
This has no effect unless the tabulator positions were changed with the |
|
.Xr roff 7 |
|
.Ic ta |
|
request. |
|
.It Ic EE |
|
This is a non-standard Version 9 |
|
.At |
|
extension later adopted by GNU. |
|
In |
|
.Xr mandoc 1 , |
|
it does the same as the |
|
.Xr roff 7 |
|
.Ic fi |
|
request (switch to fill mode). |
|
.It Ic EX |
|
This is a non-standard Version 9 |
|
.At |
|
extension later adopted by GNU. |
|
In |
|
.Xr mandoc 1 , |
|
it does the same as the |
|
.Xr roff 7 |
|
.Ic nf |
|
request (switch to no-fill mode). |
|
.It Ic HP |
|
Begin a paragraph whose initial output line is left-justified, but |
|
subsequent output lines are indented, with the following syntax: |
.Pp |
.Pp |
Grammatic: |
.D1 Pf . Ic HP Op Ar width |
.Bl -tag -width 12n -offset "XXXX" -compact |
|
.It \\(em |
|
.Pq em-dash |
|
.It \\(en |
|
.Pq en-dash |
|
.It \e- |
|
.Pq hyphen |
|
.It \\\\ |
|
.Pq back-slash |
|
.It \e' |
|
.Pq apostrophe |
|
.It \e` |
|
.Pq back-tick |
|
.It \\ |
|
.Pq space |
|
.It \\. |
|
.Pq period |
|
.It \\(r! |
|
.Pq upside-down exclamation |
|
.It \\(r? |
|
.Pq upside-down question |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
.Pp |
Enclosures: |
The |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Ar width |
.It \\(lh |
argument is a |
.Pq left hand |
.Xr roff 7 |
.It \\(rh |
scaling width. |
.Pq right hand |
If specified, it's saved for later paragraph left margins; |
.It \\(Fo |
if unspecified, the saved or default width is used. |
.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: |
This macro is portable, but deprecated |
.Bl -tag -width 12n -offset "XXXX" -compact |
because it has no good representation in HTML output, |
.It \\(<- |
usually ending up indistinguishable from |
.Pq left arrow |
.Ic PP . |
.It \\(-> |
.It Ic I |
.Pq right arrow |
Text is rendered in italics. |
.It \\(ua |
.It Ic IB |
.Pq up arrow |
Text is rendered alternately in italics and bold face. |
.It \\(da |
Whitespace between arguments is omitted in output. |
.Pq down arrow |
See also |
.It \\(<> |
.Ic BI . |
.Pq left-right arrow |
.It Ic IP |
.It \\(lA |
Begin an indented paragraph with the following syntax: |
.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 |
.Pp |
Mathematical: |
.D1 Pf . Ic IP Op Ar head Op Ar width |
.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 |
.Pp |
Ligatures: |
The |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Ar width |
.It \\(ss |
argument is a |
.Pq German eszett |
.Xr roff 7 |
.It \\(AE |
scaling width defining the left margin. |
.Pq upper-case AE |
It's saved for later paragraph left-margins; if unspecified, the saved or |
.It \\(ae |
default width is used. |
.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 |
.Pp |
Diacritics and letters: |
The |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Ar head |
.It \\(ga |
argument is used as a leading term, flushed to the left margin. |
.Pq grave accent |
This is useful for bulleted paragraphs and so on. |
.It \\(aa |
.It Ic IR |
.Pq accute accent |
Text is rendered alternately in italics and roman (the default font). |
.It \\(a" |
Whitespace between arguments is omitted in output. |
.Pq umlaut accent |
See also |
.It \\(ad |
.Ic BI . |
.Pq dieresis accent |
.It Ic LP |
.It \\(a~ |
A synonym for |
.Pq tilde accent |
.Ic PP . |
.It \\(a^ |
.It Ic ME |
.Pq circumflex accent |
End a mailto block started with |
.It \\(ac |
.Ic MT . |
.Pq cedilla accent |
This is a non-standard GNU extension. |
.It \\(ad |
.It Ic MT |
.Pq dieresis accent |
Begin a mailto block. |
.It \\(ah |
This is a non-standard GNU extension. |
.Pq caron accent |
It has the following syntax: |
.It \\(ao |
.Bd -unfilled -offset indent |
.Pq ring accent |
.Pf . Ic MT Ar address |
.It \\(ho |
link description to be shown |
.Pq hook accent |
.Pf . Ic ME |
.It \\(ab |
.Ed |
.Pq breve accent |
.It Ic OP |
.It \\(a- |
Optional command-line argument. |
.Pq macron accent |
This is a non-standard GNU extension. |
.It \\(-D |
It has the following syntax: |
.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 |
.Pp |
Monetary: |
.D1 Pf . Ic OP Ar key Op Ar value |
.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 |
.Pp |
Special symbols: |
The |
.Bl -tag -width 12n -offset "XXXX" -compact |
.Ar key |
.It \\(de |
is usually a command-line flag and |
.Pq degree |
.Ar value |
.It \\(ps |
its argument. |
.Pq paragraph |
.It Ic P |
.It \\(sc |
This synonym for |
.Pq section |
.Ic PP |
.It \\(dg |
is an |
.Pq dagger |
.At III |
.It \\(dd |
extension later adopted by |
.Pq double dagger |
.Bx 4.3 . |
.It \\(ci |
.It Ic PD |
.Pq circle |
Specify the vertical space to be inserted before each new paragraph. |
.It \\(ba |
.br |
.Pq bar |
The syntax is as follows: |
.It \\(bb |
.Pp |
.Pq broken bar |
.D1 Pf . Ic PD Op Ar height |
.It \\(Ba |
.Pp |
.Pq bar, deprecated |
The |
.It \\(co |
.Ar height |
.Pq copyright |
argument is a |
.It \\(rg |
.Xr roff 7 |
.Pq registered |
scaling width. |
.It \\(tm |
It defaults to |
.Pq trademarked |
.Cm 1v . |
.It \\& |
If the unit is omitted, |
.Pq non-breaking space |
.Cm v |
.It \\e |
is assumed. |
.Pq escape |
.Pp |
.It \\(Am |
This macro affects the spacing before any subsequent instances of |
.Pq ampersand, deprecated |
.Ic HP , |
.El |
.Ic IP , |
.\" SECTION |
.Ic LP , |
.Sh STRUCTURE |
.Ic P , |
Macros are case in-sensitive and one to three three characters in |
.Ic PP , |
length. All follow the same structural rules: |
.Ic SH , |
.Bd -literal -offset XXXX |
.Ic SS , |
\&.Yo \(lBbody...\(rB |
.Ic SY , |
|
and |
|
.Ic TP . |
|
.It Ic 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 reset to the default. |
|
.It Ic RB |
|
Text is rendered alternately in roman (the default font) and bold face. |
|
Whitespace between arguments is omitted in output. |
|
See also |
|
.Ic BI . |
|
.It Ic RE |
|
Explicitly close out the scope of a prior |
|
.Ic RS . |
|
The default left margin is restored to the state before that |
|
.Ic RS |
|
invocation. |
|
.Pp |
|
The syntax is as follows: |
|
.Pp |
|
.D1 Pf . Ic RE Op Ar level |
|
.Pp |
|
Without an argument, the most recent |
|
.Ic RS |
|
block is closed out. |
|
If |
|
.Ar level |
|
is 1, all open |
|
.Ic RS |
|
blocks are closed out. |
|
Otherwise, |
|
.Ar level No \(mi 1 |
|
nested |
|
.Ic RS |
|
blocks remain open. |
|
.It Ic RI |
|
Text is rendered alternately in roman (the default font) and italics. |
|
Whitespace between arguments is omitted in output. |
|
See also |
|
.Ic BI . |
|
.It Ic RS |
|
Temporarily reset the default left margin. |
|
This has the following syntax: |
|
.Pp |
|
.D1 Pf . Ic RS Op Ar width |
|
.Pp |
|
The |
|
.Ar width |
|
argument is a |
|
.Xr roff 7 |
|
scaling width. |
|
If not specified, the saved or default width is used. |
|
.Pp |
|
See also |
|
.Ic RE . |
|
.It Ic SB |
|
Text is rendered in small size (one point smaller than the default font) |
|
bold face. |
|
This macro is an extension that probably first appeared in SunOS 4.0 |
|
and was later adopted by GNU and by |
|
.Bx 4.4 . |
|
.It Ic 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 reset to the default. |
|
.It Ic SM |
|
Text is rendered in small size (one point smaller than the default |
|
font). |
|
.It Ic 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 reset to the default. |
|
.It Ic SY |
|
Begin a synopsis block with the following syntax: |
|
.Bd -unfilled -offset indent |
|
.Pf . Ic SY Ar command |
|
.Ar arguments |
|
.Pf . Ic YS |
.Ed |
.Ed |
.Pp |
.Pp |
|
This is a non-standard GNU extension |
|
and very rarely used even in GNU manual pages. |
|
Formatting is similar to |
|
.Ic IP . |
|
.It Ic TH |
|
Set the name of the manual page for use in the page header |
|
and footer with the following syntax: |
|
.Pp |
|
.D1 Pf . Ic TH Ar name section date Op Ar source Op Ar volume |
|
.Pp |
|
Conventionally, the document |
|
.Ar name |
|
is given in all caps. |
The |
The |
.Dq body |
.Ar section |
consists of zero or more arguments to the macro. |
is usually a single digit, in a few cases followed by a letter. |
.\" PARAGRAPH |
The recommended |
.Sh MACROS |
.Ar date |
This section contains a complete list of all |
format is |
|
.Sy YYYY-MM-DD |
|
as specified in the ISO-8601 standard; |
|
if the argument does not conform, it is printed verbatim. |
|
If the |
|
.Ar date |
|
is empty or not specified, the current date is used. |
|
The optional |
|
.Ar source |
|
string specifies the organisation providing the utility. |
|
When unspecified, |
|
.Xr mandoc 1 |
|
uses its |
|
.Fl Ios |
|
argument. |
|
The |
|
.Ar volume |
|
string replaces the default volume title of the |
|
.Ar section . |
|
.Pp |
|
Examples: |
|
.Pp |
|
.Dl \&.TH CVS 5 "1992-02-12" GNU |
|
.It Ic 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 |
|
advancing to the indentation width. |
|
Subsequent output lines are indented. |
|
The syntax is as follows: |
|
.Bd -unfilled -offset indent |
|
.Pf . Ic TP Op Ar width |
|
.Ar head No \e" one line |
|
.Ar body |
|
.Ed |
|
.Pp |
|
The |
|
.Ar width |
|
argument is a |
|
.Xr roff 7 |
|
scaling width. |
|
If specified, it's saved for later paragraph left-margins; if |
|
unspecified, the saved or default width is used. |
|
.It Ic TQ |
|
Like |
|
.Ic TP , |
|
except that no vertical spacing is inserted before the paragraph. |
|
This is a non-standard GNU extension |
|
and very rarely used even in GNU manual pages. |
|
.It Ic UC |
|
Sets the volume for the footer for compatibility with man pages from |
|
.Bx |
|
releases. |
|
The optional first argument specifies which release it is from. |
|
This macro is an extension that first appeared in |
|
.Bx 3 . |
|
.It Ic UE |
|
End a uniform resource identifier block started with |
|
.Ic UR . |
|
This is a non-standard GNU extension. |
|
.It Ic UR |
|
Begin a uniform resource identifier block. |
|
This is a non-standard GNU extension. |
|
It has the following syntax: |
|
.Bd -unfilled -offset indent |
|
.Pf . Ic UR Ar uri |
|
link description to be shown |
|
.Pf . Ic UE |
|
.Ed |
|
.It Ic YS |
|
End a synopsis block started with |
|
.Ic SY . |
|
This is a non-standard GNU extension. |
|
.It Ic in |
|
Indent relative to the current indentation: |
|
.Pp |
|
.D1 Pf . Ic in Op Ar width |
|
.Pp |
|
If |
|
.Ar width |
|
is signed, the new offset is relative. |
|
Otherwise, it is absolute. |
|
This value is reset upon the next paragraph, section, or sub-section. |
|
.El |
|
.Sh MACRO SYNTAX |
|
The |
.Nm |
.Nm |
macros, arranged alphabetically, with the number of arguments. |
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, which must be text, is used instead. |
|
Thus: |
|
.Bd -literal -offset indent |
|
\&.I |
|
foo |
|
.Ed |
.Pp |
.Pp |
.Bl -column "MacroX" "Arguments" -compact -offset XXXX |
is equivalent to |
.It Em Macro Ta Em Arguments |
.Sq .I foo . |
.It \&.TH Ta >0 |
If next-line macros are invoked consecutively, only the last is used. |
.It \&.SH Ta n |
If a next-line macro is followed by a non-next-line macro, an error is |
.It \&.SS Ta n |
raised. |
.It \&.TP Ta n |
.Pp |
.It \&.LP Ta n |
The syntax is as follows: |
.It \&.PP Ta n |
.Bd -literal -offset indent |
.It \&.P Ta n |
\&.YO \(lBbody...\(rB |
.It \&.IP Ta n |
\(lBbody...\(rB |
.It \&.HP Ta n |
.Ed |
.It \&.SM Ta n |
.Bl -column "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX" -offset indent |
.It \&.SB Ta n |
.It Em Macro Ta Em Arguments Ta Em Scope Ta Em Notes |
.It \&.BI Ta n |
.It Ic AT Ta <=1 Ta current Ta \& |
.It \&.IB Ta n |
.It Ic B Ta n Ta next-line Ta \& |
.It \&.BR Ta n |
.It Ic BI Ta n Ta current Ta \& |
.It \&.RB Ta n |
.It Ic BR Ta n Ta current Ta \& |
.It \&.R Ta n |
.It Ic DT Ta 0 Ta current Ta \& |
.It \&.B Ta n |
.It Ic EE Ta 0 Ta current Ta Version 9 At |
.It \&.I Ta n |
.It Ic EX Ta 0 Ta current Ta Version 9 At |
.It \&.IR Ta n |
.It Ic I Ta n Ta next-line Ta \& |
|
.It Ic IB Ta n Ta current Ta \& |
|
.It Ic IR Ta n Ta current Ta \& |
|
.It Ic OP Ta >=1 Ta current Ta GNU |
|
.It Ic PD Ta 1 Ta current Ta \& |
|
.It Ic RB Ta n Ta current Ta \& |
|
.It Ic RI Ta n Ta current Ta \& |
|
.It Ic SB Ta n Ta next-line Ta \& |
|
.It Ic SM Ta n Ta next-line Ta \& |
|
.It Ic TH Ta >1, <6 Ta current Ta \& |
|
.It Ic UC Ta <=1 Ta current Ta \& |
|
.It Ic in Ta 1 Ta current Ta Xr roff 7 |
.El |
.El |
.\" SECTION |
.Ss Block Macros |
|
Block macros comprise a head and body. |
|
As with in-line macros, the head is scoped to the current line and, in |
|
one circumstance, the next line (the next-line stipulations as in |
|
.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 |
|
.Ic SH ; |
|
sub-section, closed by a section or |
|
.Ic SS ; |
|
or paragraph, closed by a section, sub-section, |
|
.Ic HP , |
|
.Ic IP , |
|
.Ic LP , |
|
.Ic P , |
|
.Ic PP , |
|
.Ic RE , |
|
.Ic SY , |
|
or |
|
.Ic 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. |
|
.Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" "compatX" -offset indent |
|
.It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope Ta Em Notes |
|
.It Ic HP Ta <2 Ta current Ta paragraph Ta \& |
|
.It Ic IP Ta <3 Ta current Ta paragraph Ta \& |
|
.It Ic LP Ta 0 Ta current Ta paragraph Ta \& |
|
.It Ic ME Ta 0 Ta none Ta none Ta GNU |
|
.It Ic MT Ta 1 Ta current Ta to \&ME Ta GNU |
|
.It Ic P Ta 0 Ta current Ta paragraph Ta \& |
|
.It Ic PP Ta 0 Ta current Ta paragraph Ta \& |
|
.It Ic RE Ta <=1 Ta current Ta none Ta \& |
|
.It Ic RS Ta 1 Ta current Ta to \&RE Ta \& |
|
.It Ic SH Ta >0 Ta next-line Ta section Ta \& |
|
.It Ic SS Ta >0 Ta next-line Ta sub-section Ta \& |
|
.It Ic SY Ta 1 Ta current Ta to \&YS Ta GNU |
|
.It Ic TP Ta n Ta next-line Ta paragraph Ta \& |
|
.It Ic TQ Ta n Ta next-line Ta paragraph Ta GNU |
|
.It Ic UE Ta 0 Ta current Ta none Ta GNU |
|
.It Ic UR Ta 1 Ta current Ta part Ta GNU |
|
.It Ic YS Ta 0 Ta none Ta none Ta GNU |
|
.El |
|
.Pp |
|
If a block macro is next-line scoped, it may only be followed by in-line |
|
macros for decorating text. |
|
.Ss Font handling |
|
In |
|
.Nm |
|
documents, both |
|
.Sx Physical markup |
|
macros and |
|
.Xr roff 7 |
|
.Ql \ef |
|
font escape sequences can be used to choose fonts. |
|
In text lines, the effect of manual font selection by escape sequences |
|
only lasts until the next macro invocation; in macro lines, it only lasts |
|
until the end of the macro scope. |
|
Note that macros like |
|
.Ic BR |
|
open and close a font scope for each argument. |
.Sh SEE ALSO |
.Sh SEE ALSO |
|
.Xr man 1 , |
|
.Xr mandoc 1 , |
|
.Xr eqn 7 , |
|
.Xr mandoc_char 7 , |
|
.Xr mdoc 7 , |
|
.Xr roff 7 , |
|
.Xr tbl 7 |
|
.Sh HISTORY |
|
The |
|
.Nm |
|
language first appeared as a macro package for the roff typesetting |
|
system in |
|
.At v7 . |
|
It was later rewritten by James Clark as a macro package for groff. |
|
Eric S. Raymond wrote the extended |
|
.Nm |
|
macros for groff in 2007. |
|
The stand-alone implementation that is part of the |
.Xr mandoc 1 |
.Xr mandoc 1 |
.\" SECTION |
utility written by Kristaps Dzonsons appeared in |
|
.Ox 4.6 . |
.Sh AUTHORS |
.Sh AUTHORS |
The |
This |
.Nm |
.Nm |
utility was written by |
reference was written by |
.An Kristaps Dzonsons Aq kristaps@openbsd.org . |
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . |
.\" SECTION |
|
.Sh CAVEATS |
|
Do not use this language. Use |
|
.Xr mdoc 7 , |
|
instead. |
|