version 1.49, 2014/03/17 06:57:48 |
version 1.59, 2014/11/19 01:20:25 |
Line 239 pica (~1/6 inch) |
|
Line 239 pica (~1/6 inch) |
|
.It p |
.It p |
point (~1/72 inch) |
point (~1/72 inch) |
.It f |
.It f |
synonym for |
scale |
.Sq u |
.Sq u |
|
by 65536 |
.It v |
.It v |
default vertical span |
default vertical span |
.It m |
.It m |
Line 254 width of rendered |
|
Line 255 width of rendered |
|
.Pq en |
.Pq en |
character |
character |
.It u |
.It u |
default horizontal span |
default horizontal span for the terminal |
.It M |
.It M |
mini-em (~1/100 em) |
mini-em (~1/100 em) |
.El |
.El |
Line 262 mini-em (~1/100 em) |
|
Line 263 mini-em (~1/100 em) |
|
Using anything other than |
Using anything other than |
.Sq m , |
.Sq m , |
.Sq n , |
.Sq n , |
.Sq u , |
|
or |
or |
.Sq v |
.Sq v |
is necessarily non-portable across output media. |
is necessarily non-portable across output media. |
Line 409 and the number of arguments is not checked. |
|
Line 409 and the number of arguments is not checked. |
|
Append to a macro definition. |
Append to a macro definition. |
The syntax of this request is the same as that of |
The syntax of this request is the same as that of |
.Sx \&de . |
.Sx \&de . |
It is currently ignored by |
|
.Xr mandoc 1 , |
|
as are its children. |
|
.Ss \&ami |
.Ss \&ami |
Append to a macro definition, specifying the macro name indirectly. |
Append to a macro definition, specifying the macro name indirectly. |
The syntax of this request is the same as that of |
The syntax of this request is the same as that of |
.Sx \&dei . |
.Sx \&dei . |
It is currently ignored by |
|
.Xr mandoc 1 , |
|
as are its children. |
|
.Ss \&am1 |
.Ss \&am1 |
Append to a macro definition, switching roff compatibility mode off |
Append to a macro definition, switching roff compatibility mode off |
during macro execution. |
during macro execution. |
The syntax of this request is the same as that of |
The syntax of this request is the same as that of |
.Sx \&de1 . |
.Sx \&de1 . |
It is currently ignored by |
Since |
.Xr mandoc 1 , |
.Xr mandoc 1 |
as are its children. |
does not implement |
|
.Nm |
|
compatibility mode at all, it handles this request as an alias for |
|
.Sx \&am . |
.Ss \&as |
.Ss \&as |
Append to a user-defined string. |
Append to a user-defined string. |
The syntax of this request is the same as that of |
The syntax of this request is the same as that of |
|
|
macro, specifying the macro name indirectly. |
macro, specifying the macro name indirectly. |
The syntax of this request is the same as that of |
The syntax of this request is the same as that of |
.Sx \&de . |
.Sx \&de . |
It is currently ignored by |
The request |
.Xr mandoc 1 , |
.Pp |
as are its children. |
.D1 Pf . Cm \&dei Ar name Op Ar end |
|
.Pp |
|
has the same effect as: |
|
.Pp |
|
.D1 Pf . Cm \&de No \e* Ns Bo Ar name Bc Op \e* Ns Bq Ar end |
.Ss \&de1 |
.Ss \&de1 |
Define a |
Define a |
.Nm |
.Nm |
Line 746 If the first character of COND is |
|
Line 747 If the first character of COND is |
|
.Pq even page , |
.Pq even page , |
.Sq r |
.Sq r |
.Pq register accessed , |
.Pq register accessed , |
or |
|
.Sq t |
.Sq t |
.Pq troff mode , |
.Pq troff mode , |
|
or |
|
.Sq v |
|
.Pq vroff mode , |
COND evaluates to false. |
COND evaluates to false. |
.It |
.It |
If COND starts with a digit, optionally prefixed by a minus sign, |
If COND starts with a parenthesis or with an optionally signed |
it is evaluated as a numerical expression of the form |
integer number, it is evaluated according to the rules of |
.Ar number operator number , |
.Sx Numerical expressions |
where |
explained below. |
.Ar operator |
It evaluates to true if the result is positive, |
is one of |
or to false if the result is zero or negative. |
.Sq < , |
|
.Sq <= , |
|
.Sq = , |
|
.Sq >= , |
|
or |
|
.Sq > . |
|
.It |
.It |
Otherwise, the first character of COND is regarded as a delimiter |
Otherwise, the first character of COND is regarded as a delimiter |
and COND evaluates to true if the string extending from its first |
and COND evaluates to true if the string extending from its first |
Line 874 Otherwise, it only terminates the |
|
Line 871 Otherwise, it only terminates the |
|
and arguments following it or the |
and arguments following it or the |
.Sq \&.. |
.Sq \&.. |
request are discarded. |
request are discarded. |
|
.Ss \&ll |
|
Change the output line length. |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf . Cm \&ll Op Oo +|- Oc Ns Ar width |
|
.Pp |
|
If the |
|
.Ar width |
|
argument is omitted, the line length is reset to its previous value. |
|
The default setting for terminal output is 78n. |
|
If a sign is given, the line length is added to or subtracted from; |
|
otherwise, it is set to the provided value. |
|
Using this request in new manuals is discouraged for several reasons, |
|
among others because it overrides the |
|
.Xr mandoc 1 |
|
.Fl O Cm width |
|
command line option. |
.Ss \&ne |
.Ss \&ne |
Declare the need for the specified minimum vertical space |
Declare the need for the specified minimum vertical space |
before the next trap or the bottom of the page. |
before the next trap or the bottom of the page. |
Line 881 This line-scoped request is currently ignored. |
|
Line 895 This line-scoped request is currently ignored. |
|
.Ss \&nh |
.Ss \&nh |
Turn off automatic hyphenation mode. |
Turn off automatic hyphenation mode. |
This line-scoped request is currently ignored. |
This line-scoped request is currently ignored. |
.Ss \&rm |
|
Remove a request, macro or string. |
|
This request is intended to have one argument, |
|
the name of the request, macro or string to be undefined. |
|
Currently, it is ignored including its arguments, |
|
and the number of arguments is not checked. |
|
.Ss \&nr |
.Ss \&nr |
Define or change a register. |
Define or change a register. |
A register is an arbitrary string value that defines some sort of state, |
A register is an arbitrary string value that defines some sort of state, |
which influences parsing and/or formatting. |
which influences parsing and/or formatting. |
Its syntax is as follows: |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 Pf \. Cm \&nr Ar name Oo +|- Oc Ns Ar value |
.D1 Pf \. Cm \&nr Ar name Oo +|- Oc Ns Ar expression |
.Pp |
.Pp |
The |
For the syntax of |
.Ar value |
.Ar expression , |
may, at the moment, only be an integer. |
see |
|
.Sx Numerical expressions |
|
below. |
If it is prefixed by a sign, the register will be |
If it is prefixed by a sign, the register will be |
incremented or decremented instead of assigned to. |
incremented or decremented instead of assigned to. |
.Pp |
.Pp |
Line 927 Turn on no-space mode. |
|
Line 937 Turn on no-space mode. |
|
This line-scoped request is intended to take no arguments. |
This line-scoped request is intended to take no arguments. |
Currently, it is ignored including its arguments, |
Currently, it is ignored including its arguments, |
and the number of arguments is not checked. |
and the number of arguments is not checked. |
|
.Ss \&pl |
|
Change page length. |
|
This line-scoped request is intended to take one height argument. |
|
Currently, it is ignored including its arguments, |
|
and the number of arguments is not checked. |
.Ss \&ps |
.Ss \&ps |
Change point size. |
Change point size. |
This line-scoped request is intended to take one numerical argument. |
This line-scoped request is intended to take one numerical argument. |
Currently, it is ignored including its arguments, |
Currently, it is ignored including its arguments, |
and the number of arguments is not checked. |
and the number of arguments is not checked. |
|
.Ss \&rm |
|
Remove a request, macro or string. |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf \. Cm \&rm Ar name |
|
.Ss \&rr |
|
Remove a register. |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf \. Cm \&rr Ar name |
.Ss \&so |
.Ss \&so |
Include a source file. |
Include a source file. |
Its syntax is as follows: |
Its syntax is as follows: |
Line 1000 Begin a table, which formats input in aligned rows and |
|
Line 1025 Begin a table, which formats input in aligned rows and |
|
See |
See |
.Xr tbl 7 |
.Xr tbl 7 |
for a description of the tbl language. |
for a description of the tbl language. |
|
.Ss Numerical expressions |
|
The |
|
.Sx \&nr , |
|
.Sx \&if , |
|
and |
|
.Sx \&ie |
|
requests accept integer numerical expressions as arguments. |
|
These are always evaluated using the C |
|
.Vt int |
|
type; integer overflow works the same way as in the C language. |
|
Numbers consist of an arbitrary number of digits |
|
.Sq 0 |
|
to |
|
.Sq 9 |
|
prefixed by an optional sign |
|
.Sq + |
|
or |
|
.Sq - . |
|
.Pp |
|
The following binary operators are implemented. |
|
Unless otherwise stated, they behave as in the C language: |
|
.Pp |
|
.Bl -tag -width 2n -compact |
|
.It Ic + |
|
addition |
|
.It Ic - |
|
subtraction |
|
.It Ic * |
|
multiplication |
|
.It Ic / |
|
division |
|
.It Ic % |
|
remainder of division |
|
.It Ic < |
|
less than |
|
.It Ic > |
|
greater than |
|
.It Ic == |
|
equal to |
|
.It Ic = |
|
equal to, same effect as |
|
.Ic == |
|
(this differs from C) |
|
.It Ic <= |
|
less than or equal to |
|
.It Ic >= |
|
greater than or equal to |
|
.It Ic <> |
|
not equal to (corresponds to C |
|
.Ic != ; |
|
this one is of limited portability, it is supported by Heirloom roff, |
|
but not by groff) |
|
.It Ic & |
|
logical and (corresponds to C |
|
.Ic && ) |
|
.It Ic \&: |
|
logical or (corresponds to C |
|
.Ic \&|| ) |
|
.It Ic <? |
|
minimum (not available in C) |
|
.It Ic >? |
|
maximum (not available in C) |
|
.El |
|
.Pp |
|
There is no concept of precendence; evaluation proceeds from left to right, |
|
except when subexpressions are enclosed in parantheses. |
|
Inside parentheses, whitespace is ignored. |
.Sh ESCAPE SEQUENCE REFERENCE |
.Sh ESCAPE SEQUENCE REFERENCE |
The |
The |
.Xr mandoc 1 |
.Xr mandoc 1 |
Line 1088 Digit width space character. |
|
Line 1180 Digit width space character. |
|
Anchor definition; ignored by |
Anchor definition; ignored by |
.Xr mandoc 1 . |
.Xr mandoc 1 . |
.Ss \eB\(aq Ns Ar string Ns \(aq |
.Ss \eB\(aq Ns Ar string Ns \(aq |
Test whether |
Interpolate |
|
.Sq 1 |
|
if |
.Ar string |
.Ar string |
is a numerical expession; ignored by |
conforms to the syntax of |
.Xr mandoc 1 . |
.Sx Numerical expressions |
|
explained above and |
|
.Sq 0 |
|
otherwise. |
.Ss \eb\(aq Ns Ar string Ns \(aq |
.Ss \eb\(aq Ns Ar string Ns \(aq |
Bracket building function; ignored by |
Bracket building function; ignored by |
.Xr mandoc 1 . |
.Xr mandoc 1 . |
Line 1215 Vertical motion; ignored by |
|
Line 1312 Vertical motion; ignored by |
|
.Xr mandoc 1 . |
.Xr mandoc 1 . |
.Ss \ew\(aq Ns Ar string Ns \(aq |
.Ss \ew\(aq Ns Ar string Ns \(aq |
Interpolate the width of the |
Interpolate the width of the |
.Ar string ; |
.Ar string . |
ignored by |
The |
.Xr mandoc 1 . |
.Xr mandoc 1 |
|
implementation assumes that after expansion of user-defined strings, the |
|
.Ar string |
|
only contains normal characters, no escape sequences, and that each |
|
character has a width of 24 basic units. |
.Ss \eX\(aq Ns Ar string Ns \(aq |
.Ss \eX\(aq Ns Ar string Ns \(aq |
Output |
Output |
.Ar string |
.Ar string |
|
|
refers to groff version 1.15. |
refers to groff version 1.15. |
.Pp |
.Pp |
.Bl -dash -compact |
.Bl -dash -compact |
|
.It |
|
The |
|
.Sq u |
|
scaling unit is the default terminal unit. |
|
In traditional troff systems, this unit would change depending on the |
|
output media. |
.It |
.It |
In mandoc, the |
In mandoc, the |
.Sx \&EQ , |
.Sx \&EQ , |