diff --git a/docs/man/ipcluster.1 b/docs/man/ipcluster.1 new file mode 100644 index 0000000..ffdaa3d --- /dev/null +++ b/docs/man/ipcluster.1 @@ -0,0 +1,57 @@ +.TH IPCLUSTER 1 "October 28, 2008" "" "" +.SH NAME +\fBipcluster \- IPython parallel computing cluster control tool +.SH SYNOPSIS +.nf +.fam C +\fBipcluster\fP [\fIoptions\fP] +.fam T +.fi +.SH DESCRIPTION +ipcluster is a control tool for IPython's parallel computing functions. +.SH OPTIONS +.TP +.B +\-h, \-\-help +show this help message and exit +.TP +.B +\-\-controller\-port=CONTROLLERPORT +the TCP port the controller is listening on +.TP +.B +\-\-controller\-ip=CONTROLLERIP +the TCP IP address of the controller +.TP +.B +\-n, \-\-num=N +the number of engines to start +.TP +.B +\-\-engine\-port=ENGINEPORT +the TCP port the controller will listen on for engine connections +.TP +.B +\-\-mpi=MPI +use mpi with package: for instance --mpi=mpi4py +.TP +.B +\-l LOGFILE, \-\-logfile=LOGFILE +log file name +.TP +.B +\-f CLUSTERFILE, \-\-cluster\-file=CLUSTERFILE +file describing a remote cluster +.SH EXAMPLE +ipcluster -n 4 + +This command will start 4 IPython engines. +.SH SEE ALSO +.BR ipython(1), ipcontroller(1), 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 , +for the Debian project (but may be used by others). diff --git a/docs/man/ipcontroller.1 b/docs/man/ipcontroller.1 new file mode 100644 index 0000000..17ce6ab --- /dev/null +++ b/docs/man/ipcontroller.1 @@ -0,0 +1,86 @@ +.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 +\-\-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 +.TP +.B +\-x +turn off all client security +.TP +.B +\-\-client\-cert\-file=CLIENT_CERT_FILE +file to store the client SSL certificate +.TP +.B +\-\-task\-furl\-file=TASK_FURL_FILE +file to store the FURL for task clients to connect with +.TP +.B +\-\-multiengine\-furl\-file=MULTIENGINE_FURL_FILE +file to store the FURL for multiengine clients to connect with +.TP +.B +\-\-engine\-ip=ENGINE_IP +the IP address or hostname the controller will listen on for engine connections +.TP +.B +\-\-engine\-port=ENGINE_PORT +the port the controller will listen on for engine connections +.TP +.B +\-\-engine\-location=ENGINE_LOCATION +the IP address or hostname for engine to connect to +.TP +.B +\-y +turn off all engine security +.TP +.B +\-\-engine\-cert\-file=ENGINE_CERT_FILE +file to store the engine SSL certificate +.TP +.B +\-\-engine\-furl\-file=ENGINE_FURL_FILE +file to store the FURL for engines to connect with +.TP +.B +\-l LOGFILE, \-\-logfile=LOGFILE +log file name (default is stdout) +.TP +.B +\-\-ipythondir=IPYTHONDIR +look for config files and profiles in this directory +.SH SEE ALSO +.BR ipython(1), ipcluster(1), 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 , +for the Debian project (but may be used by others). diff --git a/docs/man/ipengine.1 b/docs/man/ipengine.1 new file mode 100644 index 0000000..6b91be8 --- /dev/null +++ b/docs/man/ipengine.1 @@ -0,0 +1,41 @@ +.TH IPENGINE 1 "October 28, 2008" "" "" +.SH NAME +\fBipengine \- IPython parallel computing engine control tool +.SH SYNOPSIS +.nf +.fam C +\fBipengine\fP [\fIoptions\fP] +.fam T +.fi +.SH DESCRIPTION +ipengine is a control tool for IPython's parallel computing functions. +.SH OPTIONS +.TP +.B +\-h, \-\-help +show this help message and exit +.TP +.B +\-\-furl\-file=FURL_FILE +The filename containing the FURL of the controller +.TP +.B +\-\-mpi=MPI +How to enable MPI (mpi4py, pytrilions, or empty string to disable) +.TP +.B +\-l LOGFILE, \-\-logfile=LOGFILE +log file name (defaults to stdout) +.TP +.B +\-\-ipythondir=IPYTHONDIR +look for config files and profiles in this directory +.SH SEE ALSO +.BR ipython(1), ipcluster(1), ipcontroller(1) +.br +.SH AUTHOR +\fBipengine\fP is a tool that ships with IPython, created by +the IPython Development Team. +.PP +This manual page was written by Stephan Peijnik , +for the Debian project (but may be used by others). diff --git a/docs/man/ipython-wx.1 b/docs/man/ipython-wx.1 new file mode 100644 index 0000000..78c7f54 --- /dev/null +++ b/docs/man/ipython-wx.1 @@ -0,0 +1,25 @@ +.TH IPYTHON-WX 1 "October 29, 2008" "" "" +.SH NAME +\fBipython-wx \- Graphical frontend that embeds a multithreaded IPython Shell +.SH SYNOPSIS +.nf +.fam C +\fBipython-wx\fP +.fam T +.fi +.SH DESCRIPTION +ipython-wx is, compared to ipythonx, a more advanced graphical frontend +to IPython. It is implemented using WxWidgets. +.SH OPTIONS +.TP +.B +ipython-wx does not accept any command line options. +.SH SEE ALSO +.BR ipython(1), ipythonx(1) +.br +.SH AUTHOR +\fBipython-wx\fP is a tool that ships with IPython, created by +the IPython Development Team. +.PP +This manual page was written by Stephan Peijnik , +for the Debian project (but may be used by others). diff --git a/docs/man/ipythonx.1 b/docs/man/ipythonx.1 new file mode 100644 index 0000000..979da98 --- /dev/null +++ b/docs/man/ipythonx.1 @@ -0,0 +1,30 @@ +.TH IPYTHONX 1 "October 29, 2008" "" "" +.SH NAME +\fBipythonx \- Simple graphical frontend to IPython, using WxWidgets. +.SH SYNOPSIS +.nf +.fam C +\fBipengine\fP [\fIoptions\fP] +.fam T +.fi +.SH DESCRIPTION +ipythonx is a simple graphical frontend to IPython, using WxWidgets. +.SH OPTIONS +.TP +.B +\-h, \-\-help +show this help message and exit +.TP +.B +\-d, \-\-debug +Enable debug messages for the wx frontend. +look for config files and profiles in this directory +.SH SEE ALSO +.BR ipython(1), ipython-wx(1) +.br +.SH AUTHOR +\fBipythonx\fP is a tool that ships with IPython, created by +the IPython Development Team. +.PP +This manual page was written by Stephan Peijnik , +for the Debian project (but may be used by others). diff --git a/docs/man/irunner.1 b/docs/man/irunner.1 new file mode 100644 index 0000000..71c9c55 --- /dev/null +++ b/docs/man/irunner.1 @@ -0,0 +1,52 @@ +.TH IRUNNER 1 "April 24, 2007" "" "" +.SH NAME +\fBirunner \- interactive runner interface +.SH SYNOPSIS +.nf +.fam C +\fBirunner\fP [\fIoptions\fP] \fIfile_to_run\fP +.fam T +.fi +.SH DESCRIPTION +irunner is an interface to the various interactive runners +available in IPython's \fBirunner\fP module. +.PP +The already implemented runners are listed below; adding +one for a new program is a trivial task, see the source +for examples. +.SH OPTIONS +.TP +.B +\-h, \-\-help +show this help message and exit +.TP +.B +\-\-ipython +IPython interactive runner (default). +.TP +.B +\-\-python +Python interactive runner. +.TP +.B +\-\-sage +SAGE interactive runner. +.SH EXAMPLE +irunner.py \-\-python \-\- \-\-help +will pass \-\-help to the python runner. +Similarly, +irunner.py \-\-ipython \-\- \-\-interact script.ipy +.SH SEE ALSO +.BR ipython(1) +.br +.SH BUGS +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. +.SH AUTHOR +\fBirunner\fP is an extension of Ken Schutte 's +script contributed on the ipython-user list: +http://scipy.net/pipermail/ipython-user/2006-May/001705.html +.PP +This manual page was written by Bernd Zeimetz , +for the Debian project (but may be used by others).