[Pkg-tcltk-devel] tclreadline.3tcl: Some remarks and a patch with editorial changes for this man page
Bjarni Ingi Gislason
bjarniig at simnet.is
Mon Sep 28 00:59:10 BST 2026
Package: tcl-tclreadline
Version: 2.5.0-1
Severity: minor
Tags: patch
Additional remarks.
Mails from me to "submit at bugs.debian.org" 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.
-.-
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 one already.
-.-
* 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 ":
an.tmac:<stdin>:1: style: .TH missing fifth argument and second argument '3tcl' not a recognized manual section; specify its title
troff:<stdin>:94: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:107: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:108: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:277: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:303: warning: end of sentence detected before end of text line [-w style]
Output from "test-nroff -mandoc -K utf8 -rF0 -rHY=0 -ww -z ":
an.tmac:<stdin>:1: style: .TH missing fifth argument and second argument '3tcl' not a recognized manual section; specify its title
troff:<stdin>:94: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:107: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:108: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:277: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:303: warning: end of sentence detected before end of text line [-w style]
* 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.6+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 tcl-tclreadline depends on:
ii libc6 2.43-6
ii libreadline8t64 8.3-4
ii tcl 8.6.18
ii tcl8.6 8.6.18+dfsg-1
ii tcl9.0 9.0.4+dfsg-1
tcl-tclreadline recommends no packages.
tcl-tclreadline suggests no packages.
-- no debconf information
-------------- next part --------------
Input file is tclreadline.3tcl
Output from "mandoc -T lint tclreadline.3tcl": (shortened list)
1 WARNING: skipping paragraph macro: PP after SH
2 WARNING: skipping paragraph macro: sp after PP
-.-.
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 "\-\-".
tclreadline.3tcl:181:-- audible or visible.
tclreadline.3tcl:204:completion characteristics as variable -- try something like "puts $b<TAB>" --
tclreadline.3tcl:205:and command completion -- try "puts [in<TAB>".
-.-.
Reduce space between words.
tclreadline.3tcl:131:or the custom completer returned an empty string. The builtin
tclreadline.3tcl:243:prompting for continuation of an incomplete command.
tclreadline.3tcl:317:Citing the readline manual: It's too big and too slow.
-.-.
Change - to \- if it shall be printed as a minus sign.
tclreadline.3tcl:276:This number is -1 by default, which means that the historyfile
-.-.
Use "\e" to print the escape character instead of "\\" (which gets
interpreted in copy mode).
218:something like "[info nameofexecutable] \\[[pwd]\\]" possibly fancy colored.
310: "\\C-xp": "puts $env(PATH)"
-.-.
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.
181:-- audible or visible.
204:completion characteristics as variable -- try something like "puts $b<TAB>" --
205:and command completion -- try "puts [in<TAB>".
276:This number is -1 by default, which means that the historyfile
-.-.
Add a "\&" (or a comma (Oxford comma)) after an abbreviation
or use English words
(man-pages(7)).
Abbreviation points should be marked as such and protected against being
interpreted as an end of sentence, if they are not, and that independent
of the current place on the line.
75:implemented in the shared lib (e.g. libtclreadline2.5.0.so).
303:is used normally for all programs which use the gnu readline (e.g. bash).
-.-.
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.]
-.-.
Add a zero (0) in front of a decimal fraction that begins with a period
(.)
17:.ta .25i .5i .75i 1i
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
[List of affected lines removed.]
tclreadline.3tcl:75:implemented in the shared lib (e.g. libtclreadline2.5.0.so).
tclreadline.3tcl:111:completion is enabled (see \fBtclreadline::readline builtincompleter\fP),
tclreadline.3tcl:121:will complete "$b" to "$bl" (the longest match) and offer a list of two
tclreadline.3tcl:134:custom completer (also, if called w/o the \fIbool\fP argument).
tclreadline.3tcl:303:is used normally for all programs which use the gnu readline (e.g. bash).
-.-.
No space is needed before a quote (") at the end of a line
228: return "[clock format [clock seconds]]> "
-.-.
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 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.
1:.TH tclreadline 3tcl "2.5.0" "Johannes Zellner"
25:.SH "NAME"
28:.SH "SYNOPSIS"
33:.SH "DESCRIPTION"
63:.SH "COMMANDS"
245:.\" .SH "EXAMPLES"
250:.SH "VARIABLES"
279:.SH "FILES"
316:.SH "BUGS"
332:.SH "AUTHOR"
347:.SH "DISCLAIMER"
-.-.
Add "\&" after an ellipsis, when it does not end a sentence.
283:file might be \fB.wishrc\fP ... depending on what interpreter you use.
-.-.
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.
5:.\" ---
10:.\" ---
-.-.
Output from "test-groff -mandoc -K utf8 -rF0 -rHY=0 -ww -z ":
troff:<stdin>:94: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:107: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:108: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:277: warning: end of sentence detected before end of text line [-w style]
troff:<stdin>:303: warning: end of sentence detected before end of text line [-w style]
-.-
Additionally:
Size/bytes:
12203 tclreadline.3tcl
12157 tclreadline.3tcl.new
-.-
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.
-------------- next part --------------
--- tclreadline.3tcl 2026-09-27 23:10:55.028464374 +0000
+++ tclreadline.3tcl.new 2026-09-27 23:44:09.355678992 +0000
@@ -1,20 +1,19 @@
-.TH tclreadline 3tcl "2.5.0" "Johannes Zellner"
+.TH tclreadline 3tcl 2.5.0 "Johannes Zellner"
.\" FILE: tclreadline.n.in
.\" $Id: d78d18368ac5980d7692a4c46835c2b56c23f7a1 $
-.\" ---
+.
.\" tclreadline -- gnu readline for tcl
.\" https://github.com/flightaware/tclreadline/
.\" Copyright (c) 1998 - 2014, Johannes Zellner <johannes at zellner.org>
.\" This software is copyright under the BSD license.
-.\" ---
-
+.
.\" # CS - begin code excerpt
.de CS
.RS
.nf
-.ta .25i .5i .75i 1i
+.ta 0.25i 0.5i 0.75i 1i
..
.\" # CE - end code excerpt
.de CE
@@ -22,16 +21,14 @@
.RE
..
-.SH "NAME"
+.SH NAME
tclreadline \- gnu readline for the tcl scripting language
-.SH "SYNOPSIS"
+.SH SYNOPSIS
.TP 6
\fB::tclreadline::readline\fP \fIcommand\fP [\fIoptions\fP]
-
-.SH "DESCRIPTION"
-
+.SH DESCRIPTION
The \fBtclreadline\fP package makes the gnu readline available
to the scripting language tcl. The primary purpose of the package
is to facilitate the interactive script development by the means
@@ -43,25 +40,19 @@ which want to use a shell like input int
\fB::tclreadline::readline read\fP command has to be called explicitly.
.PP
-
The advantage of \fBtclreadline\fP is that it uses the callback
handler mechanism of the gnu readline while it processes tcl
events. This way X events from a wish gui will be processed as
well as events from the \fPtclreadline\fP line interface.
.PP
-
\fBtclreadline\fP is basically a shared library and a few tcl scripts
which are accessed with the tcl package require command. Therefore
\fBtclreadline\fP should work with all common extensions like
-\fBblt, itcl, itk, tix ...\fP.
-
+\fBblt, itcl, itk, tix\fP \&...
.\" .SH SOURCE FILES
-
-
-.SH "COMMANDS"
-
+.SH COMMANDS
If you want to use \fBtclreadline\fP as a line interface
for developing tcl scripts, you probably don't have to read
this section. In this case the only thing you should do is
@@ -72,7 +63,7 @@ the readline's documentation.
.PP
The following list will give all commands, which are currently
-implemented in the shared lib (e.g. libtclreadline2.5.0.so).
+implemented in the shared lib (e.g., libtclreadline2.5.0.so).
Additional commands were introduced in a startup script
\fBtclreadlineSetup.tcl\fP, which lives in the tclreadline
installation directory.
@@ -81,7 +72,6 @@ These commands are primarily for interna
Note that all commands reside in the namespace \fB::tclreadline::\fP.
-
.TP 5
\fB::tclreadline::readline add\fP \fIstring\fP
Adds a string to the completer. If the string contains white
@@ -91,7 +81,7 @@ hitting <Tab>. Example:
::tclreadline::readline add "button pathName ?options?"
Typing but<Tab> will complete to button. Hitting <Tab> again
-will complete to "button pathName". ...
+will complete to "button pathName" \&...
.TP 5
\fB::tclreadline::readline complete\fP \fIstring\fP
@@ -104,8 +94,10 @@ with exactly four arguments each time co
the word to complete ("text"), the "start" and "end" positions of this word
in the line entered so far, and this line ("line"). The custom completion
script should return an array of strings which is a list of completions
-for "text". If there are no completions, it should return an empty
-string "". The first entry in the returned list is the substitution
+for "text".
+If there are no completions, it should return an empty
+string "".
+The first entry in the returned list is the substitution
for "text". The remaining entries are the possible completions. If
the custom completion script returns an empty string and builtin
completion is enabled (see \fBtclreadline::readline builtincompleter\fP),
@@ -128,7 +120,7 @@ the file tclreadlineSetup.tcl.
\fB::tclreadline::readline builtincompleter\fP [\fIbool\fP]
Enable or disable the builtin completer. If the builtin completer
is enabled, it will be invoked either if there is no custom completer,
-or the custom completer returned an empty string. The builtin
+or the custom completer returned an empty string. The builtin
completer is on by default.
\fBtclreadline::readline builtincompleter\fP returns the current
custom completer (also, if called w/o the \fIbool\fP argument).
@@ -178,7 +170,7 @@ value.
.TP 5
\fB::tclreadline::readline bell\fP
Ring the terminal bell, obeying the setting of bell-style
--- audible or visible.
+\(en audible or visible.
.TP 5
\fB::tclreadline::text\fP
@@ -201,8 +193,8 @@ arguments, it returns the current settin
Enter the tclreadline main loop. This command is typically called from
the startup resource file (something .tclshrc, depending on the interpreter
you use, see the file `sample.tclshrc'). The main loop sets up some
-completion characteristics as variable -- try something like "puts $b<TAB>" --
-and command completion -- try "puts [in<TAB>".
+completion characteristics as variable \(en try something like "puts $b<TAB>" \(en
+and command completion \(en try "puts [in<TAB>".
If the optional argument \fIhistoryfile\fP is given, this file will
be used for reading and writing the command history instead of the
default \fB.tclsh-history\fP.
@@ -215,7 +207,7 @@ it is probably a good idea to start with
\fB::tclreadline::prompt1\fP
A proc which is called by ::tclreadline::Loop and returns a string
which will be displayed as the primary prompt. This prompt will be
-something like "[info nameofexecutable] \\[[pwd]\\]" possibly fancy colored.
+something like "[info nameofexecutable] \e[[pwd]\e]" possibly fancy colored.
The default proc is defined on entering the ::tclreadline::Loop,
if it is not already defined. So: If you define your own proc
::tclreadline::prompt1 before entering ::tclreadline::Loop, this
@@ -225,7 +217,7 @@ Example:
package require tclreadline
namespace eval tclreadline {
proc prompt1 {} {
- return "[clock format [clock seconds]]> "
+ return "[clock format [clock seconds]]>"
}
}
::tclreadline::Loop
@@ -240,15 +232,12 @@ in the file tclreadlineSetup.tcl in your
\fB::tclreadline::prompt2\fP
A proc which is called by ::tclreadline::Loop and returns a string
which will be displayed as the secondary prompt when interactively
-prompting for continuation of an incomplete command.
-
-.\" .SH "EXAMPLES"
-
+prompting for continuation of an incomplete command.
+.\" .SH EXAMPLES
.\" .SH "ENVIRONMENT VARIABLES"
.SH "VARIABLES"
-
\fItclreadline\fP defines the following variables in the
namespace \fI::tclreadline\fP:
(for backwards compatibility the global variables tclreadline_version,
@@ -273,14 +262,14 @@ Holds a BSD license statement.
.TP 5
\fBtclreadline::historyLength\fP
Number of lines, which will be written to the historyfile.
-This number is -1 by default, which means that the historyfile
-will not be truncated. See also \fBtclreadline::write\fP.
-
-.SH "FILES"
+This number is \-1 by default, which means that the historyfile
+will not be truncated.
+See also \fBtclreadline::write\fP.
+.SH FILES
The \fB.tclshrc\fP file in the HOME directory, which
is read on tclsh startup. Alternatively, the name of this initialization
-file might be \fB.wishrc\fP ... depending on what interpreter you use.
+file might be \fB.wishrc\fP \&...\& depending on what interpreter you use.
These files should typically contain something like
.CS
if {$tcl_interactive} {
@@ -299,28 +288,24 @@ no history is written. For the future it
handler, which will write the history on <ctrl-c> before exiting.
.PP
-The \fB.inputrc\fP file in the users HOME directory. This file
-is used normally for all programs which use the gnu readline (e.g. bash).
+The \fB.inputrc\fP file in the users HOME directory.
+This file
+is used normally for all programs which use the gnu readline (e.g., bash).
The `global' readline settings there will be valid also for
\fBtclreadline\fP. Additionally the .inputrc might hold conditional
settings for the implementation name \fBtclreadline\fP. Example of
some lines in your .inputrc:
.CS
$if tclreadline
- "\\C-xp": "puts $env(PATH)"
+ "\eC-xp": "puts $env(PATH)"
$endif
.CE
For further documentation please refer to the gnu readline documentation.
-.SH "BUGS"
+.SH BUGS
Citing the readline manual: It's too big and too slow.
-
-
.SH "SEE ALSO"
-
-
-.PP
The official \fBtclreadline\fP web site at:
.PP
@@ -328,8 +313,7 @@ The official \fBtclreadline\fP web site
https://github.com/flightaware/tclreadline/
.RE
-
-.SH "AUTHOR"
+.SH AUTHOR
Johannes Zellner, <johannes at zellner.org>
.SH "CONTRIBUTIONS, SUGGESTIONS AND PATCHES"
@@ -337,15 +321,14 @@ Magnus Eriksson <magnus.eriksson at netinsi
Les Johnson <les at infolabs.com>,
Harald Kirsch <kir at iitb.fhg.de>,
Christian Krone <krischan at sql.de>,
-Larry W. Virden <lvirden at cas.org>,
+Larry W.\& Virden <lvirden at cas.org>,
David Engel <dlengel at home.com> <david at debian.org>,
Matthew Clarke <Matthew_Clarke at mindlink.bc.ca>
.SH "DEBIAN PACKAGE"
David Engel <dlengel at home.com>, <david at debian.org>
-.SH "DISCLAIMER"
-
+.SH DISCLAIMER
\fBtclreadline\fP comes with a BSD type license.
The read-only variable tclreadline::license holds the
complete license statement.
-------------- next part --------------
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)
-.-
-------------- next part --------------
#!/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
More information about the Pkg-tcltk-devel
mailing list