19789649 rsyslog complete documentation is missing
authorMichael Nestler <Michael.Nestler@Oracle.COM>
Tue, 14 Oct 2014 10:52:42 -0700
changeset 2149 375b11f6f4bc
parent 2148 0c3beee15d22
child 2150 1acc968ac0d9
19789649 rsyslog complete documentation is missing
components/rsyslog/Makefile
components/rsyslog/patches/tools-rsyslogd.8.patch
components/rsyslog/rsyslog.p5m
--- a/components/rsyslog/Makefile	Mon Oct 13 23:00:40 2014 -0700
+++ b/components/rsyslog/Makefile	Tue Oct 14 10:52:42 2014 -0700
@@ -66,5 +66,6 @@
 BUILD_PKG_DEPENDENCIES =	$(BUILD_TOOLS)
 
 PKG_PROTO_DIRS +=	$(COMPONENT_DIR)/files
+PKG_PROTO_DIRS +=	$(COMPONENT_SRC)
 
 include ../../make-rules/depend.mk
--- a/components/rsyslog/patches/tools-rsyslogd.8.patch	Mon Oct 13 23:00:40 2014 -0700
+++ b/components/rsyslog/patches/tools-rsyslogd.8.patch	Tue Oct 14 10:52:42 2014 -0700
@@ -1,5 +1,7 @@
---- rsyslog/tools/rsyslogd.8	Mon Apr 18 06:36:33 2011
-+++ rsyslog/tools/rsyslogd.8	Fri May 25 11:13:23 2012
+# Solaris-specific patch. Not going upstream.
+# Covers Solaris-specific configuration and makes it compatible with nroff.
+--- rsyslog/tools/rsyslogd.8	2011-04-18 06:36:33.000000000 -0700
++++ rsyslog/tools/rsyslogd.8	2014-10-14 09:41:01.559928606 -0700
 @@ -1,7 +1,8 @@
 +'\" te
  .\" Copyright 2004-2008 Rainer Gerhards and Adiscon for the rsyslog modifications
@@ -10,28 +12,54 @@
  .SH NAME
  rsyslogd \- reliable and extended syslogd 
  .SH SYNOPSIS
[email protected]@ -44,17 +45,14 @@
[email protected]@ -44,17 +45,16 @@
  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.
 -This is provided in the ./doc subdirectory and probably
 -in a separate package if you installed rsyslog via a packaging system.
++.B "Note that this version of rsyslog ships with extensive documentation in html format."
++This is provided in the /usr/share/doc/rsyslog directory.
  To use rsyslog's advanced features, you
  .B need
--to look at the html documentation, because the man pages only cover
-+to look at the online documentation, because the man pages only cover
+ to look at the html documentation, because the man pages only cover
  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 (4)
- .B man page and the online documentation at http://www.rsyslog.com/doc
+-.B man page and the online documentation at http://www.rsyslog.com/doc
++.B "For details and configuration examples, see the rsyslog.conf (4)"
++.B "man page and the online documentation at http://www.rsyslog.com/doc"
  
 -.BR Rsyslogd (8)
 +.BR rsyslogd (1M)
  is derived from the sysklogd package which in turn is derived from the
  stock BSD sources.
  
[email protected]@ -170,7 +168,8 @@
[email protected]@ -93,9 +93,9 @@
+ 
+ .LP
+ .SH OPTIONS
+-.B Note that in version 3 of rsyslog a number of command line options
+-.B have been deprecated and replaced with config file directives. The
+-.B -c option controls the backward compatibility mode in use.
++.B "Note that in version 3 of rsyslog a number of command line options"
++.B "have been deprecated and replaced with config file directives. The"
++.B "-c option controls the backward compatibility mode in use."
+ .TP
+ .BI "\-A"
+ When sending UDP messages, there are potentially multiple paths to
[email protected]@ -132,8 +132,8 @@
+ is the rsyslog version that it shall be
+ compatible with. Using -c0 tells rsyslog to be command-line compatible
+ to sysklogd, which is the default if -c is not given.
+-.B Please note that rsyslogd issues warning messages if the -c3
+-.B command line option is not given.
++.B "Please note that rsyslogd issues warning messages if the -c3"
++.B "command line option is not given."
+ This is to alert you that your are running in compatibility
+ mode. Compatibility mode interferes with your rsyslog.conf commands and
+ may cause some undesired side-effects. It is meant to be used with a
[email protected]@ -170,7 +170,8 @@
  Avoid auto-backgrounding.  This is needed especially if the
  .B rsyslogd
  is started and controlled by
@@ -41,7 +69,7 @@
  .TP
  .B "\-N " "level"
  Do a coNfig check. Do NOT run in regular mode, just check configuration
[email protected]@ -181,9 +180,6 @@
[email protected]@ -181,9 +182,6 @@
  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).
@@ -51,7 +79,7 @@
  .TP
  .BI "\-q " "add hostname if DNS fails during ACL processing"
  During ACL processing, hostnames are resolved to IP addresses for
[email protected]@ -257,7 +253,7 @@
[email protected]@ -257,7 +255,7 @@
  operation and should only be done when actually necessary. Actually, it is
  a rsyslgod stop immediately followed by a restart. Future versions will remove
  this restart functionality of HUP (it will go away in v5). So it is advised to use
@@ -60,7 +88,7 @@
  to activate configuration changes.
  .TP
  .B TERM ", " INT ", " QUIT
[email protected]@ -330,12 +326,10 @@
[email protected]@ -330,12 +328,10 @@
  The file containing the process id of 
  .BR rsyslogd .
  .TP
@@ -75,7 +103,7 @@
  .SH ENVIRONMENT
  .TP
  .B RSYSLOG_DEBUG
[email protected]@ -378,20 +372,42 @@
[email protected]@ -378,20 +374,42 @@
  .B RSYSLOG_MODDIR
  Provides the default directory in which loadable modules reside.
  .PD
--- a/components/rsyslog/rsyslog.p5m	Mon Oct 13 23:00:40 2014 -0700
+++ b/components/rsyslog/rsyslog.p5m	Tue Oct 14 10:52:42 2014 -0700
@@ -26,6 +26,7 @@
 <transform file path=usr.*/man/.+ -> default mangler.man.stability Uncommitted>
 <transform file path=usr/lib/rsyslog/.*\.so -> \
     add pkg.linted.userland.action001.2 true>
+<transform file path=usr/share/doc/rsyslog/(.+)$ -> set action.hash doc/%<1> >
 set name=pkg.fmri \
     value=pkg:/system/[email protected]$(IPS_COMPONENT_VERSION),$(BUILD_VERSION)
 set name=pkg.summary value="reliable and extended syslogd"
@@ -41,9 +42,6 @@
 set name=info.upstream-url value=$(COMPONENT_PROJECT_URL)
 set name=org.opensolaris.arc-caseid value=PSARC/2012/197
 set name=org.opensolaris.consolidation value=$(CONSOLIDATION)
-
-dir  path=var/spool/rsyslog
-
 file rsyslog.conf-solaris path=etc/rsyslog.conf group=sys mode=0644 \
     overlay=allow preserve=true
 file rsyslog.xml path=lib/svc/manifest/system/rsyslog.xml
@@ -69,8 +67,149 @@
 file path=usr/lib/rsyslog/omruleset.so
 file path=usr/lib/rsyslog/omtesting.so
 file path=usr/lib/rsyslog/rsyslogd mode=0555
