Permalink
Browse files

Update format of command line args in interactive section of docs.

  • Loading branch information...
takluyver committed Jul 8, 2011
1 parent 0e80619 commit f62c102798d7280f6bd633efe8f0a58fa4a92961
Showing with 26 additions and 26 deletions.
  1. +10 −10 docs/source/interactive/qtconsole.txt
  2. +15 −15 docs/source/interactive/reference.txt
  3. +1 −1 docs/source/whatsnew/version0.11.txt
@@ -20,16 +20,15 @@ configurable.
``%loadpy``
===========
-The ``%loadpy`` magic has been added, just for the GUI frontend. It takes any python
+The new ``%loadpy`` magic takes any python
script (must end in '.py'), and pastes its contents as your next input, so you can edit it
before executing. The script may be on your machine, but you can also specify a url, and
it will download the script from the web. This is particularly useful for playing with
examples from documentation, such as matplotlib.
.. sourcecode:: ipython
- In [6]: %loadpy
- http://matplotlib.sourceforge.net/plot_directive/mpl_examples/mplot3d/contour3d_demo.py
+ In [6]: %loadpy http://matplotlib.sourceforge.net/plot_directive/mpl_examples/mplot3d/contour3d_demo.py
In [7]: from mpl_toolkits.mplot3d import axes3d
...: import matplotlib.pyplot as plt
@@ -64,12 +63,13 @@ them in your document. This is especially useful for saving_ your work.
.. _inline:
-``pylab=inline``
+``--pylab=inline``
******************
If you want to have all of your figures embedded in your session, instead of calling
-:func:`pastefig`, you can specify ``pylab=inline``, and each time you make a plot, it
-will show up in your document, as if you had called :func:`pastefig`.
+:func:`pastefig`, you can specify ``--pylab=inline`` when you start the console,
+and each time you make a plot, it will show up in your document, as if you had
+called :func:`pastefig`.
.. _saving:
@@ -116,7 +116,7 @@ if unspecified, will be guessed based on the chosen style. Similarly, there are
styles associated with each ``colors`` option.
-Screenshot of ``ipython qtconsole colors=linux``, which uses the 'monokai' theme by
+Screenshot of ``ipython qtconsole --colors=linux``, which uses the 'monokai' theme by
default:
.. image:: figs/colors_dark.png
@@ -147,7 +147,7 @@ Fonts
The QtConsole has configurable via the ConsoleWidget. To change these, set the ``font_family``
or ``font_size`` traits of the ConsoleWidget. For instance, to use 9pt Anonymous Pro::
- $> ipython qtconsole ConsoleWidget.font_family="Anonymous Pro" ConsoleWidget.font_size=9
+ $> ipython qtconsole --ConsoleWidget.font_family="Anonymous Pro" --ConsoleWidget.font_size=9
Process Management
==================
@@ -167,7 +167,7 @@ do not have to all be qt frontends - any IPython frontend can connect and run co
When you start ipython qtconsole, there will be an output line, like::
To connect another client to this kernel, use:
- --external shell=62109 iopub=62110 stdin=62111 hb=62112
+ --external --shell=62109 --iopub=62110 --stdin=62111 --hb=62112
Other frontends can connect to your kernel, and share in the execution. This is great for
collaboration. The `-e` flag is for 'external'. Starting other consoles with that flag
@@ -178,7 +178,7 @@ By default (for security reasons), the kernel only listens on localhost, so you
connect multiple frontends to the kernel from your local machine. You can specify to
listen on an external interface by specifying the ``ip`` argument::
- $> ipython qtconsole ip=192.168.1.123
+ $> ipython qtconsole --ip=192.168.1.123
If you specify the ip as 0.0.0.0, that refers to all interfaces, so any computer that can
see yours can connect to the kernel.
@@ -35,7 +35,7 @@ version 0.11, these have been removed. Please see the new ``%gui``
magic command or :ref:`this section <gui_support>` for details on the new
interface, or specify the gui at the commandline::
- $ ipython gui=qt
+ $ ipython --gui=qt
Regular Options
@@ -59,7 +59,7 @@ All options with a [no] prepended can be specified in negated form
See :ref:`Matplotlib support <matplotlib_support>`
for more details.
- ``autocall=<val>``
+ ``--autocall=<val>``
Make IPython automatically call any callable object even if you
didn't type explicit parentheses. For example, 'str 43' becomes
'str(43)' automatically. The value can be '0' to disable the feature,
@@ -83,11 +83,11 @@ All options with a [no] prepended can be specified in negated form
``--[no-]banner``
Print the initial information banner (default on).
- ``c=<command>``
+ ``--c=<command>``
execute the given command string. This is similar to the -c
option in the normal Python interpreter.
- ``cache_size=<n>``
+ ``--cache_size=<n>``
size of the output cache (maximum number of entries to hold in
memory). The default is 1000, you can change it permanently in your
config file. Setting it to 0 completely disables the caching system,
@@ -100,7 +100,7 @@ All options with a [no] prepended can be specified in negated form
Gives IPython a similar feel to the classic Python
prompt.
- ``colors=<scheme>``
+ ``--colors=<scheme>``
Color scheme for prompts and exception reporting. Currently
implemented: NoColor, Linux and LightBG.
@@ -135,7 +135,7 @@ All options with a [no] prepended can be specified in negated form
feature is off by default [which means that you have both
normal reload() and dreload()].
- ``editor=<name>``
+ ``--editor=<name>``
Which editor to use with the %edit command. By default,
IPython will honor your EDITOR environment variable (if not
set, vi is the Unix default and notepad the Windows one).
@@ -144,12 +144,12 @@ All options with a [no] prepended can be specified in negated form
small, lightweight editor here (in case your default EDITOR is
something like Emacs).
- ``ipython_dir=<name>``
+ ``--ipython_dir=<name>``
name of your IPython configuration directory IPYTHON_DIR. This
can also be specified through the environment variable
IPYTHON_DIR.
- ``logfile=<name>``
+ ``--logfile=<name>``
specify the name of your logfile.
This implies ``%logstart`` at the beginning of your session
@@ -160,7 +160,7 @@ All options with a [no] prepended can be specified in negated form
can use this to later restore a session by loading your
logfile with ``ipython --i ipython_log.py``
- ``logplay=<name>``
+ ``--logplay=<name>``
NOT AVAILABLE in 0.11
@@ -201,7 +201,7 @@ All options with a [no] prepended can be specified in negated form
of nested data structures. If you like it, you can turn it on
permanently in your config file (default off).
- ``profile=<name>``
+ ``--profile=<name>``
Select the IPython profile by name.
@@ -263,7 +263,7 @@ All options with a [no] prepended can be specified in negated form
IPython's readline and syntax coloring fine, only 'emacs' (M-x
shell and C-c !) buffers do not.
- ``TerminalInteractiveShell.screen_length=<n>``
+ ``--TerminalInteractiveShell.screen_length=<n>``
number of lines of your screen. This is used to control
printing of very long strings. Strings longer than this number
of lines will be sent through a pager instead of directly
@@ -276,16 +276,16 @@ All options with a [no] prepended can be specified in negated form
reason this isn't working well (it needs curses support), specify
it yourself. Otherwise don't change the default.
- ``TerminalInteractiveShell.separate_in=<string>``
+ ``--TerminalInteractiveShell.separate_in=<string>``
separator before input prompts.
Default: '\n'
- ``TerminalInteractiveShell.separate_out=<string>``
+ ``--TerminalInteractiveShell.separate_out=<string>``
separator before output prompts.
Default: nothing.
- ``TerminalInteractiveShell.separate_out2=<string>``
+ ``--TerminalInteractiveShell.separate_out2=<string>``
separator after output prompts.
Default: nothing.
For these three options, use the value 0 to specify no separator.
@@ -304,7 +304,7 @@ All options with a [no] prepended can be specified in negated form
``--version`` print version information and exit.
- ``xmode=<modename>``
+ ``--xmode=<modename>``
Mode for exception reporting.
@@ -300,7 +300,7 @@ Backwards incompatible changes
from the command-line with the same syntax as in a configuration file.
* The command line options ``-wthread``, ``-qthread`` and
- ``-gthread`` have been removed. Use ``gui=wx``, ``gui=qt``, ``gui=gtk``
+ ``-gthread`` have been removed. Use ``--gui=wx``, ``--gui=qt``, ``--gui=gtk``
instead.
* The extension loading functions have been renamed to

0 comments on commit f62c102

Please sign in to comment.