scoop-cgi: add logbot archive capabilities

[bin.git] / man / scoop-cgi.1.scd

diff --git a/man/scoop-cgi.1.scd b/man/scoop-cgi.1.scd
index 0a12a7b0da2cc30de3b3800d62c0b5e0909d5969..812eaf1e10a461c22aa8f6b2d01ae551de203935 100644 (file)
--- a/man/scoop-cgi.1.scd
+++ b/man/scoop-cgi.1.scd
@@ -9,13 +9,32 @@ Run with your favorite web server
 # DESCRIPTION
 june's scooper is a great, full-featured web interface to litterbox, however it
 is relatively complex. The plaintext output of scoop is good enough for me. This
-script just makes it accesible via the web. Requires scoop and litterbox.
+script just makes it accesible via the web. It can also support logbot
+archive files. Requires scoop and litterbox.
+
+# URL SCHEME
+*/*
+       Home page
+
+*/channel*
+       Logs from channel from today
+
+*/channel/date*
+       Logs from channel from specified date. The date is passed through the date
+       command so on systems running the GNU coreutils, keywords like "last-thursday"
+       will work, however for portability, using ISO8601 (YYYY-MM-DD) is safest.
 
 # CONFIGURATION
-There are two config files that go in /etc/scoop-cgi/channels, and
-/etc/scoop-cgi/database. The channels file has a list of channels for which
-public logging is enabled, and the database file has the path to the litterbox
-database file.
+*/etc/scoop-cgi/channels*
+       Contains a newline delimited list of channels to be publicly logged
+       from scoop.
+
+*/etc/scoop-cgi/database*
+       Contains the path to the litterbox database file.
+
+*/etc/scoop-cgi/logbot*
+       Contains a newline delimited list of channels to be publicly logged
+       from logbot archive files in /srv/www/scoop-cgi/.
 
 # DRAWBACKS
 - No built-in search functionality. Combine with YaCy or scoot for a searching
@@ -24,8 +43,8 @@ database file.
 - Homepage text is hard coded
 
 # SEE ALSO
-scoop(1), litterbox(1)
+*scoop*(1), *litterbox*(1)
 
 # COPYRIGHT
 This is free and unencumbered software released into the public domain. For more
-information, please refer to <https://unlicense.org/>.
\ No newline at end of file
+information, please refer to <https://unlicense.org/>.