Insufficient escaping in generated man page

Question

Insufficient escaping in generated man page

wferi opened this issue 4 years ago · 4 comments

The ... in the qbarray.h example gets into the v2.0.2 man page unescaped, leading to the

$ man --warnings ./qbarray.h.3.gz >/dev/null
troff: <standard input>:13: warning: macro '..' not defined

and it's indeed missing from the output. In the v2.0.1 man page it's protected as \&.\&.\&. (which is arguably too much caution) and appears correctly.

Answer 1 · 2021-01-04T10:06:02.000Z

Are you sure that 2.0.1 quoted the dots like that? docygen2man in 2.0.1 didn't support @code blocks so that part of the doc wouldn't have been in the man page anyway (and isn't on my checkout of the v2.0.1 tag).

Anyway, simplest solution is to add a format before the ellipsis so that nroff doesn't look for a macro
#431

Answer 2 · 2021-01-04T11:26:36.000Z

Sorry, I mixed up the version numbers. It's 1.0.5 which employs \&.\&.\&. in qbarray.h.3.gz.

Answer 3 · 2021-01-04T11:27:52.000Z

ahh that makes a lot more sense :)

Answer 4 · 2021-03-26T08:05:44.000Z

Fixed in 47ed440