diff options
Diffstat (limited to 'usr/src/man/man5/mandoc_char.5')
| -rw-r--r-- | usr/src/man/man5/mandoc_char.5 | 113 |
1 files changed, 58 insertions, 55 deletions
diff --git a/usr/src/man/man5/mandoc_char.5 b/usr/src/man/man5/mandoc_char.5 index 15b421474d..48f8348c8e 100644 --- a/usr/src/man/man5/mandoc_char.5 +++ b/usr/src/man/man5/mandoc_char.5 @@ -1,3 +1,8 @@ +.\" $Id: mandoc_char.7,v 1.59 2015/01/20 19:39:34 schwarze Exp $ +.\" +.\" Copyright (c) 2003 Jason McIntyre <jmc@openbsd.org> +.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> +.\" Copyright (c) 2011 Ingo Schwarze <schwarze@openbsd.org> .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -11,13 +16,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.\" -.\" Copyright (c) 2003 Jason McIntyre <jmc@openbsd.org> -.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> -.\" Copyright (c) 2011 Ingo Schwarze <schwarze@openbsd.org> -.\" Copyright 2012 Nexenta Systems, Inc. All rights reserved. -.\" -.Dd Nov 23, 2011 +.Dd $Mdocdate: January 20 2015 $ .Dt MANDOC_CHAR 5 .Os .Sh NAME @@ -25,7 +24,7 @@ .Nd mandoc special characters .Sh DESCRIPTION This page documents the -.Xr roff 5 +.Xr mandoc_roff 5 escape sequences accepted by .Xr mandoc 1 to represent special characters in @@ -99,26 +98,27 @@ in literal context, and when none of the following special cases apply, just use the normal space character .Pq Sq \ . .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. To prevent a line break between two particular words, -use the non-breaking space escape sequence -.Pq Sq \e~ +use the unpaddable non-breaking space escape sequence +.Pq Sq \e\ \& instead of the normal space character. For example, the input string -.Dq number\e~1 +.Dq number\e\ 1 will be kept together as -.Dq number\~1 +.Dq number\ 1 on the same output line. .Pp On request and macro lines, the normal space character serves as an argument delimiter. -To include whitespace into arguments, quoting is usually the best choice. -In some cases, using either the non-breaking -.Pq Sq \e~ -or the breaking +To include whitespace into arguments, quoting is usually the best choice; +see the MACRO SYNTAX section in +.Xr mandoc_roff 5 . +In some cases, using the non-breaking space escape sequence .Pq Sq \e\ \& -space escape sequence may be preferable. +may be preferable. +.Pp To escape macro names and to protect whitespace at the end of input lines, the zero-width space .Pq Sq \e& @@ -147,7 +147,7 @@ The period .Pq Sq \&. is handled specially at the beginning of an input line, where it introduces a -.Xr roff 5 +.Xr mandoc_roff 5 request or a macro, and when appearing alone as a macro argument in .Xr mdoc 5 . In such situations, prepend a zero-width space @@ -171,11 +171,11 @@ is not the right way to output a backslash. Because .Xr mandoc 1 does not implement full -.Xr roff 5 +.Xr mandoc_roff 5 functionality, it may work with .Xr mandoc 1 , but it may have weird effects on complete -.Xr roff 5 +.Xr mandoc_roff 5 implementations. .Sh SPECIAL CHARACTERS Special characters are encoded as @@ -189,20 +189,19 @@ and For details, see the .Em Special Characters subsection of the -.Xr roff 5 +.Xr mandoc_roff 5 manual. .Pp Spacing: .Bl -column "Input" "Description" -offset indent -compact .It Em Input Ta Em Description -.It \e~ Ta non-breaking, non-collapsing space -.It \e Ta breaking, non-collapsing n-width space -.It \e^ Ta zero-width space -.It \e% Ta zero-width space +.It Sq \e\ \& Ta unpaddable non-breaking space +.It \e~ Ta paddable non-breaking space +.It \e0 Ta unpaddable, breaking digit-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 \e0 Ta breaking, non-collapsing digit-width space -.It \ec Ta removes any trailing space (if applicable) +.It \e% Ta zero-width space allowing hyphenation .El .Pp Lines: @@ -211,7 +210,7 @@ Lines: .It \e(ba Ta \(ba Ta bar .It \e(br Ta \(br Ta box rule .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(sl Ta \(sl Ta forward slash .It \e(rs Ta \(rs Ta backward slash @@ -274,7 +273,7 @@ Quotes: .El .Pp 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 \e(lB Ta \(lB Ta left bracket .It \e(rB Ta \(rB Ta right bracket @@ -285,30 +284,30 @@ Brackets: .It \e(bv Ta \(bv Ta brace extension .It \e[braceex] Ta \[braceex] Ta brace extension .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[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(lt Ta \(lt 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[braceleftmid] Ta \[braceleftmid] Ta mid-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(rt Ta \(rt Ta top-left hooked brace .It \e[bracerighttp] Ta \[bracerighttp] Ta top-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(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[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[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 .El .Pp @@ -353,7 +352,7 @@ Mathematical: .It \e(-+ Ta \(-+ Ta minus-plus .It \e(+- Ta \(+- Ta plus-minus .It \e[t+-] Ta \[t+-] Ta plus-minus (text) -.It \e(pc Ta \(pc Ta centre-dot +.It \e(pc Ta \(pc Ta center-dot .It \e(mu Ta \(mu Ta multiply .It \e[tmu] Ta \[tmu] Ta multiply (text) .It \e(c* Ta \(c* Ta circle-multiply @@ -370,11 +369,11 @@ Mathematical: .It \e(!= Ta \(!= Ta not equal .It \e(== Ta \(== Ta equivalent .It \e(ne Ta \(ne Ta not equivalent -.It \e(=~ Ta \(=~ Ta congruent -.It \e(-~ Ta \(-~ Ta asymptotically congruent -.It \e(ap Ta \(ap Ta asymptotically similar -.It \e(~~ Ta \(~~ Ta approximately similar -.It \e(~= Ta \(~= Ta approximately equal +.It \e(ap Ta \(ap Ta tilde operator +.It \e(|= Ta \(|= Ta asymptotically equal +.It \e(=~ Ta \(=~ Ta approximately equal +.It \e(~~ Ta \(~~ Ta almost equal +.It \e(~= Ta \(~= Ta almost equal .It \e(pt Ta \(pt Ta proportionate .It \e(es Ta \(es Ta empty set .It \e(mo Ta \(mo Ta element @@ -622,7 +621,7 @@ and For details, see the .Em Predefined Strings subsection of the -.Xr roff 5 +.Xr mandoc_roff 5 manual. .Bl -column "Input" "Rendered" "Description" -offset indent .It Em Input Ta Em Rendered Ta Em Description @@ -656,13 +655,18 @@ manual. .It \e*(Ai Ta \*(Ai Ta ANSI standard name .El .Sh UNICODE CHARACTERS -The escape sequence +The escape sequences .Pp -.Dl \e[uXXXX] +.Dl \e[uXXXX] and \eC'uXXXX' .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. -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. Unicode surrogates are not allowed. .\" .Pp @@ -685,7 +689,7 @@ For example, do not use \eN'34', use \e(dq, or even the plain .Sq \(dq character where possible. .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 .Pq Qq groff . .Pp @@ -723,18 +727,17 @@ known representation. .Sh SEE ALSO .Xr mandoc 1 , .Xr man 5 , -.Xr mdoc 5 , -.Xr roff 5 +.Xr mandoc_roff 5 , +.Xr mdoc 5 .Sh AUTHORS The .Nm manual page was written by -.An Kristaps Dzonsons , -.Mt kristaps@bsd.lv . +.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . .Sh CAVEATS -The +The predefined string .Sq \e*(Ba -escape mimics the behaviour of the +mimics the behaviour of the .Sq \&| character in .Xr mdoc 5 ; |