##// END OF EJS Templates
Update format of command line args in interactive section of docs.
Thomas Kluyver -
Show More
@@ -20,7 +20,7 b' configurable.'
20 20 ``%loadpy``
21 21 ===========
22 22
23 The ``%loadpy`` magic has been added, just for the GUI frontend. It takes any python
23 The new ``%loadpy`` magic takes any python
24 24 script (must end in '.py'), and pastes its contents as your next input, so you can edit it
25 25 before executing. The script may be on your machine, but you can also specify a url, and
26 26 it will download the script from the web. This is particularly useful for playing with
@@ -28,8 +28,7 b' examples from documentation, such as matplotlib.'
28 28
29 29 .. sourcecode:: ipython
30 30
31 In [6]: %loadpy
32 http://matplotlib.sourceforge.net/plot_directive/mpl_examples/mplot3d/contour3d_demo.py
31 In [6]: %loadpy http://matplotlib.sourceforge.net/plot_directive/mpl_examples/mplot3d/contour3d_demo.py
33 32
34 33 In [7]: from mpl_toolkits.mplot3d import axes3d
35 34 ...: import matplotlib.pyplot as plt
@@ -64,12 +63,13 b' them in your document. This is especially useful for saving_ your work.'
64 63
65 64 .. _inline:
66 65
67 ``pylab=inline``
66 ``--pylab=inline``
68 67 ******************
69 68
70 69 If you want to have all of your figures embedded in your session, instead of calling
71 :func:`pastefig`, you can specify ``pylab=inline``, and each time you make a plot, it
72 will show up in your document, as if you had called :func:`pastefig`.
70 :func:`pastefig`, you can specify ``--pylab=inline`` when you start the console,
71 and each time you make a plot, it will show up in your document, as if you had
72 called :func:`pastefig`.
73 73
74 74
75 75 .. _saving:
@@ -116,7 +116,7 b' if unspecified, will be guessed based on the chosen style. Similarly, there are '
116 116 styles associated with each ``colors`` option.
117 117
118 118
119 Screenshot of ``ipython qtconsole colors=linux``, which uses the 'monokai' theme by
119 Screenshot of ``ipython qtconsole --colors=linux``, which uses the 'monokai' theme by
120 120 default:
121 121
122 122 .. image:: figs/colors_dark.png
@@ -147,7 +147,7 b' Fonts'
147 147 The QtConsole has configurable via the ConsoleWidget. To change these, set the ``font_family``
148 148 or ``font_size`` traits of the ConsoleWidget. For instance, to use 9pt Anonymous Pro::
149 149
150 $> ipython qtconsole ConsoleWidget.font_family="Anonymous Pro" ConsoleWidget.font_size=9
150 $> ipython qtconsole --ConsoleWidget.font_family="Anonymous Pro" --ConsoleWidget.font_size=9
151 151
152 152 Process Management
153 153 ==================
@@ -167,7 +167,7 b' do not have to all be qt frontends - any IPython frontend can connect and run co'
167 167 When you start ipython qtconsole, there will be an output line, like::
168 168
169 169 To connect another client to this kernel, use:
170 --external shell=62109 iopub=62110 stdin=62111 hb=62112
170 --external --shell=62109 --iopub=62110 --stdin=62111 --hb=62112
171 171
172 172 Other frontends can connect to your kernel, and share in the execution. This is great for
173 173 collaboration. The `-e` flag is for 'external'. Starting other consoles with that flag
@@ -178,7 +178,7 b' By default (for security reasons), the kernel only listens on localhost, so you '
178 178 connect multiple frontends to the kernel from your local machine. You can specify to
179 179 listen on an external interface by specifying the ``ip`` argument::
180 180
181 $> ipython qtconsole ip=192.168.1.123
181 $> ipython qtconsole --ip=192.168.1.123
182 182
183 183 If you specify the ip as 0.0.0.0, that refers to all interfaces, so any computer that can
184 184 see yours can connect to the kernel.
@@ -35,7 +35,7 b' version 0.11, these have been removed. Please see the new ``%gui``'
35 35 magic command or :ref:`this section <gui_support>` for details on the new
36 36 interface, or specify the gui at the commandline::
37 37
38 $ ipython gui=qt
38 $ ipython --gui=qt
39 39
40 40
41 41 Regular Options
@@ -59,7 +59,7 b' All options with a [no] prepended can be specified in negated form'
59 59 See :ref:`Matplotlib support <matplotlib_support>`
60 60 for more details.
61 61
62 ``autocall=<val>``
62 ``--autocall=<val>``
63 63 Make IPython automatically call any callable object even if you
64 64 didn't type explicit parentheses. For example, 'str 43' becomes
65 65 'str(43)' automatically. The value can be '0' to disable the feature,
@@ -83,11 +83,11 b' All options with a [no] prepended can be specified in negated form'
83 83 ``--[no-]banner``
84 84 Print the initial information banner (default on).
85 85
86 ``c=<command>``
86 ``--c=<command>``
87 87 execute the given command string. This is similar to the -c
88 88 option in the normal Python interpreter.
89 89
90 ``cache_size=<n>``
90 ``--cache_size=<n>``
91 91 size of the output cache (maximum number of entries to hold in
92 92 memory). The default is 1000, you can change it permanently in your
93 93 config file. Setting it to 0 completely disables the caching system,
@@ -100,7 +100,7 b' All options with a [no] prepended can be specified in negated form'
100 100 Gives IPython a similar feel to the classic Python
101 101 prompt.
102 102
103 ``colors=<scheme>``
103 ``--colors=<scheme>``
104 104 Color scheme for prompts and exception reporting. Currently
105 105 implemented: NoColor, Linux and LightBG.
106 106
@@ -135,7 +135,7 b' All options with a [no] prepended can be specified in negated form'
135 135 feature is off by default [which means that you have both
136 136 normal reload() and dreload()].
137 137
138 ``editor=<name>``
138 ``--editor=<name>``
139 139 Which editor to use with the %edit command. By default,
140 140 IPython will honor your EDITOR environment variable (if not
141 141 set, vi is the Unix default and notepad the Windows one).
@@ -144,12 +144,12 b' All options with a [no] prepended can be specified in negated form'
144 144 small, lightweight editor here (in case your default EDITOR is
145 145 something like Emacs).
146 146
147 ``ipython_dir=<name>``
147 ``--ipython_dir=<name>``
148 148 name of your IPython configuration directory IPYTHON_DIR. This
149 149 can also be specified through the environment variable
150 150 IPYTHON_DIR.
151 151
152 ``logfile=<name>``
152 ``--logfile=<name>``
153 153 specify the name of your logfile.
154 154
155 155 This implies ``%logstart`` at the beginning of your session
@@ -160,7 +160,7 b' All options with a [no] prepended can be specified in negated form'
160 160 can use this to later restore a session by loading your
161 161 logfile with ``ipython --i ipython_log.py``
162 162
163 ``logplay=<name>``
163 ``--logplay=<name>``
164 164
165 165 NOT AVAILABLE in 0.11
166 166
@@ -201,7 +201,7 b' All options with a [no] prepended can be specified in negated form'
201 201 of nested data structures. If you like it, you can turn it on
202 202 permanently in your config file (default off).
203 203
204 ``profile=<name>``
204 ``--profile=<name>``
205 205
206 206 Select the IPython profile by name.
207 207
@@ -263,7 +263,7 b' All options with a [no] prepended can be specified in negated form'
263 263 IPython's readline and syntax coloring fine, only 'emacs' (M-x
264 264 shell and C-c !) buffers do not.
265 265
266 ``TerminalInteractiveShell.screen_length=<n>``
266 ``--TerminalInteractiveShell.screen_length=<n>``
267 267 number of lines of your screen. This is used to control
268 268 printing of very long strings. Strings longer than this number
269 269 of lines will be sent through a pager instead of directly
@@ -276,16 +276,16 b' All options with a [no] prepended can be specified in negated form'
276 276 reason this isn't working well (it needs curses support), specify
277 277 it yourself. Otherwise don't change the default.
278 278
279 ``TerminalInteractiveShell.separate_in=<string>``
279 ``--TerminalInteractiveShell.separate_in=<string>``
280 280
281 281 separator before input prompts.
282 282 Default: '\n'
283 283
284 ``TerminalInteractiveShell.separate_out=<string>``
284 ``--TerminalInteractiveShell.separate_out=<string>``
285 285 separator before output prompts.
286 286 Default: nothing.
287 287
288 ``TerminalInteractiveShell.separate_out2=<string>``
288 ``--TerminalInteractiveShell.separate_out2=<string>``
289 289 separator after output prompts.
290 290 Default: nothing.
291 291 For these three options, use the value 0 to specify no separator.
@@ -304,7 +304,7 b' All options with a [no] prepended can be specified in negated form'
304 304
305 305 ``--version`` print version information and exit.
306 306
307 ``xmode=<modename>``
307 ``--xmode=<modename>``
308 308
309 309 Mode for exception reporting.
310 310
@@ -300,7 +300,7 b' Backwards incompatible changes'
300 300 from the command-line with the same syntax as in a configuration file.
301 301
302 302 * The command line options ``-wthread``, ``-qthread`` and
303 ``-gthread`` have been removed. Use ``gui=wx``, ``gui=qt``, ``gui=gtk``
303 ``-gthread`` have been removed. Use ``--gui=wx``, ``--gui=qt``, ``--gui=gtk``
304 304 instead.
305 305
306 306 * The extension loading functions have been renamed to
General Comments 0
You need to be logged in to leave comments. Login now