changeset 81:17e542b7985a

urllog, quotedb: Improve documentation.
author Matti Hamalainen <ccr@tnsp.org>
date Sun, 11 Sep 2011 18:49:06 +0300
parents 3eb07f55bf86
children 1bbc79f41a1c
files quotedb.tcl urllog.tcl
diffstat 2 files changed, 12 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/quotedb.tcl	Sun Sep 11 18:37:10 2011 +0300
+++ b/quotedb.tcl	Sun Sep 11 18:49:06 2011 +0300
@@ -39,7 +39,7 @@
 ### Search related settings
 ###
 
-# Limit how many quotes should the "!<cmd> find" command show (maximum limit)
+# Limit how many quotes should the "!<cmd> find" command show at most.
 set qdb_showmax_pub 3
 
 # Same as above, but for private message search.
--- a/urllog.tcl	Sun Sep 11 18:37:10 2011 +0300
+++ b/urllog.tcl	Sun Sep 11 18:49:06 2011 +0300
@@ -6,14 +6,16 @@
 ##########################################################################
 #
 # URL-logger script for EggDrop IRC robot, utilizing SQLite3 database
+# This script requires SQLite TCL extension. Under Debian, you need:
+# tcl8.5 libsqlite3-tcl (and eggdrop eggdrop-data, of course)
 #
-# NOTICE! If you are upgrading to v2.0+ from any 1.x version, you
+# NOTICE! If you are upgrading to URLLog v2.0+ from any 1.x version, you
 # may want to run a conversion script against your URL-database file,
 # if you wish to preserve the old data.
 #
 # See convert_urllog_db.tcl for more information.
 #
-# If you are making a fresh install, you will need to create the
+# If you are doing a fresh install, you will need to create the
 # initial SQLite3 database with the required table schemas. You
 # can do that by running: create_urllog_db.tcl
 #
@@ -22,14 +24,16 @@
 ###
 ### HTTP options
 ###
-# Set to 1 if you want to use HTTP proxy
+# Set to 1 if you want to enable use of HTTP proxy.
+# If you do, you MUST set the proxy settings below too.
 set http_proxy 0
 
 # Proxy host and port number (only used if enabled above)
 set http_proxy_host ""
 set http_proxy_port 8080
 
-# 1 = Enable experimental TLS/SSL support. This may not work.
+# Enable _experimental_ TLS/SSL support. This may not work at all.
+# If unsure, leave this option disabled (0).
 set http_tls_support 0
 
 
@@ -65,11 +69,10 @@
 set urllog_search 1
 
 
-# How many URL's should the !urlfind command show (maximum limit)
+# Limit how many URLs should the "!urlfind" command show at most.
 set urllog_showmax_pub 3
 
-
-# For private-search, this is the default limit (user can change it)
+# Same as above, but for private message search.
 set urllog_showmax_priv 6
 
 
@@ -90,7 +93,7 @@
 
 
 ###
-### Message-texts
+### Message texts (informal, errors, etc.)
 ###
 
 # No such host was found