fix man pages

2008-02-11 10:59:32 +00:00 · 2008-02-11 10:59:32 +00:00 · 24e541ec35
commit 24e541ec35
parent b5c4957303
2 changed files with 115 additions and 2 deletions
--- a/rsyslog-2.0.0-manPage.patch
+++ b/rsyslog-2.0.0-manPage.patch
@ -0,0 +1,108 @@
+diff -upb rsyslog-2.0.0/doc/rsconf1_actionexeconlywhenpreviousissuspended.html.manPage rsyslog-2.0.0/doc/rsconf1_actionexeconlywhenpreviousissuspended.html
+--- rsyslog-2.0.0/doc/rsconf1_actionexeconlywhenpreviousissuspended.html.manPage	2008-02-07 11:50:17.000000000 +0100
+++ rsyslog-2.0.0/doc/rsconf1_actionexeconlywhenpreviousissuspended.html	2008-02-07 11:52:13.000000000 +0100
+@@ -0,0 +1,29 @@
+<html>
+<head>
+<title>rsyslog.conf file</title>
+</head>
+<body>
+<h2>$ActionExecOnlyWhenPreviousIsSuspended</h2>
+<p><b>Type:</b> global configuration directive</p>
+<p><b>Default:</b> off</p>
+<p><b>Description:</b></p>
+<p>This directive allows to specify if actions should always be executed ("off," the default) or only if the previous action is suspended ("on"). This directive works hand-in-hand with the multiple actions per selector feature. It can be used, for example, to create rules that automatically switch destination servers or databases to a (set of) backup(s), if the primary server fails. Note that this feature depends on proper implementation of the suspend feature in the output module. All built-in output modules properly support it (most importantly the database write and the syslog message forwarder).</p>
+<p>This selector processes all messages it receives (*.*).  It tries to forward every message to primary-syslog.example.com (via tcp). If it can not reach that server, it tries secondary-1-syslog.example.com, if that fails too, it tries secondary-2-syslog.example.com. If neither of these servers can be connected, the data is stored in /var/log/localbuffer. Please note that the secondaries and the local log buffer are only used if the one before them does not work. So ideally, /var/log/localbuffer will never receive a message. If one of the servers resumes operation, it automatically takes over processing again.</p>
+<p>We strongly advise not to use repeated line reduction together with ActionExecOnlyWhenPreviousIsSuspended. It may lead to "interesting" and undesired results (but you can try it if you like).</p>
+<p><b>Sample:</b></p>
+<p><code><b>*.* @@primary-syslog.example.com
+<br>$ActionExecOnlyWhenPreviousIsSuspended on
+<br>&   @@secondary-1-syslog.example.com    # & is used to have more than one action for
+<br>&   @@secondary-2-syslog.example.com    # the same selector - the mult-action feature
+<br>&   /var/log/localbuffer
+<br>$ActionExecOnlyWhenPreviousIsSuspended off # to re-set it for the next selector </b></code></p>
+
+<p>[<a href="rsyslog_conf.html">rsyslog.conf overview</a>] [<a href="manual.html">manual 
+index</a>] [<a href="http://www.rsyslog.com/">rsyslog site</a>]</p>
+<p><font size="2">This documentation is part of the
+<a href="http://www.rsyslog.com/">rsyslog</a> project.<br>
+Copyright &copy; 2007 by <a href="http://www.gerhards.net/rainer">Rainer Gerhards</a> and
+<a href="http://www.adiscon.com/">Adiscon</a>. Released under the GNU GPL 
+version 2 or higher.</font></p>
+</body>
+</html>
+diff -upb rsyslog-2.0.0/doc/rsyslog_conf.html.manPage rsyslog-2.0.0/doc/rsyslog_conf.html
+--- rsyslog-2.0.0/doc/rsyslog_conf.html.manPage	2008-02-07 11:45:32.000000000 +0100
+++ rsyslog-2.0.0/doc/rsyslog_conf.html	2008-02-07 13:38:22.000000000 +0100
+@@ -25,7 +25,7 @@ to rsyslogd.</p>
+ start with a dollar-sign. Here is a list in alphabetical order. Follow links for 
+ a description.</p>
+ <ul>
+-	<li><a href="rsconf1_actionexeconlyifpreviousissuspended.html">$ActionExecOnlyIfPreviousIsSuspended</a></li>
+	<li><a href="rsconf1_actionexeconlywhenpreviousissuspended.html">$ActionExecOnlyWhenPreviousIsSuspended</a></li>
+ 	<li><a href="rsconf1_actionresumeinterval.html">$ActionResumeInterval</a></li>
+ 	<li><a href="rsconf1_allowedsender.html">$AllowedSender</a></li>
+ 	<li><a href="rsconf1_controlcharacterescapeprefix.html">$ControlCharacterEscapePrefix</a></li>
+@@ -43,9 +43,6 @@ a description.</p>
+ 	<li><a href="rsconf1_filecreatemode.html">$FileCreateMode</a></li>
+ 	<li><a href="rsconf1_filegroup.html">$FileGroup</a></li>
+ 	<li><a href="rsconf1_fileowner.html">$FileOwner</a></li>
+-	<li><a href="rsconf1_gssforwardservicename.html">$GssForwardServiceName</a></li>
+-	<li><a href="rsconf1_gsslistenservicename.html">$GssListenServiceName</a></li>
+-	<li><a href="rsconf1_gssmode.html">$GssMode</a></li>
+ 	<li><a href="rsconf1_includeconfig.html">$IncludeConfig</a></li>
+ 	<li><a href="rsconf1_mainmsgqueuesize.html">$MainMsgQueueSize</a></li>
+ 	<li><a href="rsconf1_moddir.html">$ModDir</a></li>
+diff -upb rsyslog-2.0.0/rsyslogd.8.manPage rsyslog-2.0.0/rsyslogd.8
+--- rsyslog-2.0.0/rsyslogd.8.manPage	2008-02-07 11:35:22.000000000 +0100
+++ rsyslog-2.0.0/rsyslogd.8	2008-02-07 13:38:00.000000000 +0100
+@@ -18,9 +18,6 @@ rsyslogd \- reliable and extended syslog
+ .RB [ " \-f "
+ .I config file
+ ]
+-.RB [ " \-g "
+-.I port,max-nbr-of-sessions
+-]
+ .RB [ " \-h " ] 
+ .br
+ .RB [ " \-i "
+@@ -158,12 +155,6 @@ Specify an alternative configuration fil
+ .IR /etc/rsyslog.conf ","
+ which is the default.
+ .TP
+-.BI "\-g "
+-Identical to -t except that every tcp connection is authenticated
+-using gss-api (kerberos 5). Service name may be set using
+-$GssListenServiceName or the default "host" will be used. Encryption
+-can be used if specified by the client and supported by both sides.
+-.TP
+ .BI "\-h "
+ By default rsyslogd will not forward messages it receives from remote hosts.
+ Specifying this switch on the command line will cause the log daemon to
+@@ -276,15 +267,10 @@ will be reread and the
+ .BR rsyslog (3)
+ facility is started again.
+ .TP
+-.B SIGTERM
+.B SIGTERM "," SIGINT "," SIGQUIT
+ .B Rsyslogd
+ will die.
+ .TP
+-.BR SIGINT ", " SIGQUIT
+-If debugging is enabled these are ignored, otherwise 
+-.B rsyslogd
+-will die.
+-.TP
+ .B SIGUSR1
+ Switch debugging on/off.  This option can only be used if
+ .B rsyslogd
+@@ -501,8 +487,7 @@ If remote logging is enabled, messages c
+ As the messages are transmitted in clear-text, an attacker might use
+ the information obtained from the packets for malicious things. Also, an
+ attacker might reply recorded messages or spoof a sender's IP address,
+-which could lead to a wrong perception of system activity. These can
+-be prevented by using GSS-API authentication and encryption. Be sure
+which could lead to a wrong perception of system activity. Be sure
+ to think about syslog network security before enabling it.
+ .LP
+ .SH DEBUGGING
--- a/rsyslog.spec
+++ b/rsyslog.spec
@ -3,7 +3,7 @@
 Summary: Enhanced system logging and kernel message trapping daemons
 Name: rsyslog
 Version: 2.0.0
-Release: 2%{?dist}
+Release: 3%{?dist}
 License: GPLv2+
 Group: System Environment/Daemons
 URL: http://www.rsyslog.com/
@ -12,6 +12,7 @@ Source1: rsyslog.init
 Source2: rsyslog.sysconfig
 Patch1: rsyslog-2.0.0-sockhang.patch
 Patch2: rsyslog-2.0.0-strerror.patch
+Patch3: rsyslog-2.0.0-manPage.patch
 BuildRequires: zlib-devel
 BuildRequires: autoconf automake libtool
 Requires: logrotate >= 3.5.2
@ -48,6 +49,7 @@ MySQL database support to rsyslog.
 %setup -q
 %patch1 -p1 -b .sockHang
 %patch2 -p1 -b .strerror
+%patch3 -p1 -b .manPage
 autoreconf

 %build
@ -105,7 +107,7 @@ fi

 %files
 %defattr(-,root,root,-)
-%doc AUTHORS COPYING INSTALL NEWS README doc
+%doc AUTHORS COPYING INSTALL NEWS README doc/*html
 %config(noreplace) %{_sysconfdir}/rsyslog.conf
 %config(noreplace) %{_sysconfdir}/sysconfig/rsyslog
 %config(noreplace) %{_sysconfdir}/logrotate.d/rsyslog
@ -121,6 +123,9 @@ fi
 %{_libdir}/rsyslog/ommysql.so

 %changelog
+* Mon Feb 11 2008 Peter Vrabec <pvrabec@redhat.com> 2.0.0-3
+- fix documentation problems
+
 * Tue Jan 22 2008 Peter Vrabec <pvrabec@redhat.com> 2.0.0-2
 - strerror fix (#428775)