version 1.98, 2018/08/10 20:40:45 |
version 1.100, 2018/08/18 21:37:01 |
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 1851 is an unpaddable space-sized non-breaking space charac |
|
Line 1819 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% |
.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 1867 with two-letter names, see |
|
Line 1841 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 . |