Merge branch 'docs', fixes to docs and a few small things I bumped into.

From now on, will only touch documentation so the RC can be cut as
close as possible to the final 0.11.

IPython/config/application.py

@@ -48,9 +48,9 b' from IPython.utils.text import indent, wrap_paragraphs, dedent'
 option_description = """
 IPython command-line arguments are passed as '--<flag>', or '--<name>=<value>'.
 
-Arguments that take values are actually aliases to full Configurables, whose
-aliases are listed on the help line. For more information on full
-configurables, see '--help-all'.
+Arguments that take values are actually convenience aliases to full
+Configurables, whose aliases are listed on the help line. For more information
+on full configurables, see '--help-all'.
 """.strip() # trim newlines of front and back
 
 keyvalue_description = """
@@ -250,8 +250,8 b' class Application(SingletonConfigurable):'
         for p in wrap_paragraphs(self.subcommand_description):
             lines.append(p)
             lines.append('')
-        for subc, (cls,help) in self.subcommands.iteritems():
-            lines.append("%s : %s"%(subc, cls))
+        for subc, (cls, help) in self.subcommands.iteritems():
+            lines.append(subc)
             if help:
                 lines.append(indent(dedent(help.strip())))
         lines.append('')

IPython/core/usage.py

@@ -13,40 +13,49 b' import sys'
 from IPython.core import release
 
 cl_usage = """\
-ipython [options] [files]
+=========
+ IPython
+=========
 
-IPython: an enhanced interactive Python shell.
+Tools for Interactive Computing in Python
+=========================================
 
     A Python shell with automatic history (input and output), dynamic object
     introspection, easier configuration, command completion, access to the
     system shell and more.  IPython can also be embedded in running programs.
 
+
+Usage
+-----
+
+    ipython [subcommand] [options] [files]
+
     If invoked with no options, it executes all the files listed in sequence
-    and exits, use --i to enter interactive mode after running the files.  Files
+    and exits, use -i to enter interactive mode after running the files.  Files
     ending in .py will be treated as normal Python, but files ending in .ipy
     can contain special IPython syntax (magic commands, shell expansions, etc.)
 
     Almost all configuration in IPython is available via the command-line. Do
     `ipython --help-all` to see all available options.  For persistent
-    configuration, Look into your ipython_config.py configuration file for 
+    configuration, look into your `ipython_config.py` configuration file for 
     details.
 
-    This file is typically installed in the IPYTHON_DIR directory, and there
+    This file is typically installed in the `IPYTHON_DIR` directory, and there
     is a separate configuration directory for each profile. The default profile
-    directory will be located in $IPYTHON_DIR/profile_default. For Linux
-    users, IPYTHON_DIR will be $HOME/.config/ipython, and for other users it will be
-    $HOME/.ipython.  For Windows users, $HOME resolves to C:\\Documents and
-    Settings\\YourUserName in most instances.
+    directory will be located in $IPYTHON_DIR/profile_default. For Linux users,
+    IPYTHON_DIR defaults to `$HOME/.config/ipython`, and for other Unix systems
+    to `$HOME/.ipython`.  For Windows users, $HOME resolves to C:\\Documents
+    and Settings\\YourUserName in most instances.
     
-    To initialize a profile with the default configuration file, do:
+    To initialize a profile with the default configuration file, do::
     
       $> ipython profile create
     
-    and start editing IPYTHON_DIR/profile_default/ipython_config.py
+    and start editing `IPYTHON_DIR/profile_default/ipython_config.py`
 
-    In IPython's documentation, we will refer to this directory as IPYTHON_DIR,
-    you can change its default location by setting any path you want in this
-    environment variable.
+    In IPython's documentation, we will refer to this directory as
+    `IPYTHON_DIR`, you can change its default location by creating an
+    environment variable with this name and setting it to the desired path.
 
     For more information, see the manual available in HTML and PDF in your
     installation, or online at http://ipython.org/documentation.html.

IPython/frontend/terminal/embed.py

