Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: fix display of "problematic" ASCII characters #44373

Merged
merged 1 commit into from Oct 21, 2022
Merged

doc: fix display of "problematic" ASCII characters #44373

merged 1 commit into from Oct 21, 2022

Commits on Aug 24, 2022

  1. doc: fix display of "problematic" ASCII characters

    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.
    Alhadis committed Aug 24, 2022
    Copy the full SHA
    72adfd6 View commit details
    Browse the repository at this point in the history