rev 1274 - trunk/siesta

[prev] [thread] [next] [lurker] [Date index for 2003/07/31]

Author: simon
Date: 2003-07-31 13:46:50 +0100 (Thu, 31 Jul 2003)
New Revision: 1274

Modified:
   trunk/siesta/Config.pm.in
Log:
Put some documentation in


Modified: trunk/siesta/Config.pm.in
==============================================================================
--- trunk/siesta/Config.pm.in	2003-07-31 11:23:08 UTC (rev 1273)
+++ trunk/siesta/Config.pm.in	2003-07-31 12:46:50 UTC (rev 1274)
@@ -3,10 +3,92 @@
 use strict;
 use vars qw( $CONFIG_FILE $ROOT $MESSAGES @STORAGE $ARCHIVE $LOG_PATH $LOG_LEVEL $config );
 
+
+=head1 NAME 
+
+Siesta::Config - organise the configuration of a Siesta install
+
+=head1 VARIABLES
+
 =head2 C<$ROOT>
 
-Where to install everything to
+Where to install everything to. Currently this is set to 
 
+	@@ROOT@@
+
+=head2 C<$CONFIG_FILE>
+
+Where the config file is currently 
+
+	@@ROOT@@/siesta.conf
+
+This can be overridden when using the command line tools by 
+using 
+
+	-f <new config file>
+
+
+=head3 CONFIG OPTIONS
+
+The following options are set within the config file :
+
+=over 4
+
+=item root
+
+override the C<$ROOT> variable above
+
+=item messages
+
+Where our message templates are stored.
+
+By default - @@ROOT@@/messages/
+
+=item archive
+
+Where we archive list mails.
+
+By default - @@ROOT@@/archive/<list name>/
+
+=item log_path
+
+Where we log things
+
+By default - @@ROOT@@/error
+
+
+=item log_level
+
+By default - 3
+
+=item storage_dsn
+
+The DSN for our local DB
+
+By default - dbi:SQLite:@@ROOT@@/database/
+
+=item storage_user
+
+The user name for our DB
+
+By default - root
+
+=item storage_pass
+
+The password for our DB
+
+By default - undef
+
+=back 
+
+=head2 C<@STORAGE>
+
+A list containing the dsn, the user and password.
+
+=head1 CREATION
+
+This file is autogenerated from Config.pm.in when you run Build.PL
+
 =cut
 
 BEGIN {

• rev 1274 - trunk/siesta simon 13:46 on 31 Jul 2003

Generated at 13:57 on 01 Jul 2004 by mariachi 0.52