Package: anacron
Version: 2.3-37
Severity: minor
Tags: patch
Dear Maintainer,
here are some notes and editorial fixes for the man page.
The patch is in the attachment.
-.-.
The difference between the formatted outputs can be seen with:
nroff -man <file1> > <out1>
nroff -man <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
"groff -man -Z" instead of "nroff -man"
Use "less -R" or similar to read the output of "diff -u".
-.-.
Output from "mandoc -T lint anacron.8":
mandoc: anacron.8:26:38: STYLE: whitespace at end of input line
mandoc: anacron.8:64:93: STYLE: input text line longer than 80 bytes: the
address containe...
mandoc: anacron.8:107:71: STYLE: whitespace at end of input line
mandoc: anacron.8:134:2: WARNING: skipping paragraph macro: PP after SH
mandoc: anacron.8:167:2: WARNING: skipping paragraph macro: PP after SH
mandoc: anacron.8:184:100: STYLE: input text line longer than 80 bytes: Mail
comments, sugge...
mandoc: anacron.8:190:86: STYLE: input text line longer than 80 bytes: The code
base was ma...
mandoc: anacron.8:191:87: STYLE: input text line longer than 80 bytes: During
2004-2006, it...
-.-.
Change '-' (\-) to '\(en' (en-dash) for a numeric range.
GNU gnulib has recently (2023-06-18) updated its
"build_aux/update-copyright" to recognize "\(en" in man pages.
anacron.8:191:During 2004-2006, it was maintained by Pascal Hakim
<pasc@(debian.org|redellipse.net)>.
anacron.8:192:During 2009-2014, it was maintained by Peter Eisentraut
<pet...@debian.org>.
-.-.
Mark a full stop (.) and the exclamation mark (!) with "\&",
if it does not mean an end of a sentence.
This is a preventive action,
the paragraph could be reshaped, e.g., after changes.
When typing, one does not always notice when the line wraps after the
period.
There are too many examples of input lines in manual pages,
that end with an abbreviation point.
This marking is robust, and independent of the position on the line.
It corresponds to "\ " in TeX, and to "@:" in Texinfo.
71:"Active" jobs (i.e. jobs that Anacron already decided
-.-.
Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.
5:.B anacron \fR[\fB-s\fR] [\fB-f\fR] [\fB-n\fR] [\fB-d\fR] [\fB-q\fR]
6:[\fB-t anacrontab\fR] [\fB-S spooldir\fR] [\fIjob\fR] ...
8:.B anacron [\fB-S spooldir\fR] -u [\fB-t anacrontab\fR] \fR[\fIjob\fR] ...
10:.B anacron \fR[\fB-V\fR|\fB-h\fR]
12:.B anacron -T [\fB-t anacrontab\fR]
54:Unless the \fB-d\fR option is given (see below), Anacron forks to the
58:Unless the \fB-s\fR or \fB-n\fR options are given, Anacron starts jobs
78:.B -f
81:.B -u
85:.B -s
89:.B -n
92:file. This options implies \fB-s\fR.
94:.B -d
99:.B -q
100:Suppress messages to standard error. Only applicable with \fB-d\fR.
102:.B -t anacrontab
105:.B -T
110:.B -S spooldir
114:.B -V
117:.B -h
-.-.
Add a comma (or \&) after "e.g." and "i.e.", or use English words
(man-pages(7).
Abbreviation points should be protected against being interpreted as
an end of sentence, if they are not, and that independent of the
current place on the line.
71:"Active" jobs (i.e. jobs that Anacron already decided
-.-.
Wrong distance between sentences.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
106:Anacrontab testing. The configuration file will be tested for validity. If
108:return 1. Valid anacrontabs will return 0.
111:Use the specified spooldir to store timestamps in. This option is required
for
138:On activation, anacron will check if it missed some jobs. If yes, it will
start
144:connected to the computer. It is meant to reduce power usage and extend
148:supply. Please read Debian-specific documentation in
164:This file provides systemd timer for anacron. Currently the service is
187:<schw...@monet.m.isar.de>. The current implementation is a complete rewrite
by
-.-.
Protect a period (.) or a apostrophe (') with '\&' from becoming a
control character, if it could end up at the start of a line (by
splitting the line into more lines).
184:Mail comments, suggestions and bug reports to Sean 'Shaleh' Perry
<shaleh@(debian.org|valinux.com)>.
190:The code base was maintained by Sean 'Shaleh' Perry
<shaleh@(debian.org|valinux.com)>.
-.-.
SYNOPSIS: variable (replaceable) text is typeset in italic, see man-page(7).
-.-.
Spelling:
the Debian Project -> The Deb...
-.-.
Avoid a hyphenation in an email address by using '\%' in front of it.
-.-.
Output from "test-nroff -man -b -ww -z -rCHECKSTYLE=3":
[ "test-groff" is a developmental version of "groff" ]
Input file is ./anacron.8
Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z
-rSTYLECHECK=3":
troff: backtrace: file '<stdin>':26
troff:<stdin>:26: warning: trailing space in the line
troff: backtrace: file '<stdin>':107
troff:<stdin>:107: warning: trailing space in the line
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.3.7-1 (SMP w/2 CPU threads; PREEMPT)
Kernel taint flags: TAINT_WARN
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1),
LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages anacron depends on:
ii libc6 2.37-5
ii lsb-base 11.6
ii sysvinit-utils [lsb-base] 3.07-1
Versions of packages anacron recommends:
ii cron [cron-daemon] 3.0pl1-162
Versions of packages anacron suggests:
ii exim4-daemon-light [mail-transport-agent] 4.96-16
pn powermgmt-base <none>
ii rsyslog [system-log-daemon] 8.2306.0-1
-- no debconf information
The difference between the formatted outputs can be seen with:
nroff -man <file1> > <out1>
nroff -man <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
"groff -man -Z" instead of "nroff -man"
Use "less -R" or similar to read the output from "diff -u".
-.-.
Output from "mandoc -T lint anacron.8":
mandoc: anacron.8:26:38: STYLE: whitespace at end of input line
mandoc: anacron.8:64:93: STYLE: input text line longer than 80 bytes: the
address containe...
mandoc: anacron.8:107:71: STYLE: whitespace at end of input line
mandoc: anacron.8:134:2: WARNING: skipping paragraph macro: PP after SH
mandoc: anacron.8:167:2: WARNING: skipping paragraph macro: PP after SH
mandoc: anacron.8:184:100: STYLE: input text line longer than 80 bytes: Mail
comments, sugge...
mandoc: anacron.8:190:86: STYLE: input text line longer than 80 bytes: The code
base was ma...
mandoc: anacron.8:191:87: STYLE: input text line longer than 80 bytes: During
2004-2006, it...
-.-.
Change '-' (\-) to '\(en' (en-dash) for a numeric range.
GNU gnulib has recently (2023-06-18) updated its
"build_aux/update-copyright" to recognize "\(en" in man pages.
anacron.8:191:During 2004-2006, it was maintained by Pascal Hakim
<pasc@(debian.org|redellipse.net)>.
anacron.8:192:During 2009-2014, it was maintained by Peter Eisentraut
<pet...@debian.org>.
-.-.
Mark a full stop (.) and the exclamation mark (!) with "\&",
if it does not mean an end of a sentence.
This is a preventive action,
the paragraph could be reshaped, e.g., after changes.
When typing, one does not always notice when the line wraps after the
period.
There are too many examples of input lines in manual pages,
that end with an abbreviation point.
This marking is robust, and independent of the position on the line.
It corresponds to "\ " in TeX, and to "@:" in Texinfo.
71:"Active" jobs (i.e. jobs that Anacron already decided
-.-.
Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.
5:.B anacron \fR[\fB-s\fR] [\fB-f\fR] [\fB-n\fR] [\fB-d\fR] [\fB-q\fR]
6:[\fB-t anacrontab\fR] [\fB-S spooldir\fR] [\fIjob\fR] ...
8:.B anacron [\fB-S spooldir\fR] -u [\fB-t anacrontab\fR] \fR[\fIjob\fR] ...
10:.B anacron \fR[\fB-V\fR|\fB-h\fR]
12:.B anacron -T [\fB-t anacrontab\fR]
54:Unless the \fB-d\fR option is given (see below), Anacron forks to the
58:Unless the \fB-s\fR or \fB-n\fR options are given, Anacron starts jobs
78:.B -f
81:.B -u
85:.B -s
89:.B -n
92:file. This options implies \fB-s\fR.
94:.B -d
99:.B -q
100:Suppress messages to standard error. Only applicable with \fB-d\fR.
102:.B -t anacrontab
105:.B -T
110:.B -S spooldir
114:.B -V
117:.B -h
-.-.
Add a comma (or \&) after "e.g." and "i.e.", or use English words
(man-pages(7).
Abbreviation points should be protected against being interpreted as
an end of sentence, if they are not, and that independent of the
current place on the line.
71:"Active" jobs (i.e. jobs that Anacron already decided
-.-.
Wrong distance between sentences.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
106:Anacrontab testing. The configuration file will be tested for validity. If
108:return 1. Valid anacrontabs will return 0.
111:Use the specified spooldir to store timestamps in. This option is required
for
138:On activation, anacron will check if it missed some jobs. If yes, it will
start
144:connected to the computer. It is meant to reduce power usage and extend
148:supply. Please read Debian-specific documentation in
164:This file provides systemd timer for anacron. Currently the service is
187:<schw...@monet.m.isar.de>. The current implementation is a complete rewrite
by
-.-.
Protect a period (.) or a apostrophe (') with '\&' from becoming a
control character, if it could end up at the start of a line (by
splitting the line into more lines).
184:Mail comments, suggestions and bug reports to Sean 'Shaleh' Perry
<shaleh@(debian.org|valinux.com)>.
190:The code base was maintained by Sean 'Shaleh' Perry
<shaleh@(debian.org|valinux.com)>.
-.-.
SYNOPSIS: variable (replaceable) text is typeset in italic, see man-page(7).
-.-.
Spelling:
the Debian Project -> The Deb...
-.-.
Avoid a hyphenation in an email address by using '\%' in front of it.
-.-.
Output from "test-nroff -man -b -ww -z -rCHECKSTYLE=3":
[ "test-groff" is a developmental version of "groff" ]
Input file is ./anacron.8
Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z
-rSTYLECHECK=3":
troff: backtrace: file '<stdin>':26
troff:<stdin>:26: warning: trailing space in the line
troff: backtrace: file '<stdin>':107
troff:<stdin>:107: warning: trailing space in the line
-.-.