@@ -1,4 +1,3 b''
-#!/usr/bin/env python
 # encoding: utf-8
 """
 An embedded IPython shell.

IPython/frontend/terminal/ipapp.py

@@ -158,8 +158,8 b" flags['quick']=("
 
 flags['i'] = (
     {'TerminalIPythonApp' : {'force_interact' : True}},
-    """also works as '-i'
-    If running code from the command line, become interactive afterwards."""
+    """If running code from the command line, become interactive afterwards.
+    Note: can also be given simply as '-i.'"""
 )
 flags['pylab'] = (
     {'TerminalIPythonApp' : {'pylab' : 'auto'}},
@@ -180,7 +180,6 b' aliases.update(dict('
 # Main classes and functions
 #-----------------------------------------------------------------------------
 
-
 class TerminalIPythonApp(BaseIPythonApplication, InteractiveShellApp):
     name = u'ipython'
     description = usage.cl_usage
@@ -190,7 +189,8 b' class TerminalIPythonApp(BaseIPythonApplication, InteractiveShellApp):'
 
     flags = Dict(flags)
     aliases = Dict(aliases)
-    classes = [InteractiveShellApp, TerminalInteractiveShell, ProfileDir, PlainTextFormatter]
+    classes = [InteractiveShellApp, TerminalInteractiveShell, ProfileDir,
+               PlainTextFormatter]
     subcommands = Dict(dict(
         qtconsole=('IPython.frontend.qt.console.qtconsoleapp.IPythonQtConsoleApp',
             """Launch the IPython Qt Console."""
@@ -247,17 +247,14 b' class TerminalIPythonApp(BaseIPythonApplication, InteractiveShellApp):'
 
     def parse_command_line(self, argv=None):
         """override to allow old '-pylab' flag with deprecation warning"""
+
         argv = sys.argv[1:] if argv is None else argv
-        
-        try:
-            idx = argv.index('-pylab')
-        except ValueError:
-            # `-pylab` not given, proceed as normal
-            pass
-        else:
+
+        if '-pylab' in argv:
             # deprecated `-pylab` given,
             # warn and transform into current syntax
-            argv = list(argv) # copy, don't clobber
+            argv = argv[:] # copy, don't clobber
+            idx = argv.index('-pylab')
             warn.warn("`-pylab` flag has been deprecated.\n"
             "    Use `--pylab` instead, or `--pylab=foo` to specify a backend.")
             sub = '--pylab'
@@ -375,4 +372,3 b' def launch_new_instance():'
 
 if __name__ == '__main__':
     launch_new_instance()
-

IPython/lib/irunner.py

@@ -403,10 +403,6 b' interact with IPython at the end of the script (instead of exiting).'
 
 The already implemented runners are listed below; adding one for a new program
 is a trivial task, see the source for examples.
-
-WARNING: the SAGE runner only works if you manually configure your SAGE copy
-to use 'colors NoColor' in the ipythonrc config file, since currently the
-prompt matching regexp does not identify color sequences.
 """
 
 def main():

IPython/lib/pylabtools.py

@@ -101,7 +101,8 b" def print_figure(fig, fmt='png'):"
     try:
         string_io = StringIO()
         # use 72 dpi to match QTConsole's dpi
-        fig.canvas.print_figure(string_io, format=fmt, dpi=72)
+        fig.canvas.print_figure(string_io, format=fmt, dpi=72,
+                                bbox_inches='tight')
         data = string_io.getvalue()
     finally:
         fig.set_facecolor(fc)

IPython/scripts/ipython

