version 1.131, 2015/01/24 02:41:49 |
version 1.139, 2018/08/18 02:08:27 |
|
|
.\" $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 |
Line 266 in the alphabetical reference below. |
|
Line 267 in the alphabetical reference below. |
|
.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 |
Line 275 in the alphabetical reference below. |
|
Line 274 in the alphabetical reference below. |
|
.Bl -column "PP, LP, P" description |
.Bl -column "PP, LP, P" 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 |
Line 299 The optional arguments specify which release it is fro |
|
Line 297 The optional arguments specify which release it is fro |
|
Text is rendered in bold face. |
Text is rendered in bold face. |
.Pp |
.Pp |
See also |
See also |
.Sx \&I |
.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, |
|
|
and |
and |
.Sx \&IR . |
.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, included only for compatibility. |
In |
In |
|
|
Text is rendered in italics. |
Text is rendered in italics. |
.Pp |
.Pp |
See also |
See also |
.Sx \&B |
.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. |
|
|
.Sx \&PP , |
.Sx \&PP , |
and |
and |
.Sx \&TP . |
.Sx \&TP . |
|
.Ss \&ME |
|
End a mailto block. |
|
This is a non-standard GNU extension, included only for compatibility. |
|
See |
|
.Sx \&MT . |
|
.Ss \&MT |
|
Begin a mailto block. |
|
This is a non-standard GNU extension, included only for compatibility. |
|
It has the following syntax: |
|
.Bd -literal -offset indent |
|
.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, included only for compatibility. |
|
|
.Sx \&P , |
.Sx \&P , |
and |
and |
.Sx \&TP . |
.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. |
Line 626 Begin a sub-section. |
|
Line 631 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 |
Sets the title of the manual page for use in the page header |
and footer with the following syntax: |
and footer with the following syntax: |
|
|
.Sx \&P , |
.Sx \&P , |
and |
and |
.Sx \&PP . |
.Sx \&PP . |
|
.Ss \&TQ |
|
Like |
|
.Sx \&TP , |
|
except that no vertical spacing is inserted before the paragraph. |
|
This is a non-standard GNU extension and rarely used even by GNU |
|
manual pages. |
.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 |
Line 708 It has the following syntax: |
|
Line 731 It has the following syntax: |
|
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 by |
Consecutive invocations have no further effect. |
.Pf \. 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 begun by |
.Sx \&nf . |
.Sx \&nf . |
Line 736 Literal mode is implicitly ended by |
|
Line 757 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 780 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 801 The syntax is as follows: |
|
Line 801 The syntax is as follows: |
|
.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 0, 1 Ta current Ta compat |
.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 compat |
.It Sx \&fi Ta 0 Ta current Ta compat |
.It Sx \&in Ta 1 Ta current Ta compat |
.It Sx \&in Ta 1 Ta current Ta compat |
.It Sx \&nf Ta 0 Ta current Ta compat |
.It Sx \&nf Ta 0 Ta current Ta compat |
.It Sx \&sp Ta 1 Ta current Ta compat |
|
.El |
.El |
.Pp |
.Pp |
Macros marked as |
Macros marked as |
Line 894 until the end of the macro scope. |
|
Line 891 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 , |