changeset 5655:115278a9a95f

added standalone server --help text (thanks to franklin)
author Thomas Waldmann <tw AT waldmann-edv DOT de>
date Sun, 11 Apr 2010 18:21:53 +0200
parents 63016f784d88
children c7dd42405e5a
files MoinMoin/script/server/standalone.py
diffstat 1 files changed, 19 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/MoinMoin/script/server/standalone.py	Mon Apr 05 23:37:52 2010 +0200
+++ b/MoinMoin/script/server/standalone.py	Sun Apr 11 18:21:53 2010 +0200
@@ -15,6 +15,25 @@
 from MoinMoin.web.serving import run_server
 
 class PluginScript(MoinScript):
+    """\
+Purpose:
+========
+This tool allows you to start a standalone server
+
+Detailed Instructions:
+======================
+General syntax: moin [options] server standalone [standalone-options]
+
+[options] usually should be:
+    --config-dir=/path/to/my/cfg/ --wiki-url=http://wiki.example.org/
+
+[standalone-options] see below:
+    Please note:
+    * You must run this script as the owner of the wiki files.
+    * You should not run this script as root. You should use --user and
+      --group to run the server without superuser privileges.
+"""
+
     def __init__(self, argv, def_values):
         MoinScript.__init__(self, argv, def_values)
         self.parser.add_option(