@@ -1,9 +1,6 b''
 #!/usr/bin/env python
 """Terminal-based IPython entry point.
-
-Note: this is identical to IPython/frontend/terminal/scripts/ipython for now.
-Once 0.11 is closer to release, we will likely need to reorganize the script
-entry points."""
+"""
 
 from IPython.frontend.terminal.ipapp import launch_new_instance
 

docs/man/ipcluster.1

@@ -1,4 +1,4 b''
-.TH IPCLUSTER 1 "October 28, 2008" "" ""
+.TH IPCLUSTER 1 "July 15, 2011" "" ""
 .SH NAME
 \fBipcluster \- IPython parallel computing cluster control tool
 .SH SYNOPSIS
@@ -12,28 +12,26 b" ipcluster is a control tool for IPython's parallel computing functions."
 
 IPython cluster startup. This starts a controller and engines using various
 approaches. Use the IPYTHON_DIR environment variable to change your IPython
-directory from the default of .ipython or _ipython. The log and security
+directory from the default of ~/.ipython or ~/.config/ipython. The log and security
 subdirectories of your IPython directory will be used by this script for log
 files and security files.
 .SH POSITIONAL ARGUMENTS
 
-The first positional argument should be one of: {mpiexec, local, mpirun, pbs,
-ssh}, which are the available cluster types.
+The first positional argument should be one of: {start, stop, engines},
+which are the available subcommands.
 
-For detailed help on each, type "ipcluster TYPE --help". Briefly:
+For detailed help on each, type "ipcluster CMD --help". Briefly:
 
-  local         run a local cluster
-  mpirun        run a cluster using mpirun (mpiexec also works)
-  mpiexec       run a cluster using mpiexec (mpirun also works)
-  pbs           run a pbs cluster
-  ssh           run a cluster using ssh, should have ssh-keys setup
+  start         start an IPython cluster
+  stop          stop a running IPython cluster
+  engines       add a number of engines to a running cluster
 .SH OPTIONS
 .TP
 .B
 \-h, \-\-help
 show help message and exit
 .SH EXAMPLE
-ipcluster local -n 4
+ipcluster start --n=4
 
 This command will start 4 IPython engines on the local computer.
 .SH SEE ALSO

docs/man/ipcontroller.1

@@ -16,65 +16,139 b" ipcontroller is a control tool for IPython's parallel computing functions."
 show this help message and exit
 .TP
 .B
-\-\-client\-ip=CLIENT_IP
-the IP address or hostname the controller will listen on for
-client connections
 .TP
-.B
-\-\-client\-port=CLIENT_PORT
-the port the controller will listen on for client connections
-.TP
-.B
-\-\-client\-location=CLIENT_LOCATION
-hostname or ip for clients to connect to
+.B \-\-no-secure
+Don't authenticate messages.
 .TP
-.B
-\-x
-turn off all client security
+.B \-\-usethreads
+Use threads instead of processes for the schedulers
 .TP
-.B
-\-\-client\-cert\-file=CLIENT_CERT_FILE
-file to store the client SSL certificate
+.B \-\-init
+Initialize profile with default config files
 .TP
-.B
-\-\-task\-furl\-file=TASK_FURL_FILE
-file to store the FURL for task clients to connect with
+.B \-\-log-to-file
+send log output to a file
 .TP
-.B
-\-\-multiengine\-furl\-file=MULTIENGINE_FURL_FILE
-file to store the FURL for multiengine clients to connect with
+.B \-\-reuse
+reuse existing json connection files
 .TP
-.B
-\-\-engine\-ip=ENGINE_IP
-the IP address or hostname the controller will listen on for engine connections
+.B \-\-mongodb
+use the MongoDB backend
 .TP
-.B
-\-\-engine\-port=ENGINE_PORT
-the port the controller will listen on for engine connections
+.B \-\-quiet
+set log level to logging.CRITICAL (minimize logging output)
 .TP
-.B
-\-\-engine\-location=ENGINE_LOCATION
-the IP address or hostname for engine to connect to
+.B \-\-debug
+set log level to logging.DEBUG (maximize logging output)
 .TP
-.B
-\-y
-turn off all engine security
+.B \-\-sqlitedb
+use the SQLiteDB backend
 .TP
-.B
-\-\-engine\-cert\-file=ENGINE_CERT_FILE
-file to store the engine SSL certificate
+.B \-\-dictdb
+use the in-memory DictDB backend
 .TP
-.B
-\-\-engine\-furl\-file=ENGINE_FURL_FILE
-file to store the FURL for engines to connect with
+.B \-\-secure
+Use HMAC digests for authentication of messages.
 .TP
-.B
-\-l LOGFILE, \-\-logfile=LOGFILE
-log file name (default is stdout)
+.B \-\-profile=<Unicode> (BaseIPythonApplication.profile)
+Default: u'default'
+The IPython profile to use.
 .TP
-.B
-\-r
-try to reuse all furl files
+.B \-\-hwm=<Int> (TaskScheduler.hwm)
+Default: 0
+.br
+specify the High Water Mark (HWM) for the downstream socket in the Task
+scheduler. This is the maximum number of allowed outstanding tasks on each
+engine.
+.TP
+.B \-\-secure=<Bool> (IPControllerApp.secure)
+Default: True
+Whether to use HMAC digests for extra message authentication.
+.TP
+.B \-\-ip=<Unicode> (HubFactory.ip)
+Default: '127.0.0.1'
+The IP address for registration.  This is generally either '127.0.0.1' for
+loopback only or '*' for all interfaces. [default: '127.0.0.1']
+.TP
+.B \-\-log-url=<Unicode> (BaseParallelApplication.log_url)
+Default: ''
+The ZMQ URL of the iplogger to aggregate logging.
+.TP
+.B \-\-work-dir=<Unicode> (BaseParallelApplication.work_dir)
+Default: u'/Users/minrk/dev/ip/mine/docs/man'
+Set the working dir for the process.
+.TP
+.B \-\-port=<Int> (HubFactory.regport)
+Default: 0
+The port on which the Hub listens for registration.
+.TP
+.B \-\-profile-dir=<Unicode> (ProfileDir.location)
+Default: u''
+Set the profile location directly. This overrides the logic used by the
+`profile` option.
+.TP
+.B \-\-ident=<CBytes> (Session.session)
+Default: ''
+The UUID identifying this session.
+.TP
+.B \-\-log-to-file=<Bool> (BaseParallelApplication.log_to_file)
+Default: False
+whether to log to a file
+.TP
+.B \-\-ipython-dir=<Unicode> (BaseIPythonApplication.ipython_dir)
+Default: u'/Users/minrk/.ipython'
+The name of the IPython directory. This directory is used for logging
+configuration (through profiles), history storage, etc. The default is
+usually $HOME/.ipython. This options can also be specified through the
+environment variable IPYTHON_DIR.
+.TP
+.B \-\-url=<Unicode> (HubFactory.url)
+Default: ''
+The 0MQ url used for registration. This sets transport, ip, and port in one
+variable. For example: url='tcp://127.0.0.1:12345' or url='epgm://*:90210'
+.TP
+.B \-\-user=<Unicode> (Session.username)
+Default: 'minrk'
+Username for the Session. Default is your system username.
+.TP
+.B \-\-ping=<CFloat> (HeartMonitor.period)
+Default: 1000
+The frequency at which the Hub pings the engines for heartbeats  (in ms)
+.TP
+.B \-\-log-level=<Enum> (Application.log_level)
+Default: 30
+Choices: (0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL')
+Set the log level by value or name.
+.TP
+.B \-\-location=<Unicode> (IPControllerApp.location)
+Default: u''
+The external IP or domain name of the Controller, used for disambiguating
+engine and client connections.
+.TP
+.B \-\-clean-logs=<Bool> (BaseParallelApplication.clean_logs)
+Default: False
+whether to cleanup old logfiles before starting
+.TP
+.B \-\-scheme=<Enum> (TaskScheduler.scheme_name)
+Default: 'leastload'
+Choices: ('leastload', 'pure', 'lru', 'plainrandom', 'weighted', 'twobin')
+select the task scheduler scheme  [default: Python LRU] Options are: 'pure',
+'lru', 'plainrandom', 'weighted', 'twobin','leastload'
+.TP
+.B \-\-keyfile=<Unicode> (Session.keyfile)
+Default: ''
+path to file containing execution key.
+.TP
+.B \-\-transport=<Unicode> (HubFactory.transport)
+Default: 'tcp'
+The 0MQ transport for communications.  This will likely be the default of
+'tcp', but other values include 'ipc', 'epgm', 'inproc'.
+.TP
+.B \-\-ssh=<Unicode> (IPControllerApp.ssh_server)
+Default: u''
+ssh url for clients to use when connecting to the Controller processes. It
+should be of the form: [user@]server[:port]. The Controller's listening
+addresses must be accessible from the ssh server
 .SH SEE ALSO
 .BR ipython(1), ipcluster(1), ipengine(1)
 .br
@@ -84,4 +158,5 b' the IPython Development Team.'
 .PP
 This manual page was written by Stephan Peijnik <[e-mail]>,
 for the Debian project (but may be used by others).  Modified by Fernando Perez
-<[e-mail]> for inclusion in IPython.
+<[e-mail]> for inclusion in IPython, and updated by
+Min Ragan-Kelley <[e-mail]> for 0.11.

docs/man/ipengine.1

@@ -1,4 +1,4 b''
-.TH IPENGINE 1 "October 28, 2008" "" ""
+.TH IPENGINE 1 "July 15, 2011" "" ""
 .SH NAME
 \fBipengine \- IPython parallel computing engine control tool
 .SH SYNOPSIS
@@ -16,8 +16,12 b" ipengine is a control tool for IPython's parallel computing functions."
 show this help message and exit
 .TP
 .B
-\-\-furl\-file=FURL_FILE
-The filename containing the FURL of the controller
+\-\-profile=name
+The name of the IPython configuration profile to use.
+.TP
+.B
+\-\-file=URL_FILE
+The JSON file containing the connection information of the controller.
 .TP
 .B
 \-\-mpi=MPI

docs/man/ipython.1

@@ -2,7 +2,7 b''
 .\" First parameter, NAME, should be all caps
 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
 .\" other parameters are allowed: see man(7), man(1)
-.TH IPYTHON 1 "November 30, 2004"
+.TH IPYTHON 1 "July 15, 2011"
 .\" Please adjust this date whenever revising the manpage.
 .\"
 .\" Some roff macros, for reference:
@@ -22,304 +22,205 b''
 .\" To preview this page as plain text: nroff -man ipython.1
 .\"
 .SH NAME
-ipython \- An Enhanced Interactive Python
+ipython \- Tools for Interactive Computing in Python.
 .SH SYNOPSIS
 .B ipython
 .RI [ options ] " files" ...
 .SH DESCRIPTION
-An interactive Python shell with automatic history (input and output),
-dynamic object introspection, easier configuration, command
-completion, access to the system shell, integration with numerical and
-scientific computing tools, and more.
+An interactive Python shell with automatic history (input and output), dynamic
+object introspection, easier configuration, command completion, access to the
+system shell, integration with numerical and scientific computing tools, and
+more.
 .
 .SH REGULAR OPTIONS
-After the above threading options have been given, regular options can follow
-in any order.  All options can be abbreviated to their shortest non-ambiguous
-form and are case-sensitive.  One or two dashes can be used.  Some options
-have an alternate short form, indicated after a |.
+All options that take values, must be of the form '\-\-name=value', but
+flags that take no arguments are allowed a single '\-' to allow common
+patterns like: 'ipython -i myscript.py'.  To pass arguments to scripts,
+rather than to IPython, specify them after '--'.
 .br
 .sp 1
-Most options can also be set from your ipythonrc configuration file.
+All options can also be set from your ipython_config.py configuration file.
 See the provided examples for assistance.  Options given on the
-commandline override the values set in the ipythonrc file.
+commandline override the values set in ipython_config.py.  To generate
+the default config file, do `ipython profile create`.
 .br
 .sp 1
 All options with a [no] prepended can be specified in negated form
-(\-nooption instead of \-option) to turn the feature off.
+(\\--no\-option instead of \-\-option) to turn the feature off.
 .TP
 .B \-h, \-\-help
 Show summary of options.
-.TP
-.B \-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, '1' for 'smart' autocall, where it is not applied if
-there are no more arguments on the line, and '2' for 'full'
-autocall, where all callable objects are automatically called
-(even if no arguments are present).  The default is '1'.
-.TP
-.B \-[no]autoindent
-Turn automatic indentation on/off.
-.TP
-.B \-[no]automagic
-Make magic commands automatic (without needing their first character
-to be %).  Type %magic at the IPython prompt for more information.
-.TP
-.B \-[no]autoedit_syntax
-When a syntax error occurs after editing a file, automatically open the file
-to the trouble causing line for convenient fixing.
-.TP
-.B \-[no]banner
-Print the intial information banner (default on).
-.TP
-.B \-c <command>
-Execute the given command string, and set sys.argv to ['c'].  This is similar
-to the \-c option in the normal Python interpreter.
-.TP
-.B \-cache_size|cs <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,
-and the minimum value accepted is 20 (if you provide a value less than
-20, it is reset to 0 and a warning is issued).  This limit is defined
-because otherwise you'll spend more time re-flushing a too small cache
-than working.
-.TP
-.B \-classic|cl
-Gives IPython a similar feel to the classic Python prompt.
-.TP
-.B \-colors <scheme>
-Color scheme for prompts and exception reporting.  Currently
-implemented: NoColor, Linux, and LightBG.
-.TP
-.B \-[no]color_info
-IPython can display information about objects via a set of functions,
-and optionally can use colors for this, syntax highlighting source
-code and various other elements.  However, because this information is
-passed through a pager (like 'less') and many pagers get confused with
-color codes, this option is off by default.  You can test it and turn
-it on permanently in your ipythonrc file if it works for you.  As a
-reference, the 'less' pager supplied with Mandrake 8.2 works ok, but
-that in RedHat 7.2 doesn't.
-.br
-.sp 1
-Test it and turn it on permanently if it works with your system.  The
-magic function @color_info allows you to toggle this interactively for
-testing.
-.TP
-.B \-[no]confirm_exit
-Set to confirm when you try to exit IPython with an EOF (Control-D in
-Unix, Control-Z/Enter in Windows). Note that using the magic functions
-@Exit or @Quit you can force a direct exit, bypassing any
-confirmation.
-.TP
-.B \-[no]debug
-Show information about the loading process. Very useful to pin down
-problems with your configuration files or to get details about session
-restores.
-.TP
-.B \-[no]deep_reload
-IPython can use the deep_reload module which reloads changes in
-modules recursively (it replaces the reload() function, so you don't
-need to change anything to use it). deep_reload() forces a full reload
-of modules whose code may have changed, which the default reload()
-function does not.
-.br
-.sp 1
-When deep_reload is off, IPython will use the normal reload(), but
+.B \-\-no-autoindent
+Turn off autoindenting.
+.TP
+.B \-\-autoedit-syntax
+Turn on auto editing of files with syntax errors.
+.TP
+.B \-\-pylab
+Pre-load matplotlib and numpy for interactive use with
+the default matplotlib backend.
+.TP
+.B \-\-confirm-exit
+Set to confirm when you try to exit IPython with an EOF (Control-D
+in Unix, Control-Z/Enter in Windows). By typing 'exit' or 'quit',
+you can force a direct exit without any confirmation.
+.TP
+.B \-\-deep-reload
+Enable deep (recursive) reloading by default. IPython can use the
+deep_reload module which reloads changes in modules recursively (it
+replaces the reload() function, so you don't need to change anything to
+use it). deep_reload() forces a full reload of modules whose code may
+have changed, which the default reload() function does not.  When
+deep_reload is off, IPython will use the normal reload(), but
 deep_reload will still be available as dreload(). This feature is off
 by default [which means that you have both normal reload() and
 dreload()].
 .TP
-.B \-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). Since this editor is invoked on
-the fly by IPython and is meant for editing small code snippets, you
-may want to use a small, lightweight editor here (in case your default
-EDITOR is something like Emacs).
-.TP
-.B \-ipythondir <name>
-The name of your IPython configuration directory IPYTHON_DIR.  This can
-also be specified through the environment variable IPYTHON_DIR.
-.TP
-.B \-log|l
-Generate a log file of all input. The file is named ipython_log.py in your
-current directory (which prevents logs from multiple IPython sessions from
-trampling each other). You can use this to later restore a session by loading
-your logfile as a file to be executed with option -logplay (see below).
-.TP
-.B \-logfile|lf
-Specify the name of your logfile.
-.TP
-.B \-logplay|lp
-Replay a previous log. For restoring a session as close as possible to
-the state you left it in, use this option (don't just run the
-logfile). With \-logplay, IPython will try to reconstruct the previous
-working environment in full, not just execute the commands in the
-logfile.
-.br
-.sp 1
-When a session is restored, logging is automatically turned on again
-with the name of the logfile it was invoked with (it is read from the
-log header). So once you've turned logging on for a session, you can
-quit IPython and reload it as many times as you want and it will
-continue to log its history and restore from the beginning every time.
-.br
-.sp 1
-Caveats: there are limitations in this option. The history variables
-_i*,_* and _dh don't get restored properly. In the future we will try
-to implement full session saving by writing and retrieving a
-snapshot of the memory state of IPython. But our first attempts
-failed because of inherent limitations of Python's Pickle module, so
-this may have to wait.
-.TP
-.B \-[no]messages
-Print messages which IPython collects about its startup process
-(default on).
-.TP
-.B \-[no]pdb
-Automatically call the pdb debugger after every uncaught exception. If
-you are used to debugging using pdb, this puts you automatically
-inside of it after any call (either in IPython or in code called by
-it) which triggers an exception which goes uncaught.
-.TP
-.B \-pydb
-Makes IPython use the third party "pydb" package as debugger,
-instead of pdb. Requires that pydb is installed.
-.TP
-.B \-[no]pprint
-IPython can optionally use the pprint (pretty printer) module for
-displaying results. pprint tends to give a nicer display of nested
-data structures. If you like it, you can turn it on permanently in
-your config file (default off).
-.TP
-.B \-profile|p <name>
-Assume that your config file is ipythonrc-<name> (looks in current dir
-first, then in IPYTHON_DIR). This is a quick way to keep and load
-multiple config files for different tasks, especially if you use the
-include option of config files. You can keep a basic
-IPYTHON_DIR/ipythonrc file and then have other 'profiles' which include
-this one and load extra things for particular tasks. For example:
-.br
-.sp 1
-1) $HOME/.ipython/ipythonrc : load basic things you always want.
-.br
-2) $HOME/.ipython/ipythonrc-math : load (1) and basic math-related
-modules.
-.br
-3) $HOME/.ipython/ipythonrc-numeric : load (1) and Numeric and
-plotting modules.
-.br
-.sp 1
-Since it is possible to create an endless loop by having circular file
-inclusions, IPython will stop if it reaches 15 recursive inclusions.
-.TP
-.B \-prompt_in1|pi1 <string>
-Specify the string used for input prompts. Note that if you are using
-numbered prompts, the number is represented with a '\\#' in the
-string. Don't forget to quote strings with spaces embedded in
-them. Default: 'In [\\#]: '.
-.br
-.sp 1
-Most bash-like escapes can be used to customize IPython's prompts, as well as
-a few additional ones which are IPython-specific.  All valid prompt escapes
-are described in detail in the Customization section of the IPython HTML/PDF
-manual.
-.TP
-.B \-prompt_in2|pi2 <string>
-Similar to the previous option, but used for the continuation prompts. The
-special sequence '\\D' is similar to '\\#', but with all digits replaced dots
-(so you can have your continuation prompt aligned with your input
-prompt). Default: '   .\\D.: ' (note three spaces at the start for alignment
-with 'In [\\#]').
-.TP
-.B \-prompt_out|po <string>
-String used for output prompts, also uses numbers like prompt_in1.
-Default: 'Out[\\#]:'.
-.TP
-.B \-quick
-Start in bare bones mode (no config file loaded).
-.TP
-.B \-rcfile <name>
-Name of your IPython resource configuration file.  normally IPython
-loads ipythonrc (from current directory) or IPYTHON_DIR/ipythonrc.  If
-the loading of your config file fails, IPython starts with a bare
-bones configuration (no modules loaded at all).
-.TP
-.B \-[no]readline
-Use the readline library, which is needed to support name completion
-and command history, among other things. It is enabled by default, but
-may cause problems for users of X/Emacs in Python comint or shell
-buffers.
-.br
-.sp 1
-Note that emacs 'eterm' buffers (opened with M-x term) support
-IPython's readline and syntax coloring fine, only 'emacs' (M-x shell
-and C-c !)  buffers do not.
-.TP
-.B \-screen_length|sl <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 printed.
-.br
-.sp 1
-The default value for this is 0, which means IPython will auto-detect
-your screen size every time it needs to print certain potentially long
-strings (this doesn't change the behavior of the 'print' keyword, it's
-only triggered internally). If for some reason this isn't working well
-(it needs curses support), specify it yourself. Otherwise don't change
-the default.
-.TP
-.B \-separate_in|si <string>
-Separator before input prompts.  Default '\n'.
-.TP
-.B \-separate_out|so <string>
-Separator before output prompts.  Default: 0 (nothing).
-.TP
-.B \-separate_out2|so2 <string>
-Separator after output prompts.  Default: 0 (nothing).
-.TP
-.B \-nosep
-Shorthand for '\-separate_in 0 \-separate_out 0 \-separate_out2 0'.
-Simply removes all input/output separators.
-.TP
-.B \-upgrade
-Allows you to upgrade your IPYTHON_DIR configuration when you install a
-new version of IPython.  Since new versions may include new command
-lines options or example files, this copies updated ipythonrc-type
-files.  However, it backs up (with a .old extension) all files which
-it overwrites so that you can merge back any custimizations you might
-have in your personal files.
-.TP
-.B \-Version
-Print version information and exit.
-.TP
-.B -wxversion <string>
-Select a specific version of wxPython (used in conjunction with
-\-wthread). Requires the wxversion module, part of recent wxPython
-distributions.
-.TP
-.B \-xmode <modename>
-Mode for exception reporting.  The valid modes are Plain, Context, and
-Verbose.
-.br
-.sp 1
-\- Plain: similar to python's normal traceback printing.
-.br
-.sp 1
-\- Context: prints 5 lines of context source code around each line in the
-traceback.
-.br
-.sp 1
-\- Verbose: similar to Context, but additionally prints the variables
-currently visible where the exception happened (shortening their strings if
-too long).  This can potentially be very slow, if you happen to have a huge
-data structure whose string representation is complex to compute.  Your
-computer may appear to freeze for a while with cpu usage at 100%.  If this
-occurs, you can cancel the traceback with Ctrl-C (maybe hitting it more than
-once).
+.B \-\-no-autoedit-syntax
+Turn off auto editing of files with syntax errors.
+.TP
+.B \-\-term-title
+Enable auto setting the terminal title.
+.TP
+.B \-\-no-confirm-exit
+Don't prompt the user when exiting.
+.TP
+.B \-\-autoindent
+Turn on autoindenting.
+.TP
+.B \-\-classic
+Gives IPython a similar feel to the classic Python prompt.
+.TP
+.B \-\-no-automagic
+Turn off the auto calling of magic commands.
+.TP
+.B \-\-banner
+Display a banner upon starting IPython.
+.TP
+.B \-\-automagic
+Turn on the auto calling of magic commands. Type %%magic at the
+IPython  prompt  for  more information.
+.TP
+.B \-\-no-deep-reload
+Disable deep (recursive) reloading by default.
+.TP
+.B \-\-no-term-title
+Disable auto setting the terminal title.
+.TP
+.B \-\-nosep
+Eliminate all spacing between prompts.
+.TP
+.B \-\-i
+also works as '-i'
+If running code from the command line, become interactive afterwards.
+.TP
+.B \-\-debug
+set log level to logging.DEBUG (maximize logging output)
+.TP
+.B \-\-pprint
+Enable auto pretty printing of results.
+.TP
+.B \-\-quiet
+set log level to logging.CRITICAL (minimize logging output)
+.TP
+.B \-\-pdb
+Enable auto calling the pdb debugger after every exception.
+.TP
+.B \-\-color-info
+IPython can display information about objects via a set of func-
+tions, and optionally can use colors for this, syntax highlighting
+source code and various other elements.  However, because this
+information is passed through a pager (like 'less') and many pagers get
+confused with color codes, this option is off by default.  You can test
+it and turn it on permanently in your ipython_config.py file if it
+works for you.  Test it and turn it on permanently if it works with
+your system.  The magic function %%color_info allows you to toggle this
+interactively for testing.
+.TP
+.B \-\-init
+Initialize profile with default config files
+.TP
+.B \-\-no-pdb
+Disable auto calling the pdb debugger after every exception.
+.TP
+.B \-\-quick
+Enable quick startup with no config files.
+.TP
+.B \-\-no-color-info
+Disable using colors for info related things.
+.TP
+.B \-\-no-pprint
+Disable auto auto pretty printing of results.
+.TP
+.B \-\-no-banner
+Don't display a banner upon starting IPython.
+.TP
+.B \-\-profile=<Unicode> (BaseIPythonApplication.profile)
+Default: u'default'
+The IPython profile to use.
+.TP
+.B \-\-c=<Unicode> (InteractiveShellApp.code_to_run)
+Default: ''
+Execute the given command string.
+.TP
+.B \-\-logappend=<Unicode> (InteractiveShell.logappend)
+Default: ''
+Start logging to the given file in append mode.
+.TP
+.B \-\-autocall=<Enum> (InteractiveShell.autocall)
+Default: 1
+Choices: (0, 1, 2)
+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, '1' for 'smart' autocall, where
+it is not applied if there are no more arguments on the line, and '2' for
+'full' autocall, where all callable objects are automatically called (even
+if no arguments are present). The default is '1'.
+.TP
+.B \-\-ipython-dir=<Unicode> (BaseIPythonApplication.ipython_dir)
+Default: u'/Users/minrk/.ipython'
+The name of the IPython directory. This directory is used for logging
+configuration (through profiles), history storage, etc. The default is
+usually $HOME/.ipython. This options can also be specified through the
+environment variable IPYTHON_DIR.
+.TP
+.B \-\-gui=<CaselessStrEnum> (TerminalIPythonApp.gui)
+Default: None
+Choices: ('qt', 'wx', 'gtk')
+Enable GUI event loop integration ('qt', 'wx', 'gtk').
+.TP
+.B \-\-pylab=<CaselessStrEnum> (TerminalIPythonApp.pylab)
+Default: None
+Choices: ['tk', 'qt', 'wx', 'gtk', 'osx', 'auto']
+Pre-load matplotlib and numpy for interactive use, selecting a particular
+matplotlib backend and loop integration.
+.TP
+.B \-\-ext=<Unicode> (InteractiveShellApp.extra_extension)
+Default: ''
+dotted module name of an IPython extension to load.
+.TP
+.B \-\-log-level=<Enum> (Application.log_level)
+Default: 30
+Choices: (0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL')
+Set the log level by value or name.
+.TP
+.B \-\-colors=<CaselessStrEnum> (InteractiveShell.colors)
+Default: 'LightBG'
+Choices: ('NoColor', 'LightBG', 'Linux')
+Set the color scheme (NoColor, Linux, or LightBG).
+.TP
+.B \-\-cache-size=<Int> (InteractiveShell.cache_size)
+Default: 1000
+Set the size of the output cache.  The default is 1000, you can change it
+permanently in your config file.  Setting it to 0 completely disables the
+caching system, and the minimum value accepted is 20 (if you provide a value
+less than 20, it is reset to 0 and a warning is issued).  This limit is
+defined because otherwise you'll spend more time re-flushing a too small
+cache than working
+.TP
+.B \-\-logfile=<Unicode> (InteractiveShell.logfile)
+Default: ''
+The name of the logfile to use.
 .
 .SH EMBEDDING
 It is possible to start an IPython instance inside your own Python
@@ -336,4 +237,5 b" values because you won't break your code in bizarre ways by doing so."
 IPython was written by Fernando Perez <[e-mail]>, based on earlier
 code by Janko Hauser <[e-mail]> and Nathaniel Gray
 <[e-mail]>.  This manual page was written by Jack Moffitt
-<[e-mail]>, for the Debian project (but may be used by others).
+<[e-mail]>, for the Debian project (but may be used by others), and updated by
+Min Ragan-Kelley <[e-mail]> for 0.11.

docs/man/irunner.1

@@ -1,4 +1,4 b''
-.TH IRUNNER 1 "April 24, 2007" "" ""
+.TH IRUNNER 1 "July 15, 2011" "" ""
 .SH NAME
 \fBirunner \- interactive runner interface
 .SH SYNOPSIS

docs/man/pycolor.1

@@ -2,7 +2,7 b''
 .\" First parameter, NAME, should be all caps
 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
 .\" other parameters are allowed: see man(7), man(1)
-.TH PYCOLOR 1 "May 12, 2007"
+.TH PYCOLOR 1 "July 15, 2011"
 .\" Please adjust this date whenever revising the manpage.
 .\"
 .\" Some roff macros, for reference:
@@ -30,9 +30,10 b' given, or the file name - is given) to standard out.'
 Output a brief help message.
 .TP
 .B \-s, \-\-scheme <scheme>
-Give the color scheme to use.  Currently only Linux (default),
-LightBG, and NOColor are implemented.
+Give the color scheme to use.  Currently only Linux (default), LightBG, and
+NoColor are implemented.
 .SH AUTHOR
-pycolor was written by Fernando Perez <[e-mail]>.
+pycolor is part of the IPython project (http://ipython.org).
 This manual page was written by Jack Moffitt <[e-mail]>,
-for the Debian project (but may be used by others).
+for the Debian project (but may be used by others).  Updated by Fernando Perez
+<[e-mail]>.