From 7604468afa83b2e38b2d08b394dd332499cb71df 2009-04-22 18:59:17
From: Brian Granger <ellisonbg@gmail.com>
Date: 2009-04-22 18:59:17
Subject: [PATCH] Adding information about IPYTHONDIR to usage of ipcluster and friends.

---

diff --git a/IPython/kernel/scripts/ipcluster.py b/IPython/kernel/scripts/ipcluster.py
index 1e438bc..dcebf04 100755
--- a/IPython/kernel/scripts/ipcluster.py
+++ b/IPython/kernel/scripts/ipcluster.py
@@ -736,8 +736,11 @@ def get_args():
     
     parser = argparse.ArgumentParser(
         description='IPython cluster startup.  This starts a controller and\
-        engines using various approaches.  THIS IS A TECHNOLOGY PREVIEW AND\
-        THE API WILL CHANGE SIGNIFICANTLY BEFORE THE FINAL RELEASE.'
+        engines using various approaches.  Use the IPYTHONDIR environment\
+        variable to change your IPython directory from the default of\
+        .ipython or _ipython.  The log and security subdirectories of your\
+        IPython directory will be used by this script for log files and\
+        security files.'
     )
     subparsers = parser.add_subparsers(
         help='available cluster types.  For help, do "ipcluster TYPE --help"')
diff --git a/IPython/kernel/scripts/ipcontroller.py b/IPython/kernel/scripts/ipcontroller.py
index 58be438..496b139 100755
--- a/IPython/kernel/scripts/ipcontroller.py
+++ b/IPython/kernel/scripts/ipcontroller.py
@@ -264,7 +264,14 @@ def init_config():
     Initialize the configuration using default and command line options.
     """
     
-    parser = OptionParser()
+    parser = OptionParser("""ipcontroller [options]
+
+Start an IPython controller.
+
+Use the IPYTHONDIR environment variable to change your IPython directory 
+from the default of .ipython or _ipython.  The log and security 
+subdirectories of your IPython directory will be used by this script 
+for log files and security files.""")
     
     # Client related options
     parser.add_option(
diff --git a/IPython/kernel/scripts/ipengine.py b/IPython/kernel/scripts/ipengine.py
index 8997f44..a70ec6a 100755
--- a/IPython/kernel/scripts/ipengine.py
+++ b/IPython/kernel/scripts/ipengine.py
@@ -140,7 +140,14 @@ def init_config():
     Initialize the configuration using default and command line options.
     """
     
-    parser = OptionParser()
+    parser = OptionParser("""ipengine [options]
+
+Start an IPython engine.
+
+Use the IPYTHONDIR environment variable to change your IPython directory 
+from the default of .ipython or _ipython.  The log and security 
+subdirectories of your IPython directory will be used by this script 
+for log files and security files.""")
     
     parser.add_option(
         "--furl-file",