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

manpage autogeneration: Problem with escaping backslashes #1398

Closed
buhtz opened this issue Jan 16, 2023 · 0 comments · Fixed by #1433
Closed

manpage autogeneration: Problem with escaping backslashes #1398

buhtz opened this issue Jan 16, 2023 · 0 comments · Fixed by #1433
Assignees
Labels
Bug Cosmetics appearance, icons, themes Documentation Infrastructure Low relevant, but not urgent Reproduced
Milestone

Comments

@buhtz
Copy link
Member

buhtz commented Jan 16, 2023

Related to the packaging process at Debian I was pointed to a tiny problem with the manpages which maybe caused by the script create-manpage-backintime-config.py that auto-generates the manpage.

.IP "\fIprofile<N>.snapshots.ssh.prefix.value\fR" 6
.RS
Type: str Allowed Values: text
.br
Prefix to run before every command on remote host. Variables need to be escaped with \\$FOO. This doesn't touch rsync. So to add a prefix for rsync use \fIprofile<N>.snapshots.rsync_options.value\fR with --rsync-path="FOO=bar:\\$FOO /usr/bin/rsync"
.PP
Default: 'PATH=/opt/bin:/opt/sbin:\\\$PATH'
.RE

Line 734 has three \ but it should be only two.

Default: 'PATH=/opt/bin:/opt/sbin:\\\$PATH'
                                  ^^^

That line is generated from that value where are only two \:

DEFAULT_SSH_PREFIX = 'PATH=/opt/bin:/opt/sbin:\\$PATH'
                                              ^^

I will look into the script later and fix it.

Lintian does use this command to check such manpages.

$ LC_ALL=C.UTF-8 MANROFFSEQ='' MANWIDTH=80 man --warnings -E UTF-8 -l -Tutf8 -Z "backintime-config.1" > /dev/null

troff: <standard input>:734: bad argument name 'P'
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Cosmetics appearance, icons, themes Documentation Infrastructure Low relevant, but not urgent Reproduced
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant