##// END OF EJS Templates
update usage.py for 0.11...
MinRK -
Show More
@@ -22,18 +22,27 b' IPython: an enhanced interactive Python shell.'
22 22 system shell and more. IPython can also be embedded in running programs.
23 23
24 24 If invoked with no options, it executes all the files listed in sequence
25 and exits, use -i to enter interactive mode after running the files. Files
25 and exits, use --i to enter interactive mode after running the files. Files
26 26 ending in .py will be treated as normal Python, but files ending in .ipy
27 27 can contain special IPython syntax (magic commands, shell expansions, etc.)
28 28
29 Please note that some of the configuration options are not available at the
30 command line, simply because they are not practical here. Look into your
31 ipython_config.py configuration file for details on those.
29 Almost all configuration in IPython is available via the command-line. Do
30 `ipython --help-all` to see all available options. For persistent
31 configuration, Look into your ipython_config.py configuration file for
32 details.
32 33
33 This file is typically installed in the IPYTHON_DIR directory. For Linux
34 users, this will be $HOME/.config/ipython, and for other users it will be
34 This file is typically installed in the IPYTHON_DIR directory, and there
35 is a separate configuration directory for each profile. The default profile
36 directory will be located in $IPYTHON_DIR/profile_default. For Linux
37 users, IPYTHON_DIR will be $HOME/.config/ipython, and for other users it will be
35 38 $HOME/.ipython. For Windows users, $HOME resolves to C:\\Documents and
36 39 Settings\\YourUserName in most instances.
40
41 To initialize a profile with the default configuration file, do:
42
43 $> ipython profile create
44
45 and start editing IPYTHON_DIR/profile_default/ipython_config.py
37 46
38 47 In IPython's documentation, we will refer to this directory as IPYTHON_DIR,
39 48 you can change its default location by setting any path you want in this
@@ -53,13 +62,9 b' caching, similar to Mathematica). It is intended to be a fully compatible'
53 62 replacement for the standard Python interpreter, while offering vastly
54 63 improved functionality and flexibility.
55 64
56 At your system command line, type 'ipython -help' to see the command line
65 At your system command line, type 'ipython -h' to see the command line
57 66 options available. This document only describes interactive features.
58 67
59 Warning: IPython relies on the existence of a global variable called __IP which
60 controls the shell itself. If you redefine __IP to anything, bizarre behavior
61 will quickly occur.
62
63 68 MAIN FEATURES
64 69
65 70 * Access to the standard Python help. As of Python 2.1, a help system is
@@ -111,7 +116,9 b' MAIN FEATURES'
111 116 your history for lines that match what you've typed so far, completing as
112 117 much as it can.
113 118
114 * Persistent command history across sessions (readline required).
119 - %hist: search history by index (this does *not* require readline).
120
121 * Persistent command history across sessions.
115 122
116 123 * Logging of input with the ability to save and restore a working session.
117 124
@@ -294,7 +301,7 b' inline graphics and much more.'
294 301
295 302 This quick reference document contains the basic information you'll need to
296 303 know to make the most efficient use of it. For the various command line
297 options available at startup, type ``--help`` at the command line.
304 options available at startup, type ``ipython qtconsole --help`` at the command line.
298 305
299 306
300 307 Multiline editing
@@ -473,10 +480,10 b' Inline matplotlib graphics'
473 480 ==========================
474 481
475 482 The IPython console is capable of displaying matplotlib figures inline, in SVG
476 format. If started with the ``pylab=inline``, then all figures are
477 rendered inline automatically. If started with ``--pylab`` or ``pylab=<your
478 backend>``, then a GUI backend will be used, but IPython's ``display()`` and
479 ``getfigs()`` functions can be used to view plots inline::
483 or PNG format. If started with the ``pylab=inline``, then all figures are
484 rendered inline automatically (PNG by default). If started with ``--pylab``
485 or ``pylab=<your backend>``, then a GUI backend will be used, but IPython's
486 ``display()`` and ``getfigs()`` functions can be used to view plots inline::
480 487
481 488 In [9]: display(*getfigs()) # display all figures inline
482 489
General Comments 0
You need to be logged in to leave comments. Login now