Nodejs/node
1
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2024-11-21 10:59:27 +00:00
Code Issues Actions 25 Packages Projects Releases Wiki Activity

doc: fix display of "problematic" ASCII characters

Browse Source 
When preparing output for a terminal that supports Unicode, Groff remaps
the following characters to typographically "fancier" versions:

    ^ (U+005E)  ->  ˆ (U+02C6)
    ~ (U+007E)  ->  ˜ (U+02DC)
    - (U+002D)  ->  ‐ (U+2010)
    ` (U+0060)  ->  ‘ (U+2018)
    ' (U+0027)  ->  ’ (U+2019)

This transformation is normally desirable in high-quality typeset output
(PDF and PostScript), but frequently problematic in terminal display. As
described in groff_char(7), the following escape sequences are needed to
display the aforementioned characters as they appear in source code:

    ^   ->   \(ha   (Mnemonic: "hat")
    ~   ->   \(ti   (Mnemonic: "tilde")
    -   ->   \-
    `   ->   \(ga   (Mnemonic: "grave accent")
    '   ->   \(aq   (Mnemonic: "apostrophe quote")

These constructs are cumbersome to write, obstruct readability of source
code, and are completely opaque to the majority of man page authors (who
only care about terminal display). A simpler solution is to use `.tr` to
translate these characters automatically.

PR-URL: https://github.com/nodejs/node/pull/44373
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
John Gardner 2022-10-22 02:11:37 +11:00 committed by GitHub
parent ee07e6632c
commit 9dddc6acb0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/node.1
View File

@ -26,6 +26,7 @@
.\"
.\"======================================================================
.
.tr -\-^\(ha~\(ti`\(ga
.Dd 2018
.Dt NODE 1
.