version 1.55, 2014/07/07 11:35:06 |
version 1.67, 2015/01/23 00:42:00 |
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. |
|
|
.Xr mandoc 1 |
.Xr mandoc 1 |
.Nm |
.Nm |
parser recognises the following requests. |
parser recognises the following requests. |
Note that the |
For requests marked as "ignored" or "unsupported", any arguments are |
.Nm |
ignored, and the number of arguments is not checked. |
language defines many more requests not implemented in |
.Ss \&ab |
.Xr mandoc 1 . |
Abort processing. |
|
Currently unsupported. |
.Ss \&ad |
.Ss \&ad |
Set line adjustment mode. |
Set line adjustment mode. |
This line-scoped request is intended to have one argument to select |
It takes one argument to select normal, left, right, |
normal, left, right, or centre adjustment for subsequent text. |
or center adjustment for subsequent text. |
Currently, it is ignored including its arguments, |
Currently ignored. |
and the number of arguments is not checked. |
.Ss \&af |
|
Assign an output format to a number register. |
|
Currently ignored. |
|
.Ss \&aln |
|
Create an alias for a number register. |
|
Currently unsupported. |
|
.Ss \&als |
|
Create an alias for a request, string, macro, or diversion. |
|
Currently unsupported. |
.Ss \&am |
.Ss \&am |
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 . |
.Ss \&ami |
|
Append to a macro definition, specifying the macro name indirectly. |
|
The syntax of this request is the same as that of |
|
.Sx \&dei . |
|
.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 (groff extension). |
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 . |
Since |
Since |
Line 424 does not implement |
|
Line 429 does not implement |
|
.Nm |
.Nm |
compatibility mode at all, it handles this request as an alias for |
compatibility mode at all, it handles this request as an alias for |
.Sx \&am . |
.Sx \&am . |
|
.Ss \&ami |
|
Append to a macro definition, specifying the macro name indirectly |
|
(groff extension). |
|
The syntax of this request is the same as that of |
|
.Sx \&dei . |
|
.Ss \&ami1 |
|
Append to a macro definition, specifying the macro name indirectly |
|
and switching roff compatibility mode off during macro execution |
|
(groff extension). |
|
The syntax of this request is the same as that of |
|
.Sx \&dei1 . |
|
Since |
|
.Xr mandoc 1 |
|
does not implement |
|
.Nm |
|
compatibility mode at all, it handles this request as an alias for |
|
.Sx \&ami . |
.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 |
.Sx \&ds . |
.Sx \&ds . |
If a user-defined string with the specified name does not yet exist, |
If a user-defined string with the specified name does not yet exist, |
it is set to the empty string before appending. |
it is set to the empty string before appending. |
|
.Ss \&as1 |
|
Append to a user-defined string, switching roff compatibility mode off |
|
during macro execution (groff extension). |
|
The syntax of this request is the same as that of |
|
.Sx \&ds1 . |
|
Since |
|
.Xr mandoc 1 |
|
does not implement |
|
.Nm |
|
compatibility mode at all, it handles this request as an alias for |
|
.Sx \&as . |
|
.Ss \&asciify |
|
Fully unformat a diversion. |
|
Currently unsupported. |
|
.Ss \&backtrace |
|
Print a backtrace of the input stack. |
|
This is a groff extension and currently ignored. |
|
.Ss \&bd |
|
Artificially embolden by repeated printing with small shifts. |
|
Currently ignored. |
|
.Ss \&bleedat |
|
Set the BleedBox page parameter for PDF generation. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&blm |
|
Set a blank line trap. |
|
Currently unsupported. |
|
.Ss \&box |
|
Begin a diversion without including a partially filled line. |
|
Currently unsupported. |
|
.Ss \&boxa |
|
Add to a diversion without including a partially filled line. |
|
Currently unsupported. |
|
.Ss \&bp |
|
Begin new page. |
|
Currently ignored. |
|
.Ss \&BP |
|
Define a frame and place a picture in it. |
|
This is a Heirloom extension and currently unsupported. |
|
.Ss \&br |
|
Break the output line. |
|
See |
|
.Xr man 7 |
|
and |
|
.Xr mdoc 7 . |
|
.Ss \&break |
|
Break out of a |
|
.Sx \&while |
|
loop. |
|
Currently unsupported. |
|
.Ss \&breakchar |
|
Optional line break characters. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&brnl |
|
Break output line after next N input lines. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&brp |
|
Break and spread output line. |
|
Currently, this is implemented as an alias for |
|
.Sx \&br . |
|
.Ss \&brpnl |
|
Break and spread output line after next N input lines. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&c2 |
|
Change the no-break control character. |
|
Currently unsupported. |
.Ss \&cc |
.Ss \&cc |
Changes the control character. |
Change the control character. |
Its syntax is as follows: |
Its syntax is as follows: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
.Pf . Cm \&cc Op Ar c |
.Pf . Cm \&cc Op Ar c |
Line 444 is not specified, the control character is reset to |
|
Line 531 is not specified, the control character is reset to |
|
Trailing characters are ignored. |
Trailing characters are ignored. |
.Ss \&ce |
.Ss \&ce |
Center some lines. |
Center some lines. |
This line-scoped request is intended to take one integer argument, |
It takes one integer argument, specifying how many lines to center. |
specifying how many lines to center. |
Currently ignored. |
Currently, it is ignored including its arguments, and the number |
.Ss \&cf |
of arguments is not checked. |
Output the contents of a file. |
|
Ignored because insecure. |
|
.Ss \&cflags |
|
Set character flags. |
|
This is a groff extension and currently ignored. |
|
.Ss \&ch |
|
Change a trap location. |
|
Currently ignored. |
|
.Ss \&char |
|
Define a new glyph. |
|
Currently unsupported. |
|
.Ss \&chop |
|
Remove the last character from a macro, string, or diversion. |
|
Currently unsupported. |
|
.Ss \&class |
|
Define a character class. |
|
This is a groff extension and currently ignored. |
|
.Ss \&close |
|
Close an open file. |
|
Ignored because insecure. |
|
.Ss \&CL |
|
Print text in color. |
|
This is a Heirloom extension and currently unsupported. |
|
.Ss \&color |
|
Activate or deactivate colors. |
|
This is a groff extension and currently ignored. |
|
.Ss \&composite |
|
Define a name component for composite glyph names. |
|
This is a groff extension and currently unsupported. |
|
.Ss \&continue |
|
Immediately start the next iteration of a |
|
.Sx \&while |
|
loop. |
|
Currently unsupported. |
|
.Ss \&cp |
|
Switch |
|
.Nm |
|
compatibility mode on or off. |
|
Currently ignored. |
|
.Ss \&cropat |
|
Set the CropBox page parameter for PDF generation. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&cs |
|
Constant character spacing mode. |
|
Currently ignored. |
|
.Ss \&cu |
|
Underline including whitespace. |
|
Currently ignored. |
|
.Ss \&da |
|
Append to a diversion. |
|
Currently unsupported. |
|
.Ss \&dch |
|
Change a trap location in the current diversion. |
|
This is a Heirloom extension and currently unsupported. |
.Ss \&de |
.Ss \&de |
Define a |
Define a |
.Nm |
.Nm |
Line 543 one explicit newline character. |
|
Line 683 one explicit newline character. |
|
In order to prevent endless recursion, both groff and |
In order to prevent endless recursion, both groff and |
.Xr mandoc 1 |
.Xr mandoc 1 |
limit the stack depth for expanding macros and strings |
limit the stack depth for expanding macros and strings |
to a large, but finite number. |
to a large, but finite number, and |
Do not rely on the exact value of this limit. |
.Xr mandoc 1 |
|
also limits the length of the expanded input line. |
|
Do not rely on the exact values of these limits. |
|
.Ss \&de1 |
|
Define a |
|
.Nm |
|
macro that will be executed with |
|
.Nm |
|
compatibility mode switched off during macro execution. |
|
This is a groff extension. |
|
Since |
|
.Xr mandoc 1 |
|
does not implement |
|
.Nm |
|
compatibility mode at all, it handles this request as an alias for |
|
.Sx \&de . |
|
.Ss \&defcolor |
|
Define a color name. |
|
This is a groff extension and currently ignored. |
.Ss \&dei |
.Ss \&dei |
Define a |
Define a |
.Nm |
.Nm |
macro, specifying the macro name indirectly. |
macro, specifying the macro name indirectly (groff extension). |
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 . |
The request |
The request |
|
|
has the same effect as: |
has the same effect as: |
.Pp |
.Pp |
.D1 Pf . Cm \&de No \e* Ns Bo Ar name Bc Op \e* Ns Bq Ar end |
.D1 Pf . Cm \&de No \e* Ns Bo Ar name Bc Op \e* Ns Bq Ar end |
.Ss \&de1 |
.Ss \&dei1 |
Define a |
Define a |
.Nm |
.Nm |
macro that will be executed with |
macro that will be executed with |
.Nm |
.Nm |
compatibility mode switched off during macro execution. |
compatibility mode switched off during macro execution, |
This is a GNU extension not available in traditional |
specifying the macro name indirectly (groff extension). |
.Nm |
|
implementations and not even in older versions of groff. |
|
Since |
Since |
.Xr mandoc 1 |
.Xr mandoc 1 |
does not implement |
does not implement |
.Nm |
.Nm |
compatibility mode at all, it handles this request as an alias for |
compatibility mode at all, it handles this request as an alias for |
.Sx \&de . |
.Sx \&dei . |
|
.Ss \&device |
|
This request only makes sense with the groff-specific intermediate |
|
output format and is unsupported. |
|
.Ss \&devicem |
|
This request only makes sense with the groff-specific intermediate |
|
output format and is unsupported. |
|
.Ss \&di |
|
Begin a diversion. |
|
Currently unsupported. |
|
.Ss \&do |
|
Execute |
|
.Nm |
|
request or macro line with compatibility mode disabled. |
|
Currently unsupported. |
.Ss \&ds |
.Ss \&ds |
Define a user-defined string. |
Define a user-defined string. |
Its syntax is as follows: |
Its syntax is as follows: |
Line 631 macro when used in a |
|
Line 801 macro when used in a |
|
.Xr man 7 |
.Xr man 7 |
document. |
document. |
Such abuse is of course strongly discouraged. |
Such abuse is of course strongly discouraged. |
|
.Ss \&ds1 |
|
Define a user-defined string that will be expanded with |
|
.Nm |
|
compatibility mode switched off during string expansion. |
|
This is a groff extension. |
|
Since |
|
.Xr mandoc 1 |
|
does not implement |
|
.Nm |
|
compatibility mode at all, it handles this request as an alias for |
|
.Sx \&ds . |
|
.Ss \&dwh |
|
Set a location trap in the current diversion. |
|
This is a Heirloom extension and currently unsupported. |
|
.Ss \&dt |
|
Set a trap within a diversion. |
|
Currently unsupported. |
|
.Ss \&ec |
|
Change the escape character. |
|
Currently unsupported. |
|
.Ss \&ecs |
|
Restore the escape character. |
|
Currently unsupported. |
|
.Ss \&ecr |
|
Save the escape character. |
|
Currently unsupported. |
.Ss \&el |
.Ss \&el |
The |
The |
.Qq else |
.Qq else |
Line 645 then false is assumed. |
|
Line 841 then false is assumed. |
|
The syntax of this request is similar to |
The syntax of this request is similar to |
.Sx \&if |
.Sx \&if |
except that the conditional is missing. |
except that the conditional is missing. |
|
.Ss \&em |
|
Set a trap at the end of input. |
|
Currently unsupported. |
.Ss \&EN |
.Ss \&EN |
End an equation block. |
End an equation block. |
See |
See |
.Sx \&EQ . |
.Sx \&EQ . |
|
.Ss \&eo |
|
Disable the escape mechanism completely. |
|
Currently unsupported. |
|
.Ss \&EP |
|
End a picture started by |
|
.Sx \&BP . |
|
This is a Heirloom extension and currently unsupported. |
.Ss \&EQ |
.Ss \&EQ |
Begin an equation block. |
Begin an equation block. |
See |
See |
.Xr eqn 7 |
.Xr eqn 7 |
for a description of the equation language. |
for a description of the equation language. |
|
.Ss \&errprint |
|
Print a string like an error message. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&ev |
|
Switch to another environment. |
|
Currently unsupported. |
|
.Ss \&evc |
|
Copy an environment into the current environment. |
|
Currently unsupported. |
|
.Ss \&ex |
|
Abort processing and exit. |
|
Currently unsupported. |
|
.Ss \&fallback |
|
Select the fallback sequence for a font. |
|
This is a Heirloom extension and currently ignored. |
.Ss \&fam |
.Ss \&fam |
Change the font family. |
Change the font family. |
This line-scoped request is intended to have one argument specifying |
Takes one argument specifying the font family to be selected. |
the font family to be selected. |
It is a groff extension and currently ignored. |
It is a groff extension, and currently, it is ignored including its |
.Ss \&fc |
arguments, and the number of arguments is not checked. |
Define a delimiting and a padding character for fields. |
|
Currently unsupported. |
|
.Ss \&fchar |
|
Define a fallback glyph. |
|
Currently unsupported. |
|
.Ss \&fcolor |
|
Set the fill color for \eD objects. |
|
This is a groff extension and currently ignored. |
|
.Ss \&fdeferlig |
|
Defer ligature building. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&feature |
|
Enable or disable an OpenType feature. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&fi |
|
Switch to fill mode. |
|
See |
|
.Xr man 7 . |
|
Ignored in |
|
.Xr mdoc 7 . |
|
.Ss \&fkern |
|
Control the use of kerning tables for a font. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&fl |
|
Flush output. |
|
Currently ignored. |
|
.Ss \&flig |
|
Define ligatures. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&fp |
|
Assign font position. |
|
Currently ignored. |
|
.Ss \&fps |
|
Mount a font with a special character map. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&fschar |
|
Define a font-specific fallback glyph. |
|
This is a groff extension and currently unsupported. |
|
.Ss \&fspacewidth |
|
Set a font-specific width for the space character. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&fspecial |
|
Conditionally define a special font. |
|
This is a groff extension and currently ignored. |
.Ss \&ft |
.Ss \&ft |
Change the font. |
Change the font. |
Its syntax is as follows: |
Its syntax is as follows: |
Line 688 This request takes effect only locally, may be overrid |
|
Line 952 This request takes effect only locally, may be overrid |
|
and escape sequences, and is only supported in |
and escape sequences, and is only supported in |
.Xr man 7 |
.Xr man 7 |
for now. |
for now. |
|
.Ss \&ftr |
|
Translate font name. |
|
This is a groff extension and currently ignored. |
|
.Ss \&fzoom |
|
Zoom font size. |
|
Currently ignored. |
|
.Ss \&gcolor |
|
Set glyph color. |
|
This is a groff extension and currently ignored. |
|
.Ss \&hc |
|
Set the hyphenation character. |
|
Currently ignored. |
|
.Ss \&hcode |
|
Set hyphenation codes of characters. |
|
Currently ignored. |
|
.Ss \&hidechar |
|
Hide characters in a font. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&hla |
|
Set hyphenation language. |
|
This is a groff extension and currently ignored. |
|
.Ss \&hlm |
|
Set maximum number of consecutive hyphenated lines. |
|
Currently ignored. |
|
.Ss \&hpf |
|
Load hyphenation pattern file. |
|
This is a groff extension and currently ignored. |
|
.Ss \&hpfa |
|
Load hyphenation pattern file, appending to the current patterns. |
|
This is a groff extension and currently ignored. |
|
.Ss \&hpfcode |
|
Define mapping values for character codes in hyphenation patterns. |
|
This is a groff extension and currently ignored. |
.Ss \&hw |
.Ss \&hw |
Specify hyphenation points in words. |
Specify hyphenation points in words. |
This line-scoped request is currently ignored. |
Currently ignored. |
.Ss \&hy |
.Ss \&hy |
Set automatic hyphenation mode. |
Set automatic hyphenation mode. |
This line-scoped request is currently ignored. |
Currently ignored. |
|
.Ss \&hylang |
|
Set hyphenation language. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&hylen |
|
Minimum word length for hyphenation. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&hym |
|
Set hyphenation margin. |
|
This is a groff extension and currently ignored. |
|
.Ss \&hypp |
|
Define hyphenation penalties. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&hys |
|
Set hyphenation space. |
|
This is a groff extension and currently ignored. |
.Ss \&ie |
.Ss \&ie |
The |
The |
.Qq if |
.Qq if |
Line 747 If the first character of COND is |
|
Line 1059 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 parenthesis or with an optionally signed |
If COND starts with a parenthesis or with an optionally signed |
integer number, it is evaluated according to the rules of |
integer number, it is evaluated according to the rules of |
.Sx Numerical expressions |
.Sx Numerical expressions |
explained below. |
explained below. |
It evaluates to true if the the result is positive, |
It evaluates to true if the result is positive, |
or to false if the result is zero or negative. |
or to false if the result is zero or negative. |
.It |
.It |
Otherwise, the first character of COND is regarded as a delimiter |
Otherwise, the first character of COND is regarded as a delimiter |
Line 869 Otherwise, it only terminates the |
|
Line 1183 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 \&in |
|
Change indentation. |
|
See |
|
.Xr man 7 . |
|
Ignored in |
|
.Xr mdoc 7 . |
|
.Ss \&index |
|
Find a substring in a string. |
|
This is a Heirloom extension and currently unsupported. |
|
.Ss \&it |
|
Set an input line trap. |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf . Cm it Ar number macro |
|
.Pp |
|
The named |
|
.Ar macro |
|
will be invoked after processing the specified |
|
.Ar number |
|
of input text lines. |
|
.Ss \&itc |
|
Set an input line trap, not counting lines ending with \ec. |
|
Currently unsupported. |
|
.Ss \&IX |
|
To support the generation of a table of contents, |
|
.Xr pod2man 1 |
|
emits this user-defined macro, usually without defining it. |
|
To avoid reporting large numbers of spurious errors, |
|
.Xr mandoc 1 |
|
ignores it. |
|
.Ss \&kern |
|
Switch kerning on or off. |
|
Currently ignored. |
|
.Ss \&kernafter |
|
Increase kerning after some characters. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&kernbefore |
|
Increase kerning before some characters. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&kernpair |
|
Add a kerning pair to the kerning table. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&lc |
|
Define a leader repetition character. |
|
Currently unsupported. |
|
.Ss \&lc_ctype |
|
Set the |
|
.Dv LC_CTYPE |
|
locale. |
|
This is a Heirloom extension and currently unsupported. |
|
.Ss \&lds |
|
Define a local string. |
|
This is a Heirloom extension and currently unsupported. |
|
.Ss \&length |
|
Count the number of input characters in a user-defined string. |
|
Currently unsupported. |
|
.Ss \&letadj |
|
Dynamic letter spacing and reshaping. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&lf |
|
Change the line number for error messages. |
|
Ignored because insecure. |
|
.Ss \&lg |
|
Switch the ligature mechanism on or off. |
|
Currently ignored. |
|
.Ss \&lhang |
|
Hang characters at left margin. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&linetabs |
|
Enable or disable line-tabs mode. |
|
This is a groff extension and currently unsupported. |
.Ss \&ll |
.Ss \&ll |
Change the output line length. |
Change the output line length. |
Its syntax is as follows: |
Its syntax is as follows: |
Line 886 among others because it overrides the |
|
Line 1271 among others because it overrides the |
|
.Xr mandoc 1 |
.Xr mandoc 1 |
.Fl O Cm width |
.Fl O Cm width |
command line option. |
command line option. |
|
.Ss \&lnr |
|
Set local number register. |
|
This is a Heirloom extension and currently unsupported. |
|
.Ss \&lnrf |
|
Set local floating-point register. |
|
This is a Heirloom extension and currently unsupported. |
|
.Ss \&lpfx |
|
Set a line prefix. |
|
This is a Heirloom extension and currently unsupported. |
|
.Ss \&ls |
|
Set line spacing. |
|
It takes one integer argument specifying the vertical distance of |
|
subsequent output text lines measured in v units. |
|
Currently ignored. |
|
.Ss \&lsm |
|
Set a leading spaces trap. |
|
This is a groff extension and currently unsupported. |
|
.Ss \< |
|
Set title line length. |
|
Currently ignored. |
|
.Ss \&mc |
|
Print margin character in the right margin. |
|
Currently ignored. |
|
.Ss \&mediasize |
|
Set the device media size. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&minss |
|
Set minimum word space. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&mk |
|
Mark vertical position. |
|
Currently ignored. |
|
.Ss \&mso |
|
Load a macro file. |
|
Ignored because insecure. |
|
.Ss \&na |
|
Disable adjusting without changing the adjustment mode. |
|
Currently ignored. |
.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. |
This line-scoped request is currently ignored. |
Currently ignored. |
|
.Ss \&nf |
|
Switch to no-fill mode. |
|
See |
|
.Xr man 7 . |
|
Ignored by |
|
.Xr mdoc 7 . |
.Ss \&nh |
.Ss \&nh |
Turn off automatic hyphenation mode. |
Turn off automatic hyphenation mode. |
This line-scoped request is currently ignored. |
Currently ignored. |
|
.Ss \&nhychar |
|
Define hyphenation-inhibiting characters. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&nm |
|
Print line numbers. |
|
Currently unsupported. |
|
.Ss \&nn |
|
Temporarily turn off line numbering. |
|
Currently unsupported. |
|
.Ss \&nop |
|
Exexute the rest of the input line as a request or macro line. |
|
Currently unsupported. |
.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, |
Line 930 section with the |
|
Line 1371 section with the |
|
.Cm \&Sh |
.Cm \&Sh |
macro will reset this register. |
macro will reset this register. |
.El |
.El |
|
.Ss \&nrf |
|
Define or change a floating-point register. |
|
This is a Heirloom extension and currently unsupported. |
|
.Ss \&nroff |
|
Force nroff mode. |
|
This is a groff extension and currently ignored. |
.Ss \&ns |
.Ss \&ns |
Turn on no-space mode. |
Turn on no-space mode. |
This line-scoped request is intended to take no arguments. |
Currently ignored. |
Currently, it is ignored including its arguments, |
.Ss \&nx |
and the number of arguments is not checked. |
Abort processing of the current input file and process another one. |
|
Ignored because insecure. |
|
.Ss \&open |
|
Open a file for writing. |
|
Ignored because insecure. |
|
.Ss \&opena |
|
Open a file for appending. |
|
Ignored because insecure. |
|
.Ss \&os |
|
Output saved vertical space. |
|
Currently ignored. |
|
.Ss \&output |
|
Output directly to intermediate output. |
|
Not supported. |
|
.Ss \&padj |
|
Globally control paragraph-at-once adjustment. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&papersize |
|
Set the paper size. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&pc |
|
Change the page number character. |
|
Currently ignored. |
|
.Ss \&pev |
|
Print environments. |
|
This is a groff extension and currently ignored. |
|
.Ss \&pi |
|
Pipe output to a shell command. |
|
Ignored because insecure. |
|
.Ss \&PI |
|
Low-level request used by |
|
.Sx \&BP . |
|
This is a Heirloom extension and currently unsupported. |
|
.Ss \&pl |
|
Change page length. |
|
Takes one height argument. |
|
Currently ignored. |
|
.Ss \&pm |
|
Print names and sizes of macros, strings, and diversions. |
|
Currently ignored. |
|
.Ss \&pn |
|
Change page number of the next page. |
|
Currently ignored. |
|
.Ss \&pnr |
|
Print all number registers. |
|
Currently ignored. |
|
.Ss \&po |
|
Set horizontal page offset. |
|
Currently ignored. |
.Ss \&ps |
.Ss \&ps |
Change point size. |
Change point size. |
This line-scoped request is intended to take one numerical argument. |
Takes one numerical argument. |
Currently, it is ignored including its arguments, |
Currently ignored. |
and the number of arguments is not checked. |
.Ss \&psbb |
|
Retrieve the bounding box of a PostScript file. |
|
Currently unsupported. |
|
.Ss \&pshape |
|
Set a special shape for the current paragraph. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&pso |
|
Include output of a shell command. |
|
Ignored because insecure. |
|
.Ss \&ptr |
|
Print the names and positions of all traps. |
|
This is a groff extension and currently ignored. |
|
.Ss \&pvs |
|
Change post-vertical spacing. |
|
This is a groff extension and currently ignored. |
|
.Ss \&rchar |
|
Remove glyph definitions. |
|
Currently unsupported. |
|
.Ss \&rd |
|
Read from standard input. |
|
Currently ignored. |
|
.Ss \&recursionlimit |
|
Set the maximum stack depth for recursive macros. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&return |
|
Exit a macro and return to the caller. |
|
Currently unsupported. |
|
.Ss \&rfschar |
|
Remove font-specific fallback glyph definitions. |
|
Currently unsupported. |
|
.Ss \&rhang |
|
Hang characters at right margin. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&rj |
|
Justify unfilled text to the right margin. |
|
Currently ignored. |
.Ss \&rm |
.Ss \&rm |
Remove a request, macro or string. |
Remove a request, macro or string. |
Its syntax is as follows: |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 Pf \. Cm \&rm Ar name |
.D1 Pf \. Cm \&rm Ar name |
|
.Ss \&rn |
|
Rename a request, macro, diversion, or string. |
|
Currently unsupported. |
|
.Ss \&rnn |
|
Rename a number register. |
|
Currently unsupported. |
.Ss \&rr |
.Ss \&rr |
Remove a register. |
Remove a register. |
Its syntax is as follows: |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 Pf \. Cm \&rr Ar name |
.D1 Pf \. Cm \&rr Ar name |
|
.Ss \&rs |
|
End no-space mode. |
|
Currently ignored. |
|
.Ss \&rt |
|
Return to marked vertical position. |
|
Currently ignored. |
|
.Ss \&schar |
|
Define global fallback glyph. |
|
This is a groff extension and currently unsupported. |
|
.Ss \&sentchar |
|
Define sentence-ending characters. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&shc |
|
Change the soft hyphen character. |
|
Currently ignored. |
|
.Ss \&shift |
|
Shift macro arguments. |
|
Currently unsupported. |
|
.Ss \&sizes |
|
Define permissible point sizes. |
|
This is a groff extension and currently ignored. |
.Ss \&so |
.Ss \&so |
Include a source file. |
Include a source file. |
Its syntax is as follows: |
Its syntax is as follows: |
|
Line 1540 is discouraged. |
|
Use |
Use |
.Xr ln 1 |
.Xr ln 1 |
instead. |
instead. |
|
.Ss \&spacewidth |
|
Set the space width from the font metrics file. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&special |
|
Define a special font. |
|
This is a groff extension and currently ignored. |
|
.Ss \&spreadwarn |
|
Warn about wide spacing between words. |
|
Currently ignored. |
|
.Ss \&ss |
|
Set space character size. |
|
Currently ignored. |
|
.Ss \&sty |
|
Associate style with a font position. |
|
This is a groff extension and currently ignored. |
|
.Ss \&substring |
|
Replace a user-defined string with a substring. |
|
Currently unsupported. |
|
.Ss \&sv |
|
Save vertical space. |
|
Currently ignored. |
|
.Ss \&sy |
|
Execute shell command. |
|
Ignored because insecure. |
|
.Ss \&T& |
|
Re-start a table layout, retaining the options of the prior table |
|
invocation. |
|
See |
|
.Sx \&TS . |
.Ss \&ta |
.Ss \&ta |
Set tab stops. |
Set tab stops. |
This line-scoped request can take an arbitrary number of arguments. |
Takes an arbitrary number of arguments. |
Currently, it is ignored including its arguments. |
Currently ignored. |
|
.Ss \&tc |
|
Change tab repetion character. |
|
Currently unsupported. |
|
.Ss \&TE |
|
End a table context. |
|
See |
|
.Sx \&TS . |
|
.Ss \&ti |
|
Temporary indent. |
|
Currently ignored. |
|
.Ss \&tkf |
|
Enable track kerning for a font. |
|
Currently ignored. |
|
.Ss \&tl |
|
Print a title line. |
|
Currently unsupported. |
|
.Ss \&tm |
|
Print to standard error output. |
|
Currently ignored. |
|
.Ss \&tm1 |
|
Print to standard error output, allowing leading blanks. |
|
This is a groff extension and currently ignored. |
|
.Ss \&tmc |
|
Print to standard error output without a trailing newline. |
|
This is a groff extension and currently ignored. |
.Ss \&tr |
.Ss \&tr |
Output character translation. |
Output character translation. |
Its syntax is as follows: |
Its syntax is as follows: |
Line 1004 Replacement (or origin) characters may also be charact |
|
Line 1615 Replacement (or origin) characters may also be charact |
|
.Dl tr \e(xx\e(yy |
.Dl tr \e(xx\e(yy |
.Pp |
.Pp |
replaces all invocations of \e(xx with \e(yy. |
replaces all invocations of \e(xx with \e(yy. |
.Ss \&T& |
.Ss \&track |
Re-start a table layout, retaining the options of the prior table |
Static letter space tracking. |
invocation. |
This is a Heirloom extension and currently ignored. |
See |
.Ss \&transchar |
.Sx \&TS . |
Define transparent characters for sentence-ending. |
.Ss \&TE |
This is a Heirloom extension and currently ignored. |
End a table context. |
.Ss \&trf |
See |
Output the contents of a file, disallowing invalid characters. |
.Sx \&TS . |
This is a groff extension and ignored because insecure. |
|
.Ss \&trimat |
|
Set the TrimBox page parameter for PDF generation. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&trin |
|
Output character translation, ignored by |
|
.Cm \&asciify . |
|
Currently unsupported. |
|
.Ss \&trnt |
|
Output character translation, ignored by \e!. |
|
Currently unsupported. |
|
.Ss \&troff |
|
Force troff mode. |
|
This is a groff extension and currently ignored. |
.Ss \&TS |
.Ss \&TS |
Begin a table, which formats input in aligned rows and columns. |
Begin a table, which formats input in aligned rows and columns. |
See |
See |
.Xr tbl 7 |
.Xr tbl 7 |
for a description of the tbl language. |
for a description of the tbl language. |
|
.Ss \&uf |
|
Globally set the underline font. |
|
Currently ignored. |
|
.Ss \&ul |
|
Underline. |
|
Currently ignored. |
|
.Ss \&unformat |
|
Unformat spaces and tabs in a diversion. |
|
Currently unsupported. |
|
.Ss \&unwatch |
|
Disable notification for string or macro. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&unwatchn |
|
Disable notification for register. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&vpt |
|
Enable or disable vertical position traps. |
|
This is a groff extension and currently ignored. |
|
.Ss \&vs |
|
Change vertical spacing. |
|
Currently ignored. |
|
.Ss \&warn |
|
Set warning level. |
|
Currently ignored. |
|
.Ss \&warnscale |
|
Set the scaling indicator used in warnings. |
|
This is a groff extension and currently ignored. |
|
.Ss \&watch |
|
Notify on change of string or macro. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&watchlength |
|
On change, report the contents of macros and strings |
|
up to the sepcified length. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&watchn |
|
Notify on change of register. |
|
This is a Heirloom extension and currently ignored. |
|
.Ss \&wh |
|
Set a page location trap. |
|
Currently unsupported. |
|
.Ss \&while |
|
Repeated execution while a condition is true. |
|
Currently unsupported. |
|
.Ss \&write |
|
Write to an open file. |
|
Ignored because insecure. |
|
.Ss \&writec |
|
Write to an open file without appending a newline. |
|
Ignored because insecure. |
|
.Ss \&writem |
|
Write macro or string to an open file. |
|
Ignored because insecure. |
|
.Ss \&xflag |
|
Set the extension level. |
|
This is a Heirloom extension and currently ignored. |
.Ss Numerical expressions |
.Ss Numerical expressions |
The |
The |
.Sx \&nr , |
.Sx \&nr , |
Line 1036 prefixed by an optional sign |
|
Line 1715 prefixed by an optional sign |
|
.Sq + |
.Sq + |
or |
or |
.Sq - . |
.Sq - . |
|
Each number may be followed by one optional scaling unit described below |
|
.Sx Scaling Widths . |
|
The following equations hold: |
|
.Bd -literal -offset indent |
|
1i = 6v = 6P = 10m = 10n = 72p = 1000M = 240u = 240 |
|
254c = 100i = 24000u = 24000 |
|
1f = 65536u = 65536 |
|
.Ed |
.Pp |
.Pp |
The following binary operators are implemented. |
The following binary operators are implemented. |
Unless otherwise stated, they behave as in the C language: |
Unless otherwise stated, they behave as in the C language: |
Line 1189 Bracket building function; ignored by |
|
Line 1876 Bracket building function; ignored by |
|
.Sx Special Characters |
.Sx Special Characters |
with names of arbitrary length. |
with names of arbitrary length. |
.Ss \ec |
.Ss \ec |
Interrupt text processing to insert requests or macros; ignored by |
When encountered at the end of an input text line, |
.Xr mandoc 1 . |
the next input text line is considered to continue that line, |
|
even if there are request or macro lines in between. |
|
No whitespace is inserted. |
.Ss \eD\(aq Ns Ar string Ns \(aq |
.Ss \eD\(aq Ns Ar string Ns \(aq |
Draw graphics function; ignored by |
Draw graphics function; ignored by |
.Xr mandoc 1 . |
.Xr mandoc 1 . |
Line 1267 For short names, there are variants |
|
Line 1956 For short names, there are variants |
|
and |
and |
.No \en( Ns Ar cc . |
.No \en( Ns Ar cc . |
.Ss \eo\(aq Ns Ar string Ns \(aq |
.Ss \eo\(aq Ns Ar string Ns \(aq |
Overstrike |
Overstrike, writing all the characters contained in the |
.Ar string ; |
.Ar string |
ignored by |
to the same output position. |
.Xr mandoc 1 . |
In terminal and HTML output modes, |
|
only the last one of the characters is visible. |
.Ss \eR\(aq Ns Ar name Oo +|- Oc Ns Ar number Ns \(aq |
.Ss \eR\(aq Ns Ar name Oo +|- Oc Ns Ar number Ns \(aq |
Set number register; ignored by |
Set number register; ignored by |
.Xr mandoc 1 . |
.Xr mandoc 1 . |
|
|
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 , |