Package: gnumeric
Version: 1.12.57-1.1+b2
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
grep -n -e ' $' -e '\\~$' -e ' \\f.$' -e ' \\"' <file>
to find (most) 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?
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:62: warning: trailing space in the line
troff:<stdin>:67: warning: trailing space in the line
troff:<stdin>:166: warning: trailing space in the line
troff:<stdin>:177: 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: forky/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.16.3+deb14-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 gnumeric depends on:
ii debconf [debconf-2.0] 1.5.91
ii gnumeric-common 1.12.57-1.1
ii libatk1.0-0t64 2.57.2-1
ii libc6 2.41-12
ii libcairo2 1.18.4-1+b1
ii libgdk-pixbuf-2.0-0 2.42.12+dfsg-5
ii libglib2.0-0t64 2.84.4-3
ii libgoffice-0.10-10t64 0.10.57-2+b1
ii libgsf-1-114 1.14.53-1+b1
ii libgtk-3-0t64 3.24.50-2
ii libpango-1.0-0 1.56.3-2
ii libpangocairo-1.0-0 1.56.3-2
ii libxml2-16 2.14.5+dfsg-0.2
ii procps 2:4.0.4-9
ii pxlib1 0.6.9-1+b1
ii zlib1g 1:1.3.dfsg+really1.3.1-1+b1
Versions of packages gnumeric recommends:
pn evince <none>
pn gnumeric-doc <none>
pn lp-solve <none>
Versions of packages gnumeric suggests:
pn fonts-liberation | ttf-mscorefonts-installer <none>
pn gnumeric-plugins-extra <none>
pn libgsf-1-dev <none>
-- debconf information:
gnumeric/existing-process-title:
gnumeric/existing-process: false
Input file is gnumeric.1
Output from "mandoc -T lint gnumeric.1": (shortened list)
2 STYLE: input text line longer than 80 bytes:
5 STYLE: whitespace at end of input line
1 WARNING: skipping paragraph macro: br before sp
Find most trailing spaces with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
Output from
test-nroff -mandoc -t -ww -z gnumeric.1: (shortened list)
4 line(s) with a trailing space
Find most trailing spaces with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
Input file is gnumeric.1
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
5
-.-.
Change two HYPHEN-MINUSES (code 0x2D) to an em-dash (\(em),
if one is intended.
" \(em " creates a too big gap in the text (in "troff").
An en-dash is usually surrounded by a space,
while an em-dash is used without spaces.
"man" (1 byte characters in input) transforms an en-dash (\(en) to one
HYPHEN-MINUS,
and an em-dash to two HYPHEN-MINUSES without considering the space
around it.
If "--" are two single "-"
(begin of an option or end of options)
then use "\-\-".
gnumeric.1:46:starting with two dashes (`--').
gnumeric.1:195:-- and many others. For a more complete list, see the About
dialog.
-.-.
Use "\e" to print the escape character instead of "\\" (which gets
interpreted in copy mode).
24:the LaTeX \\longtable format. Plugins can be used to define custom
-.-.
Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.
45:letter options starting with a single dash (`-') and longer options
46:starting with two dashes (`--').
195:-- and many others. For a more complete list, see the About dialog.
-.-.
Wrong distance (not two spaces) 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.
Use
#!/usr/bin/sh
sed -e '/^\./n' \
-e 's/\([[:alpha:]]\)\. */\1.\n/g' $1
to split lines after a sentence period.
Check result with the difference between the formatted outputs.
See also the attachment "general.bugs"
14:project. \fBGnumeric\fR intends to compete with commercial
21:financial and database access functions. Plotting data is supported
22:through an incomplete but powerful plotting system. A plugin system
24:the LaTeX \\longtable format. Plugins can be used to define custom
25:functionality. A rudimentary scripting API for the Python language
26:exists and will be extended in the near future. Since \fBgnumeric\fR
31:from one of the menus provided by the underlying platform. When started
34:which will then be opened immediately. For instance, the command:
39:"myfile.gnumeric". The default \fBgnumeric\fR file format is in
68:Set the size and position of the first window. All units are in
69:pixels. The X offset is from the left hand side of the screen, the Y
70:offset is from the top of the screen. For example, \-g=800x600+20+30
77:machinename:Xdisplay.Screen. Note that the machine displaying gnumeric
123:The host on which to contact the gxid daemon. This overrides the GXID_HOST
environment variable. This option is only available if GTK+ has been configured
with \-\-gdk-target=x11.
126:The port for the connection to gxid. This overrides the GXID_PORT
environment variable. This option is only available if GTK+ has been configured
with \-\-gdk-target=x11.
176:License (GPL), version 2 or 3. For information on this license look at the
-.-.
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 123, length 179
The host on which to contact the gxid daemon. This overrides the GXID_HOST
environment variable. This option is only available if GTK+ has been configured
with \-\-gdk-target=x11.
Line 126, length 170
The port for the connection to gxid. This overrides the GXID_PORT environment
variable. This option is only available if GTK+ has been configured with
\-\-gdk-target=x11.
Longest line is number 123 with 179 characters
-.-.
Remove unnecessary double font change (e.g., \fR\fI) in a row or (better)
use a two-fonts macro.
75:.B \fB\-\-display=\fR\fIDISPLAY\fR
82:.B \fB\-\-screen=\fR\fISCREEN\fR
99:\fB\-\-espeaker=\fR\fIHOSTNAME:PORT\fR
107:\fB\-\-gdk-debug=\fR\fIFLAGS\fR
110:\fB\-\-gdk-no-debug=\fR\fIFLAGS\fR
116:\fB\-\-name=\fR\fINAME\fR
119:\fB\-\-class=\fR\fICLASS\fR
122:\fB\-\-gxid_host=\fR\fIHOST\fR
125:\fB\-\-gxid_port=\fR\fIPORT\fR
128:\fB\-\-gtk-debug=\fR\fIFLAGS\fR
131:\fB\-\-gtk-no-debug=\fR\fIFLAGS\fR
137:\fB\-\-gtk-module=\fR\fIMODULE\fR
142:\fB\-\-sm-client-id=\fR\fIID\fR
145:\fB\-\-sm-config-prefix=\fR\fIPREFIX\fR
-.-.
Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).
gnumeric.1:14:project. \fBGnumeric\fR intends to compete with commercial
gnumeric.1:21:financial and database access functions. Plotting data is
supported
gnumeric.1:22:through an incomplete but powerful plotting system. A plugin
system
gnumeric.1:24:the LaTeX \\longtable format. Plugins can be used to define custom
gnumeric.1:25:functionality. A rudimentary scripting API for the Python language
gnumeric.1:26:exists and will be extended in the near future. Since
\fBgnumeric\fR
gnumeric.1:31:from one of the menus provided by the underlying platform. When
started
gnumeric.1:34:which will then be opened immediately. For instance, the command:
gnumeric.1:39:"myfile.gnumeric". The default \fBgnumeric\fR file format is in
gnumeric.1:68:Set the size and position of the first window. All units are in
gnumeric.1:69:pixels. The X offset is from the left hand side of the screen,
the Y
gnumeric.1:70:offset is from the top of the screen. For example,
\-g=800x600+20+30
gnumeric.1:77:machinename:Xdisplay.Screen. Note that the machine displaying
gnumeric
gnumeric.1:123:The host on which to contact the gxid daemon. This overrides the
GXID_HOST environment variable. This option is only available if GTK+ has been
configured with \-\-gdk-target=x11.
gnumeric.1:126:The port for the connection to gxid. This overrides the
GXID_PORT environment variable. This option is only available if GTK+ has been
configured with \-\-gdk-target=x11.
gnumeric.1:176:License (GPL), version 2 or 3. For information on this license
look at the
-.-.
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.
gnumeric.1:5:.TH GNUMERIC 1 "2009-02-08" gnumeric "GNOME"
gnumeric.1:167:.URL "http://www.gnome.org/projects/gnumeric/doc/gnumeric.shtml";
online .
gnumeric.1:169:.URL "http://www.gnome.org/projects/gnumeric/"; "The Gnumeric
Homepage" .
gnumeric.1:171:.URL "http://www.gnome.org/"; "The GNOME project page" .
gnumeric.1:178:.URL "http://www.gnu.org/"; "GNU project page" .
gnumeric.1:187:.SS "Gnumeric"
-.-.
Space character after a macro call.
81:.TP
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:62: warning: trailing space in the line
troff:<stdin>:67: warning: trailing space in the line
troff:<stdin>:166: warning: trailing space in the line
troff:<stdin>:177: warning: trailing space in the line
-.-
Additionally:
Rename local macro "URL" to "URL_private" to avoid using the system macro
"URL", as it gets defined after calling the "TH" macro.
-.-
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- gnumeric.1 2025-09-15 18:22:26.603759194 +0000
+++ gnumeric.1.new 2025-09-15 19:45:24.319231236 +0000
@@ -1,7 +1,6 @@
-.de URL
+.de URL_private
\\$2 \(laURL: \\$1 \(ra\\$3
..
-.if \n[.g] .mso www.tmac
.TH GNUMERIC 1 "2009-02-08" gnumeric "GNOME"
.SH NAME
gnumeric \- a GNOME spreadsheet application.
@@ -21,7 +20,7 @@ Oleo(TM) and OpenOffice.org formats.
financial and database access functions. Plotting data is supported
through an incomplete but powerful plotting system. A plugin system
extends \fBgnumeric\fR , for instance enabling the export of data to
-the LaTeX \\longtable format. Plugins can be used to define custom
+the LaTeX \elongtable format. Plugins can be used to define custom
functionality. A rudimentary scripting API for the Python language
exists and will be extended in the near future. Since \fBgnumeric\fR
is \fBfree\fR software, \fBgnumeric\fR can also be extended directly
@@ -42,8 +41,8 @@ compressed with \fBgzip\fR.
.SH USER OPTIONS
This program follows the usual GNU command line syntax, with single
-letter options starting with a single dash (`-') and longer options
-starting with two dashes (`--').
+letter options starting with a single dash (`\-') and longer options
+starting with two dashes (`\-\-').
.SS "Help options"
.B \-?, \-\-help
@@ -59,12 +58,12 @@ Displays the version number of the insta
\fBgnumeric\fR.
.TP
.B \-\-no-splash
-Start \fBgnumeric\fR without showing the splash screen. The splash
+Start \fBgnumeric\fR without showing the splash screen. The splash
screen is normally shown if loading files takes too long.
.SS "Options for window placement"
.TP
-\fB\-g, \-\-geometry=WIDTHxHEIGHT+XOFF+YOFF
+\fB\-g, \-\-geometry=WIDTHxHEIGHT+XOFF+YOFF
Set the size and position of the first window. All units are in
pixels. The X offset is from the left hand side of the screen, the Y
offset is from the top of the screen. For example, \-g=800x600+20+30
@@ -78,14 +77,11 @@ machinename:Xdisplay.Screen. Note that t
must have granted the machine running gnumeric the right to display
(see xhost).
-.TP
+.TP
.B \fB\-\-screen=\fR\fISCREEN\fR
X screen to use, a more compact form of the functionality described
above.
-
-
-
.SH ADVANCED OPTIONS
.SS "GNOME options"
@@ -163,26 +159,25 @@ please visit \fIhttp://bugzilla.gnome.or
\fBssgrep\fR(1)
.PP
.B The Gnumeric Manual
-Available through the \fBHelp\fR menu or
-.URL "http://www.gnome.org/projects/gnumeric/doc/gnumeric.shtml"; online .
+Available through the \fBHelp\fR menu or
+.URL_private "http://www.gnome.org/projects/gnumeric/doc/gnumeric.shtml";
online .
.PP
-.URL "http://www.gnome.org/projects/gnumeric/"; "The Gnumeric Homepage" .
+.URL_private "http://www.gnome.org/projects/gnumeric/"; "The Gnumeric Homepage"
.
.PP
-.URL "http://www.gnome.org/"; "The GNOME project page" .
+.URL_private "http://www.gnome.org/"; "The GNOME project page" .
.SH LICENSE
\fBGnumeric\fR is licensed under the terms of the General Public
License (GPL), version 2 or 3. For information on this license look at the
-source code that came with the software or see the
-.URL "http://www.gnu.org/"; "GNU project page" .
+source code that came with the software or see the
+.URL_private "http://www.gnu.org/"; "GNU project page" .
.SH COPYRIGHT
The copyright on the \fBgnumeric\fR software and source code is held
by the individual authors as is documented in the source code.
-
.SH AUTHORS
.SS "Gnumeric"
Jody Goldberg <[email protected]>
@@ -190,9 +185,8 @@ Jody Goldberg <[email protected]>
Miguel de Icaza <[email protected]>
.br
Morten Welinder <[email protected]>
-.br
--- and many others. For a more complete list, see the About dialog.
+\(en and many others. For a more complete list, see the About dialog.
.SS "This manual page"
Jan Schaumann <[email protected]>
.br
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>
To find trailing space use
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
The same goes for man pages that are used as an input.
-.-
For a style guide use
mandoc -T lint
-.-
For general input conventions consult the man page "nroff(7)" (item
"Input conventions") or the Texinfo manual about the same item.
-.-
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)
-.-
