More work on documentation

docs/docs/guide/ini/archivers.md

@@ -0,0 +1,7 @@
+# archivers.ini
+
+This file is where you configure your archivers, each section deals with a specific archiver, use *a for archive name *f for file list to pack and *d for destination directory. Users default archive type (the one used for offline mail) will default to the first defined archiver. Users can change archivers via the settings menu.
+
+* **Extension** The file extension used to represent this archive type
+* **Pack** The command to pack (for example, for info zip: zip -j *a *f)
+* **Unpack** The command to unpack (for example, for info zip: unzip -j -o *a -d *d)

docs/docs/guide/ini/bbs.md

@@ -0,0 +1,61 @@
+# bbs.ini
+
+This is the main bbs INI file and contains the following sections
+
+## Main
+ * **Codepage** The default codepage to use when a user logs in. (Required)
+ * **Telnet Port** The port to listen to telnet connections on (Required)
+ * **BBS Name** The name of your BBS (Required)
+ * **Sysop Name** The Sysop's Login Name (Required)
+ * **Nodes** The maximum number of nodes (Required)
+ * **New User Level** The security level new users are given (See s10.ini) (Required)
+ * **MagiChat Server** The MagiChat Server you want to connect to (Optional)
+ * **MagiChat Port** The port of the above MagiChat Server (Required if MagiChat Server is set);
+ * **MagiChat BBSTag** The (short) tag to identify users of your BBS (Required if MagiChat Server is set);
+ * **Default Tagline** The tagline to use if a conference doesn't have it's own set
+ * **External Editor Cmd** The script to launch for running an external editor (NOT Required - remove if you dont have one)
+ * **External Editor Stdio** True or False if your editor requires stdio redirection (Only Required if External Editor CMD is set)
+ * **External Editor Codepage** The codepage the external editor uses (CP437 for magichat) (Only required if External Editor CMD is set)
+ * **Automessage Write Level** The security level a user needs to change the automessage (Required)
+ * **Fork** True if you want the BBS to run in daemon mode false if not. (Required)
+ * **Enable WWW** True to enable the WWW server, false if not. (Required)
+ * **WWW Port** Port to listen for HTTP connections (Required if WWW is enabled)
+ * **WWW URL** Public facing url of the BBS (Required if WWW is enabled)
+ * **Enable SSH** True to enable the SSH server, false to not. (Required)
+ * **SSH Port** Port to listen for SSH connection. (Required if Enable SSH is true)
+ * **SSH DSA Key** Path to SSH DSA Host Key. (Required if Enable SSH is true)
+ * **SSH RSA Key** Path to SSH RSA Host Key. (Required if Enable SSH is true)
+ * **QWK Name** Name used for the system for Bluewave (Required - restricted to 8 characters)
+ * **Main AKA** Your main network address (Required)
+ * **QWK Max Messages** Maximum number of messages per Bluewave bundle (Required)
+ * **Broadcast Enable** Set to true to enable the Broadcast Feature (Required)
+ * **Broadcast Port** The port to send broadcast messages on (Required)
+ * **Broadcast Address** The address to broadcast on (Required)
+ * **IP Guard Enable** Set to true to enable the IP Guard (Required)
+ * **IP Guard Timeout** Timeout between connections (Required)
+ * **IP Guard Tries** Number of connections allowed within IP Guard Timeout (Required)
+ * **Root Menu** The menu file for the "main menu" (Required)
+ * **Date Style** The style for dates (EU or US) (Required)
+ * **Enable IPv6** Enable listening on IPv6 as well as IPv4 (Required)
+
+## Paths
+ * **Config Path** Path to your config files (Required)
+ * **WWW Path** Path to webserver files (Required)
+ * **String File** Path and filename of the 'magicka.strings' file (Required)
+ * **ANSI Path** Path to your system ansi files (Required)
+ * **BBS Path** Path to your main BBS directory (Required)
+ * **Script Path** Path to user configurable lua scripts (Required)
+ * **Echomail Semaphore** Path to semaphore to create when a new echomail is written. (Required)
+ * **Netmail Semaphore** Path to semaphore to create when a new netmail is written. (Required)
+ * **PID File** Path of pid file (Required)
+ * **Log Path** Path to log files (Required)
+ * **Menu Path** Path to menu files (Required)
+
+## Mail Conferences
+ * Mail Conferences include a list of Name = Path to configuration INI (At least 1 is required)
+
+## File Directories
+ * Same as Mail Conferences, but for files
+ 
+## Text Files
+ * A list of text files with name = Path/Filename for text files in the text file collection

docs/docs/guide/ini/doors.md

@@ -0,0 +1,7 @@
+# doors.ini
+
+Door configurations are stored in sections, with the section name being the name of the door (or anything really as long as it's unique per door).
+
+* **Command** This is the command line to run the door, it is passed the node number as the first argument and the socket as the second argument.
+* **Stdio** Either true or false depending on whether stdio redirection is needed.
+* **Codepage** Codepage the door uses. (Not required)

docs/docs/guide/ini/protocols.md

@@ -0,0 +1,10 @@
+# protocols.ini
+
+This file is where you configure your protocols, each section deals with a specific protocol, *f for file name. 
+
+* **Internal Zmodem** True if this section is the internal zmodem (No other options required if true)
+* **Upload Prompt** True if protocol requires the user to enter the filename, eg. XModem (Required)
+* **Upload Command** The command to execute to receive a file. (Required)
+* **Download Command** The command to execute to send a file. (Required)
+* **stdio** True if using stdio redirection when running the protocol. (Required)
+

docs/docs/guide/ini/seclevels.md

@@ -0,0 +1,13 @@
+# Security Levels (s10.ini)
+
+This file defines the security level 10, you need one ini file for each security level you want to define, and it must be named sN.ini where N is the security level.
+
+## Main
+
+  * **Time Per Day** This is the number of minutes a user has each day.
+
+To change a user's security level, use an sqlite3 utility to edit users.sq3. For example using the sqlite3 command line utility, enter the following to change the user "apam" to level 99
+
+    update users set seclevel=99 where loginname LIKE "apam";
+
+You will need to make sure there is an s99.ini for that user to be able to login.