upstream/ipython Commit - r4194:f62c1027

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

Thomas Kluyver -

r4194:f62c1027

parent child

docs/source/interactive/qtconsole.txt

0 +10 -10

             ``%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
             .. sourcecode:: ipython
-                In [6]: %loadpy
+                In [6]: %loadpy http://matplotlib.sourceforge.net/plot_directive/mpl_examples/mplot3d/contour3d_demo.py
-                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
             .. _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
+            :func:`pastefig`, you can specify ``--pylab=inline`` when you start the console,
-            will show up in your document, as if you had called :func:`pastefig`.
+            and each time you make a plot, it will show up in your document, as if you had
+            called :func:`pastefig`.
             .. _saving:
             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
             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
             ==================
             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
             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.

docs/source/interactive/reference.txt

0 +15 -15

             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
                 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,
                 ``--[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,
             	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.
             	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).
             	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
                     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
             	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.
             	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
             	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.
                 ``--version``    print version information and exit.
-                ``xmode=<modename>``
+                ``--xmode=<modename>``
             	Mode for exception reporting.

docs/source/whatsnew/version0.11.txt

0 +1 -1

               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

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages