Subject: tcpspy.rules.5: Some remarks and a patch with editorial changes for this man page

From: Bjarni Ingi Gislason <[email-masked]>
Date: Sun, 16 Feb 2025 23:45:45 +0000

Package: tcpspy
Version: 1.7d-16
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 "groff -e ' $' -e '\\~$' <file>" to find obvious 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>:40: misuse, warning: .IR is for at least 2 arguments, got 1
	Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:83: misuse, warning: .BI is for at least 2 arguments, got 1
	Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:86: misuse, warning: .BI is for at least 2 arguments, got 1
	Use macro '.B' for one argument or split argument.
troff:<stdin>:135: warning: trailing space in the line
troff:<stdin>:142: 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: trixie/sid
  APT prefers testing
  APT policy: (500, 'testing')
Architecture: amd64 (x86_64)

Kernel: Linux 6.12.12-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 tcpspy depends on:
ii  libc6  2.40-6

tcpspy recommends no packages.

tcpspy suggests no packages.

-- no debconf information
--- tcpspy.rules.5	2025-02-16 15:38:18.840142782 +0000
+++ tcpspy.rules.5.new	2025-02-16 16:10:56.793468823 +0000
@@ -5,7 +5,7 @@
 .\" Copyright (c) 2001 Pablo Lorenzzoni.
 .\" Copyright (c) 2011 Mats Erik Andersson
 .\" All rights reserved.
-.\" 
+.\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
 .\" are met:
@@ -16,7 +16,7 @@
 .\"    documentation and/or other materials provided with the distribution.
 .\" 3. The name of the author may not be used to endorse or promote products
 .\"    derived from this software without specific prior written permission.
-.\" 
+.\"
 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
 .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 .\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
@@ -29,17 +29,18 @@
 .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
 .\" $Id: tcpspy.rules.5,v 1.33 2001/01/28 13:09:12 fyre Exp $
-.TH TCPSPY.RULES 5 "April 2001" Spectra "tcpspy.rules"
+.TH TCPSPY.RULES 5 "April 2001" Spectra tcpspy.rules
 .SH NAME
 tcpspy.rules \- configuration file for tcpspy
 .SH DESCRIPTION
-.LP
 This file, by default
 .IR /etc/tcpspy.rules ,
 is read by the
-.IR /etc/init.d/tcpspy 
-script at init time in order to configure
-tcpspy (see tcpspy(8)) logger filtering rules.
+.I /etc/init.d/tcpspy
+script at init time in order to configure tcpspy
+(see
+.BR tcpspy (8))
+logger filtering rules.
 .LP
 It might look like:
 .IP
@@ -52,23 +53,22 @@ lport 22 or lport 21
 .fi
 .LP
 This rules file specifies that tcpspy logs tcp connections according
