##// END OF EJS Templates
Finishing up help string work.
Brian E. Granger -
Show More
@@ -77,8 +77,9 b' where you can edit ipython_config.py to start configuring IPython.'
77 _list_examples = "ipython profile list # list all profiles"
77 _list_examples = "ipython profile list # list all profiles"
78
78
79 _create_examples = """
79 _create_examples = """
80 ipython profile create foo # create profile foo
80 ipython profile create foo # create profile foo w/ default config files
81 ipython profile create foo --init # create with default config files
81 ipython profile create foo --reset # restage default config files over current
82 ipython profile create foo --parallel # also stage parallel config files
82 """
83 """
83
84
84 _main_examples = """
85 _main_examples = """
@@ -63,9 +63,12 b' ipython --pylab # start in pylab mode'
63 ipython --pylab=qt # start in pylab mode with the qt4 backend
63 ipython --pylab=qt # start in pylab mode with the qt4 backend
64 ipython --log_level=DEBUG # set logging to DEBUG
64 ipython --log_level=DEBUG # set logging to DEBUG
65 ipython --profile=foo # start with profile foo
65 ipython --profile=foo # start with profile foo
66
66 ipython qtconsole # start the qtconsole GUI application
67 ipython qtconsole # start the qtconsole GUI application
67 ipython profile -h # show the help string for the profile subcmd
68 ipython qtconsole -h # show the help string for the qtconsole subcmd
68 ipython qtconsole -h # show the help string for the qtconsole subcmd
69
70 ipython profile create foo # create profile foo w/ default config files
71 ipython profile -h # show the help string for the profile subcmd
69 """
72 """
70
73
71 #-----------------------------------------------------------------------------
74 #-----------------------------------------------------------------------------
@@ -67,7 +67,9 b" configuration files, followed by 'ipcluster start --profile=mycluster --n=4'."
67 """
67 """
68
68
69 _main_examples = """
69 _main_examples = """
70 ipcluster start --n=4 # start a 4 node cluster on localhost
70 ipcluster start -h # show the help string for the start subcmd
71 ipcluster start -h # show the help string for the start subcmd
72
71 ipcluster stop -h # show the help string for the stop subcmd
73 ipcluster stop -h # show the help string for the stop subcmd
72 ipcluster engines -h # show the help string for the engines subcmd
74 ipcluster engines -h # show the help string for the engines subcmd
73 """
75 """
@@ -113,8 +115,8 b' security related files and are named using the convention'
113 'profile_<name>' and should be creating using the 'start'
115 'profile_<name>' and should be creating using the 'start'
114 subcommand of 'ipcluster'. If your cluster directory is in
116 subcommand of 'ipcluster'. If your cluster directory is in
115 the cwd or the ipython directory, you can simply refer to it
117 the cwd or the ipython directory, you can simply refer to it
116 using its profile name, 'ipcluster start n=4 profile=<profile>`,
118 using its profile name, 'ipcluster start --n=4 --profile=<profile>`,
117 otherwise use the 'profile_dir' option.
119 otherwise use the 'profile-dir' option.
118 """
120 """
119 stop_help = """Stop a running IPython cluster
121 stop_help = """Stop a running IPython cluster
120
122
@@ -122,8 +124,8 b' Stop a running ipython cluster by its profile name or cluster'
122 directory. Cluster directories are named using the convention
124 directory. Cluster directories are named using the convention
123 'profile_<name>'. If your cluster directory is in
125 'profile_<name>'. If your cluster directory is in
124 the cwd or the ipython directory, you can simply refer to it
126 the cwd or the ipython directory, you can simply refer to it
125 using its profile name, 'ipcluster stop profile=<profile>`, otherwise
127 using its profile name, 'ipcluster stop --profile=<profile>`, otherwise
126 use the 'profile_dir' option.
128 use the '--profile-dir' option.
127 """
129 """
128 engines_help = """Start engines connected to an existing IPython cluster
130 engines_help = """Start engines connected to an existing IPython cluster
129
131
@@ -134,8 +136,8 b' security related files and are named using the convention'
134 'profile_<name>' and should be creating using the 'start'
136 'profile_<name>' and should be creating using the 'start'
135 subcommand of 'ipcluster'. If your cluster directory is in
137 subcommand of 'ipcluster'. If your cluster directory is in
136 the cwd or the ipython directory, you can simply refer to it
138 the cwd or the ipython directory, you can simply refer to it
137 using its profile name, 'ipcluster engines n=4 profile=<profile>`,
139 using its profile name, 'ipcluster engines --n=4 --profile=<profile>`,
138 otherwise use the 'profile_dir' option.
140 otherwise use the 'profile-dir' option.
139 """
141 """
140 stop_aliases = dict(
142 stop_aliases = dict(
141 signal='IPClusterStop.signal',
143 signal='IPClusterStop.signal',
@@ -82,7 +82,7 b' clients. The controller needs to be started before the engines and can be'
82 configured using command line options or using a cluster directory. Cluster
82 configured using command line options or using a cluster directory. Cluster
83 directories contain config, log and security files and are usually located in
83 directories contain config, log and security files and are usually located in
84 your ipython directory and named as "profile_name". See the `profile`
84 your ipython directory and named as "profile_name". See the `profile`
85 and `profile_dir` options for details.
85 and `profile-dir` options for details.
86 """
86 """
87
87
88 _examples = """
88 _examples = """
@@ -61,12 +61,12 b' and controller. A controller needs to be started before the engines. The'
61 engine can be configured using command line options or using a cluster
61 engine can be configured using command line options or using a cluster
62 directory. Cluster directories contain config, log and security files and are
62 directory. Cluster directories contain config, log and security files and are
63 usually located in your ipython directory and named as "profile_name".
63 usually located in your ipython directory and named as "profile_name".
64 See the `profile` and `profile_dir` options for details.
64 See the `profile` and `profile-dir` options for details.
65 """
65 """
66
66
67 _examples = """
67 _examples = """
68 ipengine --ip=192.168.0.1 --port=1000 # connect to hub at ip and port
68 ipengine --ip=192.168.0.1 --port=1000 # connect to hub at ip and port
69 ipengine --log-to-file --log_level=DEBUG # log to a file with DEBUG verbosity
69 ipengine --log-to-file --log-level=DEBUG # log to a file with DEBUG verbosity
70 """
70 """
71
71
72 #-----------------------------------------------------------------------------
72 #-----------------------------------------------------------------------------
@@ -48,7 +48,7 b' by registering a `zmq.log.handlers.PUBHandler` with the `logging` module. The'
48 logger can be configured using command line options or using a cluster
48 logger can be configured using command line options or using a cluster
49 directory. Cluster directories contain config, log and security files and are
49 directory. Cluster directories contain config, log and security files and are
50 usually located in your ipython directory and named as "profile_name".
50 usually located in your ipython directory and named as "profile_name".
51 See the `profile` and `profile_dir` options for details.
51 See the `profile` and `profile-dir` options for details.
52 """
52 """
53
53
54
54
@@ -252,7 +252,7 b' class IPControllerTask(WinHPCTask):'
252
252
253 task_name = Unicode('IPController', config=True)
253 task_name = Unicode('IPController', config=True)
254 controller_cmd = List(['ipcontroller.exe'], config=True)
254 controller_cmd = List(['ipcontroller.exe'], config=True)
255 controller_args = List(['--log-to-file', 'log-level=40'], config=True)
255 controller_args = List(['--log-to-file', '--log-level=40'], config=True)
256 # I don't want these to be configurable
256 # I don't want these to be configurable
257 std_out_file_path = Unicode('', config=False)
257 std_out_file_path = Unicode('', config=False)
258 std_err_file_path = Unicode('', config=False)
258 std_err_file_path = Unicode('', config=False)
@@ -280,7 +280,7 b' class IPEngineTask(WinHPCTask):'
280
280
281 task_name = Unicode('IPEngine', config=True)
281 task_name = Unicode('IPEngine', config=True)
282 engine_cmd = List(['ipengine.exe'], config=True)
282 engine_cmd = List(['ipengine.exe'], config=True)
283 engine_args = List(['--log-to-file', 'log_level=40'], config=True)
283 engine_args = List(['--log-to-file', '--log-level=40'], config=True)
284 # I don't want these to be configurable
284 # I don't want these to be configurable
285 std_out_file_path = Unicode('', config=False)
285 std_out_file_path = Unicode('', config=False)
286 std_err_file_path = Unicode('', config=False)
286 std_err_file_path = Unicode('', config=False)
General Comments 0
You need to be logged in to leave comments. Login now