summaryrefslogtreecommitdiffstats
path: root/mandoc_char.7
Commit message (Collapse)AuthorAgeFilesLines
* Since \. is not a character escape sequence, re-classify it from theIngo Schwarze2022-06-021-7/+12
| | | | | | | | | | | | | 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.
* Delete a sentence pointing to "the Predefined Strings subsectionIngo Schwarze2020-10-311-5/+0
| | | | | | 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.
* Digit-width and narrow spaces are non-breaking.Ingo Schwarze2020-02-131-6/+6
| | | | Noticed because Branden Robinson worked on related documentation in groff.
* While we do encourage simplicity in the sense of writing plain '-'Ingo Schwarze2019-03-311-2/+2
| | | | | | | | 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@
* Several improvements to escape sequence handling.Ingo Schwarze2018-12-151-3/+5
| | | | | | | | | | | | | | | | | | | | | | | * 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.
* Fix some issues found looking at groff_char(7):Ingo Schwarze2018-08-211-0/+2
| | | | | | * 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: "~".
* handle the non-portable GNU-style \[charNN], \[charNNN] characterIngo Schwarze2018-08-101-4/+6
| | | | escape sequences, used for example in the groff_char(7) manual page
* Even though we strongly discourage escaping hyphens in manual pagesIngo Schwarze2018-08-081-1/+1
| | | | | in general, when introducing the *typographic* term "hyphen", actually display a real hyphen in output modes supporting it.
* Reorder the text in the "Dashes and Hyphens" subsection to keep theIngo Schwarze2018-08-081-24/+24
| | | | | | simplest and most important instructions together and at the beginning. No text change. Suggested by jmc@.
* Clarify the confusing "(text)" annotation in the character lists.Ingo Schwarze2018-08-081-16/+17
| | | | | | | | | | 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@
* After years of deliberation, finally provide a clear recommendationIngo Schwarze2018-08-081-14/+19
| | | | | | | | 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@
* Soften the language discouraging special character escape sequences.Ingo Schwarze2018-03-151-6/+20
| | | | | | | 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@.
* add the \(ru (0.5m baseline ruler) character escape sequence,Ingo Schwarze2017-06-141-0/+1
| | | | abused by mail/nmh; groff_char(7) confirms that this really exists
* add about 15 missing character escape sequences found in groff_char(7);Ingo Schwarze2017-06-021-4/+24
| | | | triggered by multimedia/mkvtoolnix mkvmerge(1) using \(S2
* Delete the -T xhtml command line option.Ingo Schwarze2017-05-171-3/+1
| | | | | It has been obsolete for more than two years. Use -T html.
* document hyphenationIngo Schwarze2017-02-051-0/+24
|
* Recommend an unambiguous escape for minus signs instead of \-.Ingo Schwarze2015-09-021-5/+5
| | | | | | | | | | | | | | | | | | | | | | 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. from bentley@, ok jmc@ (after reams of discussion)
* Escape punctuation characters that have a different meaning in -Tpdf.Ingo Schwarze2015-03-301-40/+36
| | | | | | | | ~, `, 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. Patch from bentley@.
* oops, forgot to apply the actual patch...Ingo Schwarze2015-03-271-0/+22
|
* Document that certain stand-alone accents need escaping in rare cases toIngo Schwarze2015-03-271-1/+1
| | | | | prevent them from being converted to Unicode replacements in PDF output. Issue found by bentley@, OK jmc@ bentley@.
* change spelling of centre to center: consistent with other man pagesIngo Schwarze2015-01-201-1/+1
| | | | and the name of the syntax elements being described; from tedu@
* correct -Tutf8 and -Thtml rendering of \(~=Ingo Schwarze2014-12-161-5/+5
| | | | | and change the name of \(-~ to \(|= to agree with groff; difference found by Carsten dot Kunze at arcor dot de
* correct some character names to match groff;Ingo Schwarze2014-12-151-8/+8
| | | | reported by Carsten dot Kunze at arcor dot de
* Rework the documentation of Spaces, using the Ossanna/Kernighan/RitterIngo Schwarze2013-12-261-20/+20
| | | | | | | | | | | | | | | | 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.
* Document the alternative syntax \C'uXXXX' for Unicode characters.Ingo Schwarze2013-12-221-3/+3
| | | | Forgotten when committing mandoc.c rev. 1.70.
* clarify that \[uXXXX] wants uppercase hex digitsIngo Schwarze2013-11-101-1/+6
|
* For citing the names and email addresses of authors,Ingo Schwarze2013-07-131-2/+1
| | | | | | | consistently use the style ".An name Aq Mt email". Triggered by a question from Jan Stary <hans at stare dot cz>, ok jmc@.
* - (mdoc.7) fix Xr to selfIngo Schwarze2013-04-281-1/+1
| | | | | - double word fix from jmc@
* Fix whitespace in manuals.Kristaps Dzonsons2011-11-231-1/+1
|
* Add lots of information about special characters that's actually neededIngo Schwarze2011-11-141-40/+175
| | | | | | in practice, and discourage using fancy characters in manuals. Text about "Dashes and Hyphens" by jmc@. Feedback and ok jmc@, grudgingly ok kristaps@.
* Order -column lists to have the arguments follow `-column'. From aKristaps Dzonsons2011-08-301-18/+18
| | | | patch by Jason McIntyre.
* Remove unnecessary `Pp'/`-compat' combination for column lists.Kristaps Dzonsons2011-08-301-2/+1
| | | | Directly from a patch by Jason McIntyre.
* Replace the old `An'/`Aq' AUTHORS note with `An'/`Mt'.Kristaps Dzonsons2011-08-181-1/+2
|
* Add support for 1/2, 1/4, and 3/4 (needed by eqn).Kristaps Dzonsons2011-07-221-0/+3
|
* Support groff's escape for Unicode input. SeeKristaps Dzonsons2011-05-151-0/+14
| | | | | | http://mdocml.bsd.lv/archives/tech/0368.html For the time being, we just throw it away.
* Document the fact that \N'' accepts only printable characters.Kristaps Dzonsons2011-05-011-0/+3
|
* Add \*(Ai (ANSI) and \*(Px (POSIX) predefined strings, which are part ofKristaps Dzonsons2011-04-201-2/+9
| | | | | | groff's tmac.doc package. Originally noted by Matthew Dempsky. Feedback by Jason McIntyre, joerg@, and schwarze@. Also add some documentation about predefined strings, tweaked by schwarze@.
* Clean up the COMPATIBILITY section;Ingo Schwarze2011-02-091-22/+30
| | | | | | | | | 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@
* Implement the \N'number' (numbered character) roff escape sequence.Ingo Schwarze2011-01-301-0/+15
| | | | | | | 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@ jmc@ and tested by Matthieu Herrb (matthieu at openbsd dot org)
* Remove a left-over ".Xr groff 1"; patch from jmc@.Ingo Schwarze2010-10-291-2/+1
|
* Fix quoting of bar: \*(Ba mapping "|" is dumb, dumb, dumb (thanks groff).Kristaps Dzonsons2010-05-121-1/+1
|
* Noted \*(Ba side effects.Kristaps Dzonsons2010-05-091-0/+11
|
* Fixed ugly formatting of mandoc_char.7 in groff (-column widths were using ↵Kristaps Dzonsons2010-05-091-2/+2
| | | | an escape, which groff understands but mandoc doesn't).
* As per Jason McIntyre's heartful urgings, do away with '.' separators ↵Kristaps Dzonsons2010-04-131-39/+2
| | | | | | between logical sections. Change email address to BSD.lv one (this is not an academic project...)
* Make mathematical symbols have a longer first-column width (pointed out by ↵Kristaps Dzonsons2010-04-051-1/+1
| | | | Joerg Sonnenberger).
* Escape TH -> Th (noticed by Joerg Sonnenberger).Kristaps Dzonsons2010-03-301-19/+0
| | | | Moved pod2man escapes into man.3 (they're not part of -man or -mdoc, technically).
* Added stupid pod2man reserved strings.Kristaps Dzonsons2010-03-231-0/+19
|
* Removed STANDARDS in mandoc_char(7), as they're no longer relevant (the ↵Kristaps Dzonsons2010-03-221-13/+0
| | | | manual deals with input characters, not output formats).
* mandoc_char(7) sync with OpenBSD version.Kristaps Dzonsons2010-01-071-1/+1
|
* Fixed -column widths to be string literals (as per mdoc.samples: surprise!). ↵Kristaps Dzonsons2010-01-051-25/+25
| | | | | | | (Jason McIntyre, Ingo Schwarze) Remove trailing whitespace. (Jason McIntyre, Ingo Schwarze). Remove reference to `\\', which is a groff strangeism. (Jason McIntyre, Ingo Schwarze).
generated by cgit (git 2.34.1) at 2024-10-01 05:03:40 +0000