Package: dpkg
Version: 1.19.0.5+b1
Severity: minor
Tags: patch

Dear Maintainer,

   * What led up to the situation?

  Warnings from "groff":

<dpkg-deb.1>:133 (macro IR): only 1 argument, but more are expected
<dpkg-deb.1>:210 (macro BR): only 1 argument, but more are expected
<dpkg-deb.1>:279 (macro BR): only 1 argument, but more are expected

Output is from: test-groff -b -e -mandoc -T utf8 -rF0 -t -w w -z 

  ["test-groff" is a developmental version of "groff"]

###

  Summary:

  Remove extra quotation mark (").

  Use '\(en', not '\-' to denote a range of numbers.

  Protect an ellipsis on both sides, '\&...\&'.

  Protect a full stop, exclamation mark, that is not an end of sentence.

  Know the difference between "abc..." and "abc ...".

  Print a reverse solidus (\) with '\e', not '\\'.

  Use a macro 'I', 'IX', or 'XI' instead of escape requests, where the
italic correction is too often missing in the text.

  Begin each sentence on a new line (or use two spaces between them,
which is not recommended as the text contains formatting commands).
See man-pages(7) [package "manpages"] and "info groff".


###

  Details:

Input file is dpkg-deb.1

mandoc: dpkg-deb.1:68:32: STYLE: unterminated quoted argument

####

Test nr. 5:

Change '-' (\-) to '\(en' (en-dash) for a numeric range.

dpkg-deb.1:234:The accepted values are 0-9 with: 0 being mapped to compressor 
none for gzip.

#####

Test nr. 8:

Protect a full stop (.) with "\&", if it has a blank (white-space) in
front of or (ignoring characters transparent to it) after it, and it
does not mean an end of a sentence.

28:.RI [ option "...] " command
43:.BR dpkg\-deb ". " dpkg
57:.IR binary-directory ". " binary-directory
251:members (i.e. \fBcontrol.tar\fP and \fBdata.tar\fP; since dpkg 1.17.6).

#####

Test nr. 10:

Separate an ellipsis from the preceding string with a space
character, if it does not mean a continuation of it.

See a manual of style about the difference between "abc..." and
"abc ...".

28:.RI [ option "...] " command
99:.BR \-I ", " \-\-info " \fIarchive\fP [\fIcontrol-file-name\fP...]"
122:.BR \-f ", " \-\-field " \fIarchive\fP [\fIcontrol-field-name\fP...]"

#####

Test nr. 16:

Use the correct macro for the font change of one argument.
Split a  punctuation mark from the only argument if one is there

133:.IR control-field-name
210:.BR \-\-version
279:.BR \-\-nocheck

#####

Test nr. 20:

Use "\e" to print the escape character instead of "\\" (which gets
interpreted in copy mode).

229:The default for this field is \(lq${Package}\\t${Version}\\n\(rq.

#####

Test nr. 21:

Use a macro to change to the italic font, instead of \fI [1], if
possible.
The macros have the italic corrections, but "\c" removes them
  or
add the italic corrections.
[1] man-pages(7) [package "manpages"]

215:\fB\-\-showformat=\fP\fIformat\fR
221:\(lq${\fIfield-name\fR}\(rq form, a list of the valid fields can be easily
265:\fIrootless\-builds.txt\fP), but should \fBnot\fP be used when the

#####

Test nr. 40:

Add a comma after "e.g." and "i.e." (man-pages(7) [package "manpages"]).

251:members (i.e. \fBcontrol.tar\fP and \fBdata.tar\fP; since dpkg 1.17.6).

#####

Test nr. 41:

Wrong distance between sentences or protect the indicator.

1) Separate the sentences and subordinate clauses; each begins on a new
line.  See man-pages(7) [package "manpages"] and "info groff".

Or

2) Adjust space between sentences (two spaces),

3) or protect the indicator by adding "\&" after it.

The "indicator" is an "end-of-sentence character" (.!?).

61:as the control file itself. This directory will
71:and parse it. It will check the file for syntax errors and other problems,
119:argument. The default format displays the package's name and version
132:control file. If more than one
142:package archive. It is currently produced in the format generated by
152:result in a correct installation! Use
182:format (since dpkg 1.17.14). Together with
191:format. Together with
217:will produce. The format is a string that will be output for each package
224:on the same package. A complete explanation of the formatting options
240:building a package (since dpkg 1.16.2). Allowed values are \fBnone\fP (since
251:members (i.e. \fBcontrol.tar\fP and \fBdata.tar\fP; since dpkg 1.17.6).
253:\fBdata.tar\fP member will use those parameters. The only supported
282:usual checks on the proposed contents of an archive. You can build
291:Enables debugging output. This is not very interesting.
317:to install software! You must use
333:md5sum control file generated by debian/rules. Though this is not directly

#####

  Patch:

--- dpkg-deb.1  2018-05-06 07:53:26.000000000 +0000
+++ dpkg-deb.1.new      2018-05-23 22:49:55.000000000 +0000
@@ -25,7 +25,7 @@ dpkg\-deb \- Debian package archive (.de
 .
 .SH SYNOPSIS
 .B dpkg\-deb
-.RI [ option "...] " command
+.RI [ option " \&...\&] " command
 .
 .SH DESCRIPTION
 .B dpkg\-deb
@@ -40,7 +40,7 @@ You can also invoke
 by calling
 .B dpkg
 with whatever options you want to pass to
-.BR dpkg\-deb ". " dpkg
+.BR dpkg\-deb ".\& " dpkg
 will spot that you wanted
 .B dpkg\-deb
 and run it for you.
@@ -58,17 +58,17 @@ Creates a debian archive from the filesy
 must have a
 .B DEBIAN
 subdirectory, which contains the control information files such
-as the control file itself. This directory will
+as the control file itself.  This directory will
 .I not
 appear in the binary package's filesystem archive, but instead
 the files in it will be put in the binary package's control
 information area.
 
 Unless you specify
-.BR \-\-nocheck ", " dpkg\-deb "
+.BR \-\-nocheck ", " dpkg\-deb
 will read
 .B DEBIAN/control
-and parse it. It will check the file for syntax errors and other problems,
+and parse it.  It will check the file for syntax errors and other problems,
 and display the name of the binary package being built.
 .B dpkg\-deb
 will also check the permissions of the maintainer scripts and other
@@ -96,7 +96,7 @@ option may not be used (since
 needs to read and parse the package control file to determine which
 filename to use).
 .TP
-.BR \-I ", " \-\-info " \fIarchive\fP [\fIcontrol-file-name\fP...]"
+.BR \-I ", " \-\-info " \fIarchive\fP [\fIcontrol-file-name\fP \&...\&]"
 Provides information about a binary package archive.
 
 If no
@@ -116,10 +116,10 @@ about each one and exit with status 2.
 Provides information about a binary package archive in the format
 specified by the
 .B \-\-showformat
-argument. The default format displays the package's name and version
+argument.  The default format displays the package's name and version
 on one line, separated by a tabulator.
 .TP
-.BR \-f ", " \-\-field " \fIarchive\fP [\fIcontrol-field-name\fP...]"
+.BR \-f ", " \-\-field " \fIarchive\fP [\fIcontrol-field-name\fP \&...\&]"
 Extracts control file information from a binary package archive.
 
 If no
@@ -129,8 +129,8 @@ are specified then it will print the who
 If any are specified then
 .B dpkg\-deb
 will print their contents, in the order in which they appear in the
-control file. If more than one
-.IR control-field-name
+control file.  If more than one
+.I control-field-name
 is specified then
 .B dpkg\-deb
 will precede each with its field name (and a colon and space).
@@ -139,7 +139,7 @@ No errors are reported for fields reques
 .TP
 .BR \-c ", " \-\-contents " \fIarchive\fP"
 Lists the contents of the filesystem tree archive portion of the
-package archive. It is currently produced in the format generated by
+package archive.  It is currently produced in the format generated by
 .BR tar 's
 verbose listing.
 .TP
@@ -149,7 +149,7 @@ directory.
 
 Note that extracting a package to the root directory will
 .I not
-result in a correct installation! Use
+result in a correct installation!  Use
 .B dpkg
 to install packages.
 
@@ -173,13 +173,13 @@ subdirectory of the specified directory
 The target directory (but not its parents) will be created if necessary.
 
 The input archive is not (currently) processed sequentially, so reading
-it from standard input (\(Fo\fB-\fP\(Fc) is \fBnot\fP supported.
+it from standard input (\(Fo\fB\-\fP\(Fc) is \fBnot\fP supported.
 .TP
 .BR \-\-ctrl\-tarfile " \fIarchive\fP"
 Extracts the control data from a binary package and sends it to standard
 output in
 .B tar
-format (since dpkg 1.17.14). Together with
+format (since dpkg 1.17.14).  Together with
 .BR tar (1)
 this can be used to extract a particular control file from a package archive.
 The input archive will always be processed sequentially.
@@ -188,7 +188,7 @@ The input archive will always be process
 Extracts the filesystem tree data from a binary package and sends it
 to standard output in
 .B tar
-format. Together with
+format.  Together with
 .BR tar (1)
 this can be used to extract a particular file from a package archive.
 The input archive will always be processed sequentially.
@@ -207,37 +207,38 @@ necessary.
 .BR \-? ", " \-\-help
 Show the usage message and exit.
 .TP
-.BR \-\-version
+.B \-\-version
 Show the version and exit.
 .
 .SH OPTIONS
 .TP
-\fB\-\-showformat=\fP\fIformat\fR
+\fB\-\-showformat=\,\fIformat\fR
 This option is used to specify the format of the output \fB\-\-show\fP
-will produce. The format is a string that will be output for each package
+will produce.  The format is a string that will be output for each package
 listed.
 
 The string may reference any status field using the
-\(lq${\fIfield-name\fR}\(rq form, a list of the valid fields can be easily
+.RI \(lq${ field-name }\(rq
+form, a list of the valid fields can be easily
 produced using
 .B \-I
-on the same package. A complete explanation of the formatting options
+on the same package.  A complete explanation of the formatting options
 (including escape sequences and field tabbing) can be found in the
 explanation of the \fB\-\-showformat\fP option in
 .BR dpkg\-query (1).
 
-The default for this field is \(lq${Package}\\t${Version}\\n\(rq.
+The default for this field is \(lq${Package}\et${Version}\en\(rq.
 .TP
 .BI \-z compress-level
 Specify which compression level to use on the compressor backend, when
 building a package (default is 9 for gzip, 6 for xz).
-The accepted values are 0-9 with: 0 being mapped to compressor none for gzip.
+The accepted values are 0\(en9 with: 0 being mapped to compressor none for 
gzip.
 Before dpkg 1.16.2 level 0 was equivalent to compressor none for all
 compressors.
 .TP
 .BI \-S compress-strategy
 Specify which compression strategy to use on the compressor backend, when
-building a package (since dpkg 1.16.2). Allowed values are \fBnone\fP (since
+building a package (since dpkg 1.16.2).  Allowed values are \fBnone\fP (since
 dpkg 1.16.4), \fBfiltered\fP, \fBhuffman\fP, \fBrle\fP and \fBfixed\fP for
 gzip (since dpkg 1.17.0) and \fBextreme\fP for xz.
 .TP
@@ -248,9 +249,9 @@ and \fBnone\fP (default is \fBxz\fP).
 .TP
 .B \-\-[no\-]uniform\-compression
 Specify that the same compression parameters should be used for all archive
-members (i.e. \fBcontrol.tar\fP and \fBdata.tar\fP; since dpkg 1.17.6).
+members (i.e., \fBcontrol.tar\fP and \fBdata.tar\fP; since dpkg 1.17.6).
 Otherwise only the
-\fBdata.tar\fP member will use those parameters. The only supported
+\fBdata.tar\fP member will use those parameters.  The only supported
 compression types allowed to be uniformly used are \fBnone\fP, \fBgzip\fP
 and \fBxz\fP.
 The \fB\-\-no\-uniform\-compression\fP option disables uniform compression
@@ -262,7 +263,8 @@ Set the owner and group for each entry i
 root with id 0 (since dpkg 1.19.0).
 
 \fBNote\fP: This option can be useful for rootless builds (see
-\fIrootless\-builds.txt\fP), but should \fBnot\fP be used when the
+.IR rootless\-builds.txt ),
+but should \fBnot\fP be used when the
 entries have an owner or group that is not root.
 Support for these will be added later in the form of a meta manifest.
 .TP
@@ -276,10 +278,10 @@ now obsolete; its only use is when build
 versions of dpkg older than 0.93.76 (September 1995), which was released
 as i386 a.out only.
 .TP
-.BR \-\-nocheck
+.B \-\-nocheck
 Inhibits
 .BR "dpkg\-deb \-\-build" 's
-usual checks on the proposed contents of an archive. You can build
+usual checks on the proposed contents of an archive.  You can build
 any archive you want, no matter how broken, this way.
 .TP
 .BR \-v ", " \-\-verbose
@@ -288,7 +290,7 @@ This currently only affects \fB\-\-extra
 \fB\-\-vextract\fP.
 .TP
 .BR \-D ", " \-\-debug
-Enables debugging output. This is not very interesting.
+Enables debugging output.  This is not very interesting.
 .
 .SH EXIT STATUS
 .TP
@@ -314,7 +316,7 @@ the \fBtar\fP(5) file entries.
 .SH NOTES
 Do not attempt to use just
 .B dpkg\-deb
-to install software! You must use
+to install software!  You must use
 .B dpkg
 proper to ensure that all the files are correctly placed and the
 package's scripts run and its status and contents recorded.
@@ -330,7 +332,7 @@ There is no authentication on
 files; in fact, there isn't even a straightforward checksum.
 (Higher level tools like APT support authenticating \fB.deb\fP packages
 retrieved from a given repository, and most packages nowadays provide an
-md5sum control file generated by debian/rules. Though this is not directly
+md5sum control file generated by debian/rules.  Though this is not directly
 supported by the lower level tools.)
 .
 .SH SEE ALSO


-- System Information:
Debian Release: buster/sid
  APT prefers stable-updates
  APT policy: (500, 'stable-updates'), (500, 'proposed-updates'), (500, 
'testing'), (500, 'stable')
Architecture: amd64 (x86_64)

Kernel: Linux 4.9.88-1-u1 (SMP w/2 CPU cores)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), 
LANGUAGE=is_IS.iso88591 (charmap=ISO-8859-1)
Shell: /bin/sh linked to /bin/dash
Init: sysvinit (via /sbin/init)

Versions of packages dpkg depends on:
ii  libbz2-1.0   1.0.6-8.1
ii  libc6        2.27-3
ii  liblzma5     5.2.2-1.3
ii  libselinux1  2.7-2+b2
ii  tar          1.30+dfsg-2
ii  zlib1g       1:1.2.11.dfsg-1

dpkg recommends no packages.

Versions of packages dpkg suggests:
ii  apt            1.6.1
pn  debsig-verify  <none>

-- no debconf information

-- 
Bjarni I. Gislason

Reply via email to