manpage update

fix a few formatting errors and a typo

docs/man/ipcluster.1

@@ -1,46 +1,48
 .TH IPCLUSTER 1 "July 15, 2011" "" ""
 .SH NAME
 \fBipcluster \- IPython parallel computing cluster control tool
 .SH SYNOPSIS
 .nf
 .fam C
 \fBipcluster\fP {\fmpiexec,local,mpirun,pbs,ssh\fP} [\fIoptions\fP]
 .fam T
 .fi
 .SH DESCRIPTION
 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 ~/.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: {start, stop, engines},
 which are the available subcommands.
 
 For detailed help on each, type "ipcluster CMD --help". Briefly:
 
   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 start --n=4
 
 This command will start 4 IPython engines on the local computer.
 .SH SEE ALSO
-.BR ipython(1), ipcontroller(1), ipengine(1)
+.BR ipython(1),
+.BR ipcontroller(1),
+.BR ipengine(1)
 .br
 .SH AUTHOR
 \fBipcluster\fP is a tool that ships with IPython, created by
 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.

docs/man/ipcontroller.1

@@ -1,162 +1,164
 .TH IPCONTROLLER 1 "October 29, 2008" "" ""
 .SH NAME
 \fBipcontroller \- IPython parallel computing controller control tool
 .SH SYNOPSIS
 .nf
 .fam C
 \fBipengine\fP [\fIoptions\fP]
 .fam T
 .fi
 .SH DESCRIPTION
 ipcontroller is a control tool for IPython's parallel computing functions.
 .SH OPTIONS
 .TP
 .B
 \-h, \-\-help
 show this help message and exit
 .TP
 .B
 .TP
 .B \-\-no-secure
 Don't authenticate messages.
 .TP
 .B \-\-usethreads
 Use threads instead of processes for the schedulers
 .TP
 .B \-\-init
 Initialize profile with default config files
 .TP
 .B \-\-log-to-file
 send log output to a file
 .TP
 .B \-\-reuse
 reuse existing json connection files
 .TP
 .B \-\-mongodb
 use the MongoDB backend
 .TP
 .B \-\-quiet
 set log level to logging.CRITICAL (minimize logging output)
 .TP
 .B \-\-debug
 set log level to logging.DEBUG (maximize logging output)
 .TP
 .B \-\-sqlitedb
 use the SQLiteDB backend
 .TP
 .B \-\-dictdb
 use the in-memory DictDB backend
 .TP
 .B \-\-secure
 Use HMAC digests for authentication of messages.
 .TP
 .B \-\-profile=<Unicode> (BaseIPythonApplication.profile)
 Default: u'default'
 The IPython profile to use.
 .TP
 .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'
+\&'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'.
+\&'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 ipython(1),
+.BR ipcluster(1),
+.BR ipengine(1)
 .br
 .SH AUTHOR
 \fBipcontroller\fP is a tool that ships with IPython, created by
 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, and updated by
 Min Ragan-Kelley <[e-mail]> for 0.11.

docs/man/ipython.1

@@ -1,241 +1,241
 .\"                                      Hey, EMACS: -*- nroff -*-
 .\" 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 "July 15, 2011"
 .\" Please adjust this date whenever revising the manpage.
 .\"
 .\" Some roff macros, for reference:
 .\" .nh        disable hyphenation
 .\" .hy        enable hyphenation
 .\" .ad l      left justify
 .\" .ad b      justify to both left and right margins
 .\" .nf        disable filling
 .\" .fi        enable filling
 .\" .br        insert line break
 .\" .sp <n>    insert n+1 empty lines
 .\" for manpage-specific macros, see man(7) and groff_man(7)
 .\" .SH        section heading
 .\" .SS        secondary section heading
 .\"
 .\"
 .\" To preview this page as plain text: nroff -man ipython.1
 .\"
 .SH NAME
 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.
 .
 .SH REGULAR OPTIONS
 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
 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 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
-(\\--no\-option 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.
 .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 \-\-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
+\&'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
 programs.  In the documentation example files there are some
 illustrations on how to do this.
 .br
 .sp 1
 This feature allows you to evalutate dynamically the state of your
 code, operate with your variables, analyze them, etc.  Note however
 that any changes you make to values while in the shell do NOT
 propagate back to the running code, so it is safe to modify your
 values because you won't break your code in bizarre ways by doing so.
 .SH AUTHOR
 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), and updated by
 Min Ragan-Kelley <[e-mail]> for 0.11.