From: Sami Kerola <kerolasa@iki.fi>
Date: Sat, 28 Jun 2014 14:37:39 +0000 (+0100)
Subject: docs: add logger protocol notes to manual page
X-Git-Tag: v2.26-rc1~576^2~6
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d9b38f6baf4a6dde2daf113b26691d2a909ca19d;p=thirdparty%2Futil-linux.git

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>
---

diff --git a/bash-completion/logger b/bash-completion/logger
index 6b4c7df2c9..0a66af3097 100644
--- a/bash-completion/logger
+++ b/bash-completion/logger
@@ -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
 			;;
diff --git a/misc-utils/logger.1 b/misc-utils/logger.1
index 35d53c86e1..a624f44fba 100644
--- a/misc-utils/logger.1
+++ b/misc-utils/logger.1
@@ -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.