Show More
@@ -48,9 +48,9 b' from IPython.utils.text import indent, wrap_paragraphs, dedent' | |||||
48 | option_description = """ |
|
48 | option_description = """ | |
49 | IPython command-line arguments are passed as '--<flag>', or '--<name>=<value>'. |
|
49 | IPython command-line arguments are passed as '--<flag>', or '--<name>=<value>'. | |
50 |
|
50 | |||
51 |
Arguments that take values are actually aliases to full |
|
51 | Arguments that take values are actually convenience aliases to full | |
52 |
aliases are listed on the help line. For more information |
|
52 | Configurables, whose aliases are listed on the help line. For more information | |
53 | configurables, see '--help-all'. |
|
53 | on full configurables, see '--help-all'. | |
54 | """.strip() # trim newlines of front and back |
|
54 | """.strip() # trim newlines of front and back | |
55 |
|
55 | |||
56 | keyvalue_description = """ |
|
56 | keyvalue_description = """ | |
@@ -250,8 +250,8 b' class Application(SingletonConfigurable):' | |||||
250 | for p in wrap_paragraphs(self.subcommand_description): |
|
250 | for p in wrap_paragraphs(self.subcommand_description): | |
251 | lines.append(p) |
|
251 | lines.append(p) | |
252 | lines.append('') |
|
252 | lines.append('') | |
253 | for subc, (cls,help) in self.subcommands.iteritems(): |
|
253 | for subc, (cls, help) in self.subcommands.iteritems(): | |
254 |
lines.append( |
|
254 | lines.append(subc) | |
255 | if help: |
|
255 | if help: | |
256 | lines.append(indent(dedent(help.strip()))) |
|
256 | lines.append(indent(dedent(help.strip()))) | |
257 | lines.append('') |
|
257 | lines.append('') |
@@ -13,14 +13,23 b' import sys' | |||||
13 | from IPython.core import release |
|
13 | from IPython.core import release | |
14 |
|
14 | |||
15 | cl_usage = """\ |
|
15 | cl_usage = """\ | |
16 | ipython [options] [files] |
|
16 | ========= | |
|
17 | IPython | |||
|
18 | ========= | |||
17 |
|
19 | |||
18 | IPython: an enhanced interactive Python shell. |
|
20 | Tools for Interactive Computing in Python | |
|
21 | ========================================= | |||
19 |
|
22 | |||
20 | A Python shell with automatic history (input and output), dynamic object |
|
23 | A Python shell with automatic history (input and output), dynamic object | |
21 | introspection, easier configuration, command completion, access to the |
|
24 | introspection, easier configuration, command completion, access to the | |
22 | system shell and more. IPython can also be embedded in running programs. |
|
25 | system shell and more. IPython can also be embedded in running programs. | |
23 |
|
26 | |||
|
27 | ||||
|
28 | Usage | |||
|
29 | ----- | |||
|
30 | ||||
|
31 | ipython [subcommand] [options] [files] | |||
|
32 | ||||
24 | If invoked with no options, it executes all the files listed in sequence |
|
33 | If invoked with no options, it executes all the files listed in sequence | |
25 | and exits, use -i to enter interactive mode after running the files. Files |
|
34 | and exits, use -i to enter interactive mode after running the files. Files | |
26 | ending in .py will be treated as normal Python, but files ending in .ipy |
|
35 | ending in .py will be treated as normal Python, but files ending in .ipy | |
@@ -28,25 +37,25 b' IPython: an enhanced interactive Python shell.' | |||||
28 |
|
37 | |||
29 | Almost all configuration in IPython is available via the command-line. Do |
|
38 | Almost all configuration in IPython is available via the command-line. Do | |
30 | `ipython --help-all` to see all available options. For persistent |
|
39 | `ipython --help-all` to see all available options. For persistent | |
31 |
configuration, |
|
40 | configuration, look into your `ipython_config.py` configuration file for | |
32 | details. |
|
41 | details. | |
33 |
|
42 | |||
34 | This file is typically installed in the IPYTHON_DIR directory, and there |
|
43 | This file is typically installed in the `IPYTHON_DIR` directory, and there | |
35 | is a separate configuration directory for each profile. The default profile |
|
44 | is a separate configuration directory for each profile. The default profile | |
36 | directory will be located in $IPYTHON_DIR/profile_default. For Linux |
|
45 | directory will be located in $IPYTHON_DIR/profile_default. For Linux users, | |
37 |
|
|
46 | IPYTHON_DIR defaults to `$HOME/.config/ipython`, and for other Unix systems | |
38 |
$HOME/.ipython. For Windows users, $HOME resolves to C:\\Documents |
|
47 | to `$HOME/.ipython`. For Windows users, $HOME resolves to C:\\Documents | |
39 | Settings\\YourUserName in most instances. |
|
48 | and Settings\\YourUserName in most instances. | |
40 |
|
49 | |||
41 | To initialize a profile with the default configuration file, do: |
|
50 | To initialize a profile with the default configuration file, do:: | |
42 |
|
51 | |||
43 | $> ipython profile create |
|
52 | $> ipython profile create | |
44 |
|
53 | |||
45 | and start editing IPYTHON_DIR/profile_default/ipython_config.py |
|
54 | and start editing `IPYTHON_DIR/profile_default/ipython_config.py` | |
46 |
|
55 | |||
47 |
In IPython's documentation, we will refer to this directory as |
|
56 | In IPython's documentation, we will refer to this directory as | |
48 |
you can change its default location by |
|
57 | `IPYTHON_DIR`, you can change its default location by creating an | |
49 | environment variable. |
|
58 | environment variable with this name and setting it to the desired path. | |
50 |
|
59 | |||
51 | For more information, see the manual available in HTML and PDF in your |
|
60 | For more information, see the manual available in HTML and PDF in your | |
52 | installation, or online at http://ipython.org/documentation.html. |
|
61 | installation, or online at http://ipython.org/documentation.html. |
@@ -1,4 +1,3 b'' | |||||
1 | #!/usr/bin/env python |
|
|||
2 |
|
|
1 | # encoding: utf-8 | |
3 | """ |
|
2 | """ | |
4 | An embedded IPython shell. |
|
3 | An embedded IPython shell. |
@@ -372,4 +372,3 b' def launch_new_instance():' | |||||
372 |
|
372 | |||
373 | if __name__ == '__main__': |
|
373 | if __name__ == '__main__': | |
374 | launch_new_instance() |
|
374 | launch_new_instance() | |
375 |
|
@@ -403,10 +403,6 b' interact with IPython at the end of the script (instead of exiting).' | |||||
403 |
|
403 | |||
404 | The already implemented runners are listed below; adding one for a new program |
|
404 | The already implemented runners are listed below; adding one for a new program | |
405 | is a trivial task, see the source for examples. |
|
405 | is a trivial task, see the source for examples. | |
406 |
|
||||
407 | WARNING: the SAGE runner only works if you manually configure your SAGE copy |
|
|||
408 | to use 'colors NoColor' in the ipythonrc config file, since currently the |
|
|||
409 | prompt matching regexp does not identify color sequences. |
|
|||
410 | """ |
|
406 | """ | |
411 |
|
407 | |||
412 | def main(): |
|
408 | def main(): |
@@ -101,7 +101,8 b" def print_figure(fig, fmt='png'):" | |||||
101 | try: |
|
101 | try: | |
102 | string_io = StringIO() |
|
102 | string_io = StringIO() | |
103 | # use 72 dpi to match QTConsole's dpi |
|
103 | # use 72 dpi to match QTConsole's dpi | |
104 |
fig.canvas.print_figure(string_io, format=fmt, dpi=72 |
|
104 | fig.canvas.print_figure(string_io, format=fmt, dpi=72, | |
|
105 | bbox_inches='tight') | |||
105 | data = string_io.getvalue() |
|
106 | data = string_io.getvalue() | |
106 | finally: |
|
107 | finally: | |
107 | fig.set_facecolor(fc) |
|
108 | fig.set_facecolor(fc) |
@@ -2,7 +2,7 b'' | |||||
2 | .\" First parameter, NAME, should be all caps |
|
2 | .\" First parameter, NAME, should be all caps | |
3 | .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection |
|
3 | .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection | |
4 | .\" other parameters are allowed: see man(7), man(1) |
|
4 | .\" other parameters are allowed: see man(7), man(1) | |
5 |
.TH IPYTHON 1 " |
|
5 | .TH IPYTHON 1 "July 15, 2011" | |
6 | .\" Please adjust this date whenever revising the manpage. |
|
6 | .\" Please adjust this date whenever revising the manpage. | |
7 | .\" |
|
7 | .\" | |
8 | .\" Some roff macros, for reference: |
|
8 | .\" Some roff macros, for reference: | |
@@ -22,15 +22,15 b'' | |||||
22 | .\" To preview this page as plain text: nroff -man ipython.1 |
|
22 | .\" To preview this page as plain text: nroff -man ipython.1 | |
23 | .\" |
|
23 | .\" | |
24 | .SH NAME |
|
24 | .SH NAME | |
25 |
ipython \- |
|
25 | ipython \- Tools for Interactive Computing in Python. | |
26 | .SH SYNOPSIS |
|
26 | .SH SYNOPSIS | |
27 | .B ipython |
|
27 | .B ipython | |
28 | .RI [ options ] " files" ... |
|
28 | .RI [ options ] " files" ... | |
29 | .SH DESCRIPTION |
|
29 | .SH DESCRIPTION | |
30 | An interactive Python shell with automatic history (input and output), |
|
30 | An interactive Python shell with automatic history (input and output), dynamic | |
31 |
|
|
31 | object introspection, easier configuration, command completion, access to the | |
32 |
|
|
32 | system shell, integration with numerical and scientific computing tools, and | |
33 | scientific computing tools, and more. |
|
33 | more. | |
34 | . |
|
34 | . | |
35 | .SH REGULAR OPTIONS |
|
35 | .SH REGULAR OPTIONS | |
36 | All options that take values, must be of the form '\-\-name=value', but |
|
36 | All options that take values, must be of the form '\-\-name=value', but |
@@ -1,4 +1,4 b'' | |||||
1 |
.TH IRUNNER 1 " |
|
1 | .TH IRUNNER 1 "July 15, 2011" "" "" | |
2 | .SH NAME |
|
2 | .SH NAME | |
3 | \fBirunner \- interactive runner interface |
|
3 | \fBirunner \- interactive runner interface | |
4 | .SH SYNOPSIS |
|
4 | .SH SYNOPSIS |
@@ -2,7 +2,7 b'' | |||||
2 | .\" First parameter, NAME, should be all caps |
|
2 | .\" First parameter, NAME, should be all caps | |
3 | .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection |
|
3 | .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection | |
4 | .\" other parameters are allowed: see man(7), man(1) |
|
4 | .\" other parameters are allowed: see man(7), man(1) | |
5 |
.TH PYCOLOR 1 " |
|
5 | .TH PYCOLOR 1 "July 15, 2011" | |
6 | .\" Please adjust this date whenever revising the manpage. |
|
6 | .\" Please adjust this date whenever revising the manpage. | |
7 | .\" |
|
7 | .\" | |
8 | .\" Some roff macros, for reference: |
|
8 | .\" Some roff macros, for reference: | |
@@ -30,9 +30,10 b' given, or the file name - is given) to standard out.' | |||||
30 | Output a brief help message. |
|
30 | Output a brief help message. | |
31 | .TP |
|
31 | .TP | |
32 | .B \-s, \-\-scheme <scheme> |
|
32 | .B \-s, \-\-scheme <scheme> | |
33 | Give the color scheme to use. Currently only Linux (default), |
|
33 | Give the color scheme to use. Currently only Linux (default), LightBG, and | |
34 |
|
|
34 | NoColor are implemented. | |
35 | .SH AUTHOR |
|
35 | .SH AUTHOR | |
36 | pycolor was written by Fernando Perez <fperez@colorado.edu>. |
|
36 | pycolor is part of the IPython project (http://ipython.org). | |
37 | This manual page was written by Jack Moffitt <jack@xiph.org>, |
|
37 | This manual page was written by Jack Moffitt <jack@xiph.org>, | |
38 | for the Debian project (but may be used by others). |
|
38 | for the Debian project (but may be used by others). Updated by Fernando Perez | |
|
39 | <fernando.perez@berkeley.edu>. |
General Comments 0
You need to be logged in to leave comments.
Login now