upstream/ipython Files · docs/man/ipcluster.1

Add missing man pages contributed by Debian's Stephan Peijnik....

Add missing man pages contributed by Debian's Stephan Peijnik. This is an initial import of missing man pages taken verbatim from: http://svn.debian.org/viewsvn/python-modules/packages/ipython/trunk/debian/ This starts to close this bug: https://bugs.launchpad.net/ipython/+bug/291143 I wanted this commit to be purely an import of Stephan's documentation unmodified. I've made some edits to the man pages to update them for 0.10, that will go in the next commit.

Stephan Peijnik - - Load All Authors

File last commit:

r2098:5d6f848d


                r2098:5d6f848d

Download file

             ipcluster.1
        
                    57 lines
            
             | 1.2 KiB
            
                | application/x-troff
            
             |
                GroffLexer
            
             / docs / man / ipcluster.1
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      .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 <debian@sp.or.at>,

      for the Debian project (but may be used by others).

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				.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 <debian@sp.or.at>,
				for the Debian project (but may be used by others).