Package: whois
Version: 5.5.17
Severity: minor
Tags: patch

Dear Maintainer,

here are some notes and editorial fixes for the man page.

-.-.

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

"groff -man -Z" instead of "nroff -man"

-.-.

Output from "mandoc -T lint whois.1":

mandoc: whois.1:45:2: WARNING: skipping paragraph macro: PP empty
mandoc: whois.1:58:2: WARNING: skipping paragraph macro: PP empty

-.-.

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.


210:When querying the Verisign gTLDs (e.g. .com, .net...) thin registry servers

-.-.

Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.

188:.I -q sources
234:.IR "-T dn" .

-.-.

Add a comma (or \&) after "e.g." and "i.e.", or use English words
(man-pages(7).
Abbreviation points should be protected against being interpreted as
an end of sentence, if they are not, and that independent of the
current place on the line.

210:When querying the Verisign gTLDs (e.g. .com, .net...) thin registry servers

-.-.

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.

  The amount of space between sentences in the output can then be
controlled with the ".ss" request.

N.B

  The number of lines affected is too large to be in the patch.


53:ask for the specified object. If no guess can be made it will connect to
80:whois server authoritative for that request. This works for IP addresses,
109:Disable objects filtering. (Show the e-mail addresses.)
125:update serial number. It is useful to obtain Near Real Time Mirroring 
stream.
139:Return primary key attributes only. An exception is the
143:objects, which is always returned. Another exception are all
210:When querying the Verisign gTLDs (e.g. .com, .net...) thin registry servers
243:servers. This may or may not be the behaviour intended by the user.
252:to find a server before applying the normal rules. Each line of the
283:of objects are located. If the variable does not exist then

-.-.

Protect a period (.) or a apostrophe (') with '\&' from becoming a
control character, if it could end up at the start of a line (by
splitting the line into more lines).

210:When querying the Verisign gTLDs (e.g. .com, .net...) thin registry servers

-.-.

Split a punctuation from a single argument, if a two-font macro is meant

131:.I ATTR[,ATTR]...
183:.I SOURCE[,SOURCE]...
197:.I TYPE[,TYPE]...

-.-.

Output from "test-nroff -man -b -ww -z -rCHECKSTYLE=3":


[ "test-groff" is a developmental version of "groff" ]

Input file is ./whois.1

Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z 
-rSTYLECHECK=3":
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':613: macro 'BR'
troff: backtrace: file '<stdin>':17
troff:<stdin>:17: warning: trailing space in the line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':613: macro 'BR'
troff: backtrace: file '<stdin>':20
troff:<stdin>:20: warning: trailing space in the line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':613: macro 'BR'
troff: backtrace: file '<stdin>':23
troff:<stdin>:23: warning: trailing space in the line

-.-.

--- whois.1     2023-07-07 22:29:42.000000000 +0000
+++ whois.1.new 2023-07-07 23:02:31.000000000 +0000
@@ -42,7 +42,6 @@ whois \- client for the whois directory
 
 .B whois \-\-version
 
-.PP
 .SH DESCRIPTION
 .B whois
 searches for an object in a
@@ -55,11 +54,10 @@ ask for the specified object. If no gues
 for NIC handles or
 .I whois.arin.net
 for IPv4 addresses and network names.
-.PP
 .SH OPTIONS
 .TP 8
 .B \-h \c
-.IR HOST ", "\c
+.IR HOST ,
 .BI \-\-host= HOST
 Connect to
 .IR HOST .
@@ -68,7 +66,7 @@ Connect to
 Do not display the legal disclaimers that some registries like to show you.
 .TP 8
 .B \-p \c
-.IR PORT ", "\c
+.IR PORT ,
 .BI \-\-port= PORT
 Connect to
 .IR PORT .
@@ -106,7 +104,8 @@ Also search all the mirrored databases.
 Return brief IP address ranges with abuse contact.
 .TP 8
 .B \-B
-Disable objects filtering. (Show the e-mail addresses.)
+Disable objects filtering.
+(Show the e-mail addresses.)
 .TP 8
 .B \-c
 Return the smallest IP address range with a reference to an irt object.
@@ -128,7 +127,7 @@ update serial number. It is useful to ob
 Disable grouping of associated objects.
 .TP 8
 .B \-i \c
-.I ATTR[,ATTR]...
+.IR ATTR [, ATTR ]...
 Inverse-search objects having associated attributes.
 .I ATTR
 is the attribute name, while the positional
@@ -180,12 +179,12 @@ Disable following referrals and force sh
 in the server.
 .TP 8
 .B \-s \c
-.I SOURCE[,SOURCE]...
+.IR SOURCE [, SOURCE ]...
 Request the server to search for objects mirrored from
 .IR SOURCE .
 Sources are delimited by comma, and the order is significant.
 Use the
-.I -q sources
+.I \-q sources
 parameter to obtain a list of valid sources.
 .TP 8
 .B \-t \c
@@ -194,7 +193,7 @@ Return the template for a object of
 .IR TYPE .
 .TP 8
 .B \-T \c
-.I TYPE[,TYPE]...
+.IR TYPE [, TYPE ]...
 Restrict the search to objects of
 .IR TYPE .
 Multiple types are separated by a comma.
@@ -207,7 +206,7 @@ Return the verbose template for a object
 .B \-x
 Search for only exact match on network address prefix.
 .SH NOTES
-When querying the Verisign gTLDs (e.g. .com, .net...) thin registry servers
+When querying the Verisign gTLDs (e.g.\& \&.com, \&.net...\&) thin registry 
servers
 for a domain, the program will automatically prepend the
 .I domain
 keyword to only show domain records.  The
@@ -231,7 +230,7 @@ When querying
 .I whois.denic.de
 for domain names and no other
 flags have been specified, the program will automatically add the flag
-.IR "-T dn" .
+.IR "\-T dn" .
 .P
 When querying
 .I whois.dk\-hostmaster.dk



-- System Information:
Debian Release: trixie/sid
  APT prefers testing
  APT policy: (500, 'testing')
Architecture: amd64 (x86_64)

Kernel: Linux 6.3.7-1 (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 whois depends on:
ii  libc6      2.37-3
ii  libcrypt1  1:4.4.35-1
ii  libidn2-0  2.3.3-1+b1

whois recommends no packages.

whois suggests no packages.

-- no debconf information

Reply via email to