mandoc/mandoc_char.7 - diff

Return to mandoc_char.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc_char.7 between version 1.63 and 1.70

version 1.63, 2015/09/02 15:38:35

version 1.70, 2018/08/08 14:03:27

Line 2

.\"

.\" Permission to use, copy, modify, and distribute this software for any

.\" purpose with or without fee is hereby granted, provided that the above

Line 35 documents.

.Pp

The rendering depends on the

.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> ,

.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 ,

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

In particular, in English manual pages, do not use special-character

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

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).

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;

Line 62 blue-eyed

Line 76 blue-eyed

lorry-driver

.Ed

.Pp

The mathematical minus sign is used for negative numbers or subtraction.

If a word on a text input line contains a hyphen, a formatter may decide

It should be written as

to insert an output line break after the hyphen if that helps filling

.Sq \e(mi :

the current output line, but the whole word would overflow the line.

.Bd -unfilled -offset indent

If it is important that the word is not broken across lines in this

a = 3 \e(mi 1;

way, a zero-width space

b = \e(mi2;

.Pq Sq \e&

.Ed

can be inserted before or after the hyphen.

While

.Xr mandoc 1

never breaks the output line after hyphens adjacent to a zero-width

space, after any of the other dash- or hyphen-like characters

represented by escape sequences, or after hyphens inside words in

macro arguments, other software may not respect these rules and may

break the line even in such cases.

.Pp

Some

.Xr roff 7

implementations contains dictionaries allowing to break the line

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 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

Line 88 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.

.Ed

.Pp

Note:

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

To separate words in normal text, for indenting and alignment

in literal context, and when none of the following special cases apply,

Line 145 even on request and macro lines.

Line 188 even on request and macro lines.

.Ss Accents

In output modes supporting such special output characters, for example

.Fl T Cm pdf ,

and sometimes less consistently in

.Fl T Cm utf8 ,

some

.Xr roff 7

formatters convert the following ASCII input characters to the

Line 153 following Unicode special output characters:

Line 198 following Unicode special output characters:

.It \(ga Ta U+2018 Ta left single quotation mark

.It \(aq Ta U+2019 Ta right single quotation mark

.It \(ti Ta U+02DC Ta small tilde

.It \(ha Ta U+02C6 Ta modifier letter circumflex

.El

.Pp

In prose, this automatic substitution is often desirable;

Line 163 escaping to render as follows:

Line 209 escaping to render as follows:

.It \e(ga Ta U+0060 Ta grave accent

.It \e(aq Ta U+0027 Ta apostrophe

.It \e(ti Ta U+007E Ta tilde

.It \e(ha Ta U+005E Ta circumflex accent

.El

.Ss Periods

The period

Line 232 Lines:

Line 279 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(ru Ta \(ru Ta underscore (width 0.5m)

.It \e(rn Ta \(rn Ta overline

.It \e(bb Ta \(bb Ta broken bar

.It \e(sl Ta \(sl Ta forward slash

Line 255 Text markers:

Line 303 Text markers:

.It \e(sh Ta \(sh Ta hash (pound)

.It \e(CR Ta \(CR Ta carriage return

.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

.Pp

Legal symbols:

Line 286 Quotes:

Line 338 Quotes:

.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(aq Ta \(aq Ta apostrophe quote (ASCII character)

.It \e(dq Ta \(dq Ta double quote (text)

.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

Line 303 Brackets:

Line 355 Brackets:

.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(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

Line 348 Arrows:

Line 400 Arrows:

.It \e(uA Ta \(uA Ta up double-arrow

.It \e(dA Ta \(dA Ta down double-arrow

.It \e(vA Ta \(vA Ta up-down double-arrow

.It \e(an Ta \(an Ta horizontal arrow extension

.El

.Pp

Logical:

Line 355 Logical:

Line 408 Logical:

.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 font)

.It \e[tno] Ta \[tno] Ta logical not (text)

.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

Line 368 Logical:

Line 421 Logical:

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- Ta \- Ta minus (text font)

.It \e(mi Ta \(mi Ta minus

.It \e(mi Ta \(mi Ta minus (special font)

.It \e- Ta \- Ta minus (text)

.It + Ta + Ta plus (text font)

.It \e(pl Ta \(pl Ta plus (special font)

.It \e(-+ Ta \(-+ Ta minus-plus

.It \e(+- Ta \(+- Ta plus-minus

.It \e[t+-] Ta \[t+-] Ta plus-minus (text font)

.It \e[t+-] Ta \[t+-] Ta plus-minus (text)

.It \e(+- Ta \(+- Ta plus-minus (special font)

.It \e(pc Ta \(pc Ta center-dot

.It \e(mu Ta \(mu Ta multiply

.It \e[tmu] Ta \[tmu] Ta multiply (text font)

.It \e[tmu] Ta \[tmu] Ta multiply (text)

.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(di Ta \(di Ta divide

.It \e[tdi] Ta \[tdi] Ta divide (text font)

.It \e[tdi] Ta \[tdi] Ta divide (text)

.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

Line 426 Mathematical:

Line 480 Mathematical:

.It \e(Ah Ta \(Ah Ta aleph

.It \e(Im Ta \(Im Ta imaginary

.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(-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

.Pp

Ligatures:

Line 468 Accents:

Line 531 Accents:

.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(ha Ta \(ha Ta hat (ASCII character)

.It \e(ti Ta \(ti Ta tilde (text)

.It \e(ti Ta \(ti Ta tilde (ASCII character)

.El

.Pp

Accented letters:

Line 564 Units:

Line 627 Units:

.It \e(fm Ta \(fm Ta minute

.It \e(sd Ta \(sd Ta second

.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

.Pp

Greek letters:

Line 724 the

Line 789 the

differently between mandoc and groff.

.It

.Fl T Ns Cm html

.Fl T Ns Cm html ,

and

.Fl T Ns Cm xhtml ,

the \e(\(ti=, \e(nb, and \e(nc special characters render differently

between mandoc and groff.

.It

CVSweb