[tor-commits] [stem/master] Revising prompt --help output

atagar at torproject.org atagar at torproject.org
Sun May 11 01:02:51 UTC 2014


commit 7f63b5a525768ab80dd04ac670fb9a68aa329324
Author: Damian Johnson <atagar at torproject.org>
Date:   Sat May 10 18:02:00 2014 -0700

    Revising prompt --help output
    
    Just a few minor tweaks. Dropping the examples from the end since we have
    better example usage earlier now.
---
 stem/interpretor/arguments.py |    2 +-
 stem/interpretor/settings.cfg |   14 +++++++-------
 2 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/stem/interpretor/arguments.py b/stem/interpretor/arguments.py
index 6dc327b..9c23e0f 100644
--- a/stem/interpretor/arguments.py
+++ b/stem/interpretor/arguments.py
@@ -93,4 +93,4 @@ def get_help():
     address = DEFAULT_ARGS['control_address'],
     port = DEFAULT_ARGS['control_port'],
     socket = DEFAULT_ARGS['control_socket'],
-  ).strip()
+  )
diff --git a/stem/interpretor/settings.cfg b/stem/interpretor/settings.cfg
index 444936a..8782e66 100644
--- a/stem/interpretor/settings.cfg
+++ b/stem/interpretor/settings.cfg
@@ -14,7 +14,9 @@ msg.help
 |Interactive interpretor for Tor. This can provide you with either direct
 |access to Tor's control interface or a python prompt connected to Tor...
 |
-|  % prompt -i 9051
+|--------------------------------------------------------------------------------
+|
+|  % prompt
 |  >>> GETINFO version
 |  0.2.5.1-alpha-dev (git-245ecfff36c0cecc)
 |
@@ -23,7 +25,9 @@ msg.help
 |
 |  >>> /quit
 |
-|  % prompt -pi 9051
+|--------------------------------------------------------------------------------
+|
+|  % prompt --python
 |  >>> controller.get_info('version')
 |  '0.2.5.1-alpha-dev (git-245ecfff36c0cecc)'
 |
@@ -34,7 +38,7 @@ msg.help
 |
 |  >>> quit()
 |
-|================================================================================
+|--------------------------------------------------------------------------------
 |
 |  -i, --interface [ADDRESS:]PORT  change control interface from {address}:{port}
 |  -s, --socket SOCKET_PATH        attach using unix domain socket if present,
@@ -43,10 +47,6 @@ msg.help
 |                                    Tor rather than attaching directly
 |  -h, --help                      presents this help
 |
-|Example:
-|prompt -i 1643            attach to control port 1643
-|prompt -ps ~/.tor/socket  attach to this control socket, and provide a python
-|                          interpretor
 
 msg.python_banner
 |Welcome to Stem's interpretor prompt. You presently have a connection to Tor



More information about the tor-commits mailing list