changeset 50:f69363fc1f61

Update some comments and add a bit of documentation.
author Matti Hamalainen <ccr@tnsp.org>
date Wed, 07 Sep 2011 14:53:46 +0300
parents 7ecb0a0bfb36
children eb17a6bfd443
files urllog.tcl
diffstat 1 files changed, 14 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/urllog.tcl	Wed Sep 07 14:47:34 2011 +0300
+++ b/urllog.tcl	Wed Sep 07 14:53:46 2011 +0300
@@ -5,12 +5,17 @@
 #
 ##########################################################################
 #
-# NOTICE! If you are upgrading to v1.90+ from any older version, you
-# might want to run a conversion script against your URL-database file.
+# URL-logger script for EggDrop IRC robot, utilizing SQLite3 database
+#
+# NOTICE! If you are upgrading to 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.
 #
-# It is NOT strictly necessary, but recommended especially if you
-# utilize the "shorturl" functionality. The conversion script is
-# available at < http://tnsp.org/egg-tcls/ >
+# See convert_urllog_db.tcl for more information.
+#
+# If you are making 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
 #
 ##########################################################################
 
@@ -24,13 +29,15 @@
 set http_proxy_host ""
 set http_proxy_port 8080
 
+# 1 = Enable experimental TLS/SSL support. This may not work.
 set http_tls_support 0
 
+
 ###
 ### General options
 ###
 
-# Filename where the logged URL data goes
+# Filename of the SQLite URL database file
 set urllog_db_file "urllog.sqlite"
 
 
@@ -39,7 +46,7 @@
 set urllog_verbose 1
 
 
-# 1 = Put some info to bot's Logfile during operation
+# 1 = Enable logging of various script actions into bot's log
 # 0 = Don't.
 set urllog_logmsg 1