##// END OF EJS Templates
Small updates to Debian man pages for 0.10....
Fernando Perez -
Show More
@@ -4,48 +4,38 b''
4 4 .SH SYNOPSIS
5 5 .nf
6 6 .fam C
7 \fBipcluster\fP [\fIoptions\fP]
7 \fBipcluster\fP {\fmpiexec,local,mpirun,pbs,ssh\fP} [\fIoptions\fP]
8 8 .fam T
9 9 .fi
10 10 .SH DESCRIPTION
11 11 ipcluster is a control tool for IPython's parallel computing functions.
12
13 IPython cluster startup. This starts a controller and engines using various
14 approaches. Use the IPYTHONDIR environment variable to change your IPython
15 directory from the default of .ipython or _ipython. The log and security
16 subdirectories of your IPython directory will be used by this script for log
17 files and security files.
18 .SH POSITIONAL ARGUMENTS
19
20 The first positional argument should be one of: {mpiexec, local, mpirun, pbs,
21 ssh}, which are the available cluster types.
22
23 For detailed help on each, type "ipcluster TYPE --help". Briefly:
24
25 local run a local cluster
26 mpirun run a cluster using mpirun (mpiexec also works)
27 mpiexec run a cluster using mpiexec (mpirun also works)
28 pbs run a pbs cluster
29 ssh run a cluster using ssh, should have ssh-keys setup
12 30 .SH OPTIONS
13 31 .TP
14 32 .B
15 33 \-h, \-\-help
16 show this help message and exit
17 .TP
18 .B
19 \-\-controller\-port=CONTROLLERPORT
20 the TCP port the controller is listening on
21 .TP
22 .B
23 \-\-controller\-ip=CONTROLLERIP
24 the TCP IP address of the controller
25 .TP
26 .B
27 \-n, \-\-num=N
28 the number of engines to start
29 .TP
30 .B
31 \-\-engine\-port=ENGINEPORT
32 the TCP port the controller will listen on for engine connections
33 .TP
34 .B
35 \-\-mpi=MPI
36 use mpi with package: for instance --mpi=mpi4py
37 .TP
38 .B
39 \-l LOGFILE, \-\-logfile=LOGFILE
40 log file name
41 .TP
42 .B
43 \-f CLUSTERFILE, \-\-cluster\-file=CLUSTERFILE
44 file describing a remote cluster
34 show help message and exit
45 35 .SH EXAMPLE
46 ipcluster -n 4
36 ipcluster local -n 4
47 37
48 This command will start 4 IPython engines.
38 This command will start 4 IPython engines on the local computer.
49 39 .SH SEE ALSO
50 40 .BR ipython(1), ipcontroller(1), ipengine(1)
51 41 .br
@@ -54,4 +44,5 b' This command will start 4 IPython engines.'
54 44 the IPython Development Team.
55 45 .PP
56 46 This manual page was written by Stephan Peijnik <debian@sp.or.at>,
57 for the Debian project (but may be used by others).
47 for the Debian project (but may be used by others). Modified by Fernando Perez
48 <Fernando.Perez@berkeley.edu> for inclusion in IPython.
@@ -73,8 +73,8 b' file to store the FURL for engines to connect with'
73 73 log file name (default is stdout)
74 74 .TP
75 75 .B
76 \-\-ipythondir=IPYTHONDIR
77 look for config files and profiles in this directory
76 \-r
77 try to reuse all furl files
78 78 .SH SEE ALSO
79 79 .BR ipython(1), ipcluster(1), ipengine(1)
80 80 .br
@@ -83,4 +83,5 b' look for config files and profiles in this directory'
83 83 the IPython Development Team.
84 84 .PP
85 85 This manual page was written by Stephan Peijnik <debian@sp.or.at>,
86 for the Debian project (but may be used by others).
86 for the Debian project (but may be used by others). Modified by Fernando Perez
87 <Fernando.Perez@berkeley.edu> for inclusion in IPython.
@@ -26,10 +26,6 b' How to enable MPI (mpi4py, pytrilions, or empty string to disable)'
26 26 .B
27 27 \-l LOGFILE, \-\-logfile=LOGFILE
28 28 log file name (defaults to stdout)
29 .TP
30 .B
31 \-\-ipythondir=IPYTHONDIR
32 look for config files and profiles in this directory
33 29 .SH SEE ALSO
34 30 .BR ipython(1), ipcluster(1), ipcontroller(1)
35 31 .br
@@ -38,4 +34,5 b' look for config files and profiles in this directory'
38 34 the IPython Development Team.
39 35 .PP
40 36 This manual page was written by Stephan Peijnik <debian@sp.or.at>,
41 for the Debian project (but may be used by others).
37 for the Debian project (but may be used by others). Modified by Fernando Perez
38 <Fernando.Perez@berkeley.edu> for inclusion in IPython.
@@ -39,14 +39,11 b' irunner.py \\-\\-ipython \\-\\- \\-\\-interact script.ipy'
39 39 .SH SEE ALSO
40 40 .BR ipython(1)
41 41 .br
42 .SH BUGS
43 The SAGE runner only works if you manually configure your SAGE
44 copy to use 'colors NoColor' in the ipythonrc config file, since
45 currently the prompt matching regexp does not identify color sequences.
46 42 .SH AUTHOR
47 43 \fBirunner\fP is an extension of Ken Schutte <kschutte-AT-csail.mit.edu>'s
48 44 script contributed on the ipython-user list:
49 45 http://scipy.net/pipermail/ipython-user/2006-May/001705.html
50 46 .PP
51 This manual page was written by Bernd Zeimetz <bernd@bzed.de>,
52 for the Debian project (but may be used by others).
47 This manual page was written by Bernd Zeimetz <bernd@bzed.de>, for the Debian
48 project (but may be used by others). Modified by Fernando Perez
49 <Fernando.Perez@berkeley.edu> for inclusion in IPython.
General Comments 0
You need to be logged in to leave comments. Login now