docs: add logger protocol notes to manual page

Inform about rfc5424 support, how to control what it includes to
submission, and that it is the new default when sending syslog messages
to remote server without specifying protocol.

Signed-off-by: Sami Kerola <kerolasa@iki.fi>
This commit is contained in:
Sami Kerola 2014-06-28 15:37:39 +01:00
parent 4de2e8a038
commit d9b38f6baf
2 changed files with 28 additions and 2 deletions

View File

@ -37,7 +37,7 @@ _logger_module()
esac
case $cur in
-*)
OPTS="--journald --udp --id --file --help --server --port --priority --stderr --tag --socket --version"
OPTS="--journald --udp --id --file --help --server --port --priority --rfc3164 --rfc5424 --stderr --tag --socket --version"
COMPREPLY=( $(compgen -W "${OPTS[*]}" -- $cur) )
return 0
;;

View File

@ -33,7 +33,7 @@
.\"
.\" Section on valid facility and level strings added by
.\" and1000@debian.org, 26 Oct 1997.
.TH LOGGER "1" "April 2013" "util-linux" "User Commands"
.TH LOGGER "1" "June 2014" "util-linux" "User Commands"
.SH NAME
logger \- a shell command interface to the syslog(3) system log module
.SH SYNOPSIS
@ -104,6 +104,32 @@ specified by the \fB\-p\fR option. Similarly, if no prefix is provided,
the line is logged using the \fB\-p\fR \fIpriority\fR.
This option doesn't affect a command-line message.
.TP
\fB\-\-rfc3164\fR
Use RFC 3164 BSD syslog protocol to submit messages to remote server.
.TP
\fB\-\-rfc5424\fR [\fInotime\fR,\fInotq\fR,\fInohost\fR]
Use RFC 5424 syslog protocol to submit messages to remote server.
Optional argument
.I notime
will supress submission of sender time stamp that is in ISO-8601 format,
including microseconds and timezone. When
.I notime
is specified the time quality structured data, that can be suppressed
separately with
.IR notq ,
is excluded from output. The time quality information tells if local
clock was syncronized, and maximum number of microseconds the time stamp
could be off. Option argument
.I nohost
will suppress
.IR gethostname (2)
information from message header.
.IP
The rfc5424 protocol has been default for
.B logger
since version 2.26.
.TP
\fB\-s\fR, \fB\-\-stderr\fR
Output the message to standard error as well as to the system log.