[tor-commits] [arm/master] Interpretor help for SETCONF

[atagar at torproject.org]

commit 07826242636f2fcb877404587a8266c94551b238
Author: Damian Johnson <atagar at torproject.org>
Date:   Sun Sep 18 20:18:57 2011 -0700

    Interpretor help for SETCONF
    
    Providing basic usage information and examples.
---
 src/util/torInterpretor.py |   15 +++++++++++++--
 1 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py
index 2424a29..f0d0639 100644
--- a/src/util/torInterpretor.py
+++ b/src/util/torInterpretor.py
@@ -104,14 +104,25 @@ HELP_GETINFO = """Queries the tor process for information. Options are...
 HELP_GETCONF = """Provides the current value for a given configuration value. Options include...
 """
 
+HELP_SETCONF = """Sets the given configuration parameters. Values can be quoted or non-quoted
+strings, and reverts the option to 0 or NULL if not provided.
+
+Example:
+  * Sets a contact address and resets our family to NULL
+    SETCONF MyFamily ContactInfo=foo at bar.com
+
+  * Sets an exit policy that only includes port 80/443
+    SETCONF ExitPolicy=\"accept *:80, accept *:443, reject *:*\""""
+
 HELP_OPTIONS = {
   "HELP": ("/help [OPTION]", HELP_HELP),
   "WRITE": ("/write [PATH]", HELP_WRITE),
   "INFO": ("/info [relay fingerprint, nickname, or IP address]", HELP_INFO),
   "FIND": ("/find PATTERN", HELP_FIND),
   "QUIT": ("/quit", HELP_QUIT),
-  "GETINFO": ("GETINFO [OPTION]", HELP_GETINFO),
-  "GETCONF": ("GETCONF [OPTION]", HELP_GETCONF)
+  "GETINFO": ("GETINFO OPTION", HELP_GETINFO),
+  "GETCONF": ("GETCONF OPTION", HELP_GETCONF),
+  "SETCONF": ("SETCONF PARAM[=VALUE]", HELP_SETCONF)
 }
 
 class InterpretorClosed(Exception):