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

further fixes to magic docstrings...

further fixes to magic docstrings as discussed in PR , "plain reST for docstrings, fancier sphinx extensions OK for the rest of the docs themselves." So I've removed .. sourcecode :: ipython bits with just plain literal blocks

Julian Taylor - - Load All Authors

File last commit:

r5342:0a49a993


                r6099:bd218759

Download file

             irunner.1
        
                    51 lines
            
             | 1.3 KiB
            
                | application/x-troff
            
             |
                GroffLexer
            
             / docs / man / irunner.1
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      .TH IRUNNER 1 "July 15, 2011" "" ""

      .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. 

      It can used to run scripts as if they where typed up

      interactively.

      .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 <kschutte\-AT\-csail.mit.edu>'s

      script contributed on the ipython\-user list:

      http://mail.scipy.org/pipermail/ipython\-user/2006\-May/003539.html

      .PP

      This manual page was written by Bernd Zeimetz <bernd@bzed.de>, for the Debian

      project (but may be used by others).  Modified by Fernando Perez

      <Fernando.Perez@berkeley.edu> for inclusion in IPython.

	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 IRUNNER 1 "July 15, 2011" "" ""
				.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.
				It can used to run scripts as if they where typed up
				interactively.
				.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 <kschutte\-AT\-csail.mit.edu>'s
				script contributed on the ipython\-user list:
				http://mail.scipy.org/pipermail/ipython\-user/2006\-May/003539.html
				.PP
				This manual page was written by Bernd Zeimetz <bernd@bzed.de>, for the Debian
				project (but may be used by others). Modified by Fernando Perez
				<Fernando.Perez@berkeley.edu> for inclusion in IPython.