Add a README.example

diff --git a/Makefile.am b/Makefile.am
index 7850d48f11fdabb0c96c8b4828c0f498529b832b..87dcf789df8dbcfc420f0042afba408f0d40f3ed 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -45,7 +45,7 @@ man_MANS = innduct.8 innduct-stats-report.8
 innduct_SOURCES = duct.c conn.c filemon.c infile.c recv.c xmit.c \
                cli.c defer.c help.c statemc.c __oop-read-copy.c
 
-dist_doc_DATA = README.states README.statistics
+dist_doc_DATA = README.states README.statistics README.example
 
 innduct_LDADD = -lm -loop
 

diff --git a/Makefile.in b/Makefile.in
index 6b06eaaa9a1ec2bbda77600e11d723c475554426..be9c4e7598671ba4ac4574b843b8c28aab34f490 100644 (file)
--- a/Makefile.in
+++ b/Makefile.in
@@ -362,7 +362,7 @@ man_MANS = innduct.8 innduct-stats-report.8
 innduct_SOURCES = duct.c conn.c filemon.c infile.c recv.c xmit.c \
                cli.c defer.c help.c statemc.c __oop-read-copy.c
 
-dist_doc_DATA = README.states README.statistics
+dist_doc_DATA = README.states README.statistics README.example
 innduct_LDADD = -lm -loop
 MAINTAINERCLEANFILES = configure config.h.in Makefile.in
 all: config.h

diff --git a/README.example b/README.example
new file mode 100644 (file)
index 0000000..dd79eaa
--- /dev/null
+++ b/README.example
@@ -0,0 +1,23 @@
+Example configuration
+=====================
+
+On chiark, we have newsfeeds entries that look like this:
+
+  eternal-september/eternal-september.org\
+         :!*,uk.*,cam.*,ed.*,alt.*,..(details elided)....\
+         :Tf,Wnm:
+  the.earth.li/earthli\
+         :!*,....(details elided)...\
+         :Tf,Wnm:the.earth.li
+
+This specifies innd log feed file
+  /var/spool/news/outgoing/eternal-september
+  /var/spool/news/outgoing/the.earth.li
+
+We have an /etc/news/ducts.table containing entries like this:
+  the.earth.li
+  eternal-september feeder.eternal-september.org --port 433
+
+The news user's crontab has lines like this:
+  10-59/20 *    * * *   innduct-forall 'ulimit -c 10240; innduct -q !duct'
+  36 3          * * *   find /var/spool/news/outgoing/ -type f -name '*_backlog_*' -mtime +60 -print0 | xargs -0 rm