Package: rsyslog
Version: 8.36.0-1
Severity: minor
Tags: patch
The patch is in the attachment.
Summary:
Remove space at end of lines.
Fix warnings from test-groff.
Change a two-fonts macro to an one-font macro for a
single argument.
Change a HYPHEN-MINUS (code 0x55, 2D) to a dash
(minus) if it matches " -[:alpha:]" or \(aq-[:alpha:] (for options).
Add a comma (or \&) after "e.g." and "i.e." or use English words.
Split long lines (> 80).
Remove superfluous quotation marks (") from the argument of a
single-font macro.
Fix spelling of "orignally" and "childs".
Details:
Input file is rsyslogd.8
mandoc: rsyslogd.8:6:42: STYLE: whitespace at end of input line
mandoc: rsyslogd.8:72:39: STYLE: whitespace at end of input line
mandoc: rsyslogd.8:220:38: STYLE: whitespace at end of input line
This was not changed:
mandoc: rsyslogd.8:23:2: WARNING: skipping paragraph macro: LP empty
mandoc: rsyslogd.8:78:2: WARNING: skipping paragraph macro: LP empty
mandoc: rsyslogd.8:123:2: WARNING: skipping paragraph macro: LP empty
mandoc: rsyslogd.8:140:2: WARNING: skipping paragraph macro: PP empty
mandoc: rsyslogd.8:160:2: WARNING: skipping paragraph macro: LP empty
mandoc: rsyslogd.8:193:2: WARNING: skipping paragraph macro: LP empty
mandoc: rsyslogd.8:292:2: WARNING: skipping paragraph macro: LP empty
#######
Test nr. 2:
Enable and fix warnings from 'test-groff'.
<rsyslogd.8>:116 (macro BI): only 1 argument, but more are expected
<rsyslogd.8>:283 (macro BR): only 1 argument, but more are expected
Output is from: test-groff -b -e -mandoc -T utf8 -rF0 -t -w w -z
[ "test-groff" is a developmental version of "groff" ]
####
Test nr. 16:
Use the correct macro for the font change of a single argument.
116:.BI "\-C"
283:.BR http://www.rsyslog.com/doc
#####
Test nr. 25:
Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.
98:the reserved name "NONE" (all upper case!), so "-iNONE".
110:interactively in foreground, specifying -f <config-file> and -N level.
112:not specifying the -N option at all (so this makes limited sense) and
131:kill -SIGNAL $(cat /var/run/rsyslogd.pid)
134:Note that -SIGNAL must be replaced with the actual signal
138:kill -HUP $(cat /var/run/rsyslogd.pid)
238:in the startup than command line options (i.e. -d) and as such
#####
Test nr. 40:
Add a comma (or \&) after "e.g." and "i.e." or use English words
(man-pages(7) [package "manpages"]).
135:you are trying to send, e.g. with HUP. So it then becomes:
228:is specified during compilation (e.g. /usr/local).
238:in the startup than command line options (i.e. -d) and as such
249:times, one file each (e.g. export RSYSLOG_DEBUG="LogFuncFlow
253:information is printed (e.g. abort case)!
#####
THIS IS NOT CONSIDERED AS THERE ARE TOO MANY CASES.
Test nr. 41:
Wrong distance between sentences or protect the indicator.
1) Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) [package "manpages"] and "info groff".
Or
2) Adjust space between sentences (two spaces),
3) or protect the indicator by adding "\&" after it.
The "indicator" is an "end-of-sentence character" (.!?).
49:program is. The rsyslog package supports free definition of output formats
50:via templates. It also supports precise timestamps and writing directly
51:to databases. If the database option is used, tools like phpLogCon can
58:ensure that rsyslogd follows its default, standard BSD behavior. Of course,
60:template system. However, rsyslogd should be able to use a standard
61:syslog.conf and act like the original syslogd. However, an original syslogd
62:will not work correctly with a rsyslog-enhanced configuration file. At
76:the error element is ignored. It is tried to parse the rest of the line.
82:Runs the Bison config parser in debug mode. This may help when hard to find
83:syntax errors are reported. Please note that the output generated is deeply
87:Turns on debug mode. See the DEBUGGING section for more information.
97:run on a single machine. To disable writing a pid file, use
107:Do a config check. Do NOT run in regular mode, just check configuration
109:This option is meant to verify a config file. To do so, run rsyslogd
111:The level argument modifies behaviour. Currently, 0 is the same as
113:1 actually activates the code. Later, higher levels will mean more
117:This prevents rsyslogd from changing to the root directory. This
118:is almost never a good idea in production use. This option was introduced
135:you are trying to send, e.g. with HUP. So it then becomes:
188:the information obtained from the packets for malicious things. Also, an
190:which could lead to a wrong perception of system activity. These can
191:be prevented by using GSS-API authentication and encryption. Be sure
201:environment variable and the signals received. When run in foreground,
202:the information is written to stdout. An additional output file can be
226:modules. The
228:is specified during compilation (e.g. /usr/local).
232:Controls runtime debug support. It contains an option string with the
237:Turns on debugging and prevents forking. This is processed earlier
238:in the startup than command line options (i.e. -d) and as such
239:enables earlier debugging output. Mutually exclusive with DebugOnDemand.
241:Enables debugging but turns off debug output. The output can be toggled
242:by sending SIGUSR1. Mutually exclusive with Debug.
246:Specifies which files to trace LogFuncFlow. If not set (the
247:default), a LogFuncFlow trace is provided for all files. Set to
249:times, one file each (e.g. export RSYSLOG_DEBUG="LogFuncFlow
253:information is printed (e.g. abort case)!
258:Print mutex action as it happens. Useful for finding deadlocks and
263:Do not emit debug messages to stdout. If RSYSLOG_DEBUGLOG is not
296:the BSD sources. Special thanks to Greg Wettstein (g...@wind.enjellic.com)
#####
Test nr. 42:
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks
rsyslogd.8: line 31 length 87
.B Note that this version of rsyslog ships with extensive documentation in html
format.
rsyslogd.8: line 181 length 88
\fBALSO NOTE\fP that this will prevent usage of remote logging on the default
port since
#####
Test nr. 47:
Remove superfluous quotation marks (") from the argument of a
single-font macro.
73:.B "\-f"
81:.B "\-D"
86:.B "\-d"
100:.B "\-n"
121:.B "\-v"
155:.B "\-d"
196:.B "\-d"
#####
-- System Information:
Debian Release: buster/sid
APT prefers stable-updates
APT policy: (500, 'stable-updates'), (500, 'proposed-updates'), (500,
'testing'), (500, 'stable')
Architecture: amd64 (x86_64)
Kernel: Linux 4.9.110-3 (SMP w/2 CPU cores)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1),
LANGUAGE=is_IS.iso88591 (charmap=ISO-8859-1)
Shell: /bin/sh linked to /bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages rsyslog depends on:
ii libc6 2.27-3
ii libestr0 0.1.10-2.1
ii libfastjson4 0.99.8-2
ii liblognorm5 2.0.5-1
ii libsystemd0 239-6
ii libuuid1 2.32-0.1
ii lsb-base 9.20170808
ii zlib1g 1:1.2.11.dfsg-1
Versions of packages rsyslog recommends:
ii logrotate 3.11.0-0.1
Versions of packages rsyslog suggests:
pn rsyslog-doc <none>
pn rsyslog-gnutls <none>
pn rsyslog-gssapi <none>
pn rsyslog-mongodb <none>
pn rsyslog-mysql | rsyslog-pgsql <none>
pn rsyslog-relp <none>
-- no debconf information
--
Bjarni I. Gislason
--- rsyslogd.8 2018-06-26 17:29:08.000000000 +0000
+++ rsyslogd.8.new 2018-07-21 20:11:58.000000000 +0000
@@ -3,7 +3,7 @@
.\"
.TH RSYSLOGD 8 "02 Dec 2014" "Version 8.6.0" "Linux System Administration"
.SH NAME
-rsyslogd \- reliable and extended syslogd
+rsyslogd \- reliable and extended syslogd
.SH SYNOPSIS
.B rsyslogd
.RB [ " \-d " ]
@@ -28,14 +28,15 @@ Support of both internet and
unix domain sockets enables this utility to support both local
and remote logging.
-.B Note that this version of rsyslog ships with extensive documentation in
html format.
+.B Note that this version of rsyslog ships with extensive documentation \
+in html format.
This is provided in the ./doc subdirectory and probably
in a separate package if you installed rsyslog via a packaging system.
To use rsyslog's advanced features, you
.B need
to look at the html documentation, because the man pages only covers
basic aspects of operation.
-.B For details and configuration examples, see the rsyslog.conf (5)
+.B For details and configuration examples, see the rsyslog.conf(5)
.B man page and the online documentation at http://www.rsyslog.com/doc
.BR Rsyslogd (8)
@@ -69,8 +70,8 @@ anomalous behavior.
The main configuration file
.I /etc/rsyslog.conf
-or an alternative file, given with the
-.B "\-f"
+or an alternative file, given with the
+.B \-f
option, is read at startup. Any lines that begin with the hash mark
(``#'') and empty lines are ignored. If an error occurs during parsing
the error element is ignored. It is tried to parse the rest of the line.
@@ -78,26 +79,26 @@ the error element is ignored. It is trie
.LP
.SH OPTIONS
.TP
-.B "\-D"
+.B \-D
Runs the Bison config parser in debug mode. This may help when hard to find
syntax errors are reported. Please note that the output generated is deeply
-technical and orignally targeted towards developers.
+technical and originally targeted towards developers.
.TP
-.B "\-d"
+.B \-d
Turns on debug mode. See the DEBUGGING section for more information.
.TP
.BI "\-f " "config file"
Specify an alternative configuration file instead of
-.IR /etc/rsyslog.conf ","
+.IR /etc/rsyslog.conf ,
which is the default.
.TP
.BI "\-i " "pid file"
Specify an alternative pid file instead of the default one.
This option must be used if multiple instances of rsyslogd should
run on a single machine. To disable writing a pid file, use
-the reserved name "NONE" (all upper case!), so "-iNONE".
+the reserved name "NONE" (all upper case!), so "\-iNONE".
.TP
-.B "\-n"
+.B \-n
Avoid auto-backgrounding. This is needed especially if the
.B rsyslogd
is started and controlled by
@@ -107,18 +108,18 @@ is started and controlled by
Do a config check. Do NOT run in regular mode, just check configuration
file correctness.
This option is meant to verify a config file. To do so, run rsyslogd
-interactively in foreground, specifying -f <config-file> and -N level.
+interactively in foreground, specifying \-f <config-file> and \-N level.
The level argument modifies behaviour. Currently, 0 is the same as
-not specifying the -N option at all (so this makes limited sense) and
+not specifying the \-N option at all (so this makes limited sense) and
1 actually activates the code. Later, higher levels will mean more
verbosity (this is a forward-compatibility option).
.TP
-.BI "\-C"
+.B \-C
This prevents rsyslogd from changing to the root directory. This
is almost never a good idea in production use. This option was introduced
in support of the internal testbed.
.TP
-.B "\-v"
+.B \-v
Print version and exit.
.LP
.SH SIGNALS
@@ -128,14 +129,14 @@ reacts to a set of signals. You may eas
using the following:
.IP
.nf
-kill -SIGNAL $(cat /var/run/rsyslogd.pid)
+kill \-SIGNAL $(cat /var/run/rsyslogd.pid)
.fi
.PP
-Note that -SIGNAL must be replaced with the actual signal
-you are trying to send, e.g. with HUP. So it then becomes:
+Note that \-SIGNAL must be replaced with the actual signal
+you are trying to send, e.g.\& with HUP. So it then becomes:
.IP
.nf
-kill -HUP $(cat /var/run/rsyslogd.pid)
+kill \-HUP $(cat /var/run/rsyslogd.pid)
.fi
.PP
.TP
@@ -144,7 +145,7 @@ This lets
.B rsyslogd
perform close all open files.
.TP
-.B TERM ", " INT ", " QUIT
+.BR TERM ", " INT ", " QUIT
.B Rsyslogd
will die.
.TP
@@ -152,11 +153,11 @@ will die.
Switch debugging on/off. This option can only be used if
.B rsyslogd
is started with the
-.B "\-d"
+.B \-d
debug option.
.TP
.B CHLD
-Wait for childs if some were born, because of wall'ing messages.
+Wait for children if some were born, because of wall'ing messages.
.LP
.SH SECURITY THREATS
There is the potential for the rsyslogd daemon to be
@@ -178,8 +179,9 @@ if filled, will not impair the machine.
The ext2 filesystem can be used which can be configured to limit a
certain percentage of a filesystem to usage by root only. \fBNOTE\fP
that this will require rsyslogd to be run as a non-root process.
-\fBALSO NOTE\fP that this will prevent usage of remote logging on the default
port since
-rsyslogd will be unable to bind to the 514/UDP socket.
+\fBALSO NOTE\fP that this will prevent usage of remote logging on the
+default port
+since rsyslogd will be unable to bind to the 514/UDP socket.
.IP 4.
Disabling inet domain sockets will limit risk to the local machine.
.SS Message replay and spoofing
@@ -193,7 +195,7 @@ to think about syslog network security b
.LP
.SH DEBUGGING
When debugging is turned on using the
-.B "\-d"
+.B \-d
option,
.B rsyslogd
produces debugging information according to the
@@ -217,7 +219,7 @@ for exact information.
The Unix domain socket to from where local syslog messages are read.
.TP
.I /var/run/rsyslogd.pid
-The file containing the process id of
+The file containing the process id of
.BR rsyslogd .
.TP
.I prefix/lib/rsyslog
@@ -225,7 +227,7 @@ Default directory for
.B rsyslogd
modules. The
.I prefix
-is specified during compilation (e.g. /usr/local).
+is specified during compilation (e.g.\& /usr/local).
.SH ENVIRONMENT
.TP
.B RSYSLOG_DEBUG
@@ -235,7 +237,7 @@ following options possible (all are case
.RS
.IP Debug
Turns on debugging and prevents forking. This is processed earlier
-in the startup than command line options (i.e. -d) and as such
+in the startup than command line options (i.e.\& \-d) and as such
enables earlier debugging output. Mutually exclusive with DebugOnDemand.
.IP DebugOnDemand
Enables debugging but turns off debug output. The output can be toggled
@@ -246,11 +248,11 @@ Print out the logical flow of functions
Specifies which files to trace LogFuncFlow. If not set (the
default), a LogFuncFlow trace is provided for all files. Set to
limit it to the files specified.FileTrace may be specified multiple
-times, one file each (e.g. export RSYSLOG_DEBUG="LogFuncFlow
+times, one file each (e.g., export RSYSLOG_DEBUG="LogFuncFlow
FileTrace=vm.c FileTrace=expr.c"
.IP PrintFuncDB
Print the content of the debug function database whenever debug
-information is printed (e.g. abort case)!
+information is printed (e.g.\& abort case)!
.IP PrintAllDebugInfoOnExit
Print all debug information immediately before rsyslogd exits
(currently not implemented!)
@@ -280,7 +282,7 @@ Please review the file BUGS for up-to-da
bugs and annoyances.
.SH Further Information
Please visit
-.BR http://www.rsyslog.com/doc
+.B http://www.rsyslog.com/doc
for additional information, tutorials and a support forum.
.SH SEE ALSO
.BR rsyslog.conf (5),
