From a822cd1d3cc0f5231f58c99cc06c9f598be4b3fa Mon Sep 17 00:00:00 2001
From: Andrew Brown <brownan@gmail.com>
Date: Thu, 10 Nov 2011 00:03:30 -0500
Subject: [PATCH] added an index of command line options with brief
 descriptions

Also added a warning to regionlist that it may be broken
---
 docs/options.rst | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)

diff --git a/docs/options.rst b/docs/options.rst
index 7d9a078..d265517 100644
--- a/docs/options.rst
+++ b/docs/options.rst
@@ -24,6 +24,41 @@ files.
 Command line options
 ====================
 
+All Options:
+
+======================================== ==================================
+:option:`--advanced-help`                Print out help on all options
+:option:`--bg-color`                     Change the background of the map
+:option:`--changelist`                   Outputs a list of changed tiles
+:option:`--changelist-format`            Sets the format of the change list
+:option:`--check-terrain`                Output information on the textures
+:option:`--display-config`               Displays the configuration
+:option:`--forcerender`                  Forces every tile to render
+:option:`-h`, :option:`--help <-h>`      Prints help on the basic options
+:option:`--imgformat`                    Choose from png or jpg output
+:option:`--imgquality`                   Change jpg output quality
+:option:`--list-rendermodes`             List the installed rendermodes
+:option:`--no-signs`                     Do not place signs on the map
+:option:`--north-direction`              Choose which direction is north
+:option:`--optimize-img`                 Run pngcrush on outputted tiles
+:option:`-p`, :option:`--processes <-p>` Choose the number of worker processes
+:option:`-q`, :option:`--quiet <-q>`     Print less output
+:option:`--regionlist`                   Only render specified areas of a map
+:option:`--rendermodes`                  Choose which rendermode(s) to use
+:option:`--settings`                     Specify an external settings file
+:option:`--skip-js`                      Do not output generated javascript files
+:option:`--stochastic-render`            Re-render parts of the map randomly
+:option:`--textures-path`                Specify custom textures to use
+:option:`-v`, :option:`--verbose <-v>`   Print more output
+:option:`-V`, :option:`--version <-V>`   Print out the version
+:option:`--web-assets-path`              Specify alternate web assets
+:option:`-z`, :option:`--zoom <-z>`      Do not touch
+======================================== ==================================
+
+
+Help Options
+------------
+
 .. cmdoption:: -h, --help
 
     Shows the list of options and exits
@@ -280,6 +315,11 @@ Less Useful Options
     a certain date. Or perhaps you can incrementally update your map by passing
     in a subset of regions each time. It's up to you!
 
+    .. warning::
+
+        This option may currently be broken. Use at your own risk! Patches
+        welcome!
+
     **Settings file:**
         Option name: ``regionlist``