changeset 12:c2a2e35a85ac

final documentation, rpm builds properly
author carl
date Sat, 17 Dec 2005 16:17:09 -0800
parents a9b52f657f08
children 1134c6a1d692
files Makefile.am html/Makefile.am src/syslogconfig.cpp syslog2iptables.spec.in xml/syslog2iptables.in
diffstat 5 files changed, 47 insertions(+), 33 deletions(-) [+]
line wrap: on
line diff
--- a/Makefile.am	Thu Dec 15 16:20:17 2005 -0800
+++ b/Makefile.am	Sat Dec 17 16:17:09 2005 -0800
@@ -3,7 +3,7 @@
 hack_SCRIPTS = syslog2iptables
 sysconf_DATA = syslog2iptables.conf
 CLEANFILES = syslog2iptables xml/syslog2iptables xml/Makefile
-EXTRA_DIST = syslog2iptables.rc syslog2iptables.conf syslog2iptables.spec xml/*
+EXTRA_DIST = syslog2iptables.rc syslog2iptables.conf syslog2iptables.spec $(wildcard xml/h*) $(wildcard xml/M*) $(wildcard xml/s*)
 
 syslog2iptables: $(srcdir)/syslog2iptables.rc
 	   rm -f syslog2iptables
--- a/html/Makefile.am	Thu Dec 15 16:20:17 2005 -0800
+++ b/html/Makefile.am	Sat Dec 17 16:17:09 2005 -0800
@@ -1,1 +1,3 @@
-EXTRA_DIST = $(wildcard *.html) $(wildcard *.pdf)
+htmldir = ${datadir}/doc/@PACKAGE@-@VERSION@
+html_DATA = $(wildcard *.html) $(wildcard *.pdf)
+EXTRA_DIST = $(html_DATA)
--- a/syslog2iptables.spec.in	Thu Dec 15 16:20:17 2005 -0800
+++ b/syslog2iptables.spec.in	Sat Dec 17 16:17:09 2005 -0800
@@ -52,7 +52,9 @@
     includedir=$RPM_BUILD_ROOT%{_includedir} \
     sysconfdir=$RPM_BUILD_ROOT%{_sysconfdir} install
 mkdir -p $RPM_BUILD_ROOT/etc/rc.d/init.d
+mkdir -p $RPM_BUILD_ROOT%{_datadir}/doc/@PACKAGE@-@VERSION@
 mv -f $RPM_BUILD_ROOT%{_sysconfdir}/syslog2iptables  $RPM_BUILD_ROOT/etc/rc.d/init.d
+mv AUTHORS COPYING ChangeLog NEWS README             $RPM_BUILD_ROOT%{_datadir}/doc/@PACKAGE@-@VERSION@
 
 
 %clean
@@ -64,8 +66,6 @@
 
 %post
 /sbin/chkconfig --add @PACKAGE@
-/sbin/chkconfig @PACKAGE@ on
-/sbin/service @PACKAGE@ start || :
 
 
 %preun
@@ -77,13 +77,15 @@
 
 
 %files
-%doc AUTHORS COPYING ChangeLog NEWS README
 %defattr(-,root,root)
 %{_sbindir}/*
-%{_mandir}/*
+%doc %{_mandir}/*
+%docdir %{_datadir}/doc/@PACKAGE@-@VERSION@
+%{_datadir}/doc/@PACKAGE@-@VERSION@
 %config(noreplace) %{_sysconfdir}/@PACKAGE@.conf
 /etc/rc.d/init.d/@PACKAGE@
 
+# %doc AUTHORS COPYING ChangeLog NEWS README
 
 %changelog
 * Thu Dec 08 2005 Carl Byington 1.0
--- a/xml/syslog2iptables.in	Thu Dec 15 16:20:17 2005 -0800
+++ b/xml/syslog2iptables.in	Sat Dec 17 16:17:09 2005 -0800
@@ -3,10 +3,9 @@
     <partintro>
         <title>Packages</title>
         <para>The various source and binary packages are available at <ulink
-        url="http://www.five-ten-sg.com/syslog2iptables/packages">http://www.five-ten-sg.com/syslog2iptables/packages</ulink>
-        </para>
-        <para>The most recent documentation is available at <ulink
-        url="http://www.five-ten-sg.com/syslog2iptables/">http://www.five-ten-sg.com/syslog2iptables/</ulink>
+        url="http://www.five-ten-sg.com/@PACKAGE@/packages">http://www.five-ten-sg.com/@PACKAGE@/packages</ulink>
+        The most recent documentation is available at <ulink
+        url="http://www.five-ten-sg.com/@PACKAGE@/">http://www.five-ten-sg.com/@PACKAGE@/</ulink>
         </para>
     </partintro>
 
@@ -57,9 +56,19 @@
 
                 <para>Each ip address has an associated leaky bucket, which leaks one
                 token per second.  Once the bucket contains more than a configurable
-                number of tokens, that ip address is added to the INPUT chain with a
-                DROP target.  When the bucket is drained to zero, that ip address is
-                removed from the INPUT chain.</para>
+            threshold number of tokens, that ip address is added to the INPUT chain
+            with a DROP target.  When the bucket is drained to zero, that ip address
+            is removed from the INPUT chain.</para>
+
+            <para>The discussion has focused on syslog files, but any ascii text
+            file can be used, so long as some other process appends lines to that
+            file, and those lines containing hostname or ip addresses can be matched
+            with some regular expression.</para>
+
+            <para>Considering syslog files in particular, these are normally rotated
+            via logrotate.  <command>@PACKAGE@</command> properly detects and
+            handles this case by closing the old file, and reopening the newly
+            created file.</para>
         </refsect1>
 
         <refsect1 id='options.1'>
@@ -95,7 +104,8 @@
             <para>
                 The configuration file is documented in <citerefentry>
                 <refentrytitle>@PACKAGE@.conf</refentrytitle> <manvolnum>5</manvolnum>
-                </citerefentry>.
+                </citerefentry>.  Any change to the config file will cause it to be
+                reloaded within three minutes.
             </para>
         </refsect1>