version 1.94, 2017/07/05 12:25:17 |
version 1.102, 2018/08/21 18:15:22 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2010,2011,2013-2015,2017 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2010-2018 Ingo Schwarze <schwarze@openbsd.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 above |
.\" purpose with or without fee is hereby granted, provided that the above |
Line 86 character, and, in certain circumstances, the tab char |
|
Line 86 character, and, in certain circumstances, the tab char |
|
The backslash character |
The backslash character |
.Sq \e |
.Sq \e |
indicates the start of an escape sequence, used for example for |
indicates the start of an escape sequence, used for example for |
.Sx Comments , |
.Sx Comments |
.Sx Special Characters , |
|
.Sx Predefined Strings , |
|
and |
and |
user-defined strings defined using the |
.Sx Special Characters . |
.Sx ds |
|
request. |
|
For a listing of escape sequences, consult the |
For a listing of escape sequences, consult the |
.Sx ESCAPE SEQUENCE REFERENCE |
.Sx ESCAPE SEQUENCE REFERENCE |
below. |
below. |
Line 169 Text decoration is |
|
Line 165 Text decoration is |
|
recommended for |
recommended for |
.Xr mdoc 7 , |
.Xr mdoc 7 , |
which encourages semantic annotation. |
which encourages semantic annotation. |
.Ss Predefined Strings |
|
Predefined strings, like |
|
.Sx Special Characters , |
|
mark special output glyphs. |
|
Predefined strings are escaped with the slash-asterisk, |
|
.Sq \e* : |
|
single-character |
|
.Sq \e*X , |
|
two-character |
|
.Sq \e*(XX , |
|
and N-character |
|
.Sq \e* Ns Bq N . |
|
.Pp |
|
Examples: |
|
.Bl -tag -width Ds -offset indent -compact |
|
.It Li \e*(Am |
|
Two-letter ampersand predefined string. |
|
.It Li \e*q |
|
One-letter double-quote predefined string. |
|
.El |
|
.Pp |
|
Predefined strings are not recommended for use, |
|
as they differ across implementations. |
|
Those supported by |
|
.Xr mandoc 1 |
|
are listed in |
|
.Xr mandoc_char 7 . |
|
Manuals using these predefined strings are almost certainly not portable. |
|
.Ss Whitespace |
.Ss Whitespace |
Whitespace consists of the space character. |
Whitespace consists of the space character. |
In text lines, whitespace is preserved within a line. |
In text lines, whitespace is preserved within a line. |
Line 206 Unescaped trailing spaces are stripped from text line |
|
Line 174 Unescaped trailing spaces are stripped from text line |
|
literal context. |
literal context. |
In general, trailing whitespace on any input line is discouraged for |
In general, trailing whitespace on any input line is discouraged for |
reasons of portability. |
reasons of portability. |
In the rare case that a blank character is needed at the end of an |
In the rare case that a space character is needed at the end of an |
input line, it may be forced by |
input line, it may be forced by |
.Sq \e\ \e& . |
.Sq \e\ \e& . |
.Pp |
.Pp |
|
|
.Pp |
.Pp |
in the input stream, and thus in the output: \fI\^XtFree\^\fP. |
in the input stream, and thus in the output: \fI\^XtFree\^\fP. |
Each occurrence of \e\e$* is replaced with all the arguments, |
Each occurrence of \e\e$* is replaced with all the arguments, |
joined together with single blank characters. |
joined together with single space characters. |
|
The variant \e\e$@ is similar, except that each argument is |
|
individually quoted. |
.Pp |
.Pp |
Since macros and user-defined strings share a common string table, |
Since macros and user-defined strings share a common string table, |
defining a macro |
defining a macro |
|
|
.Ar font |
.Ar font |
arguments are supported: |
arguments are supported: |
.Bl -tag -width 4n -offset indent |
.Bl -tag -width 4n -offset indent |
.It Cm B , BI , 3 , 4 |
.It Cm B , BI , CB , 3 , 4 |
switches to |
switches to |
.Sy bold |
.Sy bold |
font |
font |
.It Cm I , 2 |
.It Cm I , CI , 2 |
switches to |
switches to |
.Em underlined |
.Em underlined |
font |
font |
.It Cm R , CW , 1 |
.It Cm R , CR , CW , 1 |
switches to normal font |
switches to normal font |
.It Cm P No "or no argument" |
.It Cm P No "or no argument" |
switches back to the previous font |
switches back to the previous font |
|
|
or |
or |
.Sq o |
.Sq o |
.Pq odd page , |
.Pq odd page , |
it evaluates to true. |
it evaluates to true, and the |
|
.Ar body |
|
starts with the next character. |
.It |
.It |
If the first character of |
If the first character of |
.Ar condition |
.Ar condition |
is |
is |
.Sq c |
|
.Pq character available , |
|
.Sq e |
.Sq e |
.Pq even page , |
.Pq even page , |
.Sq t |
.Sq t |
|
|
or |
or |
.Sq v |
.Sq v |
.Pq vroff mode , |
.Pq vroff mode , |
it evaluates to false. |
it evaluates to false, and the |
|
.Ar body |
|
starts with the next character. |
.It |
.It |
If the first character of |
If the first character of |
.Ar condition |
.Ar condition |
is |
is |
|
.Sq c |
|
.Pq character available , |
|
it evaluates to true if the following character is an ASCII character |
|
or a valid character escape sequence, or to false otherwise. |
|
The |
|
.Ar body |
|
starts with the character following that next character. |
|
.It |
|
If the first character of |
|
.Ar condition |
|
is |
.Sq d , |
.Sq d , |
it evaluates to true if the rest of |
it evaluates to true if the rest of |
.Ar condition |
.Ar condition |
Line 1346 Currently unsupported. |
|
Line 1329 Currently unsupported. |
|
Temporarily turn off line numbering. |
Temporarily turn off line numbering. |
Currently unsupported. |
Currently unsupported. |
.It Ic \&nop Ar body |
.It Ic \&nop Ar body |
Execute the rest of the input line as a request or macro line. |
Execute the rest of the input line as a request, macro, or text line, |
Currently unsupported. |
skipping the |
.It Ic \&nr Ar register Oo Cm + Ns | Ns Cm - Oc Ns Ar expression |
.Ic \&nop |
|
request and any space characters immediately following it. |
|
This is mostly used to indent text lines inside macro definitions. |
|
.It Ic \&nr Ar register Oo Cm + Ns | Ns Cm - Oc Ns Ar expression Op Ar stepsize |
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. |
|
|
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 |
|
The |
|
.Ar stepsize |
|
is used by the |
|
.Ic \en+ |
|
auto-increment feature. |
|
It remains unchanged when omitted while changing an existing register, |
|
and it defaults to 0 when defining a new register. |
|
.Pp |
The following |
The following |
.Ar register |
.Ar register |
is handled specially: |
is handled specially: |
Line 1471 This is a groff extension and currently ignored. |
|
Line 1465 This is a groff extension and currently ignored. |
|
.It Ic \&rchar Ar glyph ... |
.It Ic \&rchar Ar glyph ... |
Remove glyph definitions. |
Remove glyph definitions. |
Currently unsupported. |
Currently unsupported. |
.It Ic \&rd Op Ar prompt Op Ar agument ... |
.It Ic \&rd Op Ar prompt Op Ar argument ... |
Read from standard input. |
Read from standard input. |
Currently ignored. |
Currently ignored. |
.It Ic \&recursionlimit Ar maxrec maxtail |
.It Ic \&recursionlimit Ar maxrec maxtail |
Line 1840 is an unpaddable space-sized non-breaking space charac |
|
Line 1834 is an unpaddable space-sized non-breaking space charac |
|
.Ss \e\(dq |
.Ss \e\(dq |
The rest of the input line is treated as |
The rest of the input line is treated as |
.Sx Comments . |
.Sx Comments . |
|
.Ss \e# |
|
Line continuation with comment. |
|
Discard the rest of the physical input line and continue the logical |
|
input line on the next physical input line, joining the text on |
|
both lines together as if it were on a single input line. |
|
This is a groff extension. |
|
.Ss \e$ Ns Ar arg |
|
Macro argument expansion, see |
|
.Sx de . |
.Ss \e% |
.Ss \e% |
Hyphenation allowed at this point of the word; ignored by |
Hyphenation allowed at this point of the word; ignored by |
.Xr mandoc 1 . |
.Xr mandoc 1 . |
Line 1856 with two-letter names, see |
|
Line 1859 with two-letter names, see |
|
.Xr mandoc_char 7 . |
.Xr mandoc_char 7 . |
.Ss \e* Ns Bq Ar name |
.Ss \e* Ns Bq Ar name |
Interpolate the string with the |
Interpolate the string with the |
.Ar name ; |
.Ar name . |
see |
|
.Sx Predefined Strings |
|
and |
|
.Sx ds . |
|
For short names, there are variants |
For short names, there are variants |
.No \e* Ns Ar c |
.No \e* Ns Ar c |
and |
and |
.No \e*( Ns Ar cc . |
.No \e*( Ns Ar cc . |
|
.Pp |
|
One string is predefined on the |
|
.Nm |
|
language level: \e*(.T expands to the name of the output device, |
|
for example ascii, utf8, ps, pdf, html, or markdown. |
|
.Pp |
|
Macro sets traditionally predefine additional strings which are not |
|
portable and differ across implementations. |
|
Those supported by |
|
.Xr mandoc 1 |
|
are listed in |
|
.Xr mandoc_char 7 . |
|
.Pp |
|
Strings can be defined, changed, and deleted with the |
|
.Ic \&ds , |
|
.Ic \&as , |
|
and |
|
.Ic \&rm |
|
requests. |
.Ss \e, |
.Ss \e, |
Left italic correction (groff extension); ignored by |
Left italic correction (groff extension); ignored by |
.Xr mandoc 1 . |
.Xr mandoc 1 . |
|
|
Character |
Character |
.Ar number |
.Ar number |
on the current font. |
on the current font. |
.Ss \en Ns Bq Ar name |
.Ss \en Ns Oo +|- Oc Ns Bq Ar name |
Interpolate the number register |
Interpolate the number register |
.Ar name . |
.Ar name . |
For short names, there are variants |
For short names, there are variants |
.No \en Ns Ar c |
.No \en Ns Ar c |
and |
and |
.No \en( Ns Ar cc . |
.No \en( Ns Ar cc . |
|
If the optional sign is specified, |
|
the register is first incremented or decremented by the |
|
.Ar stepsize |
|
that was specified in the relevant |
|
.Ic \&nr |
|
request, and the changed value is interpolated. |
.Ss \eo\(aq Ns Ar string Ns \(aq |
.Ss \eo\(aq Ns Ar string Ns \(aq |
Overstrike, writing all the characters contained in the |
Overstrike, writing all the characters contained in the |
.Ar string |
.Ar string |