diff MoinMoin/script/xmlrpc/remote.py @ 3108:2572688e031a

improved moin script's builtin help function, thanks to Federico Lorenzi (ported from 1.6)
author Thomas Waldmann <tw AT waldmann-edv DOT de>
date Sat, 23 Feb 2008 23:40:48 +0100
parents 3d08f1cb4429
children a20de9383481
line wrap: on
line diff
--- a/MoinMoin/script/xmlrpc/remote.py	Sat Feb 23 22:59:30 2008 +0100
+++ b/MoinMoin/script/xmlrpc/remote.py	Sat Feb 23 23:40:48 2008 +0100
@@ -1,11 +1,9 @@
 # -*- coding: iso-8859-1 -*-
 """
-    MoinMoin - remote command execution, client part
+MoinMoin - remote command execution, client part
 
-    This can be used as client to execute moin scripts remotely.
-
-    @copyright: 2006 MoinMoin:ThomasWaldmann
-    @license: GNU GPL, see COPYING for details.
+@copyright: 2006 MoinMoin:ThomasWaldmann
+@license: GNU GPL, see COPYING for details.
 """
 
 import sys
@@ -14,7 +12,24 @@
 from MoinMoin.script import MoinScript, fatal
 
 class PluginScript(MoinScript):
-    """ Remote Script Execution Client """
+    """\
+Purpose:
+========
+This tool allows you to execute moin scripts remotely.
+
+Detailed Instructions:
+======================
+General syntax: moin [options] xmlrpc remote [remote-options]
+
+[options] usually should be:
+    --config-dir=/path/to/my/cfg/ --wiki-url=wiki.example.org/
+
+[remote-options] see below:
+    0. Verify that you have a remotescriptconf.py configuration file.
+
+    1. To run the script 'account check' remotely.
+       moin ... xmlrpc remote account check
+"""
 
     def __init__(self, argv, def_values):
         MoinScript.__init__(self, argv, def_values)