Show More
@@ -6,7 +6,7 b'' | |||||
6 | # the file COPYING, distributed as part of this software. |
|
6 | # the file COPYING, distributed as part of this software. | |
7 | #***************************************************************************** |
|
7 | #***************************************************************************** | |
8 |
|
8 | |||
9 |
# $Id: usage.py 11 |
|
9 | # $Id: usage.py 1301 2006-05-15 17:21:55Z vivainio $ | |
10 |
|
10 | |||
11 | from IPython import Release |
|
11 | from IPython import Release | |
12 | __author__ = '%s <%s>' % Release.authors['Fernando'] |
|
12 | __author__ = '%s <%s>' % Release.authors['Fernando'] | |
@@ -143,7 +143,7 b' REGULAR OPTIONS' | |||||
143 | will have no effect in any other position). It adds special sup- |
|
143 | will have no effect in any other position). It adds special sup- | |
144 | port for the matplotlib library (http://matplotlib.source- |
|
144 | port for the matplotlib library (http://matplotlib.source- | |
145 | forge.net), allowing interactive usage of any of its backends as |
|
145 | forge.net), allowing interactive usage of any of its backends as | |
146 |
defined in the user |
|
146 | defined in the user's .matplotlibrc file. It automatically | |
147 | activates GTK or WX threading for IPyhton if the choice of mat- |
|
147 | activates GTK or WX threading for IPyhton if the choice of mat- | |
148 | plotlib backend requires it. It also modifies the @run command |
|
148 | plotlib backend requires it. It also modifies the @run command | |
149 | to correctly execute (without blocking) any matplotlib-based |
|
149 | to correctly execute (without blocking) any matplotlib-based | |
@@ -174,7 +174,7 b' REGULAR OPTIONS' | |||||
174 | Print the intial information banner (default on). |
|
174 | Print the intial information banner (default on). | |
175 |
|
175 | |||
176 | -c <command> |
|
176 | -c <command> | |
177 |
Execute the given command string, and set sys.argv to [ |
|
177 | Execute the given command string, and set sys.argv to ['c']. | |
178 | This is similar to the -c option in the normal Python inter- |
|
178 | This is similar to the -c option in the normal Python inter- | |
179 | preter. |
|
179 | preter. | |
180 |
|
180 | |||
@@ -184,7 +184,7 b' REGULAR OPTIONS' | |||||
184 | your config file. Setting it to 0 completely disables the |
|
184 | your config file. Setting it to 0 completely disables the | |
185 | caching system, and the minimum value accepted is 20 (if you |
|
185 | caching system, and the minimum value accepted is 20 (if you | |
186 | provide a value less than 20, it is reset to 0 and a warning is |
|
186 | provide a value less than 20, it is reset to 0 and a warning is | |
187 |
issued). This limit is defined because otherwise you |
|
187 | issued). This limit is defined because otherwise you'll spend | |
188 | more time re-flushing a too small cache than working. |
|
188 | more time re-flushing a too small cache than working. | |
189 |
|
189 | |||
190 | -classic|cl |
|
190 | -classic|cl | |
@@ -198,12 +198,12 b' REGULAR OPTIONS' | |||||
198 | IPython can display information about objects via a set of func- |
|
198 | IPython can display information about objects via a set of func- | |
199 | tions, and optionally can use colors for this, syntax highlight- |
|
199 | tions, and optionally can use colors for this, syntax highlight- | |
200 | ing source code and various other elements. However, because |
|
200 | ing source code and various other elements. However, because | |
201 |
this information is passed through a pager (like |
|
201 | this information is passed through a pager (like 'less') and | |
202 | many pagers get confused with color codes, this option is off by |
|
202 | many pagers get confused with color codes, this option is off by | |
203 | default. You can test it and turn it on permanently in your |
|
203 | default. You can test it and turn it on permanently in your | |
204 |
ipythonrc file if it works for you. As a reference, the |
|
204 | ipythonrc file if it works for you. As a reference, the 'less' | |
205 | pager supplied with Mandrake 8.2 works ok, but that in RedHat |
|
205 | pager supplied with Mandrake 8.2 works ok, but that in RedHat | |
206 |
7.2 doesn |
|
206 | 7.2 doesn't. | |
207 |
|
207 | |||
208 | Test it and turn it on permanently if it works with your system. |
|
208 | Test it and turn it on permanently if it works with your system. | |
209 | The magic function @color_info allows you to toggle this inter- |
|
209 | The magic function @color_info allows you to toggle this inter- | |
@@ -223,7 +223,7 b' REGULAR OPTIONS' | |||||
223 | -[no]deep_reload |
|
223 | -[no]deep_reload | |
224 | IPython can use the deep_reload module which reloads changes in |
|
224 | IPython can use the deep_reload module which reloads changes in | |
225 | modules recursively (it replaces the reload() function, so you |
|
225 | modules recursively (it replaces the reload() function, so you | |
226 |
don |
|
226 | don't need to change anything to use it). deep_reload() forces a | |
227 | full reload of modules whose code may have changed, which the |
|
227 | full reload of modules whose code may have changed, which the | |
228 | default reload() function does not. |
|
228 | default reload() function does not. | |
229 |
|
229 | |||
@@ -256,21 +256,21 b' REGULAR OPTIONS' | |||||
256 |
|
256 | |||
257 | -logplay|lp |
|
257 | -logplay|lp | |
258 | Replay a previous log. For restoring a session as close as pos- |
|
258 | Replay a previous log. For restoring a session as close as pos- | |
259 |
sible to the state you left it in, use this option (don |
|
259 | sible to the state you left it in, use this option (don't just | |
260 | run the logfile). With -logplay, IPython will try to reconstruct |
|
260 | run the logfile). With -logplay, IPython will try to reconstruct | |
261 | the previous working environment in full, not just execute the |
|
261 | the previous working environment in full, not just execute the | |
262 | commands in the logfile. |
|
262 | commands in the logfile. | |
263 | When a session is restored, logging is automatically turned on |
|
263 | When a session is restored, logging is automatically turned on | |
264 | again with the name of the logfile it was invoked with (it is |
|
264 | again with the name of the logfile it was invoked with (it is | |
265 |
read from the log header). So once you |
|
265 | read from the log header). So once you've turned logging on for | |
266 | a session, you can quit IPython and reload it as many times as |
|
266 | a session, you can quit IPython and reload it as many times as | |
267 | you want and it will continue to log its history and restore |
|
267 | you want and it will continue to log its history and restore | |
268 | from the beginning every time. |
|
268 | from the beginning every time. | |
269 |
|
269 | |||
270 | Caveats: there are limitations in this option. The history vari- |
|
270 | Caveats: there are limitations in this option. The history vari- | |
271 |
ables _i*,_* and _dh don |
|
271 | ables _i*,_* and _dh don't get restored properly. In the future | |
272 | we will try to implement full session saving by writing and |
|
272 | we will try to implement full session saving by writing and | |
273 |
retrieving a failed because of inherent limitations of Python |
|
273 | retrieving a failed because of inherent limitations of Python's | |
274 | Pickle module, so this may have to wait. |
|
274 | Pickle module, so this may have to wait. | |
275 |
|
275 | |||
276 | -[no]messages |
|
276 | -[no]messages | |
@@ -295,7 +295,7 b' REGULAR OPTIONS' | |||||
295 | rent dir first, then in IPYTHONDIR). This is a quick way to keep |
|
295 | rent dir first, then in IPYTHONDIR). This is a quick way to keep | |
296 | and load multiple config files for different tasks, especially |
|
296 | and load multiple config files for different tasks, especially | |
297 | if you use the include option of config files. You can keep a |
|
297 | if you use the include option of config files. You can keep a | |
298 |
basic IPYTHONDIR/ipythonrc file and then have other |
|
298 | basic IPYTHONDIR/ipythonrc file and then have other 'profiles' | |
299 | which include this one and load extra things for particular |
|
299 | which include this one and load extra things for particular | |
300 | tasks. For example: |
|
300 | tasks. For example: | |
301 |
|
301 | |||
@@ -311,25 +311,25 b' REGULAR OPTIONS' | |||||
311 |
|
311 | |||
312 | -prompt_in1|pi1 <string> |
|
312 | -prompt_in1|pi1 <string> | |
313 | Specify the string used for input prompts. Note that if you are |
|
313 | Specify the string used for input prompts. Note that if you are | |
314 |
using numbered prompts, the number is represented with a |
|
314 | using numbered prompts, the number is represented with a '\#' in | |
315 |
the string. Don |
|
315 | the string. Don't forget to quote strings with spaces embedded | |
316 |
in them. Default: |
|
316 | in them. Default: 'In [\#]:'. | |
317 |
|
317 | |||
318 |
Most bash-like escapes can be used to customize IPython |
|
318 | Most bash-like escapes can be used to customize IPython's | |
319 | prompts, as well as a few additional ones which are IPython-spe- |
|
319 | prompts, as well as a few additional ones which are IPython-spe- | |
320 | cific. All valid prompt escapes are described in detail in the |
|
320 | cific. All valid prompt escapes are described in detail in the | |
321 | Customization section of the IPython HTML/PDF manual. |
|
321 | Customization section of the IPython HTML/PDF manual. | |
322 |
|
322 | |||
323 | -prompt_in2|pi2 <string> |
|
323 | -prompt_in2|pi2 <string> | |
324 | Similar to the previous option, but used for the continuation |
|
324 | Similar to the previous option, but used for the continuation | |
325 |
prompts. The special sequence |
|
325 | prompts. The special sequence '\D' is similar to '\#', but with | |
326 | all digits replaced dots (so you can have your continuation |
|
326 | all digits replaced dots (so you can have your continuation | |
327 |
prompt aligned with your input prompt). Default: |
|
327 | prompt aligned with your input prompt). Default: ' .\D.:' | |
328 |
(note three spaces at the start for alignment with |
|
328 | (note three spaces at the start for alignment with 'In [\#]'). | |
329 |
|
329 | |||
330 | -prompt_out|po <string> |
|
330 | -prompt_out|po <string> | |
331 | String used for output prompts, also uses numbers like |
|
331 | String used for output prompts, also uses numbers like | |
332 |
prompt_in1. Default: |
|
332 | prompt_in1. Default: 'Out[\#]:'. | |
333 |
|
333 | |||
334 | -quick Start in bare bones mode (no config file loaded). |
|
334 | -quick Start in bare bones mode (no config file loaded). | |
335 |
|
335 | |||
@@ -346,8 +346,8 b' REGULAR OPTIONS' | |||||
346 | by default, but may cause problems for users of X/Emacs in |
|
346 | by default, but may cause problems for users of X/Emacs in | |
347 | Python comint or shell buffers. |
|
347 | Python comint or shell buffers. | |
348 |
|
348 | |||
349 |
Note that emacs |
|
349 | Note that emacs 'eterm' buffers (opened with M-x term) support | |
350 |
IPython |
|
350 | IPython's readline and syntax coloring fine, only 'emacs' (M-x | |
351 | shell and C-c !) buffers do not. |
|
351 | shell and C-c !) buffers do not. | |
352 |
|
352 | |||
353 | -screen_length|sl <n> |
|
353 | -screen_length|sl <n> | |
@@ -357,13 +357,13 b' REGULAR OPTIONS' | |||||
357 |
|
357 | |||
358 | The default value for this is 0, which means IPython will auto- |
|
358 | The default value for this is 0, which means IPython will auto- | |
359 | detect your screen size every time it needs to print certain |
|
359 | detect your screen size every time it needs to print certain | |
360 |
potentially long strings (this doesn |
|
360 | potentially long strings (this doesn't change the behavior of | |
361 |
the |
|
361 | the 'print' keyword, it's only triggered internally). If for | |
362 |
some reason this isn |
|
362 | some reason this isn't working well (it needs curses support), | |
363 |
specify it yourself. Otherwise don |
|
363 | specify it yourself. Otherwise don't change the default. | |
364 |
|
364 | |||
365 | -separate_in|si <string> |
|
365 | -separate_in|si <string> | |
366 |
Separator before input prompts. Default |
|
366 | Separator before input prompts. Default '0. | |
367 |
|
367 | |||
368 | -separate_out|so <string> |
|
368 | -separate_out|so <string> | |
369 | Separator before output prompts. Default: 0 (nothing). |
|
369 | Separator before output prompts. Default: 0 (nothing). | |
@@ -371,7 +371,7 b' REGULAR OPTIONS' | |||||
371 | -separate_out2|so2 <string> |
|
371 | -separate_out2|so2 <string> | |
372 | Separator after output prompts. Default: 0 (nothing). |
|
372 | Separator after output prompts. Default: 0 (nothing). | |
373 |
|
373 | |||
374 |
-nosep Shorthand for |
|
374 | -nosep Shorthand for '-separate_in 0 -separate_out 0 -separate_out2 0'. | |
375 | Simply removes all input/output separators. |
|
375 | Simply removes all input/output separators. | |
376 |
|
376 | |||
377 | -upgrade |
|
377 | -upgrade | |
@@ -394,7 +394,7 b' REGULAR OPTIONS' | |||||
394 | Mode for exception reporting. The valid modes are Plain, Con- |
|
394 | Mode for exception reporting. The valid modes are Plain, Con- | |
395 | text, and Verbose. |
|
395 | text, and Verbose. | |
396 |
|
396 | |||
397 |
- Plain: similar to python |
|
397 | - Plain: similar to python's normal traceback printing. | |
398 |
|
398 | |||
399 | - Context: prints 5 lines of context source code around each |
|
399 | - Context: prints 5 lines of context source code around each | |
400 | line in the traceback. |
|
400 | line in the traceback. | |
@@ -418,7 +418,7 b' EMBEDDING' | |||||
418 | code, operate with your variables, analyze them, etc. Note however |
|
418 | code, operate with your variables, analyze them, etc. Note however | |
419 | that any changes you make to values while in the shell do NOT propagate |
|
419 | that any changes you make to values while in the shell do NOT propagate | |
420 | back to the running code, so it is safe to modify your values because |
|
420 | back to the running code, so it is safe to modify your values because | |
421 |
you won |
|
421 | you won't break your code in bizarre ways by doing so. | |
422 | """ |
|
422 | """ | |
423 |
|
423 | |||
424 | cmd_line_usage = __doc__ |
|
424 | cmd_line_usage = __doc__ |
General Comments 0
You need to be logged in to leave comments.
Login now