Package: libc-dev-bin
Version: 2.38-11
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 gencat.1": (possibly shortened list)
mandoc: gencat.1:97:14: STYLE: whitespace at end of input line
mandoc: gencat.1:99:19: STYLE: whitespace at end of input line
mandoc: gencat.1:214:2: WARNING: skipping paragraph macro: PP empty
-.-.
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:.\" TH Title
99:.\" Sh Subsection
-.-.
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.
208:gencat [OPTION...] -o OUTPUT-FILE [INPUT-FILE]...
-.-.
Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-
216:\fB-H\fR, \fB--header\fR \fINAME\fR
219:\fB--new\fR
222:\fB-o\fR, \fB--output\fR \fINAME\fR
-.-.
Add a backslash, if it is missing after \{ at the end of a line.
104:.if \nF \{
-.-.
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.
212:correctly formed input files. Additionally some extension are implemented
-.-.
Do not use "\s0" in a string definition but an absolute number,
as the size of the string could be changed.
Then a situation of "\s+X...\s+Y...\s0...\s0" could emerge.
Type size changes have an effect in "groff", but not in "nroff".
115:.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
169:.ds v
\\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
172:.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
-.-.
Add a zero (0) in front of a decimal fraction that begins with a period
(.)
30:.if t .sp .5v
131:. ds #V .8m
132:. ds #F .3m
138:. ds #V .6m
-.-.
Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z
-rCHECKSTYLE=0":
Bad use of \s0 in a string definition, the string could be resized.
115:.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
169:.ds v
\\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
172:.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
-- 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 libc-dev-bin depends on:
ii libc6 2.38-11
Versions of packages libc-dev-bin recommends:
ii manpages 6.05.01-1
ii manpages-dev 6.05.01-1
Versions of packages libc-dev-bin suggests:
pn libc-devtools <none>
-- no debconf information
--- gencat.1 2024-05-20 13:30:38.566719339 +0000
+++ gencat.1.new 2024-05-20 15:23:38.369181557 +0000
@@ -27,7 +27,7 @@
.PP
..
.de Sp
-.if t .sp .5v
+.if t .sp 0.5v
.if n .sp
..
.de Ip
@@ -94,14 +94,14 @@
'br\}
.\" If the F register is turned on, we'll generate
.\" index entries out stderr for the following things:
-.\" TH Title
+.\" TH Title
.\" SH Header
-.\" Sh Subsection
+.\" Sh Subsection
.\" Ip Item
.\" X<> Xref (embedded
.\" Of course, you have to process the output yourself
.\" in some meaningful fashion.
-.if \nF \{
+.if \nF \{\
.de IX
.tm Index:\\$1\t\\n%\t"\\$2"
..
@@ -112,7 +112,7 @@
.UC
.if n .hy 0
.if n .na
-.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s+2\v'.1v'\h'-1p'
.de CQ \" put $1 in typewriter font
.ft CW
'if n "\c
@@ -128,14 +128,14 @@
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
-. ds #V .8m
-. ds #F .3m
+. ds #V 0.8m
+. ds #F 0.3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
-. ds #V .6m
+. ds #V 0.6m
. ds #F 0
. ds #[ \&
. ds #] \&
@@ -166,10 +166,10 @@
. \" troff and (daisy-wheel) nroff accents
.ds :
\\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
-.ds v
\\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
+.ds v
\\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s+4\v'\*(#V'\h'|\\n:u'\*(#]
.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
-.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
+.ds 3 \*(#[\v'.2m'\s-2\&3\s+2\v'-.2m'\*(#]
.ds o
\\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
@@ -205,21 +205,21 @@
.SH "NAME"
gencat \- Generate message catalog
.SH "SYNOPSIS"
-gencat [OPTION...] -o OUTPUT-FILE [INPUT-FILE]...
+gencat [OPTION ...\&] \-o OUTPUT-FILE [INPUT-FILE ...]
.SH "DESCRIPTION"
The \fBgencat\fR program is specified in the X/Open standard and the
GNU implementation follows this specification and so processes all
-correctly formed input files. Additionally some extension are implemented
+correctly formed input files.
+Additionally some extension are implemented
which help to work in a more reasonable way with the \fBcatgets\fR(3)
functions.
-.PP
.TP
-\fB-H\fR, \fB--header\fR \fINAME\fR
+\fB\-H\fR, \fB\-\-header\fR \fINAME\fR
Create C header file NAME containing symbol definitions
.TP
-\fB--new\fR
+\fB\-\-new\fR
Do not use existing catalog, force new output file
.TP
-\fB-o\fR, \fB--output\fR \fINAME\fR
+\fB\-o\fR, \fB\-\-output\fR \fINAME\fR
Write output to file NAME
.SH "AUTHOR"
\fIgencat\fR was written by Ulrich Drepper as part of the GNU C Library.
