Improved documentation for rsyslog::client class.

manifests/client.pp

 # Configure node to send its system logs to the central syslog server.
 #
 # This will add an rsyslog fragment (to /etc/rsyslog.d) for sending logs
-# to a log server.  By default, UDP over IPv4 will be used to send all
-# logs to the NSC central syslog server.
-#
-# The lookup of the logserver IP address is performed on the Puppet
-# master.  Thus, we need to specify whether IPv4 and/or IPv6 should be
-# used, since the Puppet master might not have the same view of what IP
-# families are useable as the client.  If a node specifies both IPv4 and
-# IPv6 (i.e, ipfamily=>['ipv4','ipv6'], one of them will be selected
-# based on what the resolver library on the Puppet master thinks is best
-# for *it*, not what's best for the node in question.
+# to a log server.
+#
+# Parameters:
+#
+#  - logserver	Name or address of log server.  If a name, it will be
+#		looked up during manifest compilation, and the numeric
+#		address will be written in the config fragment.
+#
+#  - ipfamily	Which IP address families are acceptable.  Since the
+#		lookup of the logserver IP address is done on the Puppet
+#		master, we can't rely on the resolver library to guess
+#		what is best, since the client might disagree.
+#
+#  - protocol	Which protocol to use for sending logs to the server.
+#		One of "tcp", "udp", or "relp" (Reliable Event Logging
+#		Protocol).
+#
+#  - port	Which TCP/UDP port on the server to send to.  Defaults
+#		to port 514 for TCP and UDP, and 2514 for RELP.
+#
+#  - selector	A selector, on the format <facility>.<severity> to
+#		select which log messages to send to the server.
+#
+#  - format	An rsyslog template name determining how the message is
+#		formatted.  Defaults to 'RSYSLOG_ForwardFormat', which
+#		includes microsecond resolution and timezone information
+#		in the timestamps (but requires rsyslog as the server).
 
 class syslog::client(
 	$logserver='syslog.nsc.liu.se',