diff options
author | Ingo Schwarze <schwarze@openbsd.org> | 2018-08-08 13:54:05 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@openbsd.org> | 2018-08-08 13:54:05 +0000 |
commit | 9b6f2e84cf2e8bb99b0b55b57daf611b9e25a7d6 (patch) | |
tree | 516cc3f3a33b9d25c11f4c96af88363a20224911 /mandoc_char.7 | |
parent | 02fe4930db205ea4563df86137f333dcd7e97a0a (diff) | |
download | mandoc-9b6f2e84cf2e8bb99b0b55b57daf611b9e25a7d6.tar.gz |
After years of deliberation, finally provide a clear recommendation
for hyphens and minus signs in manual pages.
Since there is consensus that a typographically perfect solution is
impossible, let's KISS - just write "-", don't bother with "\-", all
currently relevant manual page formatters can handle "-" reasonably.
OK jmc@ bentley@
Diffstat (limited to 'mandoc_char.7')
-rw-r--r-- | mandoc_char.7 | 33 |
1 files changed, 19 insertions, 14 deletions
diff --git a/mandoc_char.7 b/mandoc_char.7 index 2c8fe9a3..d4e02729 100644 --- a/mandoc_char.7 +++ b/mandoc_char.7 @@ -63,9 +63,9 @@ 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). +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; @@ -100,14 +100,6 @@ Such automatic hyphenation is not supported by 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 @@ -126,10 +118,23 @@ 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. +In +.Xr roff 7 +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. .Ss Spaces To separate words in normal text, for indenting and alignment in literal context, and when none of the following special cases apply, |