+file path=usr/share/doc/rsyslog/bugs.html
+file path=usr/share/doc/rsyslog/build_from_repo.html
+file path=usr/share/doc/rsyslog/contributors.html
+file path=usr/share/doc/rsyslog/dataflow.png
+file path=usr/share/doc/rsyslog/debug.html
+file path=usr/share/doc/rsyslog/dev_queue.html
+file path=usr/share/doc/rsyslog/direct_queue0.png
+file path=usr/share/doc/rsyslog/direct_queue1.png
+file path=usr/share/doc/rsyslog/direct_queue2.png
+file path=usr/share/doc/rsyslog/direct_queue3.png
+file path=usr/share/doc/rsyslog/direct_queue_directq.png
+file path=usr/share/doc/rsyslog/direct_queue_rsyslog.png
+file path=usr/share/doc/rsyslog/direct_queue_rsyslog2.png
+file path=usr/share/doc/rsyslog/droppriv.html
+file path=usr/share/doc/rsyslog/expression.html
+file path=usr/share/doc/rsyslog/features.html
+file path=usr/share/doc/rsyslog/generic_design.html
+file path=usr/share/doc/rsyslog/gssapi.html
+file path=usr/share/doc/rsyslog/gssapi.png
+file path=usr/share/doc/rsyslog/history.html
+file path=usr/share/doc/rsyslog/how2help.html
+file path=usr/share/doc/rsyslog/im3195.html
+file path=usr/share/doc/rsyslog/imfile.html
+file path=usr/share/doc/rsyslog/imgssapi.html
+file path=usr/share/doc/rsyslog/imklog.html
+file path=usr/share/doc/rsyslog/impstats.html
+file path=usr/share/doc/rsyslog/imptcp.html
+file path=usr/share/doc/rsyslog/imrelp.html
+file path=usr/share/doc/rsyslog/imsolaris.html
+file path=usr/share/doc/rsyslog/imtcp.html
+file path=usr/share/doc/rsyslog/imuxsock.html
+file path=usr/share/doc/rsyslog/index.html
+file path=usr/share/doc/rsyslog/install.html
+file path=usr/share/doc/rsyslog/ipv6.html
+file path=usr/share/doc/rsyslog/licensing.html
+file path=usr/share/doc/rsyslog/log_rotation_fix_size.html
+file path=usr/share/doc/rsyslog/manual.html
+file path=usr/share/doc/rsyslog/mmnormalize.html
+file path=usr/share/doc/rsyslog/mmsnmptrapd.html
+file path=usr/share/doc/rsyslog/module_workflow.png
+file path=usr/share/doc/rsyslog/modules.html
+file path=usr/share/doc/rsyslog/multi_ruleset.html
+file path=usr/share/doc/rsyslog/netstream.html
+file path=usr/share/doc/rsyslog/ns_gtls.html
+file path=usr/share/doc/rsyslog/ns_ptcp.html
+file path=usr/share/doc/rsyslog/omlibdbi.html
+file path=usr/share/doc/rsyslog/ommail.html
+file path=usr/share/doc/rsyslog/ommysql.html
+file path=usr/share/doc/rsyslog/omoracle.html
+file path=usr/share/doc/rsyslog/omrelp.html
+file path=usr/share/doc/rsyslog/omruleset.html
+file path=usr/share/doc/rsyslog/omsnmp.html
+file path=usr/share/doc/rsyslog/omstdout.html
+file path=usr/share/doc/rsyslog/omudpspoof.html
+file path=usr/share/doc/rsyslog/omuxsock.html
+file path=usr/share/doc/rsyslog/pmlastmsg.html
+file path=usr/share/doc/rsyslog/property_replacer.html
+file path=usr/share/doc/rsyslog/queueWorkerLogic.jpg
+file path=usr/share/doc/rsyslog/queueWorkerLogic_small.jpg
+file path=usr/share/doc/rsyslog/queue_analogy_tv.png
+file path=usr/share/doc/rsyslog/queues.html
+file path=usr/share/doc/rsyslog/queues_analogy.html
+file path=usr/share/doc/rsyslog/rainerscript.html
+file path=usr/share/doc/rsyslog/rfc5424layers.png
+file path=usr/share/doc/rsyslog/rsconf1_actionexeconlywhenpreviousissuspended.html
+file path=usr/share/doc/rsyslog/rsconf1_actionresumeinterval.html
+file path=usr/share/doc/rsyslog/rsconf1_allowedsender.html
+file path=usr/share/doc/rsyslog/rsconf1_controlcharacterescapeprefix.html
+file path=usr/share/doc/rsyslog/rsconf1_debugprintcfsyslinehandlerlist.html
+file path=usr/share/doc/rsyslog/rsconf1_debugprintmodulelist.html
+file path=usr/share/doc/rsyslog/rsconf1_debugprinttemplatelist.html
+file path=usr/share/doc/rsyslog/rsconf1_dircreatemode.html
+file path=usr/share/doc/rsyslog/rsconf1_dirgroup.html
+file path=usr/share/doc/rsyslog/rsconf1_dirowner.html
+file path=usr/share/doc/rsyslog/rsconf1_dropmsgswithmaliciousdnsptrrecords.html
+file path=usr/share/doc/rsyslog/rsconf1_droptrailinglfonreception.html
+file path=usr/share/doc/rsyslog/rsconf1_dynafilecachesize.html
+file path=usr/share/doc/rsyslog/rsconf1_escape8bitcharsonreceive.html
+file path=usr/share/doc/rsyslog/rsconf1_escapecontrolcharactersonreceive.html
+file path=usr/share/doc/rsyslog/rsconf1_failonchownfailure.html
+file path=usr/share/doc/rsyslog/rsconf1_filecreatemode.html
+file path=usr/share/doc/rsyslog/rsconf1_filegroup.html
+file path=usr/share/doc/rsyslog/rsconf1_fileowner.html
+file path=usr/share/doc/rsyslog/rsconf1_generateconfiggraph.html
+file path=usr/share/doc/rsyslog/rsconf1_gssforwardservicename.html
+file path=usr/share/doc/rsyslog/rsconf1_gsslistenservicename.html
+file path=usr/share/doc/rsyslog/rsconf1_gssmode.html
+file path=usr/share/doc/rsyslog/rsconf1_includeconfig.html
+file path=usr/share/doc/rsyslog/rsconf1_mainmsgqueuesize.html
+file path=usr/share/doc/rsyslog/rsconf1_markmessageperiod.html
+file path=usr/share/doc/rsyslog/rsconf1_moddir.html
+file path=usr/share/doc/rsyslog/rsconf1_modload.html
+file path=usr/share/doc/rsyslog/rsconf1_repeatedmsgreduction.html
+file path=usr/share/doc/rsyslog/rsconf1_resetconfigvariables.html
+file path=usr/share/doc/rsyslog/rsconf1_rulesetcreatemainqueue.html
+file path=usr/share/doc/rsyslog/rsconf1_rulesetparser.html
+file path=usr/share/doc/rsyslog/rsconf1_umask.html
+file path=usr/share/doc/rsyslog/rscript_abnf.html
+file path=usr/share/doc/rsyslog/rsyslog-example.conf
+file path=usr/share/doc/rsyslog/rsyslog-vers.png
+file path=usr/share/doc/rsyslog/rsyslog_conf.html
+file path=usr/share/doc/rsyslog/rsyslog_conf_actions.html
+file path=usr/share/doc/rsyslog/rsyslog_conf_examples.html
+file path=usr/share/doc/rsyslog/rsyslog_conf_filter.html
+file path=usr/share/doc/rsyslog/rsyslog_conf_global.html
+file path=usr/share/doc/rsyslog/rsyslog_conf_modules.html
+file path=usr/share/doc/rsyslog/rsyslog_conf_nomatch.html
+file path=usr/share/doc/rsyslog/rsyslog_conf_output.html
+file path=usr/share/doc/rsyslog/rsyslog_conf_templates.html
+file path=usr/share/doc/rsyslog/rsyslog_confgraph_complex.png
+file path=usr/share/doc/rsyslog/rsyslog_confgraph_std.png
+file path=usr/share/doc/rsyslog/rsyslog_high_database_rate.html
+file path=usr/share/doc/rsyslog/rsyslog_mysql.html
+file path=usr/share/doc/rsyslog/rsyslog_ng_comparison.html
+file path=usr/share/doc/rsyslog/rsyslog_packages.html
+file path=usr/share/doc/rsyslog/rsyslog_pgsql.html
+file path=usr/share/doc/rsyslog/rsyslog_php_syslog_ng.html
+file path=usr/share/doc/rsyslog/rsyslog_recording_pri.html
+file path=usr/share/doc/rsyslog/rsyslog_reliable_forwarding.html
+file path=usr/share/doc/rsyslog/rsyslog_secure_tls.html
+file path=usr/share/doc/rsyslog/rsyslog_stunnel.html
+file path=usr/share/doc/rsyslog/rsyslog_tls.html
+file path=usr/share/doc/rsyslog/syslog_parsing.html
+file path=usr/share/doc/rsyslog/syslog_protocol.html
+file path=usr/share/doc/rsyslog/tls_cert.jpg
+file path=usr/share/doc/rsyslog/tls_cert_100.jpg
+file path=usr/share/doc/rsyslog/tls_cert_ca.html
+file path=usr/share/doc/rsyslog/tls_cert_ca.jpg
+file path=usr/share/doc/rsyslog/tls_cert_client.html
+file path=usr/share/doc/rsyslog/tls_cert_errmsgs.html
+file path=usr/share/doc/rsyslog/tls_cert_machine.html
+file path=usr/share/doc/rsyslog/tls_cert_scenario.html
+file path=usr/share/doc/rsyslog/tls_cert_server.html
+file path=usr/share/doc/rsyslog/tls_cert_summary.html
+file path=usr/share/doc/rsyslog/tls_cert_udp_relay.html
+file path=usr/share/doc/rsyslog/troubleshoot.html
+file path=usr/share/doc/rsyslog/v3compatibility.html
+file path=usr/share/doc/rsyslog/v4compatibility.html
+file path=usr/share/doc/rsyslog/v5compatibility.html
+file path=usr/share/doc/rsyslog/version_naming.html
 file usr/share/man/man8/rsyslogd.8 path=usr/share/man/man1m/rsyslogd.1m \
     mangler.bypass=true
 file usr/share/man/man5/rsyslog.conf.5 path=usr/share/man/man4/rsyslog.conf.4
+dir  path=var/spool/rsyslog
 license rsyslog.license license=GPLv3
 depend type=require fmri=__TBD pkg.debug.depend.file=usr/bin/stat