From c5885646d46e602ec7ae6822d82bd7c6fc7985d3 2011-07-21 19:58:26 From: Julian Taylor Date: 2011-07-21 19:58:26 Subject: [PATCH] manpage update fix a few formatting errors and a typo --- diff --git a/docs/man/ipcluster.1 b/docs/man/ipcluster.1 index 797fef5..ebc1454 100644 --- a/docs/man/ipcluster.1 +++ b/docs/man/ipcluster.1 @@ -35,7 +35,9 @@ 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 diff --git a/docs/man/ipcontroller.1 b/docs/man/ipcontroller.1 index a243017..d093eac 100644 --- a/docs/man/ipcontroller.1 +++ b/docs/man/ipcontroller.1 @@ -133,7 +133,7 @@ whether to cleanup old logfiles before starting 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= (Session.keyfile) Default: '' @@ -142,7 +142,7 @@ path to file containing execution key. .B \-\-transport= (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= (IPControllerApp.ssh_server) Default: u'' @@ -150,7 +150,9 @@ 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 diff --git a/docs/man/ipython.1 b/docs/man/ipython.1 index 6c6b05d..c4c2794 100644 --- a/docs/man/ipython.1 +++ b/docs/man/ipython.1 @@ -46,7 +46,7 @@ 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. @@ -174,7 +174,7 @@ 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= (BaseIPythonApplication.ipython_dir)