diff --git a/docs/man/ipcluster.1 b/docs/man/ipcluster.1 new file mode 100644 index 0000000..d04adad --- /dev/null +++ b/docs/man/ipcluster.1 @@ -0,0 +1,48 @@ +.TH IPCLUSTER 1 "October 28, 2008" "" "" +.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 IPYTHONDIR environment variable to change your IPython +directory from the default of .ipython or _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. + +For detailed help on each, type "ipcluster TYPE --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 +.SH OPTIONS +.TP +.B +\-h, \-\-help +show help message and exit +.SH EXAMPLE +ipcluster local -n 4 + +This command will start 4 IPython engines on the local computer. +.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). Modified by Fernando Perez + for inclusion in IPython. diff --git a/docs/man/ipcontroller.1 b/docs/man/ipcontroller.1 new file mode 100644 index 0000000..bb48081 --- /dev/null +++ b/docs/man/ipcontroller.1 @@ -0,0 +1,87 @@ +.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 +\-r +try to reuse all furl files +.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). Modified by Fernando Perez + for inclusion in IPython. diff --git a/docs/man/ipengine.1 b/docs/man/ipengine.1 new file mode 100644 index 0000000..e65c368 --- /dev/null +++ b/docs/man/ipengine.1 @@ -0,0 +1,38 @@ +.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) +.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). Modified by Fernando Perez + for inclusion in IPython. 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..14edf62 --- /dev/null +++ b/docs/man/irunner.1 @@ -0,0 +1,49 @@ +.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 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). Modified by Fernando Perez + for inclusion in IPython. diff --git a/setup.py b/setup.py index f572729..afca429 100755 --- a/setup.py +++ b/setup.py @@ -78,14 +78,38 @@ if len(sys.argv) >= 2 and sys.argv[1] in ('sdist','bdist_rpm'): #('docs/magic.tex', #['IPython/Magic.py'], #"cd doc && ./update_magic.sh" ), - + + ('docs/man/ipcluster.1.gz', + ['docs/man/ipcluster.1'], + 'cd docs/man && gzip -9c ipcluster.1 > ipcluster.1.gz'), + + ('docs/man/ipcontroller.1.gz', + ['docs/man/ipcontroller.1'], + 'cd docs/man && gzip -9c ipcontroller.1 > ipcontroller.1.gz'), + + ('docs/man/ipengine.1.gz', + ['docs/man/ipengine.1'], + 'cd docs/man && gzip -9c ipengine.1 > ipengine.1.gz'), + ('docs/man/ipython.1.gz', ['docs/man/ipython.1'], - "cd docs/man && gzip -9c ipython.1 > ipython.1.gz"), + 'cd docs/man && gzip -9c ipython.1 > ipython.1.gz'), + + ('docs/man/ipython-wx.1.gz', + ['docs/man/ipython-wx.1'], + 'cd docs/man && gzip -9c ipython-wx.1 > ipython-wx.1.gz'), + + ('docs/man/ipythonx.1.gz', + ['docs/man/ipythonx.1'], + 'cd docs/man && gzip -9c ipythonx.1 > ipythonx.1.gz'), + + ('docs/man/irunner.1.gz', + ['docs/man/irunner.1'], + 'cd docs/man && gzip -9c irunner.1 > irunner.1.gz'), ('docs/man/pycolor.1.gz', ['docs/man/pycolor.1'], - "cd docs/man && gzip -9c pycolor.1 > pycolor.1.gz"), + 'cd docs/man && gzip -9c pycolor.1 > pycolor.1.gz'), ] # Only build the docs if sphinx is present diff --git a/setupbase.py b/setupbase.py index 972cafc..119037a 100644 --- a/setupbase.py +++ b/setupbase.py @@ -227,6 +227,31 @@ def find_data_files(): return data_files + +def make_man_update_target(manpage): + """Return a target_update-compliant tuple for the given manpage. + + Parameters + ---------- + manpage : string + Name of the manpage, must include the section number (trailing number). + + Example + ------- + + >>> make_man_update_target('ipython.1') #doctest: +NORMALIZE_WHITESPACE + ('docs/man/ipython.1.gz', + ['docs/man/ipython.1'], + 'cd docs/man && gzip -9c ipython.1 > ipython.1.gz') + """ + man_dir = pjoin('docs', 'man') + manpage_gz = manpage + '.gz' + manpath = pjoin(man_dir, manpage) + manpath_gz = pjoin(man_dir, manpage_gz) + gz_cmd = ( "cd %(man_dir)s && gzip -9c %(manpage)s > %(manpage_gz)s" % + locals() ) + return (manpath_gz, [manpath], gz_cmd) + #--------------------------------------------------------------------------- # Find scripts #---------------------------------------------------------------------------