]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
logger: grammarize the description of --socket-errors in the man page
authorBenno Schulenberg <bensberg@telfort.nl>
Thu, 30 Jan 2025 14:11:24 +0000 (15:11 +0100)
committerKarel Zak <kzak@redhat.com>
Mon, 3 Feb 2025 12:30:05 +0000 (13:30 +0100)
Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
misc-utils/logger.1.adoc

index 1a5b4310a6a9135bd72acc1798dc67a00e3628b5..a20736a3d2d123073964dc8113577617322304a9 100644 (file)
@@ -163,9 +163,15 @@ Most receivers accept messages larger than 1KiB over any type of syslog protocol
 Note: the message-size limit limits the overall message size, including the syslog header. Header sizes vary depending on the selected options and the hostname length. As a rule of thumb, headers are usually not longer than 50 to 80 characters. When selecting a maximum message size, it is important to ensure that the receiver supports the max size as well, otherwise messages may become truncated. Again, as a rule of thumb two to four KiB message size should generally be OK, whereas anything larger should be verified to work.
 
 *--socket-errors* __mode__::
-Print errors about Unix socket connections. The _mode_ can be a value of *off*, *on*, or *auto*. When the mode is *auto*, then *logger* will detect if the init process is *systemd*(1), and if so assumption is made _/dev/log_ can be used early at boot. Other init systems lack of _/dev/log_ will not cause errors that is identical with messaging using *openlog*(3) system call. The *logger*(1) before version 2.26 used *openlog*(3), and hence was unable to detected loss of messages sent to Unix sockets.
+Print errors about Unix socket connections. The _mode_ can be *on*, *off*, or *auto*.
+When the mode is *auto* (the default), then *logger* will detect if the init process
+is *systemd*(1), and if so, the assumption is made that _/dev/log_ can be used early
+at boot. The lack of _/dev/log_ on other init systems will not cause errors, just as
+when using the *openlog*(3) system call. The *logger*(1) before version 2.26 used
+*openlog*(3), and thus was unable to detect the loss of messages sent to Unix sockets.
 +
-The default mode is *auto*. When errors are not enabled lost messages are not communicated and will result to successful exit status of *logger*(1) invocation.
+When errors are not enabled, lost messages are not communicated and will result in a
+successful exit status of *logger*(1).
 
 *-T*, *--tcp*::
 Use stream (TCP) only. By default the connection is tried to the _syslog-conn_ port defined in _/etc/services_, which is often _601_.