Package: expect
Version: 5.45.4-3+b1
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 -ww -z < "man page"
[Use "groff -e ' $' <file>" to find 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?
an.tmac:<stdin>:1: style: .TH missing fourth argument; consider package/project
name and version (e.g., "groff 1.23.0")
troff:<stdin>:48: warning: trailing space in the line
troff:<stdin>:74: warning: trailing space in the line
troff:<stdin>:116: warning: trailing space in the line
troff:<stdin>:146: warning: trailing space in the line
an.tmac:<stdin>:152: style: .BI expects at least 2 arguments, got 1
an-end-check:<stdin>: Warning: Different number of .RS and .RE calls,
an-RS-open=1 at end of file
* 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: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.11.10-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 expect depends on:
ii libc6 2.40-4
ii libtcl8.6 8.6.15+dfsg-2
ii tcl-expect 5.45.4-3+b1
ii tcl8.6 8.6.15+dfsg-2
expect recommends no packages.
Versions of packages expect suggests:
ii tk8.6 8.6.15-1
-- no debconf information
Input file is expect_xkibitz.1
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>
The same goes for man pages that are used as an input.
For a style guide use
mandoc -T lint
-.-
So any 'generator' should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
This is just a simple quality control measure.
The 'generator' may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Input text line longer than 80 bytes.
Not removing trailing spaces (in in- and output).
The reason for these trailing spaces should be found and eliminated.
Not beginning each input sentence on a new line.
Lines should thus be shorter.
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 -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 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 -b -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Output from "mandoc -T lint expect_xkibitz.1": (shortened list)
2 skipping paragraph macro
4 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z expect_xkibitz.1": (shortened list)
4 trailing space in the line
-.-.
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
4
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
152:.BI -S
-.-.
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.
60:To drop a display, enter "- tag" where tag is the display's tag
110: xkibitz -display mercury -display fox -display dragon:1.0
141: XKIBITZ_XTERM_ARGS="-sb -ms green"
145:(this is for the Bourne shell - use whatever syntax is appropriate for your
149:.BR -display ,
150:.B -geometry
152:.BI -S
-.-.
Wrong distance 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 abbreviation point as such by suffixing them with "\\&".
133:master (the display with tag number 0). Otherwise this name remains empty.
146:favorite shell). Any option can be given that is valid for the
168:Vol. 23, No. 5, May, 1993.
-.-.
Use \(en (en-dash) for a dash at the beginning of a line,
or between space characters,
not a minus (\-) or a hyphen (-), except in the NAME section.
expect_xkibitz.1:145:(this is for the Bourne shell - use whatever syntax is
appropriate for your
-.-.
Name of a manual is set in bold, the section in roman.
See man-pages(7).
87:can produce various effects. For example, you can emulate a multi-way
write(1)
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
Not considered in a patch, too many lines.
expect_xkibitz.1:49:upon entering an escape (described when xkibitz starts) can
add
expect_xkibitz.1:70:types ^D (and the shell accepts this to be EOF), the shell
terminates
expect_xkibitz.1:133:master (the display with tag number 0). Otherwise this
name remains empty.
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:1: style: .TH missing fourth argument; consider package/project
name and version (e.g., "groff 1.23.0")
troff:<stdin>:48: warning: trailing space in the line
troff:<stdin>:74: warning: trailing space in the line
troff:<stdin>:116: warning: trailing space in the line
troff:<stdin>:146: warning: trailing space in the line
an.tmac:<stdin>:152: style: .BI expects at least 2 arguments, got 1
an-end-check:<stdin>: Warning: Different number of .RS and .RE calls,
an-RS-open=1 at end of file
-.-.
Additionally (general):
Abbreviations get a '\&' added after their final full stop (.) to mark them
as such and not as an end of a sentence.
--- expect_xkibitz.1 2024-12-18 08:22:34.247757015 +0000
+++ expect_xkibitz.1.new 2024-12-18 08:34:07.169559487 +0000
@@ -8,7 +8,6 @@ xkibitz \- allow multiple people to inte
] [
.I program program-args...
]
-.br
.SH INTRODUCTION
.B xkibitz
allows users in separate xterms to share one shell (or any program
@@ -38,16 +37,20 @@ If you want to have a large number of pe
walk-through, you can sit two in front of each workstation, and then
connect them all together while you everyone looks at code together
in the editor.
+.RE
.SH USAGE
To start
.BR xkibitz ,
one user (the master) runs xkibitz with no arguments.
.B xkibitz
-starts a new shell (or another program, if given on the command
-line). The user can interact normally with the shell, or
-upon entering an escape (described when xkibitz starts) can add
-users to the interaction.
+starts a new shell
+(or another program,
+if given on the command line).
+The user can interact normally with the shell,
+or upon entering an escape
+(described when xkibitz starts)
+can add users to the interaction.
To add users, enter "+ display" where display is the X display name.
If there is no ":X.Y" in the display name, ":0.0" is assumed.
@@ -57,7 +60,7 @@ a tag \- a small integer which can be us
To show the current tags and displays, enter "=".
-To drop a display, enter "- tag" where tag is the display's tag
+To drop a display, enter "\- tag" where tag is the display's tag
according to the "=" command.
To return to the shared shell, enter "return". Then the keystrokes of
@@ -66,12 +69,14 @@ the output from the shell.
To terminate
.B xkibitz
-it suffices to terminate the shell itself. For example, if any user
-types ^D (and the shell accepts this to be EOF), the shell terminates
-followed by
+it suffices to terminate the shell itself.
+For example,
+if any user types ^D
+(and the shell accepts this to be EOF),
+the shell terminates followed by
.BR xkibitz .
-Normally, all characters are passed uninterpreted. However, in the
+Normally, all characters are passed uninterpreted. However, in the
escape dialogue the user talks directly to the
.B xkibitz
interpreter. Any
@@ -84,11 +89,11 @@ suspend or restart
.BR xkibitz .
Various processes
-can produce various effects. For example, you can emulate a multi-way write(1)
+can produce various effects. For example, you can emulate a multi-way
+.BR write (1)
session with the command:
xkibitz sleep 1000000
-.PP
.SH ARGUMENTS
.B xkibitz
understands a few special arguments
@@ -107,13 +112,13 @@ adds a display much like the "+" command
can be given. For example, to start up xkibitz with three additional
displays:
- xkibitz -display mercury -display fox -display dragon:1.0
+ xkibitz \-display mercury \-display fox \-display dragon:1.0
.SH CAVEATS
Due to limitations in both X and UNIX, resize propagation is weak.
When the master user resizes the xterm, all the other xterms are logically
-resized.
+resized.
Unfortunately, xkibitz cannot force the physical xterm size to correspond
with the logical xterm sizes.
@@ -130,7 +135,9 @@ other program is given on the command li
If the environment variable DISPLAY is defined, its value is used for the
display name of the
.B xkibitz
-master (the display with tag number 0). Otherwise this name remains empty.
+master
+(the display with tag number 0).
+Otherwise this name remains empty.
Additional arguments may be passed to new xterms through
the environment variable XKIBITZ_XTERM_ARGS.
@@ -138,18 +145,19 @@ For example, to create xterms
with a scrollbar and a green pointer cursor:
.nf
- XKIBITZ_XTERM_ARGS="-sb -ms green"
+ XKIBITZ_XTERM_ARGS="\-sb \-ms green"
export XKIBITZ_XTERM_ARGS
.fi
-(this is for the Bourne shell - use whatever syntax is appropriate for your
-favorite shell). Any option can be given that is valid for the
+(this is for the Bourne shell \(en use whatever syntax is appropriate for your
+favorite shell).
+Any option can be given that is valid for the
.B xterm
command, with the exception of
-.BR -display ,
-.B -geometry
+.BR \-display ,
+.B \-geometry
and
-.BI -S
+.B \-S
as those are set by
.BR xkibitz .
.SH SEE ALSO
@@ -165,6 +173,6 @@ O'Reilly and Associates, January 1995.
.I
"kibitz \- Connecting Multiple Interactive Programs Together", \fRby Don Libes,
Software \- Practice & Experience, John Wiley & Sons, West Sussex, England,
-Vol. 23, No. 5, May, 1993.
+Vol.\& 23, No.\& 5, May, 1993.
.SH AUTHOR
Don Libes, National Institute of Standards and Technology