-to 4 rules (line 1 to line 4 - one per each line) using the boolean
-logic (see below) to evaluate each rule.
+to 4 rules
+(line 1 to line 4 \(en one per each line)
+using the boolean logic (see below) to evaluate each rule.
 .LP
 This particular example logs connections:
 .TP
-line 1 - for user "joedoe" connecting to 192.168.1.10:22 (remote)
+line 1 \(en for user "joedoe" connecting to 192.168.1.10:22 (remote)
 .TP
-line 2 - for user whose UID is 1003
+line 2 \(en for user whose UID is 1003
 .TP
-line 3 - to *:22 or *:21 (both locally)
+line 3 \(en to *:22 or *:21 (both locally)
 .TP
-line 4 - for user "joedoe" to *:23 (local) or to 192.168.1.20 (remote)
+line 4 \(en for user "joedoe" to *:23 (local) or to 192.168.1.20 (remote)
 .LP
 Everything from an "#" signal and the end of the line will not be evaluated.
-.LP
-.PP
-.SS "Rule Syntax - just extracted from tcpspy(8)"
+.SS "Rule Syntax \(en just extracted from tcpspy(8)"
 A rule may be specified with the following comparison operators:
 .TP
 .BI user " uid"
@@ -80,28 +80,30 @@ user id
 .BI user " \N'34'username\N'34'"
 Same as above, but using a username instead of a user id.
 .TP
-.BI ip
+.B ip
 True if the connection is IPv4.
 .TP
-.BI ip6
+.B ip6
 True if the connection is IPv6.
 .TP
 .BI lport " port"
 True if the local end of the connection has port number
 .IR port .
 .TP
-.BI lport " [low] - [high]"
+.BI lport " [low] \(en [high]"
 True if the local end of the connection has a port number
 greater than or equal to
 .I low
 and less than or equal to
 .IR high .
 If the form
-.I low-
-is used, high is assumed to be 65535.
+.I low\-
+is used, high is assumed to be 65,535.
 If the form
-.I -high
-is used, low is assumed to be 0. It is an error to omit both
+.I \-high
+is used,
+low is assumed to be 0.
+It is an error to omit both
 .IR low " and " high .
 .TP
 .BI lport " \N'34'service\N'34'"
@@ -119,12 +121,17 @@ but compares the port number of the remo
 .BI laddr " n.n.n.n/m"
 .TP
 .BI laddr " ip6-addr[/m]"
-Interpreted as a "net/mask" expression; true if "net" is equal to the bitwise
-AND of the local address of the connection and "mask". If no mask is specified,
-a default mask with all bits set (255.255.255.255) is used. The CIDR type netmask
-is also possible. With IPv6 only a prefix length netmask is allowed, and the
-length defaults to 128. Depending on the address family, these rules contain
-an implicit match condition "ip" or "ip6", respectively.
+Interpreted as a "net/mask" expression;
+true if "net" is equal to the bitwise AND of the local address of the
+connection and "mask".
+If no mask is specified,
+a default mask with all bits set (255.255.255.255) is used.
+The CIDR type netmask is also possible.
+With IPv6 only a prefix length netmask is allowed,
+and the length defaults to 128.
+Depending on the address family,
+these rules contain an implicit match condition "ip" or "ip6",
+respectively.
 .TP
 .B raddr
 Same as
@@ -132,23 +139,27 @@ Same as
 but compares the remote address.
 .TP
 .BI exe " \N'34'pattern\N'34'"
-True if the full filename (including directory) of the executable that 
-created/accepted the connection matches
+True if the full filename
+(including directory)
+of the executable
+that created/accepted the connection matches
 .IR pattern ,
 a
 .BR glob (7)-style
 wildcard pattern.
 .IP
-The pattern "" (an empty string) matches connections created/accepted by 
+The pattern "" (an empty string) matches connections created/accepted by
 processes whose executable filename is unknown.
 .IP
 If the
-.B -p
-option is not specified, a warning message will be printed, and the result of
-this comparison will always be true.
+.B \-p
+option is not specified,
+a warning message will be printed,
+and the result of this comparison will always be true.
 .PP
-Expressions (including the  comparisons listed above) may be joined together
-with the following logical operations:
+Expressions
+(including the  comparisons listed above)
+may be joined together with the following logical operations:
 .TP
 .IB expr1 " or " expr2
 True if either of
@@ -169,13 +180,15 @@ True if
 .I expr
 is false (logical NOT).
 .PP
-Rules are evaluated from left to right. Whitespace (space, tab and newline)
-characters are ignored between "words". Rules consisting of only whitespace
-match no connections, but do not cause an error.
+Rules are evaluated from left to right.
+Whitespace
+(space, tab and newline)
+characters are ignored between "words".
+Rules consisting of only whitespace match no connections,
+but do not cause an error.
 Parentheses, '(' and ')' may be placed around expressions to affect the order
 of evaluation.
-.PP
-.SS "Examples"
+.SS Examples
 .TP
 These are some sample rules which further demonstrate how they are constructed:
 .TP
@@ -192,7 +205,7 @@ Log connections made by users "bob" and
 not on a fictional "intranet".
 
 .SH AUTHOR
-Tim J. Robbins (tcpspy),
+Tim J.\& Robbins (tcpspy),
 Pablo Lorenzzoni (this manpage) and  Mats Erik Andersson (changes for IPv6)
 
 .SH SEE ALSO