OpenBSD CVS

CVS log for src/share/man/man7/mandoc_char.7


[BACK] Up to [local] / src / share / man / man7

Request diff between arbitrary revisions


Default branch: MAIN


Revision 1.44 / (download) - annotate - [select for diffs], Thu Jun 2 14:49:25 2022 UTC (2 years ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_7_5_BASE, OPENBSD_7_5, OPENBSD_7_4_BASE, OPENBSD_7_4, OPENBSD_7_3_BASE, OPENBSD_7_3, OPENBSD_7_2_BASE, OPENBSD_7_2, HEAD
Changes since 1.43: +13 -8 lines
Diff to previous 1.43 (colored)

Since \. is not a character escape sequence, re-classify it from the
wrong parsing class ESCAPE_SPECIAL to the better-suited parsing class
ESCAPE_UNDEF, exactly like it is already done for the similar \\,
which isn't a character escape sequence either.

No formatting change is intended just yet, but this will matter for
upcoming improvements in the parser for roff(7) macro, string, and
register names.

See the node "5.23.2 Copy Mode" in "info groff" regarding
what \\ and \. really mean.

Revision 1.43 / (download) - annotate - [select for diffs], Sat Oct 31 11:44:25 2020 UTC (3 years, 7 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_7_1_BASE, OPENBSD_7_1, OPENBSD_7_0_BASE, OPENBSD_7_0, OPENBSD_6_9_BASE, OPENBSD_6_9
Changes since 1.42: +2 -7 lines
Diff to previous 1.42 (colored)

Delete a sentence pointing to "the Predefined Strings subsection
of the roff(7) manual."  Such a subsection does not exist, and i
do not see why it should.  Predefined strings are an obsolete
feature of macro packages, not a feature of the roff language.

Revision 1.42 / (download) - annotate - [select for diffs], Thu Feb 13 16:16:03 2020 UTC (4 years, 3 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_6_8_BASE, OPENBSD_6_8, OPENBSD_6_7_BASE, OPENBSD_6_7
Changes since 1.41: +8 -8 lines
Diff to previous 1.41 (colored)

Digit-width and narrow spaces are non-breaking.
Noticed because Branden Robinson worked on related documentation in groff.

Revision 1.41 / (download) - annotate - [select for diffs], Sun Mar 31 19:16:13 2019 UTC (5 years, 2 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_6_6_BASE, OPENBSD_6_6, OPENBSD_6_5_BASE, OPENBSD_6_5
Changes since 1.40: +4 -4 lines
Diff to previous 1.40 (colored)

While we do encourage simplicity in the sense of writing plain '-'
for hyphen-minus, soften the language a bit: writing \- for it is
not wrong, and people started sending us patches to replace \- with '-'
in existing manual pages, which is not a worthwhile change unless
the \- is used at a place where it doesn't belong.
OK jmc@

Revision 1.40 / (download) - annotate - [select for diffs], Sat Dec 15 19:30:19 2018 UTC (5 years, 5 months ago) by schwarze
Branch: MAIN
Changes since 1.39: +7 -5 lines
Diff to previous 1.39 (colored)

Several improvements to escape sequence handling.

* Add the missing special character \_ (underscore).
* Partial implementations of \a (leader character)
and \E (uninterpreted escape character).
* Parse and ignore \r (reverse line feed).
* Add a WARNING message about undefined escape sequences.
* Add an UNSUPP message about unsupported escape sequences.
* Mark \! and \? (transparent throughput)
and \O (suppress output) as unsupported.
* Treat the various variants of zero-width spaces as one-byte escape
sequences rather than as special characters, to avoid defining bogus
forms with square brackets.
* For special characters with one-byte names, do not define bogus
forms with square brackets, except for \[-], which is valid.
* In the form with square brackets, undefined special characters do not
fall back to printing the name verbatim, not even for one-byte names.
* Starting a special character name with a blank is an error.
* Undefined escape sequences never abort formatting of the input
string, not even in HTML output mode.
* Document the newly handled escapes, and a few that were missing.
* Regression tests for most of the above.

Revision 1.39 / (download) - annotate - [select for diffs], Tue Aug 21 01:56:26 2018 UTC (5 years, 9 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_6_4_BASE, OPENBSD_6_4
Changes since 1.38: +4 -2 lines
Diff to previous 1.38 (colored)

Fix some issues found looking at groff_char(7):
* Add two missing characters, \('Y and \('y.
* The Weierstrass p is not capital, see http://unicode.org/notes/tn27/.
* Add a groff-compatible ASCII transliteration for U+02DC: "~".

Revision 1.38 / (download) - annotate - [select for diffs], Fri Aug 10 22:12:40 2018 UTC (5 years, 9 months ago) by schwarze
Branch: MAIN
Changes since 1.37: +7 -5 lines
Diff to previous 1.37 (colored)

handle the non-portable GNU-style \[charNN], \[charNNN] character
escape sequences, used for example in the groff_char(7) manual page

Revision 1.37 / (download) - annotate - [select for diffs], Wed Aug 8 14:29:42 2018 UTC (5 years, 10 months ago) by schwarze
Branch: MAIN
Changes since 1.36: +2 -2 lines
Diff to previous 1.36 (colored)

Even though we strongly discourage escaping hyphens in manual pages
in general, when introducing the *typographic* term "hyphen",
actually display a real hyphen in output modes supporting it.

Revision 1.36 / (download) - annotate - [select for diffs], Wed Aug 8 14:15:21 2018 UTC (5 years, 10 months ago) by schwarze
Branch: MAIN
Changes since 1.35: +25 -25 lines
Diff to previous 1.35 (colored)

Reorder the text in the "Dashes and Hyphens" subsection to keep the
simplest and most important instructions together and at the
beginning.  No text change.
Suggested by jmc@.

Revision 1.35 / (download) - annotate - [select for diffs], Wed Aug 8 14:03:17 2018 UTC (5 years, 10 months ago) by schwarze
Branch: MAIN
Changes since 1.34: +19 -18 lines
Diff to previous 1.34 (colored)

Clarify the confusing "(text)" annotation in the character lists.
In some cases, it meant "render as an ASCII character in output
modes that have a notion of codepoints" (e.g. UTF-8, HTML); in other
cases, "render in the text font in output modes that also provide
a special font for mathematical symbols" (e.g. PostScript, PDF).
Also explicitly annotate the escape sequences that use a special
font if available.
OK bentley@

Revision 1.34 / (download) - annotate - [select for diffs], Wed Aug 8 13:53:55 2018 UTC (5 years, 10 months ago) by schwarze
Branch: MAIN
Changes since 1.33: +21 -16 lines
Diff to previous 1.33 (colored)

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@

Revision 1.33 / (download) - annotate - [select for diffs], Thu Mar 15 18:09:00 2018 UTC (6 years, 2 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_6_3_BASE, OPENBSD_6_3
Changes since 1.32: +22 -8 lines
Diff to previous 1.32 (colored)

Soften the language discouraging special character escape sequences.
After i improved their ASCII renderings in groff and mandoc some time
ago, mathematical symbols can now be used in specialised mathematical
manual pages like libm and some X libraries.
Tweaks and OK jmc@.

Revision 1.32 / (download) - annotate - [select for diffs], Wed Jun 14 20:56:42 2017 UTC (6 years, 11 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_6_2_BASE, OPENBSD_6_2
Changes since 1.31: +3 -2 lines
Diff to previous 1.31 (colored)

add the \(ru (0.5m baseline ruler) character escape sequence,
abused by mail/nmh; groff_char(7) confirms that this really exists

Revision 1.31 / (download) - annotate - [select for diffs], Fri Jun 2 12:41:28 2017 UTC (7 years ago) by schwarze
Branch: MAIN
Changes since 1.30: +22 -6 lines
Diff to previous 1.30 (colored)

add about 15 missing character escape sequences found in groff_char(7);
triggered by multimedia/mkvtoolnix mkvmerge(1) using \(S2

Revision 1.30 / (download) - annotate - [select for diffs], Wed May 17 23:39:15 2017 UTC (7 years ago) by schwarze
Branch: MAIN
Changes since 1.29: +3 -5 lines
Diff to previous 1.29 (colored)

Delete the -T xhtml command line option.
It has been obsolete for more than two years.
Use -T html.

Revision 1.29 / (download) - annotate - [select for diffs], Sun Apr 30 15:05:27 2017 UTC (7 years, 1 month ago) by schwarze
Branch: MAIN
Changes since 1.28: +6 -2 lines
Diff to previous 1.28 (colored)

Mention that escaping "^" as "\(ha" in source code samples improves
portability, in particular when rendering to formats such as PDF
with real typesetters such as groff.

While here, make it even more explicit that the rendering of raw
ASCII accents ( ` ' ~ ^ ) found in the input is kind of a mess and
varies among implementations, software versions, macro sets, and
output devices.

Issue noticed when reading the groff_char(7) manual, and confirmed
by testing with current groff.

OK bentley@, "certainly no objection" jmc@

N.B.: Nobody will get scolded for ignoring this subtlety.

Revision 1.28 / (download) - annotate - [select for diffs], Sun Feb 5 21:39:54 2017 UTC (7 years, 4 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_6_1_BASE, OPENBSD_6_1
Changes since 1.27: +26 -2 lines
Diff to previous 1.27 (colored)

document hyphenation

Revision 1.27 / (download) - annotate - [select for diffs], Tue Sep 1 01:19:46 2015 UTC (8 years, 9 months ago) by bentley
Branch: MAIN
CVS Tags: OPENBSD_6_0_BASE, OPENBSD_6_0, OPENBSD_5_9_BASE, OPENBSD_5_9
Changes since 1.26: +7 -7 lines
Diff to previous 1.26 (colored)

Recommend an unambiguous escape for minus signs instead of \-.

Historically, \- was used in troff for three cases: flags/pathnames,
en dashes, and minus signs. mandoc_char(7) currently recommends it
for minus signs, recommends \(en for en dashes, and doesn't mention
flags/pathnames.

In the old days, nroff rendered \- as ASCII '-', and troff rendered
it as en dash/minus (which were visually indistinguishable).

In Unicode, en dashes and minus signs are semantically distinct and
encoded differently (U+2013 for en dash, U+2212 for minus), and
often rendered differently too. Meanwhile ASCII '-' has been renamed
"hyphen-minus" and fonts typically render it closest to a hyphen, not
a minus.

There is very little consistency across roff implementations and output
formats for what Unicode character \- corresponds to. So at least for
minus signs, change the recommendation to the unambiguous \(mi escape.

ok jmc@ (after reams of discussion)

Revision 1.26 / (download) - annotate - [select for diffs], Fri Jun 12 04:51:08 2015 UTC (8 years, 11 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_5_8_BASE, OPENBSD_5_8
Changes since 1.25: +3 -3 lines
Diff to previous 1.25 (colored)

Kill trailing blank; no text change.
Issue found by Tony Sim <y2s1982 at gmail dot com>
during today's BSDCan Doc Sprint.

Revision 1.25 / (download) - annotate - [select for diffs], Sun Mar 29 21:12:00 2015 UTC (9 years, 2 months ago) by bentley
Branch: MAIN
Changes since 1.24: +38 -38 lines
Diff to previous 1.24 (colored)

Escape punctuation characters that have a different meaning in -Tpdf.

~, `, and ' get translated to non-ASCII characters by most troff
implementations when generating PostScript/PDF output. When the original
ASCII character is meant, it needs to be manually escaped.

discussed with jmc@ schwarze@; ok schwarze@

Revision 1.24 / (download) - annotate - [select for diffs], Fri Mar 27 00:57:00 2015 UTC (9 years, 2 months ago) by schwarze
Branch: MAIN
Changes since 1.23: +25 -3 lines
Diff to previous 1.23 (colored)

Document that certain stand-alone accents need escaping in rare cases to
prevent them from being converted to Unicode replacements in PDF output.
Issue found by bentley@, OK jmc@ bentley@.

Revision 1.23 / (download) - annotate - [select for diffs], Tue Jan 20 18:54:33 2015 UTC (9 years, 4 months ago) by tedu
Branch: MAIN
CVS Tags: OPENBSD_5_7_BASE, OPENBSD_5_7
Changes since 1.22: +3 -3 lines
Diff to previous 1.22 (colored)

change spelling of centre to center. consistent with other man pages,
the name of the macro being described, and look(1).
ok jmc

Revision 1.22 / (download) - annotate - [select for diffs], Tue Dec 16 19:48:49 2014 UTC (9 years, 5 months ago) by schwarze
Branch: MAIN
Changes since 1.21: +7 -7 lines
Diff to previous 1.21 (colored)

correct -Tutf8 and -Thtml rendering of \(~=
and change the name of \(-~ to \(|= to agree with groff;
difference found by Carsten dot Kunze at arcor dot de

Revision 1.21 / (download) - annotate - [select for diffs], Mon Dec 15 19:41:24 2014 UTC (9 years, 5 months ago) by schwarze
Branch: MAIN
Changes since 1.20: +10 -10 lines
Diff to previous 1.20 (colored)

correct some character names to match groff;
reported by Carsten dot Kunze at arcor dot de

Revision 1.20 / (download) - annotate - [select for diffs], Thu Dec 26 17:23:31 2013 UTC (10 years, 5 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_5_6_BASE, OPENBSD_5_6, OPENBSD_5_5_BASE, OPENBSD_5_5
Changes since 1.19: +20 -20 lines
Diff to previous 1.19 (colored)

Rework the documentation of Spaces, using the Ossanna/Kernighan/Ritter
Heirloom Nroff/Troff User's Manual at the authoritative reference.
Part of our text was outright wrong.

Also, refrain from advertising the paddable non-breaking space `\~'
in the DESCRIPTION, for three reasons:  For nroff mode, -Tascii, and
fixed width fonts in general, it makes no difference, so keep the
discussion simple.  Compared to `\ ', '\~' is of questionable portability.
And if you want to keep words together, it is also more usual that you
don't want padding to intervene either.

Finally, drop the `\c' escape sequence (interrupt text processing)
which is not a special character but an input processing instruction
akin to the \<newline> escape sequence.

Revision 1.19 / (download) - annotate - [select for diffs], Sun Nov 10 20:17:14 2013 UTC (10 years, 6 months ago) by schwarze
Branch: MAIN
Changes since 1.18: +4 -4 lines
Diff to previous 1.18 (colored)

Support the alternative syntax \C'uXXXX' for Unicode characters.
It is already documented in the Heirloom troff manual,
and groff handles it as well.

Bug reported by Bjarni Ingi Gislason <bjarniig at rhi dot hi dot is>
on <bug-groff at gnu dot org>.  Well, admittedly, that bug was reported
against groff, but mandoc was even more broken than groff with respect
to this syntax...

Revision 1.18 / (download) - annotate - [select for diffs], Sun Nov 10 17:47:42 2013 UTC (10 years, 6 months ago) by jmc
Branch: MAIN
Changes since 1.17: +3 -3 lines
Diff to previous 1.17 (colored)

zap trailing whitespace;

Revision 1.17 / (download) - annotate - [select for diffs], Sun Nov 10 14:32:11 2013 UTC (10 years, 6 months ago) by schwarze
Branch: MAIN
Changes since 1.16: +8 -3 lines
Diff to previous 1.16 (colored)

clarify that \[uXXXX] wants uppercase hex digits

Revision 1.16 / (download) - annotate - [select for diffs], Sat Jul 13 19:27:47 2013 UTC (10 years, 10 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_5_4_BASE, OPENBSD_5_4
Changes since 1.15: +3 -4 lines
Diff to previous 1.15 (colored)

For citing the names and email addresses of authors,
consistently use the style ".An name Aq Mt email".

Triggered by a question from Jan Stary <hans at stare dot cz>,
ok jmc@.

Revision 1.15 / (download) - annotate - [select for diffs], Sat Apr 27 17:15:01 2013 UTC (11 years, 1 month ago) by jmc
Branch: MAIN
Changes since 1.14: +2 -2 lines
Diff to previous 1.14 (colored)

- (mdoc.7) fix Xr to self
- double word fix

Revision 1.14 / (download) - annotate - [select for diffs], Mon Nov 14 19:32:22 2011 UTC (12 years, 6 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_5_3_BASE, OPENBSD_5_3, OPENBSD_5_2_BASE, OPENBSD_5_2, OPENBSD_5_1_BASE, OPENBSD_5_1
Changes since 1.13: +3 -3 lines
Diff to previous 1.13 (colored)

zap end of line whitespace; noticed by jmc@

Revision 1.13 / (download) - annotate - [select for diffs], Mon Nov 14 15:10:17 2011 UTC (12 years, 6 months ago) by schwarze
Branch: MAIN
Changes since 1.12: +177 -42 lines
Diff to previous 1.12 (colored)

Add lots of information about special characters that's actually needed
in practice, and discourage using fancy characters in manuals.
Text about "Dashes and Hyphens" by jmc@.
Feedback and ok jmc@, grudgingly ok kristaps@.

Revision 1.12 / (download) - annotate - [select for diffs], Sun Sep 18 10:38:57 2011 UTC (12 years, 8 months ago) by schwarze
Branch: MAIN
Changes since 1.11: +6 -2 lines
Diff to previous 1.11 (colored)

sync to mandoc 1.11.5:
document eqn(7) and many other improvements
from kristaps@

no objection from deraadt@ against adding an eqn.7 page

Revision 1.11 / (download) - annotate - [select for diffs], Tue Aug 30 12:25:09 2011 UTC (12 years, 9 months ago) by jmc
Branch: MAIN
Changes since 1.10: +20 -20 lines
Diff to previous 1.10 (colored)

in column lists, enforce the following ordering:

	.Bl -column header1 header2 ... <Bl flags>

mixing things up confuses mandoc, and adding flags in can screw up the list.
this hopefully just makes things a bit safer (and more consistent).

(one more bit of work left and all column lists should format how we want)

Revision 1.10 / (download) - annotate - [select for diffs], Tue Aug 30 11:38:59 2011 UTC (12 years, 9 months ago) by jmc
Branch: MAIN
Changes since 1.9: +3 -4 lines
Diff to previous 1.9 (colored)

remove some pointless Pp/-compact combinations; either ingo or kristaps
will update mandoc repo

Revision 1.9 / (download) - annotate - [select for diffs], Tue Jun 7 23:40:10 2011 UTC (13 years ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_5_0_BASE, OPENBSD_5_0
Changes since 1.8: +24 -4 lines
Diff to previous 1.8 (colored)

bring in lots of improvements from kristaps@;
jmc@ agrees that it's easiest to first commit it,
then tweak it in the tree

Revision 1.8 / (download) - annotate - [select for diffs], Wed Feb 9 22:53:18 2011 UTC (13 years, 3 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_4_9_BASE, OPENBSD_4_9
Changes since 1.7: +33 -25 lines
Diff to previous 1.7 (colored)

Clean up the COMPATIBILITY section;
heavily based on a patch from kristaps@ with some tweaks by me.
- Also talk about -Tps and -Tpdf.
- Use the same list style as in the other mandoc manuals.
- Replace a few macros by ones better suited.
- Some improvements of wording.
ok jmc@ kristaps@

Revision 1.7 / (download) - annotate - [select for diffs], Sun Jan 30 16:05:29 2011 UTC (13 years, 4 months ago) by schwarze
Branch: MAIN
Changes since 1.6: +17 -2 lines
Diff to previous 1.6 (colored)

Implement the \N'number' (numbered character) roff escape sequence.
Don't use it in new manuals, it is inherently non-portable, but we
need it for backward-compatibility with existing manuals, for example
in Xenocara driver pages.
ok kristaps@ matthieu@ jmc@

Revision 1.6 / (download) - annotate - [select for diffs], Thu Oct 28 18:13:52 2010 UTC (13 years, 7 months ago) by jmc
Branch: MAIN
Changes since 1.5: +3 -4 lines
Diff to previous 1.5 (colored)

no more groff;

Revision 1.5 / (download) - annotate - [select for diffs], Fri May 14 15:03:01 2010 UTC (14 years ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_4_8_BASE, OPENBSD_4_8
Changes since 1.4: +17 -43 lines
Diff to previous 1.4 (colored)

sync to mandoc 1.9.25:
* remove empty macro lines
* document Ba escape quirk
* update kristaps' mail address

Revision 1.4 / (download) - annotate - [select for diffs], Sun Apr 4 13:41:23 2010 UTC (14 years, 2 months ago) by schwarze
Branch: MAIN
Changes since 1.3: +2 -21 lines
Diff to previous 1.3 (colored)

Adding the pod2man(1) special characters to mandoc_char(7) was a bad idea.
The mandoc_char(7) manual is supposed to document standard characters
for man(7) and mdoc(7), and these are not standard in any sense.
So move the documentation to an implementation-specific manual.

noticed by kristaps@  and merged in 1.9.22
ok jmc@  who also noticed that \*(TH broke the nroff -Tps build

Revision 1.3 / (download) - annotate - [select for diffs], Fri Mar 26 15:16:06 2010 UTC (14 years, 2 months ago) by schwarze
Branch: MAIN
Changes since 1.2: +21 -15 lines
Diff to previous 1.2 (colored)

sync with kristaps@ version of mandoc_char(7) in mdocml-1.9.17

* additional predefined strings needed for Perl manuals,
  now also supported by mandoc(1) - but not recommended for
  general use because they are non-portable
* remove irrelevant STANDARDS

ok jmc@

Revision 1.2 / (download) - annotate - [select for diffs], Wed Jan 6 23:28:13 2010 UTC (14 years, 5 months ago) by schwarze
Branch: MAIN
CVS Tags: OPENBSD_4_7_BASE, OPENBSD_4_7
Changes since 1.1: +27 -27 lines
Diff to previous 1.1 (colored)

miscellaneous cleanup:
* remove bogus '\\' entry, it is not a correct way to render a backslash
* fix column width specifications (problem noted by jmc@
  and cause found by kristaps@)
* mandoc_char(7) is not a utility (noticed by deraadt@)
* improve wording of first sentence (from jmc@)
* add OpenBSD RCS-Id (from jmc@)
* kill whitespace at EOLs (from jmc@)
ok kristaps@,  "formatting looks good now" jmc@

Revision 1.1 / (download) - annotate - [select for diffs], Sun Jan 3 23:29:03 2010 UTC (14 years, 5 months ago) by schwarze
Branch: MAIN

This is not intended to document just the mandoc(1) program, but rather
man(7) and mdoc(7) special characters and predefined strings in general;
just as mandoc(1) is not intending to implement new languages,
but provide standard formatting for man(7) and mdoc(7) files,
whatever "standard" may mean in this context (sigh).
So move this to the right place.

noticed by deraadt@

This form allows you to request diff's between any two revisions of a file. You may select a symbolic revision name using the selection box or you may type in a numeric name using the type-in text box.