Package: cpio
Version: 2.15+dfsg-1
Severity: minor
Tags: patch
Dear Maintainer,
here are some notes and editorial fixes for the manual.
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
"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -man -Z - "
instead of "nroff -man"
Add the option "-t", if the file contains a table.
Read the output of "diff -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 -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Output from "mandoc -T lint cpio.1": (possibly shortened list)
mandoc: cpio.1:97:11: STYLE: whitespace at end of input line
mandoc: cpio.1:226:26: STYLE: whitespace at end of input line
mandoc: cpio.1:297:31: STYLE: whitespace at end of input line
-.-.
Remove space characters at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
97:\fB\-i\fR.
226:Equivalent to \fB\-sS\fR.
297:.TP
-.-.
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.
53:[\fIpattern\fR...] [\fB<\fR \fIarchive\fR]
150:The old (POSIX.1) portable format. (8589934591 bytes)
154:having more than 65536 i-nodes. (4294967295 bytes)
160:The old tar format. (8589934591 bytes)
164:which are similar but not identical. (8589934591 bytes)
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
204:.BR all
-.-.
Strings longer than 3/4 of a standard line length (80)
25 [\fB\-\-file=\fR[[\fIUSER\fB@\fR]\fIHOST\fB:\fR]\fIARCHIVE\fR]
40 [\fB\-\-file=\fR[[\fIUSER\fB@\fR]\fIHOST\fB:\fR]\fIARCHIVE\fR]
214 \fB\-F\fR, \fB\-\-file=\fR[[\fIUSER\fB@\fR]\fIHOST\fB:\fR]\fIARCHIVE-FILE\fR
-.-.
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.
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.
150:The old (POSIX.1) portable format. (8589934591 bytes)
154:having more than 65536 i-nodes. (4294967295 bytes)
160:The old tar format. (8589934591 bytes)
164:which are similar but not identical. (8589934591 bytes)
268:Use \fIARCHIVE-NAME\fR instead of standard output. Optional \fIUSER\fR and
299:Use \fIARCHIVE-NAME\fR instead of standard input. Optional \fIUSER\fR and
-.-.
Name of a manual is set in bold, the section in roman.
See man-pages(7).
77:cpio(5)
-.-.
Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z
-rCHECKSTYLE=0":
troff: backtrace: file '<stdin>':97
troff:<stdin>:97: warning: trailing space in the line
troff: backtrace: file '<stdin>':201
troff:<stdin>:201: warning: special character 'u0438' not defined
troff: backtrace: file '<stdin>':226
troff:<stdin>:226: warning: trailing space in the line
-- System Information:
Debian Release: trixie/sid
APT prefers testing-proposed-updates
APT policy: (500, 'testing-proposed-updates'), (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.7.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 cpio depends on:
ii libc6 2.38-11
cpio recommends no packages.
Versions of packages cpio suggests:
pn libarchive-dev <none>
-- no debconf information
--- cpio.1 2024-04-24 12:30:21.034319143 +0000
+++ cpio.1.new 2024-05-19 02:07:40.907230739 +0000
@@ -50,7 +50,7 @@ cpio \- copy files to and from archives
[\fB\-\-force\-local\fR] [\fB\-\-no\-absolute\-filenames\fR] [\fB\-\-sparse\fR]
[\fB\-\-only\-verify\-crc\fR] [\fB\-\-to\-stdout\fR] [\fB\-\-quiet\fR]
[\fB\-\-rsh\-command=\fICOMMAND\fR]
-[\fIpattern\fR...] [\fB<\fR \fIarchive\fR]
+[\fIpattern\fR...\&] [\fB<\fR \fIarchive\fR]
.B cpio
{\fB\-p\fR|\fB\-\-pass\-through\fR} [\fB\-0adlmuvLV\fR]
@@ -74,7 +74,7 @@ General help using GNU software: <http:/
.PP
Report cpio translation bugs to <http://translationproject.org/team/>
.SH SEE ALSO
-cpio(5)
+.BR cpio (5)
.SH DESCRIPTION
GNU \fBcpio\fR copies files between archives and directories. It
supports the following archive formats: old binary cpio, old portable
@@ -94,7 +94,7 @@ supplied with the \fB\-\-file\fR option)
(if the \fB\-t\fR option is given) list its contents to the standard
output. If one or more \fIpattern\fRs are supplied, read or list only
files matching these patterns. The \fB\-t\fR option alone implies
-\fB\-i\fR.
+\fB\-i\fR.
.TP
.BR \-p ", " \-\-pass\-through
Pass-through. Read a list of file names from the standard input and
@@ -144,24 +144,24 @@ parentheses gives maximum size for indiv
.RS
.TP
.B bin
-The obsolete binary format. (2147483647 bytes)
+The obsolete binary format (2147483647 bytes).
.TP
.B odc
-The old (POSIX.1) portable format. (8589934591 bytes)
+The old (POSIX.1) portable format (8589934591 bytes).
.TP
.B newc
The new (SVR4) portable format, which supports file systems
-having more than 65536 i-nodes. (4294967295 bytes)
+having more than 65536 i-nodes (4294967295 bytes).
.TP
.B crc
The new (SVR4) portable format with a checksum added.
.TP
.B tar
-The old tar format. (8589934591 bytes)
+The old tar format (8589934591 bytes).
.TP
.B ustar
The POSIX.1 tar format. Also recognizes GNU tar archives,
-which are similar but not identical. (8589934591 bytes)
+which are similar but not identical (8589934591 bytes).
.TP
.B hpbin
The obsolete binary format used by HPUX's cpio (which stores
@@ -198,10 +198,10 @@ Verbosely list the files processed.
Print a "\fB.\fR" for each file processed.
.TP
\fB\-W\fR, \fB\-\-warning=\fIFLAG\fR
-Controlsи warning display. The \fIFLAG\fR is one of
+Controls warning display. The \fIFLAG\fR is one of
.BR none ,
to disable all warnings,
-.BR all
+.B all
to enable them,
.BR truncate ,
to enable warnings about field truncation, and
@@ -223,7 +223,7 @@ Print \fISTRING\fR when the end of a vol
.TP
.BR \-b ", " \-\-swap
Swap both halfwords of words and bytes of halfwords in the data.
-Equivalent to \fB\-sS\fR.
+Equivalent to \fB\-sS\fR.
.TP
.BR \-f ", " \-\-nonmatching
Only copy files that do not match any of the given patterns.
@@ -265,12 +265,13 @@ Store 0 in the device number field of ea
the actual device number.
.TP
\fB\-O\fR [[\fIUSER\fB@\fR]\fIHOST\fB:\fR]\fIARCHIVE-NAME\fR
-Use \fIARCHIVE-NAME\fR instead of standard output. Optional \fIUSER\fR and
-\fIHOST\fR specify the user and host names in case of a remote
-archive.
+Use \fIARCHIVE-NAME\fR instead of standard output.
+Optional \fIUSER\fR and \fIHOST\fR specify the user and
+host names in case of a remote archive.
-The output archive name can be specified wither using this option, or
-using \fB\-F\fR (\fB\-\-file\fR), but not both.
+The output archive name can be specified wither using this option,
+or using \fB\-F\fR (\fB\-\-file\fR),
+but not both.
.TP
.B \-\-renumber\-inodes
Renumber inodes when storing them in the archive.
@@ -294,11 +295,11 @@ newlines.
.TP
.BR \-a ", " \-\-reset\-access\-time
Reset the access times of files after reading them.
-.TP
+.TP
\fB\-I\fR [[\fIUSER\fB@\fR]\fIHOST\fB:\fR]\fIARCHIVE-NAME\fR
-Use \fIARCHIVE-NAME\fR instead of standard input. Optional \fIUSER\fR and
-\fIHOST\fR specify the user and host names in case of a remote
-archive.
+Use \fIARCHIVE-NAME\fR instead of standard input.
+Optional \fIUSER\fR and \fIHOST\fR specify the user and
+host names in case of a remote archive.
The input archive name can be specified wither using this option, or
using \fB\-F\fR (\fB\-\-file\fR), but not both.
