version 1.65, 2017/05/17 23:39:31 |
version 1.69, 2018/08/08 13:54:05 |
|
|
.\" |
.\" |
.\" Copyright (c) 2003 Jason McIntyre <jmc@openbsd.org> |
.\" Copyright (c) 2003 Jason McIntyre <jmc@openbsd.org> |
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2011, 2013, 2015 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2011, 2013, 2015, 2017 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 |
|
|
.Pp |
.Pp |
The rendering depends on the |
The rendering depends on the |
.Xr mandoc 1 |
.Xr mandoc 1 |
output mode; in ASCII output, most characters are completely |
output mode; it can be inspected by calling |
unintelligible. |
.Xr man 1 |
For that reason, using any of the special characters documented here, |
on the |
except those discussed in 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 , |
.Sx DESCRIPTION , |
is strongly discouraged; they are supported merely for backwards |
unless they are essential for explaining the subject matter at hand, |
compatibility with existing documents. |
for example when documenting complicated mathematical functions. |
.Pp |
.Pp |
In particular, in English manual pages, do not use special-character |
In particular, in English manual pages, do not use special-character |
escape sequences to represent national language characters in author |
escape sequences to represent national language characters in author |
Line 49 names; instead, provide ASCII transcriptions of the na |
|
Line 63 names; instead, provide ASCII transcriptions of the na |
|
.Ss Dashes and Hyphens |
.Ss Dashes and Hyphens |
In typography there are different types of dashes of various width: |
In typography there are different types of dashes of various width: |
the hyphen (-), |
the hyphen (-), |
the minus sign (\(mi), |
|
the en-dash (\(en), |
the en-dash (\(en), |
and the em-dash (\(em). |
the em-dash (\(em), |
|
and the mathematical minus sign (\(mi). |
.Pp |
.Pp |
Hyphens are used for adjectives; |
Hyphens are used for adjectives; |
to separate the two parts of a compound word; |
to separate the two parts of a compound word; |
Line 86 Such automatic hyphenation is not supported by |
|
Line 100 Such automatic hyphenation is not supported by |
|
which only breaks the line at whitespace, and inside words only |
which only breaks the line at whitespace, and inside words only |
after existing hyphens. |
after existing hyphens. |
.Pp |
.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, |
The en-dash is used to separate the two elements of a range, |
or can be used the same way as an em-dash. |
or can be used the same way as an em-dash. |
It should be written as |
It should be written as |
Line 112 Three things \e(em apples, oranges, and bananas. |
|
Line 118 Three things \e(em apples, oranges, and bananas. |
|
This is not that \e(em rather, this is that. |
This is not that \e(em rather, this is that. |
.Ed |
.Ed |
.Pp |
.Pp |
Note: |
In |
hyphens, minus signs, and en-dashes look identical under normal ASCII output. |
.Xr roff 7 |
Other formats, such as PostScript, render them correctly, |
documents, the minus sign is normally written as |
with differing widths. |
.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. |
.Ss Spaces |
.Ss Spaces |
To separate words in normal text, for indenting and alignment |
To separate words in normal text, for indenting and alignment |
in literal context, and when none of the following special cases apply, |
in literal context, and when none of the following special cases apply, |
Line 169 even on request and macro lines. |
|
Line 188 even on request and macro lines. |
|
.Ss Accents |
.Ss Accents |
In output modes supporting such special output characters, for example |
In output modes supporting such special output characters, for example |
.Fl T Cm pdf , |
.Fl T Cm pdf , |
|
and sometimes less consistently in |
|
.Fl T Cm utf8 , |
some |
some |
.Xr roff 7 |
.Xr roff 7 |
formatters convert the following ASCII input characters to the |
formatters convert the following ASCII input characters to the |
Line 177 following Unicode special output characters: |
|
Line 198 following Unicode special output characters: |
|
.It \(ga Ta U+2018 Ta left single quotation mark |
.It \(ga Ta U+2018 Ta left single quotation mark |
.It \(aq Ta U+2019 Ta right single quotation mark |
.It \(aq Ta U+2019 Ta right single quotation mark |
.It \(ti Ta U+02DC Ta small tilde |
.It \(ti Ta U+02DC Ta small tilde |
|
.It \(ha Ta U+02C6 Ta modifier letter circumflex |
.El |
.El |
.Pp |
.Pp |
In prose, this automatic substitution is often desirable; |
In prose, this automatic substitution is often desirable; |
Line 187 escaping to render as follows: |
|
Line 209 escaping to render as follows: |
|
.It \e(ga Ta U+0060 Ta grave accent |
.It \e(ga Ta U+0060 Ta grave accent |
.It \e(aq Ta U+0027 Ta apostrophe |
.It \e(aq Ta U+0027 Ta apostrophe |
.It \e(ti Ta U+007E Ta tilde |
.It \e(ti Ta U+007E Ta tilde |
|
.It \e(ha Ta U+005E Ta circumflex accent |
.El |
.El |
.Ss Periods |
.Ss Periods |
The period |
The period |
|
|
.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(ru Ta \(ru Ta underscore (width 0.5m) |
.It \e(rn Ta \(rn 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(sh Ta \(sh Ta hash (pound) |
.It \e(sh Ta \(sh Ta hash (pound) |
.It \e(CR Ta \(CR Ta carriage return |
.It \e(CR Ta \(CR Ta carriage return |
.It \e(OK Ta \(OK Ta check mark |
.It \e(OK Ta \(OK Ta check mark |
|
.It \e(CL Ta \(CL Ta club suit |
|
.It \e(SP Ta \(SP Ta spade suit |
|
.It \e(HE Ta \(HE Ta heart suit |
|
.It \e(DI Ta \(DI Ta diamond suit |
.El |
.El |
.Pp |
.Pp |
Legal symbols: |
Legal symbols: |
|
|
.It \e(uA Ta \(uA Ta up double-arrow |
.It \e(uA Ta \(uA Ta up double-arrow |
.It \e(dA Ta \(dA Ta down double-arrow |
.It \e(dA Ta \(dA Ta down double-arrow |
.It \e(vA Ta \(vA Ta up-down double-arrow |
.It \e(vA Ta \(vA Ta up-down double-arrow |
|
.It \e(an Ta \(an Ta horizontal arrow extension |
.El |
.El |
.Pp |
.Pp |
Logical: |
Logical: |
|
|
.It \e(Ah Ta \(Ah Ta aleph |
.It \e(Ah Ta \(Ah Ta aleph |
.It \e(Im Ta \(Im Ta imaginary |
.It \e(Im Ta \(Im Ta imaginary |
.It \e(Re Ta \(Re Ta real |
.It \e(Re Ta \(Re Ta real |
|
.It \e(wp Ta \(wp Ta Weierstrass p |
.It \e(pd Ta \(pd Ta partial differential |
.It \e(pd Ta \(pd Ta partial differential |
.It \e(-h Ta \(-h Ta Planck constant over 2\(*p |
.It \e(-h Ta \(-h Ta Planck constant over 2\(*p |
.It \e[12] Ta \[12] Ta one-half |
.It \e[hbar] Ta \[hbar] Ta Planck constant over 2\(*p |
.It \e[14] Ta \[14] Ta one-fourth |
.It \e(12 Ta \(12 Ta one-half |
.It \e[34] Ta \[34] Ta three-fourths |
.It \e(14 Ta \(14 Ta one-fourth |
|
.It \e(34 Ta \(34 Ta three-fourths |
|
.It \e(18 Ta \(18 Ta one-eighth |
|
.It \e(38 Ta \(38 Ta three-eighths |
|
.It \e(58 Ta \(58 Ta five-eighths |
|
.It \e(78 Ta \(78 Ta seven-eighths |
|
.It \e(S1 Ta \(S1 Ta superscript 1 |
|
.It \e(S2 Ta \(S2 Ta superscript 2 |
|
.It \e(S3 Ta \(S3 Ta superscript 3 |
.El |
.El |
.Pp |
.Pp |
Ligatures: |
Ligatures: |
|
|
.It \e(fm Ta \(fm Ta minute |
.It \e(fm Ta \(fm Ta minute |
.It \e(sd Ta \(sd Ta second |
.It \e(sd Ta \(sd Ta second |
.It \e(mc Ta \(mc Ta micro |
.It \e(mc Ta \(mc Ta micro |
|
.It \e(Of Ta \(Of Ta Spanish female ordinal |
|
.It \e(Om Ta \(Om Ta Spanish masculine ordinal |
.El |
.El |
.Pp |
.Pp |
Greek letters: |
Greek letters: |