Package: libxtst-dev
Version: 2:1.2.6-1
Severity: minor
Tags: patch
Additional remarks.
Mails from me to "[email protected]" are no longer acknowledged. A
Debian maintainer told me, that he would contact the mail administrator
about me not wanting to send bugs upstream.
See also Debian bug #1141378 reportbug: Automatic forwarding of upstream
bugs.
-.-
>From "www.gnu.org/philosophy/whats-wrong-with-github.html": |
The requirement to create an account at GitHub to participate in |
discussions is also a subtle social barrier to users who do not yet think |
of themselves as developers. |
-.-
Dear Maintainer,
>From "ftp.debian.org/debian/doc/bug-reporting.txt"
Don't file bugs upstream
If you file a bug in Debian, don't send a copy to the upstream software
maintainers yourself to start with, as it is possible that the bug
exists only in Debian. If necessary, the maintainer of the package will
forward the bug upstream, or ask you to do so after they've checked
that it isn't Debian-specific.
-.-
For forwarding bug reports to upstream see:
https://www.debian.org/Bugs/Developer#forward
-.-
"Handling bug reports" in
http://people.debian.org/~enrico/dcg/ch03s02.html
-.-
I do not send reports upstream if I have to get an account there.
The Debian maintainers have already one.
-.-
* 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=0 -ww -z < "man page"
[Use
grep -n -e ' $' -e '\\~$' -e ' \\f.$' -e ' \\"' -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 -K utf8 -rF0 -rHY=0 -ww -z -t":
an.tmac:<stdin>:10: style: .TH expects 2 to 5 arguments, got 9
Output from "test-nroff -mandoc -K utf8 -rF0 -rHY=0 -ww -z -t":
an.tmac:<stdin>:10: style: .TH expects 2 to 5 arguments, got 9
* 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 7.2.12+deb14-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=UTF-8) (ignored:
LC_ALL set to C.utf8), LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages libxtst-dev depends on:
ii libx11-dev 2:1.8.14-1
ii libxext-dev 2:1.3.4-1+b4
ii libxi-dev 2:1.8.4-1
ii libxtst6 2:1.2.6-1
ii x11proto-dev 2025.1-1
libxtst-dev recommends no packages.
libxtst-dev suggests no packages.
-- no debconf information
Input file is XTestQueryExtension.3
Output from "mandoc -T lint XTestQueryExtension.3": (shortened list)
1 ERROR: skipping excess arguments: TH ... 1.2.6"
26 STYLE: input text line longer than 80 bytes
3 WARNING: skipping paragraph macro: PP after SH
1 WARNING: skipping paragraph macro: sp after SH
-.-.
Show if docman-to-man created this.
A patch to a generated man page is to show where the generator
failed to make a "clean" man page rendering (that is without warnings) and
sometimes to show a better format for it.
Generated files create bigger and more difficult to read/check patches
when the generator creats long lines, instead of shorter ones or by
postprocesing its output in such a way.
A patch may be applied to a generated man page to fix it before distribution,
until the sources of the defects have been fixed.
4:.\" Generator: DocBook XSL Stylesheets vsnapshot_9276 <http://docbook.sf.net/>
-.-.
Wrong distance (not two spaces, not a new line character (\n)) between
sentences in the input file.
mandoc(1) says: "New sentence, new line."
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"
[List of affected lines removed.]
-.-.
Split lines longer than 80 characters (fill completely
an A4 sized page line on a terminal)
into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Line 10, length 98
.TH "XTEST" "3" "<pubdate>6 June 2007</pubdate>" ""libXtst 1.2.6" "X Version
11"" "XTST FUNCTIONS"
Line 31, length 288
XTestQueryExtension, XTestCompareCursorWithWindow,
XTestCompareCurrentCursorWithWindow, XTestFakeKeyEvent, XTestFakeButtonEvent,
XTestFakeMotionEvent, XTestFakeRelativeMotionEvent, XTestGrabControl,
XTestSetGContextOfGC, XTestSetVisualIDOfVisual, XTestDiscard \- XTest extension
functions
Line 46, length 152
.BI "Bool XTestQueryExtension(" "display" ", " "event_base_return" ", "
"error_base_return" ", " "major_version_return" ", " "minor_version_return" ");"
Line 58, length 83
.BI "Bool XTestCompareCursorWithWindow(" "display" ", " "window" ", " "cursor"
");"
Line 77, length 87
.BI "int XTestFakeKeyEvent(" "display" ", " "keycode" ", " "is_press" ", "
"delay" ");"
Line 88, length 89
.BI "int XTestFakeButtonEvent(" "display" ", " "button" ", " "is_press" ", "
"delay" ");"
Line 99, length 98
.BI "int XTestFakeMotionEvent(" "display" ", " "screen_number" ", " "x" ", "
"y" ", " "delay" ");"
Line 110, length 106
.BI "int XTestFakeRelativeMotionEvent(" "display" ", " "screen_number" ", " "x"
", " "y" ", " "delay" ");"
Line 157, length 228
This extension is a minimal set of client and server extensions required to
completely test the X11 server with no user intervention\&. This extension is
not intended to support general journaling and playback of user actions\&.
Line 163, length 332
These routines manipulate otherwise hidden client\-side behavior\&. The actual
implementation will depend on the details of the actual language binding and
what degree of request buffering, GContext caching, and so on, is provided\&.
In the C binding, routines are provided to access the internals of two opaque
data structures \(em
Line 165, length 167
Visuals \(em and to discard any requests pending within the output buffer of a
connection\&. The exact details can be expected to differ for other language
bindings\&.
Line 170, length 274
The first of these requests is similar to that provided in most extensions: it
allows a client to specify a major and minor version number to the server and
for the server to respond with major and minor versions of its own\&. The
remaining two requests allow the following:
Line 193, length 159
Perhaps most importantly, limited synthesis of input device events, almost as
if a cooperative user had moved the pointing device or pressed a key or
button\&.
Line 197, length 111
All XTEST extension functions and procedures, and all manifest constants and
macros, will start with the string
Line 198, length 98
\fIXTest\fR\&. All operations are classified as server/client (Server) or
client\-only (Client)\&.
Line 204, length 542
False\&. If the extension is supported, *event_base would be set to the event
number for the first event for this extension and *error_base would be set to
the error number for the first error for this extension\&. As no errors or
events are defined for this version of the extension, the values returned here
are not defined (nor useful)\&. If the extension is supported, *major_version
and *minor_version are set to the major and minor version numbers of the
extension supported by the display\&. Otherwise, none of the arguments are
set\&.
Line 208, length 81
performs a comparison of the cursor whose ID is specified by cursor (which may
be
Line 213, length 99
otherwise\&. If the extension is not supported, then the request is ignored and
zero is returned\&.
Line 217, length 93
performs a comparison of the current cursor with the cursor of the specified
window returning
Line 221, length 99
otherwise\&. If the extension is not supported, then the request is ignored and
zero is returned\&.
Line 231, length 82
False) of the key with the specified keycode; otherwise, the request is
ignored\&.
Line 233, length 140
If the extension is supported, the simulated event will not be processed until
delay milliseconds after the request is received (if delay is
Line 234, length 228
\fBCurrentTime\fR, then this is interpreted as no delay at all)\&. No other
requests from this client will be processed until this delay, if any, has
expired and subsequent processing of the simulated event has been completed\&.
Line 244, length 99
False) of the logical button numbered by the specified button; otherwise, the
request is ignored\&.
Line 246, length 140
If the extension is supported, the simulated event will not be processed until
delay milliseconds after the request is received (if delay is
Line 247, length 228
\fBCurrentTime\fR, then this is interpreted as no delay at all)\&. No other
requests from this client will be processed until this delay, if any, has
expired and subsequent processing of the simulated event has been completed\&.
Line 251, length 244
requests the server to simulate a movement of the pointer to the specified
position (x, y) on the root window of screen_number; otherwise, the request is
ignored\&. If screen_number is \-1, the current screen (that the pointer is on)
is used\&.
Line 253, length 140
If the extension is supported, the simulated event will not be processed until
delay milliseconds after the request is received (if delay is
Line 254, length 228
\fBCurrentTime\fR, then this is interpreted as no delay at all)\&. No other
requests from this client will be processed until this delay, if any, has
expired and subsequent processing of the simulated event has been completed\&.
Line 258, length 265
requests the server to simulate a movement of the pointer by the specified
offsets (x, y) relative to the current pointer position on screen_number;
otherwise, the request is ignored\&. If screen_number is \-1, the current
screen (that the pointer is on) is used\&.
Line 260, length 140
If the extension is supported, the simulated event will not be processed until
delay milliseconds after the request is received (if delay is
Line 261, length 228
\fBCurrentTime\fR, then this is interpreted as no delay at all)\&. No other
requests from this client will be processed until this delay, if any, has
expired and subsequent processing of the simulated event has been completed\&.
Line 264, length 86
True, then the executing client becomes impervious to server grabs\&. If
impervious is
Line 265, length 100
False, then the executing client returns to the normal state of being
susceptible to server grabs\&.
Line 268, length 92
sets the GContext within the opaque datatype referenced by gc to be that
specified by gid\&.
Line 271, length 101
sets the VisualID within the opaque datatype referenced by visual to be that
specified by visualid\&.
Line 274, length 86
discards any requests within the output buffer for the specified display\&. It
returns
Line 280, length 244
All routines that have return type Status will return nonzero for success and
zero for failure\&. Even if the XTEST extension is supported, the server may
withdraw such facilities arbitrarily; in which case they will subsequently
return zero\&.
Longest line is number 204 with 542 characters
-.-.
No need for '\&' to be in front of a period (.),
if there is a character in front of it.
Remove with "sed -e 's/\(.\)\\&\./\1./g'".
use_of_case = 27
27 lines are with such a use.
-.-.
Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).
Start a new sentence on a new line.
mandoc(1) says "New sentence, new line."
[List of affected lines removed.]
-.-.
Remove quotes from an argument to a macro, when there is a printable
but no space character between them. Such quotes provide no information.
XTestQueryExtension.3:10:.TH "XTEST" "3" "<pubdate>6 June 2007</pubdate>"
""libXtst 1.2.6" "X Version 11"" "XTST FUNCTIONS"
XTestQueryExtension.3:30:.SH "NAME"
XTestQueryExtension.3:32:.SH "SYNOPSIS"
XTestQueryExtension.3:46:.BI "Bool XTestQueryExtension(" "display" ", "
"event_base_return" ", " "error_base_return" ", " "major_version_return" ", "
"minor_version_return" ");"
XTestQueryExtension.3:58:.BI "Bool XTestCompareCursorWithWindow(" "display" ",
" "window" ", " "cursor" ");"
XTestQueryExtension.3:68:.BI "Bool XTestCompareCurrentCursorWithWindow("
"display" ", " "window" ");"
XTestQueryExtension.3:77:.BI "int XTestFakeKeyEvent(" "display" ", " "keycode"
", " "is_press" ", " "delay" ");"
XTestQueryExtension.3:88:.BI "int XTestFakeButtonEvent(" "display" ", "
"button" ", " "is_press" ", " "delay" ");"
XTestQueryExtension.3:99:.BI "int XTestFakeMotionEvent(" "display" ", "
"screen_number" ", " "x" ", " "y" ", " "delay" ");"
XTestQueryExtension.3:110:.BI "int XTestFakeRelativeMotionEvent(" "display" ",
" "screen_number" ", " "x" ", " "y" ", " "delay" ");"
XTestQueryExtension.3:121:.BI "int XTestGrabControl(" "display" ", "
"impervious" ");"
XTestQueryExtension.3:130:.BI "void XTestSetGContextOfGC(" "gc" ", " "gid" ");"
XTestQueryExtension.3:139:.BI "void XTestSetVisualIDOfVisual(" "visual" ", "
"visualid" ");"
XTestQueryExtension.3:148:.BI "Status XTestDiscard(" "display" ");"
XTestQueryExtension.3:155:.SH "DESCRIPTION"
XTestQueryExtension.3:281:.SH "AUTHOR"
-.-.
Use "\-" instead of "-" (rendered as a hyphen (u2010) in UTF-8 encoding)
in web addresses.
16:.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
-.-.
Change comment lines of type '.\" ====', '.\" ---', and an empty
'.\"' line) to a single period, as they contain no information and waste
work each time they are processed.
9:.\"
11:.\" -----------------------------------------------------------------
13:.\" -----------------------------------------------------------------
14:.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
17:.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20:.\" -----------------------------------------------------------------
22:.\" -----------------------------------------------------------------
27:.\" -----------------------------------------------------------------
29:.\" -----------------------------------------------------------------
-.-.
Output from "test-groff -mandoc -K utf8 -rF0 -rHY=0 -ww -z -t":
an.tmac:<stdin>:10: style: .TH expects 2 to 5 arguments, got 9
-.-
Additionally:
Size/bytes:
-.-
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
-.-
Tables:
Use the preprocessor 'tbl' to make tables.
Put data, that are wider than the header in the (centered) last column,
in a "T{...\nT}" block.
Table headings, that are wider than any data in the corresponding
column, do not need to be centered, so left adjustment (l, L) is
sufficient. There is thereby no change in the standard output.
--- XTestQueryExtension.3 2026-11-01 07:39:11.122116195 +0000
+++ XTestQueryExtension.3.new 2026-11-04 22:40:31.705408267 +0000
@@ -6,31 +6,31 @@
.\" Manual: XTST FUNCTIONS
.\" Source: "libXtst 1.2.6" "X Version 11"
.\" Language: English
-.\"
-.TH "XTEST" "3" "<pubdate>6 June 2007</pubdate>" ""libXtst 1.2.6" "X Version
11"" "XTST FUNCTIONS"
-.\" -----------------------------------------------------------------
+.
+.TH XTEST 3 "6 June 2007" "libXtst 1.2.6, X Version 11" "XTST FUNCTIONS"
+.
.\" * Define some portability stuff
-.\" -----------------------------------------------------------------
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.
+.
.\" http://bugs.debian.org/507673
-.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://lists.gnu.org/archive/html/groff/2009\-02/msg00013.html
+.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
-.\" -----------------------------------------------------------------
+.
.\" * set default formatting
-.\" -----------------------------------------------------------------
+.
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
-.\" -----------------------------------------------------------------
+.
.\" * MAIN CONTENT STARTS HERE *
-.\" -----------------------------------------------------------------
-.SH "NAME"
+.
+.SH NAME
XTestQueryExtension, XTestCompareCursorWithWindow,
XTestCompareCurrentCursorWithWindow, XTestFakeKeyEvent, XTestFakeButtonEvent,
XTestFakeMotionEvent, XTestFakeRelativeMotionEvent, XTestGrabControl,
XTestSetGContextOfGC, XTestSetVisualIDOfVisual, XTestDiscard \- XTest extension
functions
-.SH "SYNOPSIS"
-.sp
+.SH SYNOPSIS
+.\".sp
.ft B
.nf
cc [ flag \&.\&.\&. ] file \&.\&.\&. \-lXtst [ library \&.\&.\&. ]
@@ -43,7 +43,7 @@ cc [ flag \&.\&.\&. ] file \&.\&.\&. \-l
.fi
.ft
.HP \w'Bool\ XTestQueryExtension('u
-.BI "Bool XTestQueryExtension(" "display" ", " "event_base_return" ", "
"error_base_return" ", " "major_version_return" ", " "minor_version_return" ");"
+.BI "Bool XTestQueryExtension(" display ", " event_base_return ", "
error_base_return ", " major_version_return ", " minor_version_return );
.sp
.ft B
.nf
@@ -55,7 +55,7 @@ cc [ flag \&.\&.\&. ] file \&.\&.\&. \-l
.fi
.ft
.HP \w'Bool\ XTestCompareCursorWithWindow('u
-.BI "Bool XTestCompareCursorWithWindow(" "display" ", " "window" ", " "cursor"
");"
+.BI "Bool XTestCompareCursorWithWindow(" display ", " window ", " cursor );
.sp
.ft B
.nf
@@ -65,7 +65,7 @@ cc [ flag \&.\&.\&. ] file \&.\&.\&. \-l
.fi
.ft
.HP \w'Bool\ XTestCompareCurrentCursorWithWindow('u
-.BI "Bool XTestCompareCurrentCursorWithWindow(" "display" ", " "window" ");"
+.BI "Bool XTestCompareCurrentCursorWithWindow(" display ", " window );
.sp
.ft B
.nf
@@ -74,7 +74,7 @@ cc [ flag \&.\&.\&. ] file \&.\&.\&. \-l
.fi
.ft
.HP \w'int\ XTestFakeKeyEvent('u
-.BI "int XTestFakeKeyEvent(" "display" ", " "keycode" ", " "is_press" ", "
"delay" ");"
+.BI "int XTestFakeKeyEvent(" display ", " keycode ", " is_press ", " delay );
.sp
.ft B
.nf
@@ -85,7 +85,7 @@ cc [ flag \&.\&.\&. ] file \&.\&.\&. \-l
.fi
.ft
.HP \w'int\ XTestFakeButtonEvent('u
-.BI "int XTestFakeButtonEvent(" "display" ", " "button" ", " "is_press" ", "
"delay" ");"
+.BI "int XTestFakeButtonEvent(" display ", " button ", " is_press ", " delay );
.sp
.ft B
.nf
@@ -96,7 +96,7 @@ cc [ flag \&.\&.\&. ] file \&.\&.\&. \-l
.fi
.ft
.HP \w'int\ XTestFakeMotionEvent('u
-.BI "int XTestFakeMotionEvent(" "display" ", " "screen_number" ", " "x" ", "
"y" ", " "delay" ");"
+.BI "int XTestFakeMotionEvent(" display ", " screen_number ", " x ", " y ", "
delay );
.sp
.ft B
.nf
@@ -107,7 +107,7 @@ cc [ flag \&.\&.\&. ] file \&.\&.\&. \-l
.fi
.ft
.HP \w'int\ XTestFakeRelativeMotionEvent('u
-.BI "int XTestFakeRelativeMotionEvent(" "display" ", " "screen_number" ", "
"x" ", " "y" ", " "delay" ");"
+.BI "int XTestFakeRelativeMotionEvent(" display ", " screen_number ", " x ", "
y ", " delay );
.sp
.ft B
.nf
@@ -118,7 +118,7 @@ cc [ flag \&.\&.\&. ] file \&.\&.\&. \-l
.fi
.ft
.HP \w'int\ XTestGrabControl('u
-.BI "int XTestGrabControl(" "display" ", " "impervious" ");"
+.BI "int XTestGrabControl(" display ", " impervious );
.sp
.ft B
.nf
@@ -127,7 +127,7 @@ cc [ flag \&.\&.\&. ] file \&.\&.\&. \-l
.fi
.ft
.HP \w'void\ XTestSetGContextOfGC('u
-.BI "void XTestSetGContextOfGC(" "gc" ", " "gid" ");"
+.BI "void XTestSetGContextOfGC(" gc ", " gid );
.sp
.ft B
.nf
@@ -136,7 +136,7 @@ cc [ flag \&.\&.\&. ] file \&.\&.\&. \-l
.fi
.ft
.HP \w'void\ XTestSetVisualIDOfVisual('u
-.BI "void XTestSetVisualIDOfVisual(" "visual" ", " "visualid" ");"
+.BI "void XTestSetVisualIDOfVisual(" visual ", " visualid );
.sp
.ft B
.nf
@@ -145,15 +145,14 @@ cc [ flag \&.\&.\&. ] file \&.\&.\&. \-l
.fi
.ft
.HP \w'Status\ XTestDiscard('u
-.BI "Status XTestDiscard(" "display" ");"
+.BI "Status XTestDiscard(" display );
.sp
.ft B
.nf
Display *display;
.fi
.ft
-.SH "DESCRIPTION"
-.PP
+.SH DESCRIPTION
This extension is a minimal set of client and server extensions required to
completely test the X11 server with no user intervention\&. This extension is
not intended to support general journaling and playback of user actions\&.
.PP
The functions provided by this extension fall into two groups:
@@ -276,10 +275,8 @@ True
if any requests were discarded; otherwise, it returns
False\&.
.SH "RETURN VALUES"
-.PP
All routines that have return type Status will return nonzero for success and
zero for failure\&. Even if the XTEST extension is supported, the server may
withdraw such facilities arbitrarily; in which case they will subsequently
return zero\&.
-.SH "AUTHOR"
-.PP
+.SH AUTHOR
\fBKieron Drake\fR
.br
UniSoft Ltd\&.
Check the output from "lintian" in the Debian distribution.
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 most trailing spaces use
grep -n -e ' $' -e ' \\f.$' -e ' \\"' -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.
Debian can fix simple bugs in the used generators and distribute them,
and does not need to wait for upstream to do that and distribute them.
-.-
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 when that has been fixed.
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 a script "cmp.manuals" in the attachment.
Or
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)
-.-
#!/usr/bin/bash
# Compare two versions of a man page
# command old{file, directory} new{file, directory}
# command oldfile newfile
# command olddirectory newdirectory
set -eu
option=''
man_option='-mandoc' #-mandoc
Cmd_name=${0##*/}
echo main: parameters are $*
while getopts cd:em:r: opt
do
case $opt in
c) man_option="-rcR=1"
;;
d) man_option="-d$OPTARG"
;;
e) option=exact
;;
m) man_option="-m$OPTARG"
;;
r) man_option="-r$OPTARG"
;;
*) echo cmp.manuals: Error, wrong option \"$*\" >&2
exit
;;
esac
done
shift $((OPTIND - 1))
#echo main: option is $man_option ; exit 1
#echo main: parameters are $*
# Add appropriate options
if test \! -f "$1"
then
echo file $1 does not exist
exit 1
fi
if test \! -f "$2"
then
echo file $2 does not exist
exit 1
fi
case $man_option in
-man) man_option='-man -t -dAD=l -rHY=0'
;;
-mandoc) man_option='-mandoc -t -dAD=l -rHY=0'
;;
-me) man_option='-me'
;;
-ms) man_option='-ms -rpar*adj=0'
;;
-d*|-r*) :
;;
*) echo ${Cmd_name}: Unknown option for the macro packet $man_option
exit 1
;;
esac
tempuniq=$(mktemp --tmpdir $Cmd_name.XXXXXX )
uniqlines () {
uniq -d $inputX | sed -e '/^$/d' > $tempuniq
if test -s $tempuniq ; then
echo $Cmd_name: Equal lines in input from $inputX
cat $tempuniq
return 1
fi
return 0
}
compare () {
#printf 'option is %s\n' $option
inputA=old.${1##*/}
inputB=new.${2##*/}
if test ! $1 -ef /tmp/$inputA ; then
echo copy $1 to /tmp/$inputA
cp $1 /tmp/$inputA
fi
if test ! $2 -ef /tmp/$inputB ; then
echo copy $2 /tmp/$inputB
cp $2 /tmp/$inputB
fi
olddir=$PWD
cd /tmp
#MAN_KEEP_STDERR=yes
#MANOPT='--warnings=w --no-justification --no-hyphenation'
#MANWIDTH=80
#export MAN_KEEP_STDERR MANOPT MANWIDTH
# Have no sentence space (.ss 12 0)
#echo option is \"$option\"; exit 1
# getopt sets opt=? if there is no option
#echo opt is \"$opt\" >&2
if test "$opt" = '?' ; then
sed -e '/^.TH /i \
.ss 12 0\
.nr cR 1\
.kern 0\
.lg 0
s/\. *ad$/.ad l/
s/\. *ad /.ad l /
' $inputA
else
cat $inputA
fi | tee -p $inputA.intermed | \
test-nroff -t -K utf8 $man_option > $inputA.txt 2> /dev/null
#echo test-nroff man_option is $man_option for output inputA.txt >&2
# Check
echo inputA.txt from old version
ls -l $inputA.intermed
ls -l $inputA.txt
if find_cntrl $inputA.txt > /dev/null 2>&1
then
:
else
echo No formatting characters in file $inputA.txt >&2
fi
inputX=$inputA.txt
#if uniqlines ; then
# Remove multible empty lines
# uniq $inputA.txt > $tempuniq
# cp $tempuniq $inputA.txt
#fi
#echo opt is \"$opt\" >&2
if test "$opt" = '?' ; then
#echo opt is \"$opt\" >&2
sed -e '/^.TH /i \
.ss 12 0\
.nr cR 1\
.kern 0\
.lg 0
s/\. *ad$/.ad l/
s/\. *ad /.ad l /
' $inputB
else
cat $inputB
fi | tee -p $inputB.intermed | \
test-nroff -t -K utf8 $man_option > ${inputB}.txt 2> /dev/null
#echo test-nroff man_option is $man_option >&2
#Check
echo inputB from new version
ls -l $inputB.intermed
ls -l $inputB.txt
if find_cntrl ${inputB}.txt > /dev/null 2>&1
then
:
else
echo No formatting characters in file ${inputB}.txt >&2
fi
inputX=${inputB}.txt
#if uniqlines ; then
# Remove multible empty lines
# uniq $inputA.txt > $tempuniq
# cp $tempuniq $inputB.txt
#fi
#echo using diff.loc >&2
diff.loc -d $inputA.txt $inputB.txt > $inputA.txt.diff || :
# Difference in the output of "troff"
if test "$opt" = '?' ; then
sed -e '/^.TH /i \
.ss 12 0\
.nr cR 1\
.kern 0
s/\. *ad$/.ad l/
s/\. *ad /.ad l /
' $inputA
else
cat $inputA
fi | test-groff -t $man_option -K utf8 -Z \
> $inputA.ml 2> /dev/null
#echo test-groff man_option is $man_option >&2
#ls -l $inputA.ml
#stat $inputA.ml
if test \! -s $inputA.ml; then
echo $Cmd_name: intermediate file $inputA.ml is not produced >&2
ls -lt $inputA >&2
exit 1
fi
if test "$opt" = '?' ; then
sed -e '/^.TH /i \
.ss 12 0\
.nr cR 1\
.kern 0
s/\. *ad$/.ad l/
s/\. *ad /.ad l /
' $inputB
else
cat $inputB
fi | tee -p /tmp/input.to.groff | \
test-groff -t $man_option -Z -K utf8\
> $inputB.ml #2> /dev/null
#echo test-groff man_option is $man_option >&2
if test \! -s $inputB.ml; then
echo $Cmd_name: intermediate file $inputB.ml is not produced >&2
ls -l /tmp/input.to.groff >&2
exit 1
fi
#stat $inputB.ml
#ls -l $inputB.ml 1>&2
#printf 'option is = %s\n' "$option"
if test "$option" = 'exact'; then
# echo Using diff.loc >&2
diff.loc -d $inputA.ml $inputB.ml | \
sed -e '/^[-]V[0-9]\+$/d' -e '/^[+]V[0-9]\+$/d' > $inputA.ml.diff
else
echo Not exact diff between A.ml and B.ml >&2
# echo Using diff.loc >&2
diff.loc -d $inputA.ml $inputB.ml | \
sed -e '/^[-]V[0-9]\+$/d' -e '/^[+]V[0-9]\+$/d' > $inputA.ml.diff || :
fi
if test -s $inputA.txt.diff ; then
less -R $inputA.txt.diff
fi
if test -s $inputA.ml.diff ; then
if test "$option" = 'exact' ; then
less $inputA.ml.diff
else
rm.troff.space $inputA.ml.diff | less
fi
fi
cd $olddir
} # End of compare
#set -x
echo first file is $1
echo second file is $2
#echo Are in directory $PWD
if test -f $1 ; then
echo Comparing $1 with $2 >&2
compare $1 $2 |& sed -f $HOME/bin/groff.err.weedout
else
for new_file in $(find $2 -type f) ; do
old_file=$1/$(echo "$new_file" | sed -e 's#'$2'##')
echo oldfile=$old_file new_file=$new_file
compare $old_file $new_file |& sed -f $HOME/bin/groff.err.weedout
done
fi
#echo are in directory $PWD
