Print this page
9718 update mandoc to 1.14.4
*** 1,6 ****
! .\" $Id: mandoc_char.7,v 1.67 2017/06/14 20:57:07 schwarze Exp $
.\"
.\" Copyright (c) 2003 Jason McIntyre <jmc@openbsd.org>
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
.\" Copyright (c) 2011, 2013, 2015, 2017 Ingo Schwarze <schwarze@openbsd.org>
.\"
--- 1,6 ----
! .\" $Id: mandoc_char.7,v 1.72 2018/08/08 14:30:48 schwarze Exp $
.\"
.\" Copyright (c) 2003 Jason McIntyre <jmc@openbsd.org>
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
.\" Copyright (c) 2011, 2013, 2015, 2017 Ingo Schwarze <schwarze@openbsd.org>
.\"
*** 14,24 ****
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
! .Dd $Mdocdate: June 14 2017 $
.Dt MANDOC_CHAR 5
.Os
.Sh NAME
.Nm mandoc_char
.Nd mandoc special characters
--- 14,24 ----
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
! .Dd $Mdocdate: August 8 2018 $
.Dt MANDOC_CHAR 5
.Os
.Sh NAME
.Nm mandoc_char
.Nd mandoc special characters
*** 33,59 ****
.Xr man 5
documents.
.Pp
The rendering depends on the
.Xr mandoc 1
! output mode; in ASCII output, most characters are completely
! unintelligible.
! For that reason, using any of the special characters documented here,
! except those discussed in the
.Sx DESCRIPTION ,
! is strongly discouraged; they are supported merely for backwards
! compatibility with existing documents.
.Pp
In particular, in English manual pages, do not use special-character
escape sequences to represent national language characters in author
names; instead, provide ASCII transcriptions of the names.
.Ss Dashes and Hyphens
In typography there are different types of dashes of various width:
! the hyphen (-),
! the minus sign (\(mi),
the en-dash (\(en),
! and the em-dash (\(em).
.Pp
Hyphens are used for adjectives;
to separate the two parts of a compound word;
or to separate a word across two successive lines of text.
The hyphen does not need to be escaped:
--- 33,73 ----
.Xr man 5
documents.
.Pp
The rendering depends on the
.Xr mandoc 1
! output mode; it can be inspected by calling
! .Xr man 1
! on the
! .Nm
! manual page with different
! .Fl T
! arguments.
! In ASCII output, the rendering of some characters may be hard
! to interpret for the reader.
! Many are rendered as descriptive strings like
! .Qq <integral> ,
! .Qq <degree> ,
! or
! .Qq <Gamma> ,
! which may look ugly, and many are replaced by similar ASCII characters.
! In particular, accented characters are usually shown without the accent.
! For that reason, try to avoid using any of the special characters
! documented here except those discussed in the
.Sx DESCRIPTION ,
! unless they are essential for explaining the subject matter at hand,
! for example when documenting complicated mathematical functions.
.Pp
In particular, in English manual pages, do not use special-character
escape sequences to represent national language characters in author
names; instead, provide ASCII transcriptions of the names.
.Ss Dashes and Hyphens
In typography there are different types of dashes of various width:
! the hyphen (\(hy),
the en-dash (\(en),
! the em-dash (\(em),
! and the mathematical minus sign (\(mi).
.Pp
Hyphens are used for adjectives;
to separate the two parts of a compound word;
or to separate a word across two successive lines of text.
The hyphen does not need to be escaped:
*** 60,69 ****
--- 74,119 ----
.Bd -unfilled -offset indent
blue-eyed
lorry-driver
.Ed
.Pp
+ The en-dash is used to separate the two elements of a range,
+ or can be used the same way as an em-dash.
+ It should be written as
+ .Sq \e(en :
+ .Bd -unfilled -offset indent
+ pp. 95\e(en97.
+ Go away \e(en or else!
+ .Ed
+ .Pp
+ The em-dash can be used to show an interruption
+ or can be used the same way as colons, semi-colons, or parentheses.
+ It should be written as
+ .Sq \e(em :
+ .Bd -unfilled -offset indent
+ Three things \e(em apples, oranges, and bananas.
+ This is not that \e(em rather, this is that.
+ .Ed
+ .Pp
+ In
+ .Xr mandoc_roff 5
+ documents, the minus sign is normally written as
+ .Sq \e- .
+ In manual pages, some style guides recommend to also use
+ .Sq \e-
+ if an ASCII 0x2d
+ .Dq hyphen-minus
+ output glyph that can be copied and pasted is desired in output modes
+ supporting it, for example in
+ .Fl T Cm utf8
+ and
+ .Fl T Cm html .
+ But currently, no practically relevant manual page formatter actually
+ requires that subtlety, so in manual pages just write plain
+ .Sq -
+ to represent hyphen, minus, and hyphen-minus.
+ .Pp
If a word on a text input line contains a hyphen, a formatter may decide
to insert an output line break after the hyphen if that helps filling
the current output line, but the whole word would overflow the line.
If it is important that the word is not broken across lines in this
way, a zero-width space
*** 83,123 ****
at syllable boundaries even inside words that contain no hyphens.
Such automatic hyphenation is not supported by
.Xr mandoc 1 ,
which only breaks the line at whitespace, and inside words only
after existing hyphens.
- .Pp
- The mathematical minus sign is used for negative numbers or subtraction.
- It should be written as
- .Sq \e(mi :
- .Bd -unfilled -offset indent
- a = 3 \e(mi 1;
- b = \e(mi2;
- .Ed
- .Pp
- The en-dash is used to separate the two elements of a range,
- or can be used the same way as an em-dash.
- It should be written as
- .Sq \e(en :
- .Bd -unfilled -offset indent
- pp. 95\e(en97.
- Go away \e(en or else!
- .Ed
- .Pp
- The em-dash can be used to show an interruption
- or can be used the same way as colons, semi-colons, or parentheses.
- It should be written as
- .Sq \e(em :
- .Bd -unfilled -offset indent
- Three things \e(em apples, oranges, and bananas.
- This is not that \e(em rather, this is that.
- .Ed
- .Pp
- Note:
- hyphens, minus signs, and en-dashes look identical under normal ASCII output.
- Other formats, such as PostScript, render them correctly,
- with differing widths.
.Ss Spaces
To separate words in normal text, for indenting and alignment
in literal context, and when none of the following special cases apply,
just use the normal space character
.Pq Sq \ .
--- 133,142 ----
*** 317,328 ****
.It \e(bq Ta \(bq Ta right low single-quote
.It \e(lq Ta \(lq Ta left double-quote
.It \e(rq Ta \(rq Ta right double-quote
.It \e(oq Ta \(oq Ta left single-quote
.It \e(cq Ta \(cq Ta right single-quote
! .It \e(aq Ta \(aq Ta apostrophe quote (text)
! .It \e(dq Ta \(dq Ta double quote (text)
.It \e(Fo Ta \(Fo Ta left guillemet
.It \e(Fc Ta \(Fc Ta right guillemet
.It \e(fo Ta \(fo Ta left single guillemet
.It \e(fc Ta \(fc Ta right single guillemet
.El
--- 336,347 ----
.It \e(bq Ta \(bq Ta right low single-quote
.It \e(lq Ta \(lq Ta left double-quote
.It \e(rq Ta \(rq Ta right double-quote
.It \e(oq Ta \(oq Ta left single-quote
.It \e(cq Ta \(cq Ta right single-quote
! .It \e(aq Ta \(aq Ta apostrophe quote (ASCII character)
! .It \e(dq Ta \(dq Ta double quote (ASCII character)
.It \e(Fo Ta \(Fo Ta left guillemet
.It \e(Fc Ta \(Fc Ta right guillemet
.It \e(fo Ta \(fo Ta left single guillemet
.It \e(fc Ta \(fc Ta right single guillemet
.El
*** 334,344 ****
.It \e(rB Ta \(rB Ta right bracket
.It \e(lC Ta \(lC Ta left brace
.It \e(rC Ta \(rC Ta right brace
.It \e(la Ta \(la Ta left angle
.It \e(ra Ta \(ra Ta right angle
! .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[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
--- 353,363 ----
.It \e(rB Ta \(rB Ta right bracket
.It \e(lC Ta \(lC Ta left brace
.It \e(rC Ta \(rC Ta right brace
.It \e(la Ta \(la Ta left angle
.It \e(ra Ta \(ra Ta right angle
! .It \e(bv Ta \(bv Ta brace extension (special font)
.It \e[braceex] Ta \[braceex] Ta brace extension
.It \e[bracketlefttp] Ta \[bracketlefttp] Ta top-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
*** 387,398 ****
Logical:
.Bl -column "Input" "Rendered" "Description" -offset indent -compact
.It Em Input Ta Em Rendered Ta Em Description
.It \e(AN Ta \(AN Ta logical and
.It \e(OR Ta \(OR Ta logical or
! .It \e(no Ta \(no Ta logical not
! .It \e[tno] Ta \[tno] Ta logical not (text)
.It \e(te Ta \(te Ta existential quantifier
.It \e(fa Ta \(fa Ta universal quantifier
.It \e(st Ta \(st Ta such that
.It \e(tf Ta \(tf Ta therefore
.It \e(3d Ta \(3d Ta therefore
--- 406,417 ----
Logical:
.Bl -column "Input" "Rendered" "Description" -offset indent -compact
.It Em Input Ta Em Rendered Ta Em Description
.It \e(AN Ta \(AN Ta logical and
.It \e(OR Ta \(OR Ta logical or
! .It \e[tno] Ta \[tno] Ta logical not (text font)
! .It \e(no Ta \(no Ta logical not (special font)
.It \e(te Ta \(te Ta existential quantifier
.It \e(fa Ta \(fa Ta universal quantifier
.It \e(st Ta \(st Ta such that
.It \e(tf Ta \(tf Ta therefore
.It \e(3d Ta \(3d Ta therefore
*** 400,422 ****
.El
.Pp
Mathematical:
.Bl -column "xxcoproductxx" "Rendered" "Description" -offset indent -compact
.It Em Input Ta Em Rendered Ta Em Description
! .It \e(pl Ta \(pl Ta plus
! .It \e(mi Ta \(mi Ta minus
! .It \e- Ta \- Ta minus (text)
.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 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
.It \e(c+ Ta \(c+ Ta circle-plus
! .It \e(di Ta \(di Ta divide
! .It \e[tdi] Ta \[tdi] Ta divide (text)
.It \e(f/ Ta \(f/ Ta fraction
.It \e(** Ta \(** Ta asterisk
.It \e(<= Ta \(<= Ta less-than-equal
.It \e(>= Ta \(>= Ta greater-than-equal
.It \e(<< Ta \(<< Ta much less
--- 419,442 ----
.El
.Pp
Mathematical:
.Bl -column "xxcoproductxx" "Rendered" "Description" -offset indent -compact
.It Em Input Ta Em Rendered Ta Em Description
! .It \e- Ta \- Ta minus (text font)
! .It \e(mi Ta \(mi Ta minus (special font)
! .It + Ta + Ta plus (text font)
! .It \e(pl Ta \(pl Ta plus (special font)
.It \e(-+ Ta \(-+ Ta minus-plus
! .It \e[t+-] Ta \[t+-] Ta plus-minus (text font)
! .It \e(+- Ta \(+- Ta plus-minus (special font)
.It \e(pc Ta \(pc Ta center-dot
! .It \e[tmu] Ta \[tmu] Ta multiply (text font)
! .It \e(mu Ta \(mu Ta multiply (special font)
.It \e(c* Ta \(c* Ta circle-multiply
.It \e(c+ Ta \(c+ Ta circle-plus
! .It \e[tdi] Ta \[tdi] Ta divide (text font)
! .It \e(di Ta \(di Ta divide (special font)
.It \e(f/ Ta \(f/ Ta fraction
.It \e(** Ta \(** Ta asterisk
.It \e(<= Ta \(<= Ta less-than-equal
.It \e(>= Ta \(>= Ta greater-than-equal
.It \e(<< Ta \(<< Ta much less
*** 509,520 ****
.It \e(ad Ta \(ad Ta dieresis
.It \e(ah Ta \(ah Ta caron
.It \e(ao Ta \(ao Ta ring
.It \e(a\(ti Ta \(a~ Ta tilde
.It \e(ho Ta \(ho Ta ogonek
! .It \e(ha Ta \(ha Ta hat (text)
! .It \e(ti Ta \(ti Ta tilde (text)
.El
.Pp
Accented letters:
.Bl -column "Input" "Rendered" "Description" -offset indent -compact
.It Em Input Ta Em Rendered Ta Em Description
--- 529,540 ----
.It \e(ad Ta \(ad Ta dieresis
.It \e(ah Ta \(ah Ta caron
.It \e(ao Ta \(ao Ta ring
.It \e(a\(ti Ta \(a~ Ta tilde
.It \e(ho Ta \(ho Ta ogonek
! .It \e(ha Ta \(ha Ta hat (ASCII character)
! .It \e(ti Ta \(ti Ta tilde (ASCII character)
.El
.Pp
Accented letters:
.Bl -column "Input" "Rendered" "Description" -offset indent -compact
.It Em Input Ta Em Rendered Ta Em Description