Package: apt
Version: 2.9.29
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with a new version
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z < "man
page"
[Use "groff -e ' $' -e '\\~$' <file>" to find obvious trailing spaces.]
["test-groff" is a script in the repository for "groff"; is not shipped]
(local copy and "troff" slightly changed by me).
[The fate of "test-nroff" was decided in groff bug #55941.]
* What was the outcome of this action?
troff:<stdin>:34: warning: trailing space in the line
troff:<stdin>:36: warning: trailing space in the line
* What outcome did you expect instead?
No output (no warnings).
-.-
General remarks and further material, if a diff-file exist, are in the
attachments.
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.12.12-amd64 (SMP w/2 CPU threads; PREEMPT)
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 apt depends on:
ii adduser 3.137
ii base-passwd 3.6.6
ii debian-archive-keyring 2023.4
ii libapt-pkg6.0t64 2.9.29
ii libc6 2.40-6
ii libgcc-s1 14.2.0-16
ii libseccomp2 2.5.5-2
ii libssl3t64 3.4.1-1
ii libstdc++6 14.2.0-16
ii libsystemd0 257.3-1
ii sqv 1.2.1-6+b1
Versions of packages apt recommends:
ii ca-certificates 20241223
Versions of packages apt suggests:
ii apt-doc 2.9.29
ii aptitude 0.8.13-6.1
ii dpkg-dev 1.22.15
ii gnupg 2.2.46-1
pn powermgmt-base <none>
-- no debconf information
Input file is apt-mark.8
Output from "mandoc -T lint apt-mark.8": (shortened list)
2 empty block: RS
1 input text line longer than 80 bytes: Configuration File; ...
1 input text line longer than 80 bytes: Set a Configuration ...
1 input text line longer than 80 bytes: Show audit (and noti...
1 input text line longer than 80 bytes: When you request tha...
1 input text line longer than 80 bytes: can be used as a uni...
1 input text line longer than 80 bytes: can be used to apply...
1 input text line longer than 80 bytes: is used to cancel a ...
1 input text line longer than 80 bytes: is used to mark (tra...
3 input text line longer than 80 bytes: is used to mark a pa...
2 input text line longer than 80 bytes: is used to print a l...
1 input text line longer than 80 bytes: respectively\&. More...
1 input text line longer than 80 bytes: selections such as h...
10 skipping paragraph macro: PP after SH
1 skipping paragraph macro: PP after SS
2 whitespace at end of input line
Remove trailing space with: sed -e 's/ *$//'
-.-.
Output from "test-groff -mandoc -t -ww -z apt-mark.8": (shortened list)
2 trailing space in the line
Remove trailing space with: sed -e 's/ *$//'
-.-.
Show if docman-to-man created this.
Who is actually creating this man page? Debian or upstream?
Is the generating software out of date?
4:.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.-.
Remove space characters (whitespace) at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
Number of lines affected is
2
-.-.
Wrong distance between sentences in the input file.
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.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
Mark a final abbreviation point as such by suffixing it with "\&".
Some sentences (etc.) do not begin on a new line.
Split (sometimes) lines after a punctuation mark; before a conjunction.
Lines with only one (or two) space(s) between sentences could be split,
so latter sentences begin on a new line.
34:\fBapt\-mark\fR {\fB\-f=\fR\fB\fIfilename\fR\fR | {auto\ |\ manual}\
\fIpkg\fR... | {showauto\ |\ showmanual}\ [\fIpkg\fR...] } | {\-v\ |\
\-\-version} | {\-h\ |\ \-\-help}
36:\fBapt\-mark\fR {hold\ |\ unhold\ |\ install\ |\ remove\ |\ purge}\
\fIpkg\fR... | {showhold\ |\ showinstall\ |\ showremove\ |\ showpurge}\
[\fIpkg\fR...]
42:selections such as hold, install, deinstall and purge which are respected
e\&.g\&. by
48:When you request that a package is installed, and as a result other packages
are installed to satisfy its dependencies, the dependencies are marked as being
automatically installed, while the package you installed explicitly is marked
as manually installed\&. Once an automatically installed package is no longer
depended on by any manually installed package it is considered no longer needed
and e\&.g\&.
69:is used to mark (transitive) dependencies of metapackages as automatically
installed\&. This can be used after an installation for example, to minimize
the number of manually installed packages; or continuously on systems managed
by system configuration metapackages\&.
75:is used to print a list of automatically installed packages with each
package on a new line\&. All automatically installed packages will be listed if
no package is given\&. If packages are given only those which are automatically
installed will be shown\&.
119:can be used to apply previously scheduled changes to the install state of
packages\&. Such changes can be scheduled with the
125:commands\&. Packages with a specific selection can be displayed with
130:respectively\&. More information about these so called dpkg selections can
be found in
146:Show audit (and notice) messages\&. This overrides the quiet option, but
only for notice messages, not progress ones\&.
151:Configuration File; Specify a configuration file to use\&. The program will
read the default configuration file and then this configuration file\&. If
configuration settings need to be set before the default configuration files
are parsed specify a file with the
153:environment variable\&. See
160:Set a Configuration Option; This will set an arbitrary configuration
option\&. The syntax is
170:Turn colors on or off\&. Colors are on by default on supported terminals for
186:Status list of auto\-installed packages\&. Configuration Item:
200:\m[blue]\fBAPT bug page\fR\m[]\&\s-2\u[1]\d\s+2\&. If you wish to report a
bug in APT, please see
-.-.
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Add "\:" to split the string for the output, "\<newline>" in the source.
Line 34, length 174
\fBapt\-mark\fR {\fB\-f=\fR\fB\fIfilename\fR\fR | {auto\ |\ manual}\
\fIpkg\fR... | {showauto\ |\ showmanual}\ [\fIpkg\fR...] } | {\-v\ |\
\-\-version} | {\-h\ |\ \-\-help}
Line 36, length 157
\fBapt\-mark\fR {hold\ |\ unhold\ |\ install\ |\ remove\ |\ purge}\
\fIpkg\fR... | {showhold\ |\ showinstall\ |\ showremove\ |\ showpurge}\
[\fIpkg\fR...]
Line 40, length 154
can be used as a unified front\-end to set various settings for a package, such
as marking a package as being automatically/manually installed or changing
Line 42, length 85
selections such as hold, install, deinstall and purge which are respected
e\&.g\&. by
Line 48, length 405
When you request that a package is installed, and as a result other packages
are installed to satisfy its dependencies, the dependencies are marked as being
automatically installed, while the package you installed explicitly is marked
as manually installed\&. Once an automatically installed package is no longer
depended on by any manually installed package it is considered no longer needed
and e\&.g\&.
Line 57, length 169
is used to mark a package as being automatically installed, which will cause
the package to be removed when no more manually installed packages depend on
this package\&.
Line 63, length 155
is used to mark a package as being manually installed, which will prevent the
package from being automatically removed if no other packages depend on it\&.
Line 69, length 269
is used to mark (transitive) dependencies of metapackages as automatically
installed\&. This can be used after an installation for example, to minimize
the number of manually installed packages; or continuously on systems managed
by system configuration metapackages\&.
Line 75, length 256
is used to print a list of automatically installed packages with each package
on a new line\&. All automatically installed packages will be listed if no
package is given\&. If packages are given only those which are automatically
installed will be shown\&.
Line 101, length 129
is used to mark a package as held back, which will prevent the package from
being automatically installed, upgraded or removed\&.
Line 107, length 82
is used to cancel a previously set hold on a package to allow all actions
again\&.
Line 113, length 93
is used to print a list of packages on hold in the same way as for the other
show commands\&.
Line 119, length 124
can be used to apply previously scheduled changes to the install state of
packages\&. Such changes can be scheduled with the
Line 130, length 86
respectively\&. More information about these so called dpkg selections can be
found in
Line 146, length 119
Show audit (and notice) messages\&. This overrides the quiet option, but only
for notice messages, not progress ones\&.
Line 151, length 262
Configuration File; Specify a configuration file to use\&. The program will
read the default configuration file and then this configuration file\&. If
configuration settings need to be set before the default configuration files
are parsed specify a file with the
Line 160, length 92
Set a Configuration Option; This will set an arbitrary configuration option\&.
The syntax is
Line 200, length 97
\m[blue]\fBAPT bug page\fR\m[]\&\s-2\u[1]\d\s+2\&. If you wish to report a bug
in APT, please see
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
apt-mark.8:146:Show audit (and notice) messages\&. This overrides the quiet
option, but only for notice messages, not progress ones\&.
-.-.
No need for "\&" to be in front of a period (.),
if there is a character in front of it
Remove with "sed -e 's/\\&\././g'".
42:selections such as hold, install, deinstall and purge which are respected
e\&.g\&. by
45:\fBaptitude\fR\&.
48:When you request that a package is installed, and as a result other packages
are installed to satisfy its dependencies, the dependencies are marked as being
automatically installed, while the package you installed explicitly is marked
as manually installed\&. Once an automatically installed package is no longer
depended on by any manually installed package it is considered no longer needed
and e\&.g\&.
52:will at least suggest removing them\&.
57:is used to mark a package as being automatically installed, which will cause
the package to be removed when no more manually installed packages depend on
this package\&.
63:is used to mark a package as being manually installed, which will prevent
the package from being automatically removed if no other packages depend on
it\&.
69:is used to mark (transitive) dependencies of metapackages as automatically
installed\&. This can be used after an installation for example, to minimize
the number of manually installed packages; or continuously on systems managed
by system configuration metapackages\&.
75:is used to print a list of automatically installed packages with each
package on a new line\&. All automatically installed packages will be listed if
no package is given\&. If packages are given only those which are automatically
installed will be shown\&.
83:except that it will print a list of manually installed packages instead\&.
94:Dir::State\&.
101:is used to mark a package as held back, which will prevent the package from
being automatically installed, upgraded or removed\&.
107:is used to cancel a previously set hold on a package to allow all actions
again\&.
113:is used to print a list of packages on hold in the same way as for the
other show commands\&.
119:can be used to apply previously scheduled changes to the install state of
packages\&. Such changes can be scheduled with the
125:commands\&. Packages with a specific selection can be displayed with
130:respectively\&. More information about these so called dpkg selections can
be found in
131:\fBdpkg\fR(1)\&.
136:Show a short usage summary\&.
141:Show the program version\&.
146:Show audit (and notice) messages\&. This overrides the quiet option, but
only for notice messages, not progress ones\&.
151:Configuration File; Specify a configuration file to use\&. The program will
read the default configuration file and then this configuration file\&. If
configuration settings need to be set before the default configuration files
are parsed specify a file with the
153:environment variable\&. See
155:for syntax information\&.
160:Set a Configuration Option; This will set an arbitrary configuration
option\&. The syntax is
161:\fB\-o Foo::Bar=bar\fR\&.
165:can be used multiple times to set different options\&.
170:Turn colors on or off\&. Colors are on by default on supported terminals for
180:for information on that\&.
186:Status list of auto\-installed packages\&. Configuration Item:
187:Dir::State::extended_states\&.
197:returns zero on normal operation, non\-zero on error\&.
200:\m[blue]\fBAPT bug page\fR\m[]\&\s-2\u[1]\d\s+2\&. If you wish to report a
bug in APT, please see
201:/usr/share/doc/debian/bug\-reporting\&.txt
204:command\&.
-.-.
Remove quotes when there is a printable
but no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.
10:.TH "APT\-MARK" "8" "14\ \&September\ \&2024" "APT 2.9.29" "APT"
30:.SH "NAME"
32:.SH "SYNOPSIS"
37:.SH "DESCRIPTION"
85:.SS "Options"
132:.SH "OPTIONS"
182:.SH "FILES"
194:.SH "DIAGNOSTICS"
198:.SH "BUGS"
205:.SH "AUTHORS"
214:.SH "NOTES"
-.-.
Use ".na" (no adjustment) instead of ".ad l" (and ".ad" to begin the
same adjustment again as before).
26:.ad l
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:34: warning: trailing space in the line
troff:<stdin>:36: warning: trailing space in the line
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- apt-mark.8 2025-02-21 23:16:32.961408972 +0000
+++ apt-mark.8.new 2025-02-22 00:05:15.482366241 +0000
@@ -7,7 +7,7 @@
.\" Source: APT 2.9.29
.\" Language: English
.\"
-.TH "APT\-MARK" "8" "14\ \&September\ \&2024" "APT 2.9.29" "APT"
+.TH APT\-MARK 8 "14\ \&September\ \&2024" "APT 2.9.29" APT
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -23,56 +23,83 @@
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
-.ad l
+.na
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
-.SH "NAME"
+.SH NAME
apt-mark \- show, set and unset various settings for a package
-.SH "SYNOPSIS"
+.SH SYNOPSIS
.HP \w'\fBapt\-mark\fR\ 'u
-\fBapt\-mark\fR {\fB\-f=\fR\fB\fIfilename\fR\fR | {auto\ |\ manual}\
\fIpkg\fR... | {showauto\ |\ showmanual}\ [\fIpkg\fR...] } | {\-v\ |\
\-\-version} | {\-h\ |\ \-\-help}
+\fBapt\-mark\fR {\fB\-f=\fR\fB\fIfilename\fR\fR | {auto\ |\ manual}
+\fIpkg\fR...\& | {showauto\ |\ showmanual}\ [\fIpkg\fR...] } | {\-v\ |
+\-\-version} | {\-h\ |\ \-\-help}
.HP \w'\fBapt\-mark\fR\ 'u
-\fBapt\-mark\fR {hold\ |\ unhold\ |\ install\ |\ remove\ |\ purge}\
\fIpkg\fR... | {showhold\ |\ showinstall\ |\ showremove\ |\ showpurge}\
[\fIpkg\fR...]
-.SH "DESCRIPTION"
-.PP
+\fBapt\-mark\fR {hold\ |\ unhold\ |\ install\ |\ remove\ |\ purge} \
+\fIpkg\fR...\& | {showhold\ |\ showinstall\ |\ showremove\ |\ showpurge} \
+[\fIpkg\fR...]
+.SH DESCRIPTION
\fBapt\-mark\fR
-can be used as a unified front\-end to set various settings for a package,
such as marking a package as being automatically/manually installed or changing
+can be used as a unified front\-end to set various settings for a package,
+such as marking a package as being automatically/manually installed
+or changing
\fBdpkg\fR
-selections such as hold, install, deinstall and purge which are respected
e\&.g\&. by
+selections such as hold,
+install, deinstall
+and purge which are respected e.g.\& by
\fBapt\-get dselect\-upgrade\fR
or
-\fBaptitude\fR\&.
-.SH "AUTOMATICALLY AND MANUALLY INSTALLED PACKAGES"
-.PP
-When you request that a package is installed, and as a result other packages
are installed to satisfy its dependencies, the dependencies are marked as being
automatically installed, while the package you installed explicitly is marked
as manually installed\&. Once an automatically installed package is no longer
depended on by any manually installed package it is considered no longer needed
and e\&.g\&.
+\fBaptitude\fR.
+.SH AUTOMATICALLY AND MANUALLY INSTALLED PACKAGES
+When you request that a package is installed,
+and as a result other packages are installed to satisfy its dependencies,
+the dependencies are marked as being automatically installed,
+while the package you installed explicitly is marked as manually installed.
+Once an automatically installed package is no longer depended on by any
+manually installed package
+it is considered no longer needed and e.g.\&
\fBapt\-get\fR
or
\fBaptitude\fR
-will at least suggest removing them\&.
+will at least suggest removing them.
.PP
\fBauto\fR
.RS 4
auto
-is used to mark a package as being automatically installed, which will cause
the package to be removed when no more manually installed packages depend on
this package\&.
+is used to mark a package as being automatically installed,
+which will cause the package to be removed
+when no more manually installed packages depend on this package.
.RE
.PP
\fBmanual\fR
.RS 4
manual
-is used to mark a package as being manually installed, which will prevent the
package from being automatically removed if no other packages depend on it\&.
+is used to mark a package as being manually installed,
+which will prevent the package from being automatically removed
+if no other packages depend on it.
.RE
.PP
\fBminimize\-manual\fR
.RS 4
minimize\-manual
-is used to mark (transitive) dependencies of metapackages as automatically
installed\&. This can be used after an installation for example, to minimize
the number of manually installed packages; or continuously on systems managed
by system configuration metapackages\&.
+is used to mark
+(transitive)
+dependencies of metapackages as automatically installed.
+This can be used after an installation for example,
+to minimize the number of manually installed packages;
+or continuously on systems managed by system configuration metapackages.
.RE
.PP
\fBshowauto\fR
.RS 4
showauto
-is used to print a list of automatically installed packages with each package
on a new line\&. All automatically installed packages will be listed if no
package is given\&. If packages are given only those which are automatically
installed will be shown\&.
+is used to print a list of automatically installed packages
+with each package on a new line.
+All automatically installed packages will be listed if no package is given.
+If packages are given,
+only those,
+which are automatically installed,
+will be shown.
.RE
.PP
\fBshowmanual\fR
@@ -80,10 +107,9 @@ is used to print a list of automatically
showmanual
can be used in the same way as
showauto
-except that it will print a list of manually installed packages instead\&.
+except that it will print a list of manually installed packages instead.
.RE
-.SS "Options"
-.PP
+.SS Options
\fB\-f=\fR\fB\fIfilename\fR\fR, \fB\-\-file=\fR\fB\fIfilename\fR\fR
.RS 4
Read/Write package stats from the filename given with the parameter
@@ -91,83 +117,102 @@ Read/Write package stats from the filena
instead of from the default location, which is
extended_states
in the directory defined by the Configuration Item:
-Dir::State\&.
+Dir::State.
.RE
-.SH "PREVENT CHANGES FOR A PACKAGE"
-.PP
+.SH PREVENT CHANGES FOR A PACKAGE
\fBhold\fR
.RS 4
hold
-is used to mark a package as held back, which will prevent the package from
being automatically installed, upgraded or removed\&.
+is used to mark a package as held back,
+which will prevent the package from being automatically installed,
+upgraded or removed.
.RE
.PP
\fBunhold\fR
.RS 4
unhold
-is used to cancel a previously set hold on a package to allow all actions
again\&.
+is used to cancel a previously set hold on a package
+to allow all actions again.
.RE
.PP
\fBshowhold\fR
.RS 4
showhold
-is used to print a list of packages on hold in the same way as for the other
show commands\&.
+is used to print a list of packages on hold
+in the same way as for the other show commands.
.RE
-.SH "SCHEDULE PACKAGES FOR INSTALL, REMOVE AND PURGE"
-.PP
+.SH SCHEDULE PACKAGES FOR INSTALL, REMOVE AND PURGE
Some front\-ends like
\fBapt\-get dselect\-upgrade\fR
-can be used to apply previously scheduled changes to the install state of
packages\&. Such changes can be scheduled with the
+can be used to apply previously scheduled changes to the install state of
+packages.
+Such changes can be scheduled with the
\fBinstall\fR,
\fBremove\fR
(also known as
\fBdeinstall\fR) and
\fBpurge\fR
-commands\&. Packages with a specific selection can be displayed with
+commands.
+Packages with a specific selection can be displayed with
\fBshowinstall\fR,
\fBshowremove\fR
and
\fBshowpurge\fR
-respectively\&. More information about these so called dpkg selections can be
found in
-\fBdpkg\fR(1)\&.
-.SH "OPTIONS"
-.PP
+respectively.
+More information about these so called dpkg selections can be found in
+\fBdpkg\fR(1).
+.SH OPTIONS
\fB\-h\fR, \fB\-\-help\fR
.RS 4
-Show a short usage summary\&.
+Show a short usage summary.
.RE
.PP
\fB\-v\fR, \fB\-\-version\fR
.RS 4
-Show the program version\&.
+Show the program version.
.RE
.PP
\fB\-\-audit\fR
.RS 4
-Show audit (and notice) messages\&. This overrides the quiet option, but only
for notice messages, not progress ones\&.
+Show audit
+(and notice)
+messages.
+This overrides the quiet option,
+but only for notice messages, not progress ones.
.RE
.PP
\fB\-c\fR, \fB\-\-config\-file\fR
.RS 4
-Configuration File; Specify a configuration file to use\&. The program will
read the default configuration file and then this configuration file\&. If
configuration settings need to be set before the default configuration files
are parsed specify a file with the
+Configuration File;
+Specify a configuration file to use.
+The program will read the default configuration file
+and then this configuration file.
+If configuration settings need to be set,
+before the default configuration files are parsed,
+specify a file with the
\fBAPT_CONFIG\fR
-environment variable\&. See
+environment variable.
+See
\fBapt.conf\fR(5)
-for syntax information\&.
+for syntax information.
.RE
.PP
\fB\-o\fR, \fB\-\-option\fR
.RS 4
-Set a Configuration Option; This will set an arbitrary configuration option\&.
The syntax is
-\fB\-o Foo::Bar=bar\fR\&.
+Set a Configuration Option;
+This will set an arbitrary configuration option.
+The syntax is
+\fB\-o Foo::Bar=bar\fR.
\fB\-o\fR
and
\fB\-\-option\fR
-can be used multiple times to set different options\&.
+can be used multiple times to set different options.
.RE
.PP
\fB\-\-no\-color\fR, \fB\-\-color\fR
.RS 4
-Turn colors on or off\&. Colors are on by default on supported terminals for
+Turn colors on or off.
+Colors are on by default on supported terminals for
\fBapt\fR(8)
and can also be disabled using the
\fBNO_COLOR\fR
@@ -177,41 +222,34 @@ environment variables, or further config
\fBAPT::Color\fR
configuration option and scope, see
\fBapt.conf\fR(5)
-for information on that\&.
+for information on that.
.RE
-.SH "FILES"
-.PP
+.SH FILES
/var/lib/apt/extended_states
.RS 4
-Status list of auto\-installed packages\&. Configuration Item:
-Dir::State::extended_states\&.
+Status list of auto\-installed packages.
+Configuration Item:
+Dir::State::extended_states.
.RE
-.SH "SEE ALSO"
-.PP
+.SH SEE ALSO
\fBapt-get\fR(8),
\fBaptitude\fR(8),
\fBapt.conf\fR(5)
-.SH "DIAGNOSTICS"
-.PP
+.SH DIAGNOSTICS
\fBapt\-mark\fR
-returns zero on normal operation, non\-zero on error\&.
-.SH "BUGS"
-.PP
-\m[blue]\fBAPT bug page\fR\m[]\&\s-2\u[1]\d\s+2\&. If you wish to report a bug
in APT, please see
-/usr/share/doc/debian/bug\-reporting\&.txt
+returns zero on normal operation, non\-zero on error.
+.SH BUGS
+\m[blue]\fBAPT bug page\fR\m[]\&\s-2\u[1]\d\s+2.
+If you wish to report a bug in APT,
+please see /usr/share/doc/debian/bug\-reporting.txt
or the
\fBreportbug\fR(1)
-command\&.
-.SH "AUTHORS"
-.PP
+command.
+.SH AUTHORS
\fBMike O\*(AqConnor\fR
-.RS 4
-.RE
.PP
\fBAPT team\fR
-.RS 4
-.RE
-.SH "NOTES"
+.SH NOTES
.IP " 1." 4
APT bug page
.RS 4
Any program (person), that produces man pages, should check the output
for defects by using (both groff and nroff)
[gn]roff -mandoc -t -ww -b -z -K utf8 <man page>
The same goes for man pages that are used as an input.
For a style guide use
mandoc -T lint
-.-
Any "autogenerator" should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
It should also check its input files for too long (> 80) lines.
This is just a simple quality control measure.
The "autogenerator" may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Not removing trailing spaces (in in- and output).
The reason for these trailing spaces should be found and eliminated.
"git" has a "tool" to point out whitespace,
see for example "git-apply(1)" and git-config(1)")
Not beginning each input sentence on a new line.
Line length and patch size should thus be reduced.
The script "reportbug" uses 'quoted-printable' encoding when a line is
longer than 1024 characters in an 'ascii' file.
See man-pages(7), item "semantic newline".
-.-
The difference between the formatted output of the original and patched file
can be seen with:
nroff -mandoc <file1> > <out1>
nroff -mandoc <file2> > <out2>
diff -d -u <out1> <out2>
and for groff, using
\"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -mandoc -Z - \"
instead of 'nroff -mandoc'
Add the option '-t', if the file contains a table.
Read the output from 'diff -d -u ...' with 'less -R' or similar.
-.-.
If 'man' (man-db) is used to check the manual for warnings,
the following must be set:
The option \"-warnings=w\"
The environmental variable:
export MAN_KEEP_STDERR=yes (or any non-empty value)
or
(produce only warnings):
export MANROFFOPT=\"-ww -b -z\"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-
