diff options
| author | Ingo Schwarze <schwarze@cvs.openbsd.org> | 2018-03-15 18:09:01 +0000 |
|---|---|---|
| committer | Ingo Schwarze <schwarze@cvs.openbsd.org> | 2018-03-15 18:09:01 +0000 |
| commit | 0a243367bf8b3d839ed2576fa8cac4d58fe3e7fe (patch) | |
| tree | 3a30cf0ff45b59ed155836b2424274e9fb0901db /share/man | |
| parent | 90ac261f6bbcc738d4843a61546f1e1a4d116029 (diff) | |
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@.
Diffstat (limited to 'share/man')
| -rw-r--r-- | share/man/man7/mandoc_char.7 | 30 |
1 files changed, 22 insertions, 8 deletions
diff --git a/share/man/man7/mandoc_char.7 b/share/man/man7/mandoc_char.7 index ff171435ad1..ed51a1e6f28 100644 --- a/share/man/man7/mandoc_char.7 +++ b/share/man/man7/mandoc_char.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mandoc_char.7,v 1.32 2017/06/14 20:56:42 schwarze Exp $ +.\" $OpenBSD: mandoc_char.7,v 1.33 2018/03/15 18:09:00 schwarze Exp $ .\" .\" Copyright (c) 2003 Jason McIntyre <jmc@openbsd.org> .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> @@ -16,7 +16,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: June 14 2017 $ +.Dd $Mdocdate: March 15 2018 $ .Dt MANDOC_CHAR 7 .Os .Sh NAME @@ -35,13 +35,27 @@ documents. .Pp The rendering depends on the .Xr mandoc 1 -output mode; in ASCII output, most characters are completely -unintelligible. -For that reason, using any of the special characters documented here, -except those discussed in the +output mode; it can be inspected by calling +.Xr man 1 +on 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 , -is strongly discouraged; they are supported merely for backwards -compatibility with existing documents. +unless they are essential for explaining the subject matter at hand, +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 |