From e5751517b1e3d35d4d326e249114df8ac9acb01a Mon Sep 17 00:00:00 2001
From: Guillaume Mazoyer <respawneral@gmail.com>
Date: Thu, 25 Sep 2014 21:44:48 +0200
Subject: Start documentation for the configuration options.

---
 config.php.example           |  1 +
 docs/configuration.md        | 29 +++++++++++++++++++++++++++++
 docs/misc.md                 |  5 -----
 includes/config.defaults.php |  5 ++++-
 4 files changed, 34 insertions(+), 6 deletions(-)
 create mode 100644 docs/configuration.md
 delete mode 100644 docs/misc.md

diff --git a/config.php.example b/config.php.example
index 3d4a201..f03e5e1 100644
--- a/config.php.example
+++ b/config.php.example
@@ -1,4 +1,5 @@
 <?php
+
 /*
  * Main configuration file example.
  *
diff --git a/docs/configuration.md b/docs/configuration.md
new file mode 100644
index 0000000..cbb77d2
--- /dev/null
+++ b/docs/configuration.md
@@ -0,0 +1,29 @@
+# Looking Glass: Configuration Options
+
+## Format
+
+The *config.php* file is a piece of regular PHP source code. This means you
+need to follow the rules or the interface will work.
+
+You can mostly get by copying the example lines, just make sure all your
+strings are quoted and your statements end in a semicolon (;).
+
+All the default values for the configuration are defined in the
+*includes/config.defaults.php* file. This file *must* not be edited. The
+directives set in *config.php* will automatically override the default ones.
+
+## Directives
+
+These are the available configuration options. They can be set in *config.php*.
+
+### Frontpage
+
+### Routers
+
+### Logs
+
+### Filters
+
+### Misc.
+
+### Documentation
diff --git a/docs/misc.md b/docs/misc.md
deleted file mode 100644
index 9c29361..0000000
--- a/docs/misc.md
+++ /dev/null
@@ -1,5 +0,0 @@
-# Looking Glass: Miscellaneous information
-
-## Topic 1
-
-## Topic 2
diff --git a/includes/config.defaults.php b/includes/config.defaults.php
index 038d661..d174967 100644
--- a/includes/config.defaults.php
+++ b/includes/config.defaults.php
@@ -78,7 +78,10 @@ $config = array(
       'description' => 'Display the path to a given destination.',
       'parameter' => 'The parameter must be an IPv4/IPv6 address (without mask) or a fully qualified domain name.<br />RFC1918 addresses, IPv6 starting with FD or FC, and IPv4 reserved ranges (0.0.0.0/8, 169.254.0.0/16, 192.0.2.0/24 and 224.0.0.0/4) may be refused.<br /><br />Example of valid arguments:<br /><ul><li>8.8.8.8</li><li>2001:db8:1337::42</li><li>example.com</li></ul>'
     )
-  )
+  ),
+
+  // Routers
+  'routers' => array()
 
 );
 
-- 
cgit v1.2.3