version 1.50, 2011/11/14 15:10:27 |
version 1.57, 2014/12/15 19:42:21 |
Line 98 in literal context, and when none of the following spe |
|
Line 98 in literal context, and when none of the following spe |
|
just use the normal space character |
just use the normal space character |
.Pq Sq \ . |
.Pq Sq \ . |
.Pp |
.Pp |
When filling text, lines may be broken between words, i.e. at space |
When filling text, output lines may be broken between words, i.e. at space |
characters. |
characters. |
To prevent a line break between two particular words, |
To prevent a line break between two particular words, |
use the non-breaking space escape sequence |
use the unpaddable non-breaking space escape sequence |
.Pq Sq \e~ |
.Pq Sq \e\ \& |
instead of the normal space character. |
instead of the normal space character. |
For example, the input string |
For example, the input string |
.Dq number\e~1 |
.Dq number\e\ 1 |
will be kept together as |
will be kept together as |
.Dq number\~1 |
.Dq number\ 1 |
on the same output line. |
on the same output line. |
.Pp |
.Pp |
On request and macro lines, the normal space character serves as an |
On request and macro lines, the normal space character serves as an |
argument delimiter. |
argument delimiter. |
To include whitespace into arguments, quoting is usually the best choice. |
To include whitespace into arguments, quoting is usually the best choice; |
In some cases, using either the non-breaking |
see the MACRO SYNTAX section in |
.Pq Sq \e~ |
.Xr roff 7 . |
or the breaking |
In some cases, using the non-breaking space escape sequence |
.Pq Sq \e\ \& |
.Pq Sq \e\ \& |
space escape sequence may be preferable. |
may be preferable. |
|
.Pp |
To escape macro names and to protect whitespace at the end |
To escape macro names and to protect whitespace at the end |
of input lines, the zero-width space |
of input lines, the zero-width space |
.Pq Sq \e& |
.Pq Sq \e& |
|
|
Spacing: |
Spacing: |
.Bl -column "Input" "Description" -offset indent -compact |
.Bl -column "Input" "Description" -offset indent -compact |
.It Em Input Ta Em Description |
.It Em Input Ta Em Description |
.It \e~ Ta non-breaking, non-collapsing space |
.It Sq \e\ \& Ta unpaddable non-breaking space |
.It \e Ta breaking, non-collapsing n-width space |
.It \e~ Ta paddable non-breaking space |
.It \e^ Ta zero-width space |
.It \e0 Ta unpaddable, breaking digit-width space |
.It \e% Ta zero-width space |
.It \e| Ta one-sixth \e(em narrow space, zero width in nroff mode |
|
.It \e^ Ta one-twelfth \e(em half-narrow space, zero width in nroff |
.It \e& Ta zero-width space |
.It \e& Ta zero-width space |
.It \e| Ta zero-width space |
.It \e% Ta zero-width space allowing hyphenation |
.It \e0 Ta breaking, non-collapsing digit-width space |
|
.It \ec Ta removes any trailing space (if applicable) |
|
.El |
.El |
.Pp |
.Pp |
Lines: |
Lines: |
|
|
.It \e(ba Ta \(ba Ta bar |
.It \e(ba Ta \(ba Ta bar |
.It \e(br Ta \(br Ta box rule |
.It \e(br Ta \(br Ta box rule |
.It \e(ul Ta \(ul Ta underscore |
.It \e(ul Ta \(ul Ta underscore |
.It \e(rl Ta \(rl Ta overline |
.It \e(rn Ta \(rn Ta overline |
.It \e(bb Ta \(bb Ta broken bar |
.It \e(bb Ta \(bb Ta broken bar |
.It \e(sl Ta \(sl Ta forward slash |
.It \e(sl Ta \(sl Ta forward slash |
.It \e(rs Ta \(rs Ta backward slash |
.It \e(rs Ta \(rs Ta backward slash |
|
|
.El |
.El |
.Pp |
.Pp |
Brackets: |
Brackets: |
.Bl -column "xxbracketrightbpx" Rendered Description -offset indent -compact |
.Bl -column "xxbracketrightbtx" Rendered Description -offset indent -compact |
.It Em Input Ta Em Rendered Ta Em Description |
.It Em Input Ta Em Rendered Ta Em Description |
.It \e(lB Ta \(lB Ta left bracket |
.It \e(lB Ta \(lB Ta left bracket |
.It \e(rB Ta \(rB Ta right bracket |
.It \e(rB Ta \(rB Ta right bracket |
|
|
.It \e(bv Ta \(bv Ta brace extension |
.It \e(bv Ta \(bv Ta brace extension |
.It \e[braceex] Ta \[braceex] Ta brace extension |
.It \e[braceex] Ta \[braceex] Ta brace extension |
.It \e[bracketlefttp] Ta \[bracketlefttp] Ta top-left hooked bracket |
.It \e[bracketlefttp] Ta \[bracketlefttp] Ta top-left hooked bracket |
.It \e[bracketleftbp] Ta \[bracketleftbp] Ta bottom-left hooked bracket |
.It \e[bracketleftbt] Ta \[bracketleftbt] Ta bottom-left hooked bracket |
.It \e[bracketleftex] Ta \[bracketleftex] Ta left hooked bracket extension |
.It \e[bracketleftex] Ta \[bracketleftex] Ta left hooked bracket extension |
.It \e[bracketrighttp] Ta \[bracketrighttp] Ta top-right hooked bracket |
.It \e[bracketrighttp] Ta \[bracketrighttp] Ta top-right hooked bracket |
.It \e[bracketrightbp] Ta \[bracketrightbp] Ta bottom-right hooked bracket |
.It \e[bracketrightbt] Ta \[bracketrightbt] Ta bottom-right hooked bracket |
.It \e[bracketrightex] Ta \[bracketrightex] Ta right hooked bracket extension |
.It \e[bracketrightex] Ta \[bracketrightex] Ta right hooked bracket extension |
.It \e(lt Ta \(lt Ta top-left hooked brace |
.It \e(lt Ta \(lt Ta top-left hooked brace |
.It \e[bracelefttp] Ta \[bracelefttp] Ta top-left hooked brace |
.It \e[bracelefttp] Ta \[bracelefttp] Ta top-left hooked brace |
.It \e(lk Ta \(lk Ta mid-left hooked brace |
.It \e(lk Ta \(lk Ta mid-left hooked brace |
.It \e[braceleftmid] Ta \[braceleftmid] Ta mid-left hooked brace |
.It \e[braceleftmid] Ta \[braceleftmid] Ta mid-left hooked brace |
.It \e(lb Ta \(lb Ta bottom-left hooked brace |
.It \e(lb Ta \(lb Ta bottom-left hooked brace |
.It \e[braceleftbp] Ta \[braceleftbp] Ta bottom-left hooked brace |
.It \e[braceleftbt] Ta \[braceleftbt] Ta bottom-left hooked brace |
.It \e[braceleftex] Ta \[braceleftex] Ta left hooked brace extension |
.It \e[braceleftex] Ta \[braceleftex] Ta left hooked brace extension |
.It \e(rt Ta \(rt Ta top-left hooked brace |
.It \e(rt Ta \(rt Ta top-left hooked brace |
.It \e[bracerighttp] Ta \[bracerighttp] Ta top-right hooked brace |
.It \e[bracerighttp] Ta \[bracerighttp] Ta top-right hooked brace |
.It \e(rk Ta \(rk Ta mid-right hooked brace |
.It \e(rk Ta \(rk Ta mid-right hooked brace |
.It \e[bracerightmid] Ta \[bracerightmid] Ta mid-right hooked brace |
.It \e[bracerightmid] Ta \[bracerightmid] Ta mid-right hooked brace |
.It \e(rb Ta \(rb Ta bottom-right hooked brace |
.It \e(rb Ta \(rb Ta bottom-right hooked brace |
.It \e[bracerightbp] Ta \[bracerightbp] Ta bottom-right hooked brace |
.It \e[bracerightbt] Ta \[bracerightbt] Ta bottom-right hooked brace |
.It \e[bracerightex] Ta \[bracerightex] Ta right hooked brace extension |
.It \e[bracerightex] Ta \[bracerightex] Ta right hooked brace extension |
.It \e[parenlefttp] Ta \[parenlefttp] Ta top-left hooked parenthesis |
.It \e[parenlefttp] Ta \[parenlefttp] Ta top-left hooked parenthesis |
.It \e[parenleftbp] Ta \[parenleftbp] Ta bottom-left hooked parenthesis |
.It \e[parenleftbt] Ta \[parenleftbt] Ta bottom-left hooked parenthesis |
.It \e[parenleftex] Ta \[parenleftex] Ta left hooked parenthesis extension |
.It \e[parenleftex] Ta \[parenleftex] Ta left hooked parenthesis extension |
.It \e[parenrighttp] Ta \[parenrighttp] Ta top-right hooked parenthesis |
.It \e[parenrighttp] Ta \[parenrighttp] Ta top-right hooked parenthesis |
.It \e[parenrightbp] Ta \[parenrightbp] Ta bottom-right hooked parenthesis |
.It \e[parenrightbt] Ta \[parenrightbt] Ta bottom-right hooked parenthesis |
.It \e[parenrightex] Ta \[parenrightex] Ta right hooked parenthesis extension |
.It \e[parenrightex] Ta \[parenrightex] Ta right hooked parenthesis extension |
.El |
.El |
.Pp |
.Pp |
|
|
.It \e*(Ai Ta \*(Ai Ta ANSI standard name |
.It \e*(Ai Ta \*(Ai Ta ANSI standard name |
.El |
.El |
.Sh UNICODE CHARACTERS |
.Sh UNICODE CHARACTERS |
The escape sequence |
The escape sequences |
.Pp |
.Pp |
.Dl \e[uXXXX] |
.Dl \e[uXXXX] and \eC'uXXXX' |
.Pp |
.Pp |
is interpreted as a Unicode codepoint. |
are interpreted as Unicode codepoints. |
The codepoint must be in the range above U+0080 and less than U+10FFFF. |
The codepoint must be in the range above U+0080 and less than U+10FFFF. |
For compatibility, points must be zero-padded to four characters; if |
For compatibility, the hexadecimal digits |
|
.Sq A |
|
to |
|
.Sq F |
|
must be given as uppercase characters, |
|
and points must be zero-padded to four characters; if |
greater than four characters, no zero padding is allowed. |
greater than four characters, no zero padding is allowed. |
Unicode surrogates are not allowed. |
Unicode surrogates are not allowed. |
.\" .Pp |
.\" .Pp |
Line 684 For example, do not use \eN'34', use \e(dq, or even th |
|
Line 689 For example, do not use \eN'34', use \e(dq, or even th |
|
.Sq \(dq |
.Sq \(dq |
character where possible. |
character where possible. |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
This section documents compatibility between mandoc and other other |
This section documents compatibility between mandoc and other |
troff implementations, at this time limited to GNU troff |
troff implementations, at this time limited to GNU troff |
.Pq Qq groff . |
.Pq Qq groff . |
.Pp |
.Pp |
Line 728 known representation. |
|
Line 733 known representation. |
|
The |
The |
.Nm |
.Nm |
manual page was written by |
manual page was written by |
.An Kristaps Dzonsons , |
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . |
.Mt kristaps@bsd.lv . |
|
.Sh CAVEATS |
.Sh CAVEATS |
The |
The predefined string |
.Sq \e*(Ba |
.Sq \e*(Ba |
escape mimics the behaviour of the |
mimics the behaviour of the |
.Sq \&| |
.Sq \&| |
character in |
character in |
.Xr mdoc 7 ; |
.Xr mdoc 7 ; |