Description
Debian's Lintian tool produces warnings about SDL's generated man pages. One category of these warnings is that man pages like SDL_GetBasePath(3)
mention a literal backslash (the Windows path separator) as '\\'
, but https://lintian.debian.org/tags/acute-accent-in-manual-page.html and https://manpages.debian.org/bookworm/groff/groff_man.7.en.html recommend encoding these as \e
:
\e: Widely used in man pages to represent a backslash output glyph. It works reliably as long as the
.ec
request is not used, which should never happen in man pages, and it is slightly more portable than the more exact\(rs
(“reverse solidus”) escape sequence.
(Yes, the de facto standard man page format is a disaster area: formally it's a combination of several collections of 1970s/1980s typesetting macros, but there are also tools that attempt to parse man pages without implementing the whole roff macro language.)