Show More
@@ -20,7 +20,7 b' files and security files.' | |||||
20 | The first positional argument should be one of: {start, stop, engines}, |
|
20 | The first positional argument should be one of: {start, stop, engines}, | |
21 | which are the available subcommands. |
|
21 | which are the available subcommands. | |
22 |
|
22 | |||
23 | For detailed help on each, type "ipcluster CMD --help". Briefly: |
|
23 | For detailed help on each, type "ipcluster CMD \-\-help". Briefly: | |
24 |
|
24 | |||
25 | start start an IPython cluster |
|
25 | start start an IPython cluster | |
26 | stop stop a running IPython cluster |
|
26 | stop stop a running IPython cluster | |
@@ -31,7 +31,7 b' For detailed help on each, type "ipcluster CMD --help". Briefly:' | |||||
31 | \-h, \-\-help |
|
31 | \-h, \-\-help | |
32 | show help message and exit |
|
32 | show help message and exit | |
33 | .SH EXAMPLE |
|
33 | .SH EXAMPLE | |
34 | ipcluster start --n=4 |
|
34 | ipcluster start \-\-n=4 | |
35 |
|
35 | |||
36 | This command will start 4 IPython engines on the local computer. |
|
36 | This command will start 4 IPython engines on the local computer. | |
37 | .SH SEE ALSO |
|
37 | .SH SEE ALSO |
@@ -17,7 +17,7 b' show this help message and exit' | |||||
17 | .TP |
|
17 | .TP | |
18 | .B |
|
18 | .B | |
19 | .TP |
|
19 | .TP | |
20 | .B \-\-no-secure |
|
20 | .B \-\-no\-secure | |
21 | Don't authenticate messages. |
|
21 | Don't authenticate messages. | |
22 | .TP |
|
22 | .TP | |
23 | .B \-\-usethreads |
|
23 | .B \-\-usethreads | |
@@ -26,7 +26,7 b' Use threads instead of processes for the schedulers' | |||||
26 | .B \-\-init |
|
26 | .B \-\-init | |
27 | Initialize profile with default config files |
|
27 | Initialize profile with default config files | |
28 | .TP |
|
28 | .TP | |
29 | .B \-\-log-to-file |
|
29 | .B \-\-log\-to\-file | |
30 | send log output to a file |
|
30 | send log output to a file | |
31 | .TP |
|
31 | .TP | |
32 | .B \-\-reuse |
|
32 | .B \-\-reuse | |
@@ -70,11 +70,11 b" Default: '127.0.0.1'" | |||||
70 | The IP address for registration. This is generally either '127.0.0.1' for |
|
70 | The IP address for registration. This is generally either '127.0.0.1' for | |
71 | loopback only or '*' for all interfaces. [default: '127.0.0.1'] |
|
71 | loopback only or '*' for all interfaces. [default: '127.0.0.1'] | |
72 | .TP |
|
72 | .TP | |
73 | .B \-\-log-url=<Unicode> (BaseParallelApplication.log_url) |
|
73 | .B \-\-log\-url=<Unicode> (BaseParallelApplication.log_url) | |
74 | Default: '' |
|
74 | Default: '' | |
75 | The ZMQ URL of the iplogger to aggregate logging. |
|
75 | The ZMQ URL of the iplogger to aggregate logging. | |
76 | .TP |
|
76 | .TP | |
77 | .B \-\-work-dir=<Unicode> (BaseParallelApplication.work_dir) |
|
77 | .B \-\-work\-dir=<Unicode> (BaseParallelApplication.work_dir) | |
78 | Default: u'/Users/minrk/dev/ip/mine/docs/man' |
|
78 | Default: u'/Users/minrk/dev/ip/mine/docs/man' | |
79 | Set the working dir for the process. |
|
79 | Set the working dir for the process. | |
80 | .TP |
|
80 | .TP | |
@@ -82,7 +82,7 b' Set the working dir for the process.' | |||||
82 | Default: 0 |
|
82 | Default: 0 | |
83 | The port on which the Hub listens for registration. |
|
83 | The port on which the Hub listens for registration. | |
84 | .TP |
|
84 | .TP | |
85 | .B \-\-profile-dir=<Unicode> (ProfileDir.location) |
|
85 | .B \-\-profile\-dir=<Unicode> (ProfileDir.location) | |
86 | Default: u'' |
|
86 | Default: u'' | |
87 | Set the profile location directly. This overrides the logic used by the |
|
87 | Set the profile location directly. This overrides the logic used by the | |
88 | `profile` option. |
|
88 | `profile` option. | |
@@ -91,11 +91,11 b' Set the profile location directly. This overrides the logic used by the' | |||||
91 | Default: '' |
|
91 | Default: '' | |
92 | The UUID identifying this session. |
|
92 | The UUID identifying this session. | |
93 | .TP |
|
93 | .TP | |
94 | .B \-\-log-to-file=<Bool> (BaseParallelApplication.log_to_file) |
|
94 | .B \-\-log\-to\-file=<Bool> (BaseParallelApplication.log_to_file) | |
95 | Default: False |
|
95 | Default: False | |
96 | whether to log to a file |
|
96 | whether to log to a file | |
97 | .TP |
|
97 | .TP | |
98 | .B \-\-ipython-dir=<Unicode> (BaseIPythonApplication.ipython_dir) |
|
98 | .B \-\-ipython\-dir=<Unicode> (BaseIPythonApplication.ipython_dir) | |
99 | Default: u'/Users/minrk/.ipython' |
|
99 | Default: u'/Users/minrk/.ipython' | |
100 | The name of the IPython directory. This directory is used for logging |
|
100 | The name of the IPython directory. This directory is used for logging | |
101 | configuration (through profiles), history storage, etc. The default is |
|
101 | configuration (through profiles), history storage, etc. The default is | |
@@ -115,7 +115,7 b' Username for the Session. Default is your system username.' | |||||
115 | Default: 1000 |
|
115 | Default: 1000 | |
116 | The frequency at which the Hub pings the engines for heartbeats (in ms) |
|
116 | The frequency at which the Hub pings the engines for heartbeats (in ms) | |
117 | .TP |
|
117 | .TP | |
118 | .B \-\-log-level=<Enum> (Application.log_level) |
|
118 | .B \-\-log\-level=<Enum> (Application.log_level) | |
119 | Default: 30 |
|
119 | Default: 30 | |
120 | Choices: (0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL') |
|
120 | Choices: (0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL') | |
121 | Set the log level by value or name. |
|
121 | Set the log level by value or name. | |
@@ -125,7 +125,7 b" Default: u''" | |||||
125 | The external IP or domain name of the Controller, used for disambiguating |
|
125 | The external IP or domain name of the Controller, used for disambiguating | |
126 | engine and client connections. |
|
126 | engine and client connections. | |
127 | .TP |
|
127 | .TP | |
128 | .B \-\-clean-logs=<Bool> (BaseParallelApplication.clean_logs) |
|
128 | .B \-\-clean\-logs=<Bool> (BaseParallelApplication.clean_logs) | |
129 | Default: False |
|
129 | Default: False | |
130 | whether to cleanup old logfiles before starting |
|
130 | whether to cleanup old logfiles before starting | |
131 | .TP |
|
131 | .TP |
@@ -35,8 +35,8 b' more.' | |||||
35 | .SH REGULAR OPTIONS |
|
35 | .SH REGULAR OPTIONS | |
36 | All options that take values, must be of the form '\-\-name=value', but |
|
36 | All options that take values, must be of the form '\-\-name=value', but | |
37 | flags that take no arguments are allowed a single '\-' to allow common |
|
37 | flags that take no arguments are allowed a single '\-' to allow common | |
38 | patterns like: 'ipython -i myscript.py'. To pass arguments to scripts, |
|
38 | patterns like: 'ipython \-i myscript.py'. To pass arguments to scripts, | |
39 | rather than to IPython, specify them after '--'. |
|
39 | rather than to IPython, specify them after '\-\-'. | |
40 | .br |
|
40 | .br | |
41 | .sp 1 |
|
41 | .sp 1 | |
42 | All options can also be set from your ipython_config.py configuration file. |
|
42 | All options can also be set from your ipython_config.py configuration file. | |
@@ -50,22 +50,22 b' All options with a [no] prepended can be specified in negated form' | |||||
50 | .TP |
|
50 | .TP | |
51 | .B \-h, \-\-help |
|
51 | .B \-h, \-\-help | |
52 | Show summary of options. |
|
52 | Show summary of options. | |
53 | .B \-\-no-autoindent |
|
53 | .B \-\-no\-autoindent | |
54 | Turn off autoindenting. |
|
54 | Turn off autoindenting. | |
55 | .TP |
|
55 | .TP | |
56 | .B \-\-autoedit-syntax |
|
56 | .B \-\-autoedit\-syntax | |
57 | Turn on auto editing of files with syntax errors. |
|
57 | Turn on auto editing of files with syntax errors. | |
58 | .TP |
|
58 | .TP | |
59 | .B \-\-pylab |
|
59 | .B \-\-pylab | |
60 | Pre-load matplotlib and numpy for interactive use with |
|
60 | Pre-load matplotlib and numpy for interactive use with | |
61 | the default matplotlib backend. |
|
61 | the default matplotlib backend. | |
62 | .TP |
|
62 | .TP | |
63 | .B \-\-confirm-exit |
|
63 | .B \-\-confirm\-exit | |
64 | Set to confirm when you try to exit IPython with an EOF (Control-D |
|
64 | Set to confirm when you try to exit IPython with an EOF (Control-D | |
65 | in Unix, Control-Z/Enter in Windows). By typing 'exit' or 'quit', |
|
65 | in Unix, Control-Z/Enter in Windows). By typing 'exit' or 'quit', | |
66 | you can force a direct exit without any confirmation. |
|
66 | you can force a direct exit without any confirmation. | |
67 | .TP |
|
67 | .TP | |
68 | .B \-\-deep-reload |
|
68 | .B \-\-deep\-reload | |
69 | Enable deep (recursive) reloading by default. IPython can use the |
|
69 | Enable deep (recursive) reloading by default. IPython can use the | |
70 | deep_reload module which reloads changes in modules recursively (it |
|
70 | deep_reload module which reloads changes in modules recursively (it | |
71 | replaces the reload() function, so you don't need to change anything to |
|
71 | replaces the reload() function, so you don't need to change anything to | |
@@ -76,13 +76,13 b' deep_reload will still be available as dreload(). This feature is off' | |||||
76 | by default [which means that you have both normal reload() and |
|
76 | by default [which means that you have both normal reload() and | |
77 | dreload()]. |
|
77 | dreload()]. | |
78 | .TP |
|
78 | .TP | |
79 | .B \-\-no-autoedit-syntax |
|
79 | .B \-\-no\-autoedit\-syntax | |
80 | Turn off auto editing of files with syntax errors. |
|
80 | Turn off auto editing of files with syntax errors. | |
81 | .TP |
|
81 | .TP | |
82 | .B \-\-term-title |
|
82 | .B \-\-term\-title | |
83 | Enable auto setting the terminal title. |
|
83 | Enable auto setting the terminal title. | |
84 | .TP |
|
84 | .TP | |
85 | .B \-\-no-confirm-exit |
|
85 | .B \-\-no\-confirm\-exit | |
86 | Don't prompt the user when exiting. |
|
86 | Don't prompt the user when exiting. | |
87 | .TP |
|
87 | .TP | |
88 | .B \-\-autoindent |
|
88 | .B \-\-autoindent | |
@@ -91,7 +91,7 b' Turn on autoindenting.' | |||||
91 | .B \-\-classic |
|
91 | .B \-\-classic | |
92 | Gives IPython a similar feel to the classic Python prompt. |
|
92 | Gives IPython a similar feel to the classic Python prompt. | |
93 | .TP |
|
93 | .TP | |
94 | .B \-\-no-automagic |
|
94 | .B \-\-no\-automagic | |
95 | Turn off the auto calling of magic commands. |
|
95 | Turn off the auto calling of magic commands. | |
96 | .TP |
|
96 | .TP | |
97 | .B \-\-banner |
|
97 | .B \-\-banner | |
@@ -101,17 +101,17 b' Display a banner upon starting IPython.' | |||||
101 | Turn on the auto calling of magic commands. Type %%magic at the |
|
101 | Turn on the auto calling of magic commands. Type %%magic at the | |
102 | IPython prompt for more information. |
|
102 | IPython prompt for more information. | |
103 | .TP |
|
103 | .TP | |
104 | .B \-\-no-deep-reload |
|
104 | .B \-\-no\-deep\-reload | |
105 | Disable deep (recursive) reloading by default. |
|
105 | Disable deep (recursive) reloading by default. | |
106 | .TP |
|
106 | .TP | |
107 | .B \-\-no-term-title |
|
107 | .B \-\-no\-term\-title | |
108 | Disable auto setting the terminal title. |
|
108 | Disable auto setting the terminal title. | |
109 | .TP |
|
109 | .TP | |
110 | .B \-\-nosep |
|
110 | .B \-\-nosep | |
111 | Eliminate all spacing between prompts. |
|
111 | Eliminate all spacing between prompts. | |
112 | .TP |
|
112 | .TP | |
113 | .B \-\-i |
|
113 | .B \-\-i | |
114 | also works as '-i' |
|
114 | also works as '\-i' | |
115 | If running code from the command line, become interactive afterwards. |
|
115 | If running code from the command line, become interactive afterwards. | |
116 | .TP |
|
116 | .TP | |
117 | .B \-\-debug |
|
117 | .B \-\-debug | |
@@ -126,7 +126,7 b' set log level to logging.CRITICAL (minimize logging output)' | |||||
126 | .B \-\-pdb |
|
126 | .B \-\-pdb | |
127 | Enable auto calling the pdb debugger after every exception. |
|
127 | Enable auto calling the pdb debugger after every exception. | |
128 | .TP |
|
128 | .TP | |
129 | .B \-\-color-info |
|
129 | .B \-\-color\-info | |
130 | IPython can display information about objects via a set of func- |
|
130 | IPython can display information about objects via a set of func- | |
131 | tions, and optionally can use colors for this, syntax highlighting |
|
131 | tions, and optionally can use colors for this, syntax highlighting | |
132 | source code and various other elements. However, because this |
|
132 | source code and various other elements. However, because this | |
@@ -140,19 +140,19 b' interactively for testing.' | |||||
140 | .B \-\-init |
|
140 | .B \-\-init | |
141 | Initialize profile with default config files |
|
141 | Initialize profile with default config files | |
142 | .TP |
|
142 | .TP | |
143 | .B \-\-no-pdb |
|
143 | .B \-\-no\-pdb | |
144 | Disable auto calling the pdb debugger after every exception. |
|
144 | Disable auto calling the pdb debugger after every exception. | |
145 | .TP |
|
145 | .TP | |
146 | .B \-\-quick |
|
146 | .B \-\-quick | |
147 | Enable quick startup with no config files. |
|
147 | Enable quick startup with no config files. | |
148 | .TP |
|
148 | .TP | |
149 | .B \-\-no-color-info |
|
149 | .B \-\-no\-color\-info | |
150 | Disable using colors for info related things. |
|
150 | Disable using colors for info related things. | |
151 | .TP |
|
151 | .TP | |
152 | .B \-\-no-pprint |
|
152 | .B \-\-no\-pprint | |
153 | Disable auto auto pretty printing of results. |
|
153 | Disable auto auto pretty printing of results. | |
154 | .TP |
|
154 | .TP | |
155 | .B \-\-no-banner |
|
155 | .B \-\-no\-banner | |
156 | Don't display a banner upon starting IPython. |
|
156 | Don't display a banner upon starting IPython. | |
157 | .TP |
|
157 | .TP | |
158 | .B \-\-profile=<Unicode> (BaseIPythonApplication.profile) |
|
158 | .B \-\-profile=<Unicode> (BaseIPythonApplication.profile) | |
@@ -177,7 +177,7 b" it is not applied if there are no more arguments on the line, and '2' for" | |||||
177 | \&'full' autocall, where all callable objects are automatically called (even |
|
177 | \&'full' autocall, where all callable objects are automatically called (even | |
178 | if no arguments are present). The default is '1'. |
|
178 | if no arguments are present). The default is '1'. | |
179 | .TP |
|
179 | .TP | |
180 | .B \-\-ipython-dir=<Unicode> (BaseIPythonApplication.ipython_dir) |
|
180 | .B \-\-ipython\-dir=<Unicode> (BaseIPythonApplication.ipython_dir) | |
181 | Default: u'/Users/minrk/.ipython' |
|
181 | Default: u'/Users/minrk/.ipython' | |
182 | The name of the IPython directory. This directory is used for logging |
|
182 | The name of the IPython directory. This directory is used for logging | |
183 | configuration (through profiles), history storage, etc. The default is |
|
183 | configuration (through profiles), history storage, etc. The default is | |
@@ -199,7 +199,7 b' matplotlib backend and loop integration.' | |||||
199 | Default: '' |
|
199 | Default: '' | |
200 | dotted module name of an IPython extension to load. |
|
200 | dotted module name of an IPython extension to load. | |
201 | .TP |
|
201 | .TP | |
202 | .B \-\-log-level=<Enum> (Application.log_level) |
|
202 | .B \-\-log\-level=<Enum> (Application.log_level) | |
203 | Default: 30 |
|
203 | Default: 30 | |
204 | Choices: (0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL') |
|
204 | Choices: (0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL') | |
205 | Set the log level by value or name. |
|
205 | Set the log level by value or name. | |
@@ -209,7 +209,7 b" Default: 'LightBG'" | |||||
209 | Choices: ('NoColor', 'LightBG', 'Linux') |
|
209 | Choices: ('NoColor', 'LightBG', 'Linux') | |
210 | Set the color scheme (NoColor, Linux, or LightBG). |
|
210 | Set the color scheme (NoColor, Linux, or LightBG). | |
211 | .TP |
|
211 | .TP | |
212 | .B \-\-cache-size=<Int> (InteractiveShell.cache_size) |
|
212 | .B \-\-cache\-size=<Int> (InteractiveShell.cache_size) | |
213 | Default: 1000 |
|
213 | Default: 1000 | |
214 | Set the size of the output cache. The default is 1000, you can change it |
|
214 | Set the size of the output cache. The default is 1000, you can change it | |
215 | permanently in your config file. Setting it to 0 completely disables the |
|
215 | permanently in your config file. Setting it to 0 completely disables the |
@@ -42,9 +42,9 b' irunner.py \\-\\-ipython \\-\\- \\-\\-interact script.ipy' | |||||
42 | .BR ipython(1) |
|
42 | .BR ipython(1) | |
43 | .br |
|
43 | .br | |
44 | .SH AUTHOR |
|
44 | .SH AUTHOR | |
45 | \fBirunner\fP is an extension of Ken Schutte <kschutte-AT-csail.mit.edu>'s |
|
45 | \fBirunner\fP is an extension of Ken Schutte <kschutte\-AT\-csail.mit.edu>'s | |
46 | script contributed on the ipython-user list: |
|
46 | script contributed on the ipython\-user list: | |
47 | http://mail.scipy.org/pipermail/ipython-user/2006-May/003539.html |
|
47 | http://mail.scipy.org/pipermail/ipython\-user/2006\-May/003539.html | |
48 | .PP |
|
48 | .PP | |
49 | This manual page was written by Bernd Zeimetz <bernd@bzed.de>, for the Debian |
|
49 | This manual page was written by Bernd Zeimetz <bernd@bzed.de>, for the Debian | |
50 | project (but may be used by others). Modified by Fernando Perez |
|
50 | project (but may be used by others). Modified by Fernando Perez |
General Comments 0
You need to be logged in to leave comments.
Login now