version 1.131, 2015/01/24 02:41:49 |
version 1.140, 2018/08/18 04:32:10 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2011-2015 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2011-2015, 2017, 2018 Ingo Schwarze <schwarze@openbsd.org> |
|
.\" Copyright (c) 2017 Anthony Bentley <bentley@openbsd.org> |
.\" Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.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 |
|
|
.Nm man |
.Nm man |
.Nd legacy formatting language for manual pages |
.Nd legacy formatting language for manual pages |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
Traditionally, the |
The |
.Nm man |
.Nm man |
language has been used to write |
language was the standard formatting language for |
.Ux |
.At |
manuals for the |
manual pages from 1979 to 1989. |
.Xr man 1 |
Do not use it to write new manual pages: it is a purely presentational |
utility. |
language and lacks support for semantic markup. |
It supports limited control of presentational details like fonts, |
|
indentation and spacing. |
|
This reference document describes the structure of manual pages |
|
and the syntax and usage of the man language. |
|
.Pp |
|
.Bf -emphasis |
|
Do not use |
|
.Nm |
|
to write your manuals: |
|
.Ef |
|
It lacks support for semantic markup. |
|
Use the |
Use the |
.Xr mdoc 7 |
.Xr mdoc 7 |
language, instead. |
language, instead. |
|
|
.Dq macro lines . |
.Dq macro lines . |
The first word is the macro name. |
The first word is the macro name. |
It usually consists of two capital letters. |
It usually consists of two capital letters. |
For a list of available macros, see |
For a list of portable macros, see |
.Sx MACRO OVERVIEW . |
.Sx MACRO OVERVIEW . |
The words following the macro name are arguments to the macro. |
The words following the macro name are arguments to the macro. |
.Pp |
.Pp |
|
|
.Xr roff 7 |
.Xr roff 7 |
manual for details, in particular regarding |
manual for details, in particular regarding |
comments, escape sequences, whitespace, and quoting. |
comments, escape sequences, whitespace, and quoting. |
.Sh MANUAL STRUCTURE |
.Pp |
Each |
Each |
.Nm |
.Nm |
document must contain the |
document starts with the |
.Sx \&TH |
.Sx \&TH |
macro describing the document's section and title. |
macro specifying the document's name and section, followed by the |
It may occur anywhere in the document, although conventionally it |
.Sx NAME |
appears as the first macro. |
section formatted as follows: |
.Pp |
|
Beyond |
|
.Sx \&TH , |
|
at least one macro or text line must appear in the document. |
|
.Pp |
|
The following is a well-formed skeleton |
|
.Nm |
|
file for a utility |
|
.Qq progname : |
|
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.TH PROGNAME 1 2009-10-10 |
\&.TH PROGNAME 1 1979-01-10 |
\&.SH NAME |
\&.SH NAME |
\efBprogname\efR \e(en one line about what it does |
\efBprogname\efR \e(en one line about what it does |
\&.\e\(dq .SH LIBRARY |
|
\&.\e\(dq For sections 2, 3, and 9 only. |
|
\&.\e\(dq Not used in OpenBSD. |
|
\&.SH SYNOPSIS |
|
\efBprogname\efR [\efB\e-options\efR] \efIfile ...\efR |
|
\&.SH DESCRIPTION |
|
The \efBfoo\efR utility processes files ... |
|
\&.\e\(dq .Sh CONTEXT |
|
\&.\e\(dq For section 9 functions only. |
|
\&.\e\(dq .SH IMPLEMENTATION NOTES |
|
\&.\e\(dq Not used in OpenBSD. |
|
\&.\e\(dq .SH RETURN VALUES |
|
\&.\e\(dq For sections 2, 3, and 9 function return values only. |
|
\&.\e\(dq .SH ENVIRONMENT |
|
\&.\e\(dq For sections 1, 6, 7, and 8 only. |
|
\&.\e\(dq .SH FILES |
|
\&.\e\(dq .SH EXIT STATUS |
|
\&.\e\(dq For sections 1, 6, and 8 only. |
|
\&.\e\(dq .SH EXAMPLES |
|
\&.\e\(dq .SH DIAGNOSTICS |
|
\&.\e\(dq For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only. |
|
\&.\e\(dq .SH ERRORS |
|
\&.\e\(dq For sections 2, 3, 4, and 9 errno settings only. |
|
\&.\e\(dq .SH SEE ALSO |
|
\&.\e\(dq .BR foobar ( 1 ) |
|
\&.\e\(dq .SH STANDARDS |
|
\&.\e\(dq .SH HISTORY |
|
\&.\e\(dq .SH AUTHORS |
|
\&.\e\(dq .SH CAVEATS |
|
\&.\e\(dq .SH BUGS |
|
\&.\e\(dq .SH SECURITY CONSIDERATIONS |
|
\&.\e\(dq Not used in OpenBSD. |
|
.Ed |
.Ed |
.Pp |
|
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 CONTEXT |
|
This section lists the contexts in which functions can be called in section 9. |
|
The contexts are autoconf, process, or interrupt. |
|
.It Em IMPLEMENTATION NOTES |
|
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 RETURN VALUES |
|
This section 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 name and a short description of how |
|
the file is used (created, modified, etc.). |
|
.It Em EXIT STATUS |
|
This section documents the command exit status for |
|
section 1, 6, and 8 utilities. |
|
Historically, this information was described in |
|
.Em DIAGNOSTICS , |
|
a practise that is now discouraged. |
|
.It Em EXAMPLES |
|
Example usages. |
|
This often contains snippets of well-formed, |
|
well-tested invocations. |
|
Make sure that examples work properly! |
|
.It Em DIAGNOSTICS |
|
Documents error conditions. |
|
In section 4 and 9 manuals, these are usually messages |
|
printed by the kernel to the console and to the kernel log. |
|
In section 1, 6, 7, and 8, these are usually messages |
|
printed by userland programs to the standard error output. |
|
.Pp |
|
Historically, this section was used in place of |
|
.Em EXIT STATUS |
|
for manuals in sections 1, 6, and 8; however, this practise is |
|
discouraged. |
|
.It Em ERRORS |
|
Documents |
|
.Xr errno 2 |
|
settings in sections 2, 3, 4, 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 |
|
A brief history of the subject, including where support first appeared. |
|
.It Em AUTHORS |
|
Credits to the person or persons who wrote the code and/or documentation. |
|
Authors should generally be noted by both name and email address. |
|
.It Em CAVEATS |
|
Common misuses and misunderstandings should be explained |
|
in this section. |
|
.It Em BUGS |
|
Known bugs, limitations, and work-arounds should be described |
|
in this section. |
|
.It Em SECURITY CONSIDERATIONS |
|
Documents any security precautions that operators should consider. |
|
.El |
|
.Sh MACRO OVERVIEW |
.Sh MACRO OVERVIEW |
This overview is sorted such that macros of similar purpose are listed |
This overview is sorted such that macros of similar purpose are listed |
together, to help find the best macro for any given purpose. |
together. |
Deprecated macros are not included in the overview, but can be found |
Deprecated and non-portable macros are not included in the overview, |
in the alphabetical reference below. |
but can be found in the alphabetical reference below. |
.Ss Page header and footer meta-data |
.Ss Page header and footer meta-data |
.Bl -column "PP, LP, P" description |
.Bl -column "RS, RE" description |
.It Sx TH Ta set the title: Ar title section date Op Ar source Op Ar volume |
.It Sx TH Ta set the title: Ar name section date Op Ar source Op Ar volume |
.It Sx AT Ta display AT&T UNIX version in the page footer (<= 1 argument) |
.It Sx AT Ta display AT&T UNIX version in the page footer (<= 1 argument) |
.It Sx UC Ta display BSD version in the page footer (<= 1 argument) |
.It Sx UC Ta display BSD version in the page footer (<= 1 argument) |
.El |
.El |
.Ss Sections and paragraphs |
.Ss Sections and paragraphs |
.Bl -column "PP, LP, P" description |
.Bl -column "RS, RE" description |
.It Sx SH Ta section header (one line) |
.It Sx SH Ta section header (one line) |
.It Sx SS Ta subsection header (one line) |
.It Sx SS Ta subsection header (one line) |
.It Sx PP , LP , P Ta start an undecorated paragraph (no arguments) |
.It Sx PP Ta start an undecorated paragraph (no arguments) |
.It Sx RS , RE Ta reset the left margin: Op Ar width |
.It Sx RS , RE Ta reset the left margin: Op Ar width |
.It Sx IP Ta indented paragraph: Op Ar head Op Ar width |
.It Sx IP Ta indented paragraph: Op Ar head Op Ar width |
.It Sx TP Ta tagged paragraph: Op Ar width |
.It Sx TP Ta tagged paragraph: Op Ar width |
.It Sx HP Ta hanged paragraph: Op Ar width |
.It Sx HP Ta hanged paragraph: Op Ar width |
.It Sx PD Ta set vertical paragraph distance: Op Ar height |
.It Sx PD Ta set vertical paragraph distance: Op Ar height |
.It Sx \&br Ta force output line break in text mode (no arguments) |
|
.It Sx \&sp Ta force vertical space: Op Ar height |
|
.It Sx fi , nf Ta fill mode and no-fill mode (no arguments) |
.It Sx fi , nf Ta fill mode and no-fill mode (no arguments) |
.It Sx in Ta additional indent: Op Ar width |
.It Sx in Ta additional indent: Op Ar width |
.El |
.El |
.Ss Physical markup |
.Ss Physical markup |
.Bl -column "PP, LP, P" description |
.Bl -column "RS, RE" description |
.It Sx B Ta boldface font |
.It Sx B Ta boldface font |
.It Sx I Ta italic font |
.It Sx I Ta italic font |
.It Sx R Ta roman (default) font |
|
.It Sx SB Ta small boldface font |
.It Sx SB Ta small boldface font |
.It Sx SM Ta small roman font |
.It Sx SM Ta small roman font |
.It Sx BI Ta alternate between boldface and italic fonts |
.It Sx BI Ta alternate between boldface and italic fonts |
|
|
The optional arguments specify which release it is from. |
The optional arguments specify which release it is from. |
.Ss \&B |
.Ss \&B |
Text is rendered in bold face. |
Text is rendered in bold face. |
.Pp |
|
See also |
|
.Sx \&I |
|
and |
|
.Sx \&R . |
|
.Ss \&BI |
.Ss \&BI |
Text is rendered alternately in bold face and italic. |
Text is rendered alternately in bold face and italic. |
Thus, |
Thus, |
|
|
render in italics. |
render in italics. |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
.Pp |
.Pp |
Examples: |
Example: |
.Pp |
.Pp |
.Dl \&.BI bold italic bold italic |
.Dl \&.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 |
.Ss \&BR |
Text is rendered alternately in bold face and roman (the default font). |
Text is rendered alternately in bold face and roman (the default font). |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
.Pp |
|
See |
|
.Sx \&BI |
|
for an equivalent example. |
|
.Pp |
|
See also |
See also |
.Sx \&BI , |
.Sx \&BI . |
.Sx \&IB , |
|
.Sx \&RB , |
|
.Sx \&RI , |
|
and |
|
.Sx \&IR . |
|
.Ss \&DT |
.Ss \&DT |
Has no effect. |
Restore the default tabulator positions. |
Included for compatibility. |
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. |
.Ss \&EE |
.Ss \&EE |
This is a non-standard GNU extension, included only for compatibility. |
This is a non-standard GNU extension. |
In |
In |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
it does the same as |
it does the same as |
.Sx \&fi . |
.Sx \&fi . |
.Ss \&EX |
.Ss \&EX |
This is a non-standard GNU extension, included only for compatibility. |
This is a non-standard GNU extension. |
In |
In |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
it does the same as |
it does the same as |
|
|
scaling width. |
scaling width. |
If specified, it's saved for later paragraph left-margins; if unspecified, the |
If specified, it's saved for later paragraph left-margins; if unspecified, the |
saved or default width is used. |
saved or default width is used. |
.Pp |
|
See also |
|
.Sx \&IP , |
|
.Sx \&LP , |
|
.Sx \&P , |
|
.Sx \&PP , |
|
and |
|
.Sx \&TP . |
|
.Ss \&I |
.Ss \&I |
Text is rendered in italics. |
Text is rendered in italics. |
.Pp |
|
See also |
|
.Sx \&B |
|
and |
|
.Sx \&R . |
|
.Ss \&IB |
.Ss \&IB |
Text is rendered alternately in italics and bold face. |
Text is rendered alternately in italics and bold face. |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
.Pp |
|
See |
|
.Sx \&BI |
|
for an equivalent example. |
|
.Pp |
|
See also |
See also |
.Sx \&BI , |
.Sx \&BI . |
.Sx \&BR , |
|
.Sx \&RB , |
|
.Sx \&RI , |
|
and |
|
.Sx \&IR . |
|
.Ss \&IP |
.Ss \&IP |
Begin an indented paragraph with the following syntax: |
Begin an indented paragraph with the following syntax: |
.Bd -filled -offset indent |
.Bd -filled -offset indent |
|
|
.Ar head |
.Ar head |
argument is used as a leading term, flushed to the left margin. |
argument is used as a leading term, flushed to the left margin. |
This is useful for bulleted paragraphs and so on. |
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 |
.Ss \&IR |
Text is rendered alternately in italics and roman (the default font). |
Text is rendered alternately in italics and roman (the default font). |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
.Pp |
|
See |
|
.Sx \&BI |
|
for an equivalent example. |
|
.Pp |
|
See also |
See also |
.Sx \&BI , |
.Sx \&BI . |
.Sx \&IB , |
|
.Sx \&BR , |
|
.Sx \&RB , |
|
and |
|
.Sx \&RI . |
|
.Ss \&LP |
.Ss \&LP |
Begin an undecorated paragraph. |
A synonym for |
The scope of a paragraph is closed by a subsequent paragraph, |
.Sx \&PP . |
sub-section, section, or end of file. |
.Ss \&ME |
The saved paragraph left-margin width is reset to the default. |
End a mailto block started with |
.Pp |
.Sx \&MT . |
See also |
This is a non-standard GNU extension. |
.Sx \&HP , |
.Ss \&MT |
.Sx \&IP , |
Begin a mailto block. |
.Sx \&P , |
This is a non-standard GNU extension. |
.Sx \&PP , |
It has the following syntax: |
and |
.Bd -literal -offset indent |
.Sx \&TP . |
.Pf \. Sx \&MT Ar address |
|
link description to be shown |
|
.Pf \. Sx ME |
|
.Ed |
.Ss \&OP |
.Ss \&OP |
Optional command-line argument. |
Optional command-line argument. |
This is a non-standard GNU extension, included only for compatibility. |
This is a non-standard GNU extension. |
It has the following syntax: |
It has the following syntax: |
.Bd -filled -offset indent |
.Bd -filled -offset indent |
.Pf \. Sx \&OP |
.Pf \. Sx \&OP |
Line 479 is usually a command-line flag and |
|
Line 249 is usually a command-line flag and |
|
.Ar value |
.Ar value |
its argument. |
its argument. |
.Ss \&P |
.Ss \&P |
Synonym for |
A synonym for |
.Sx \&LP . |
.Sx \&PP . |
.Pp |
|
See also |
|
.Sx \&HP , |
|
.Sx \&IP , |
|
.Sx \&LP , |
|
.Sx \&PP , |
|
and |
|
.Sx \&TP . |
|
.Ss \&PD |
.Ss \&PD |
Specify the vertical space to be inserted before each new paragraph. |
Specify the vertical space to be inserted before each new paragraph. |
.br |
.br |
Line 517 This macro affects the spacing before any subsequent i |
|
Line 279 This macro affects the spacing before any subsequent i |
|
.Sx \&PP , |
.Sx \&PP , |
.Sx \&SH , |
.Sx \&SH , |
.Sx \&SS , |
.Sx \&SS , |
|
.Sx \&SY , |
and |
and |
.Sx \&TP . |
.Sx \&TP . |
.Ss \&PP |
.Ss \&PP |
Synonym for |
Begin an undecorated paragraph. |
.Sx \&LP . |
The scope of a paragraph is closed by a subsequent paragraph, |
.Pp |
sub-section, section, or end of file. |
See also |
The saved paragraph left-margin width is reset to the default. |
.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 |
|
and |
|
.Sx \&B . |
|
.Ss \&RB |
.Ss \&RB |
Text is rendered alternately in roman (the default font) and bold face. |
Text is rendered alternately in roman (the default font) and bold face. |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
.Pp |
|
See |
|
.Sx \&BI |
|
for an equivalent example. |
|
.Pp |
|
See also |
See also |
.Sx \&BI , |
.Sx \&BI . |
.Sx \&IB , |
|
.Sx \&BR , |
|
.Sx \&RI , |
|
and |
|
.Sx \&IR . |
|
.Ss \&RE |
.Ss \&RE |
Explicitly close out the scope of a prior |
Explicitly close out the scope of a prior |
.Sx \&RS . |
.Sx \&RS . |
Line 581 blocks remain open. |
|
Line 321 blocks remain open. |
|
.Ss \&RI |
.Ss \&RI |
Text is rendered alternately in roman (the default font) and italics. |
Text is rendered alternately in roman (the default font) and italics. |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
.Pp |
|
See |
|
.Sx \&BI |
|
for an equivalent example. |
|
.Pp |
|
See also |
See also |
.Sx \&BI , |
.Sx \&BI . |
.Sx \&IB , |
|
.Sx \&BR , |
|
.Sx \&RB , |
|
and |
|
.Sx \&IR . |
|
.Ss \&RS |
.Ss \&RS |
Temporarily reset the default left margin. |
Temporarily reset the default left margin. |
This has the following syntax: |
This has the following syntax: |
Line 626 Begin a sub-section. |
|
Line 356 Begin a sub-section. |
|
The scope of a sub-section is closed by a subsequent sub-section, |
The scope of a sub-section is closed by a subsequent sub-section, |
section, or end of file. |
section, or end of file. |
The paragraph left-margin width is reset to the default. |
The paragraph left-margin width is reset to the default. |
|
.Ss \&SY |
|
Begin a synopsis block with the following syntax: |
|
.Bd -unfilled -offset indent |
|
.Pf \. Sx \&SY Ar command |
|
.Ar arguments |
|
.Pf \. Sx \&YS |
|
.Ed |
|
.Pp |
|
This is a non-standard GNU extension |
|
and very rarely used even in GNU manual pages. |
|
Formatting is similar to |
|
.Sx \&IP . |
.Ss \&TH |
.Ss \&TH |
Sets the title of the manual page for use in the page header |
Set the name of the manual page for use in the page header |
and footer with the following syntax: |
and footer with the following syntax: |
.Bd -filled -offset indent |
.Bd -filled -offset indent |
.Pf \. Sx \&TH |
.Pf \. Sx \&TH |
.Ar title section date |
.Ar name section date |
.Op Ar source Op Ar volume |
.Op Ar source Op Ar volume |
.Ed |
.Ed |
.Pp |
.Pp |
Conventionally, the document |
Conventionally, the document |
.Ar title |
.Ar name |
is given in all caps. |
is given in all caps. |
The recommended |
The recommended |
.Ar date |
.Ar date |
|
|
scaling width. |
scaling width. |
If specified, it's saved for later paragraph left-margins; if |
If specified, it's saved for later paragraph left-margins; if |
unspecified, the saved or default width is used. |
unspecified, the saved or default width is used. |
.Pp |
.Ss \&TQ |
See also |
Like |
.Sx \&HP , |
.Sx \&TP , |
.Sx \&IP , |
except that no vertical spacing is inserted before the paragraph. |
.Sx \&LP , |
This is a non-standard GNU extension |
.Sx \&P , |
and very rarely used even in GNU manual pages. |
and |
|
.Sx \&PP . |
|
.Ss \&UC |
.Ss \&UC |
Sets the volume for the footer for compatibility with man pages from |
Sets the volume for the footer for compatibility with man pages from |
.Bx |
.Bx |
releases. |
releases. |
The optional first argument specifies which release it is from. |
The optional first argument specifies which release it is from. |
.Ss \&UE |
.Ss \&UE |
End a uniform resource identifier block. |
End a uniform resource identifier block started with |
This is a non-standard GNU extension, included only for compatibility. |
.Sx \&UR . |
See |
This is a non-standard GNU extension. |
.Sx \&UE . |
|
.Ss \&UR |
.Ss \&UR |
Begin a uniform resource identifier block. |
Begin a uniform resource identifier block. |
This is a non-standard GNU extension, included only for compatibility. |
This is a non-standard GNU extension. |
It has the following syntax: |
It has the following syntax: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
.Pf \. Sx \&UR Ar uri |
.Pf \. Sx \&UR Ar uri |
link description to be shown |
link description to be shown |
.Pf \. Sx UE |
.Pf \. Sx UE |
.Ed |
.Ed |
.Ss \&br |
.Ss \&YS |
Breaks the current line. |
End a synopsis block started with |
Consecutive invocations have no further effect. |
.Sx \&SY . |
.Pp |
This is a non-standard GNU extension. |
See also |
|
.Sx \&sp . |
|
.Ss \&fi |
.Ss \&fi |
End literal mode begun by |
End literal mode started with |
.Sx \&nf . |
.Sx \&nf . |
.Ss \&in |
.Ss \&in |
Indent relative to the current indentation: |
Indent relative to the current indentation: |
Line 736 Literal mode is implicitly ended by |
|
Line 473 Literal mode is implicitly ended by |
|
.Sx \&SH |
.Sx \&SH |
or |
or |
.Sx \&SS . |
.Sx \&SS . |
.Ss \&sp |
|
Insert vertical spaces into output with the following syntax: |
|
.Bd -filled -offset indent |
|
.Pf \. Sx \&sp |
|
.Op Ar height |
|
.Ed |
|
.Pp |
|
The |
|
.Ar height |
|
argument is a scaling width as described in |
|
.Xr roff 7 . |
|
If 0, this is equivalent to the |
|
.Sx \&br |
|
macro. |
|
Defaults to 1, if unspecified. |
|
.Pp |
|
See also |
|
.Sx \&br . |
|
.Sh MACRO SYNTAX |
.Sh MACRO SYNTAX |
The |
The |
.Nm |
.Nm |
Line 777 is equivalent to |
|
Line 496 is equivalent to |
|
.Sq \&.I foo . |
.Sq \&.I foo . |
If next-line macros are invoked consecutively, only the last is used. |
If next-line macros are invoked consecutively, only the last is used. |
If a next-line macro is followed by a non-next-line macro, an error is |
If a next-line macro is followed by a non-next-line macro, an error is |
raised, except for |
raised. |
.Sx \&br |
|
and |
|
.Sx \&sp . |
|
.Pp |
.Pp |
The syntax is as follows: |
The syntax is as follows: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
Line 794 The syntax is as follows: |
|
Line 510 The syntax is as follows: |
|
.It Sx \&BI Ta n Ta current Ta \& |
.It Sx \&BI Ta n Ta current Ta \& |
.It Sx \&BR Ta n Ta current Ta \& |
.It Sx \&BR Ta n Ta current Ta \& |
.It Sx \&DT Ta 0 Ta current Ta \& |
.It Sx \&DT Ta 0 Ta current Ta \& |
.It Sx \&EE Ta 0 Ta current Ta compat |
.It Sx \&EE Ta 0 Ta current Ta GNU |
.It Sx \&EX Ta 0 Ta current Ta compat |
.It Sx \&EX Ta 0 Ta current Ta GNU |
.It Sx \&I Ta n Ta next-line Ta \& |
.It Sx \&I Ta n Ta next-line Ta \& |
.It Sx \&IB Ta n Ta current Ta \& |
.It Sx \&IB Ta n Ta current Ta \& |
.It Sx \&IR Ta n Ta current Ta \& |
.It Sx \&IR Ta n Ta current Ta \& |
.It Sx \&OP Ta 0, 1 Ta current Ta compat |
.It Sx \&OP Ta >=1 Ta current Ta GNU |
.It Sx \&PD Ta 1 Ta current Ta \& |
.It Sx \&PD Ta 1 Ta current Ta \& |
.It Sx \&R Ta n Ta next-line Ta \& |
|
.It Sx \&RB Ta n Ta current Ta \& |
.It Sx \&RB Ta n Ta current Ta \& |
.It Sx \&RI Ta n Ta current Ta \& |
.It Sx \&RI Ta n Ta current Ta \& |
.It Sx \&SB Ta n Ta next-line Ta \& |
.It Sx \&SB Ta n Ta next-line Ta \& |
.It Sx \&SM Ta n Ta next-line Ta \& |
.It Sx \&SM Ta n Ta next-line Ta \& |
.It Sx \&TH Ta >1, <6 Ta current Ta \& |
.It Sx \&TH Ta >1, <6 Ta current Ta \& |
.It Sx \&UC Ta <=1 Ta current Ta \& |
.It Sx \&UC Ta <=1 Ta current Ta \& |
.It Sx \&br Ta 0 Ta current Ta compat |
.It Sx \&fi Ta 0 Ta current Ta Xr roff 7 |
.It Sx \&fi Ta 0 Ta current Ta compat |
.It Sx \&in Ta 1 Ta current Ta Xr roff 7 |
.It Sx \&in Ta 1 Ta current Ta compat |
.It Sx \&nf Ta 0 Ta current Ta Xr roff 7 |
.It Sx \&nf Ta 0 Ta current Ta compat |
|
.It Sx \&sp Ta 1 Ta current Ta compat |
|
.El |
.El |
.Pp |
|
Macros marked as |
|
.Qq compat |
|
are included for compatibility with the significant corpus of existing |
|
manuals that mix dialects of roff. |
|
These macros should not be used for portable |
|
.Nm |
|
manuals. |
|
.Ss Block Macros |
.Ss Block Macros |
Block macros comprise a head and body. |
Block macros comprise a head and body. |
As with in-line macros, the head is scoped to the current line and, in |
As with in-line macros, the head is scoped to the current line and, in |
|
|
.Sx \&SH ; |
.Sx \&SH ; |
sub-section, closed by a section or |
sub-section, closed by a section or |
.Sx \&SS ; |
.Sx \&SS ; |
part, closed by a section, sub-section, or |
or paragraph, closed by a section, sub-section, |
.Sx \&RE ; |
|
or paragraph, closed by a section, sub-section, part, |
|
.Sx \&HP , |
.Sx \&HP , |
.Sx \&IP , |
.Sx \&IP , |
.Sx \&LP , |
.Sx \&LP , |
.Sx \&P , |
.Sx \&P , |
.Sx \&PP , |
.Sx \&PP , |
|
.Sx \&RE , |
|
.Sx \&SY , |
or |
or |
.Sx \&TP . |
.Sx \&TP . |
No closure refers to an explicit block closing macro. |
No closure refers to an explicit block closing macro. |
Line 861 implicitly closed, is syntactically incorrect. |
|
Line 566 implicitly closed, is syntactically incorrect. |
|
.It Sx \&HP Ta <2 Ta current Ta paragraph Ta \& |
.It Sx \&HP Ta <2 Ta current Ta paragraph Ta \& |
.It Sx \&IP Ta <3 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 \&LP Ta 0 Ta current Ta paragraph Ta \& |
|
.It Sx \&ME Ta 0 Ta none Ta none Ta GNU |
|
.It Sx \&MT Ta 1 Ta current Ta to \&ME Ta GNU |
.It Sx \&P 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 \&PP Ta 0 Ta current Ta paragraph Ta \& |
.It Sx \&RE Ta 0 Ta current Ta none Ta compat |
.It Sx \&RE Ta <=1 Ta current Ta none Ta \& |
.It Sx \&RS Ta 1 Ta current Ta part Ta compat |
.It Sx \&RS Ta 1 Ta current Ta to \&RE Ta \& |
.It Sx \&SH Ta >0 Ta next-line Ta section Ta \& |
.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 \&SS Ta >0 Ta next-line Ta sub-section Ta \& |
|
.It Sx \&SY Ta 1 Ta current Ta to \&YS Ta GNU |
.It Sx \&TP Ta n Ta next-line Ta paragraph Ta \& |
.It Sx \&TP Ta n Ta next-line Ta paragraph Ta \& |
.It Sx \&UE Ta 0 Ta current Ta none Ta compat |
.It Sx \&TQ Ta n Ta next-line Ta paragraph Ta GNU |
.It Sx \&UR Ta 1 Ta current Ta part Ta compat |
.It Sx \&UE Ta 0 Ta current Ta none Ta GNU |
|
.It Sx \&UR Ta 1 Ta current Ta part Ta GNU |
|
.It Sx \&YS Ta 0 Ta none Ta none Ta GNU |
.El |
.El |
.Pp |
.Pp |
Macros marked |
|
.Qq compat |
|
are as mentioned in |
|
.Sx Line Macros . |
|
.Pp |
|
If a block macro is next-line scoped, it may only be followed by in-line |
If a block macro is next-line scoped, it may only be followed by in-line |
macros for decorating text. |
macros for decorating text. |
.Ss Font handling |
.Ss Font handling |
Line 894 until the end of the macro scope. |
|
Line 599 until the end of the macro scope. |
|
Note that macros like |
Note that macros like |
.Sx \&BR |
.Sx \&BR |
open and close a font scope for each argument. |
open and close a font scope for each argument. |
.Sh COMPATIBILITY |
|
This section mentions some areas of questionable portability between |
|
implementations of the |
|
.Nm |
|
language. |
|
More incompatibilities exist. |
|
.Pp |
|
.Bl -dash -compact |
|
.It |
|
Do not depend on |
|
.Sx \&SH |
|
or |
|
.Sx \&SS |
|
to close out a literal context opened with |
|
.Sx \&nf . |
|
This behaviour may not be portable. |
|
.It |
|
troff suppresses a newline before |
|
.Sq \(aq |
|
macro output; in mandoc, it is an alias for the standard |
|
.Sq \&. |
|
control character. |
|
.It |
|
In page header lines, GNU troff versions up to and including 1.21 |
|
only print |
|
.Ar volume |
|
names explicitly specified in the |
|
.Sx \&TH |
|
macro; mandoc and newer groff print the default volume name |
|
corresponding to the |
|
.Ar section |
|
number when no |
|
.Ar volume |
|
is given, like in |
|
.Xr mdoc 7 . |
|
.El |
|
.Pp |
|
The |
|
.Sx EE , |
|
.Sx EX , |
|
.Sx OP , |
|
.Sx UE , |
|
and |
|
.Sx UR |
|
macros are part of the GNU extended |
|
.Nm |
|
macro set, and may not be portable to non-GNU troff implementations. |
|
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr man 1 , |
.Xr man 1 , |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
|
|
.Nm |
.Nm |
reference was written by |
reference was written by |
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . |
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . |
.Sh CAVEATS |
|
Do not use this language. |
|
Use |
|
.Xr mdoc 7 , |
|
instead. |
|