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

Fix troff warnings in manpages #8

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

davidpolverari
Copy link

Hi James! While packaging voacapl for Debian, its package checker (lintian) found some warnings caused by voacap manpages:

  • troff does not allow newline characters in an escape name.
  • it treats lines starting with an apostrophe as a control line, that can be followed by a macro call.

This patch, in the case you merge it, replaces lines containing \n by .br, and uses \(aq instead of apostrophes on the beginning of a line.

The warnings emitted by troff can be seen using the following command:

LC_ALL=C.UTF-8 MANROFFSEQ='' MANWIDTH=80 \
	man --warnings -E UTF-8 -l -Tutf8 -Z man/voacapl.1 > /dev/null

Newline characters are not allowed in an escape name. Also, troff treats
lines starting with an apostrophe as a control line, that can be
followed by a macro call.

To avoid this, this patch replaces lines containing \n by .br, and uses
\(aq instead of apostrophes on the beginning of a line.

The warnings emitted by troff can be seen using the following command:

LC_ALL=C.UTF-8 MANROFFSEQ='' MANWIDTH=80 \
	man --warnings -E UTF-8 -l -Tutf8 -Z man/voacapl.1 > /dev/null
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant