##// END OF EJS Templates
manpage checkpoint
MinRK -
Show More
@@ -22,7 +22,7 b' IPython: an enhanced interactive Python shell.'
22 system shell and more. IPython can also be embedded in running programs.
22 system shell and more. IPython can also be embedded in running programs.
23
23
24 If invoked with no options, it executes all the files listed in sequence
24 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
25 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
26 ending in .py will be treated as normal Python, but files ending in .ipy
27 can contain special IPython syntax (magic commands, shell expansions, etc.)
27 can contain special IPython syntax (magic commands, shell expansions, etc.)
28
28
@@ -1,4 +1,4 b''
1 .TH IPCLUSTER 1 "October 28, 2008" "" ""
1 .TH IPCLUSTER 1 "July 15, 2011" "" ""
2 .SH NAME
2 .SH NAME
3 \fBipcluster \- IPython parallel computing cluster control tool
3 \fBipcluster \- IPython parallel computing cluster control tool
4 .SH SYNOPSIS
4 .SH SYNOPSIS
@@ -12,28 +12,26 b" ipcluster is a control tool for IPython's parallel computing functions."
12
12
13 IPython cluster startup. This starts a controller and engines using various
13 IPython cluster startup. This starts a controller and engines using various
14 approaches. Use the IPYTHON_DIR environment variable to change your IPython
14 approaches. Use the IPYTHON_DIR environment variable to change your IPython
15 directory from the default of .ipython or _ipython. The log and security
15 directory from the default of ~/.ipython or ~/.config/ipython. The log and security
16 subdirectories of your IPython directory will be used by this script for log
16 subdirectories of your IPython directory will be used by this script for log
17 files and security files.
17 files and security files.
18 .SH POSITIONAL ARGUMENTS
18 .SH POSITIONAL ARGUMENTS
19
19
20 The first positional argument should be one of: {mpiexec, local, mpirun, pbs,
20 The first positional argument should be one of: {start, stop, engines},
21 ssh}, which are the available cluster types.
21 which are the available subcommands.
22
22
23 For detailed help on each, type "ipcluster TYPE --help". Briefly:
23 For detailed help on each, type "ipcluster CMD --help". Briefly:
24
24
25 local run a local cluster
25 start start an IPython cluster
26 mpirun run a cluster using mpirun (mpiexec also works)
26 stop stop a running IPython cluster
27 mpiexec run a cluster using mpiexec (mpirun also works)
27 engines add a number of engines to a running cluster
28 pbs run a pbs cluster
29 ssh run a cluster using ssh, should have ssh-keys setup
30 .SH OPTIONS
28 .SH OPTIONS
31 .TP
29 .TP
32 .B
30 .B
33 \-h, \-\-help
31 \-h, \-\-help
34 show help message and exit
32 show help message and exit
35 .SH EXAMPLE
33 .SH EXAMPLE
36 ipcluster local -n 4
34 ipcluster start --n=4
37
35
38 This command will start 4 IPython engines on the local computer.
36 This command will start 4 IPython engines on the local computer.
39 .SH SEE ALSO
37 .SH SEE ALSO
@@ -16,65 +16,139 b" ipcontroller is a control tool for IPython's parallel computing functions."
16 show this help message and exit
16 show this help message and exit
17 .TP
17 .TP
18 .B
18 .B
19 \-\-client\-ip=CLIENT_IP
20 the IP address or hostname the controller will listen on for
21 client connections
22 .TP
19 .TP
23 .B
20 .B \-\-no-secure
24 \-\-client\-port=CLIENT_PORT
21 Don't authenticate messages.
25 the port the controller will listen on for client connections
26 .TP
27 .B
28 \-\-client\-location=CLIENT_LOCATION
29 hostname or ip for clients to connect to
30 .TP
22 .TP
31 .B
23 .B \-\-usethreads
32 \-x
24 Use threads instead of processes for the schedulers
33 turn off all client security
34 .TP
25 .TP
35 .B
26 .B \-\-init
36 \-\-client\-cert\-file=CLIENT_CERT_FILE
27 Initialize profile with default config files
37 file to store the client SSL certificate
38 .TP
28 .TP
39 .B
29 .B \-\-log-to-file
40 \-\-task\-furl\-file=TASK_FURL_FILE
30 send log output to a file
41 file to store the FURL for task clients to connect with
42 .TP
31 .TP
43 .B
32 .B \-\-reuse
44 \-\-multiengine\-furl\-file=MULTIENGINE_FURL_FILE
33 reuse existing json connection files
45 file to store the FURL for multiengine clients to connect with
46 .TP
34 .TP
47 .B
35 .B \-\-mongodb
48 \-\-engine\-ip=ENGINE_IP
36 use the MongoDB backend
49 the IP address or hostname the controller will listen on for engine connections
50 .TP
37 .TP
51 .B
38 .B \-\-quiet
52 \-\-engine\-port=ENGINE_PORT
39 set log level to logging.CRITICAL (minimize logging output)
53 the port the controller will listen on for engine connections
54 .TP
40 .TP
55 .B
41 .B \-\-debug
56 \-\-engine\-location=ENGINE_LOCATION
42 set log level to logging.DEBUG (maximize logging output)
57 the IP address or hostname for engine to connect to
58 .TP
43 .TP
59 .B
44 .B \-\-sqlitedb
60 \-y
45 use the SQLiteDB backend
61 turn off all engine security
62 .TP
46 .TP
63 .B
47 .B \-\-dictdb
64 \-\-engine\-cert\-file=ENGINE_CERT_FILE
48 use the in-memory DictDB backend
65 file to store the engine SSL certificate
66 .TP
49 .TP
67 .B
50 .B \-\-secure
68 \-\-engine\-furl\-file=ENGINE_FURL_FILE
51 Use HMAC digests for authentication of messages.
69 file to store the FURL for engines to connect with
70 .TP
52 .TP
71 .B
53 .B \-\-profile=<Unicode> (BaseIPythonApplication.profile)
72 \-l LOGFILE, \-\-logfile=LOGFILE
54 Default: u'default'
73 log file name (default is stdout)
55 The IPython profile to use.
74 .TP
56 .TP
75 .B
57 .B \-\-hwm=<Int> (TaskScheduler.hwm)
76 \-r
58 Default: 0
77 try to reuse all furl files
59 .br
60 specify the High Water Mark (HWM) for the downstream socket in the Task
61 scheduler. This is the maximum number of allowed outstanding tasks on each
62 engine.
63 .TP
64 .B \-\-secure=<Bool> (IPControllerApp.secure)
65 Default: True
66 Whether to use HMAC digests for extra message authentication.
67 .TP
68 .B \-\-ip=<Unicode> (HubFactory.ip)
69 Default: '127.0.0.1'
70 The IP address for registration. This is generally either '127.0.0.1' for
71 loopback only or '*' for all interfaces. [default: '127.0.0.1']
72 .TP
73 .B \-\-log-url=<Unicode> (BaseParallelApplication.log_url)
74 Default: ''
75 The ZMQ URL of the iplogger to aggregate logging.
76 .TP
77 .B \-\-work-dir=<Unicode> (BaseParallelApplication.work_dir)
78 Default: u'/Users/minrk/dev/ip/mine/docs/man'
79 Set the working dir for the process.
80 .TP
81 .B \-\-port=<Int> (HubFactory.regport)
82 Default: 0
83 The port on which the Hub listens for registration.
84 .TP
85 .B \-\-profile-dir=<Unicode> (ProfileDir.location)
86 Default: u''
87 Set the profile location directly. This overrides the logic used by the
88 `profile` option.
89 .TP
90 .B \-\-ident=<CBytes> (Session.session)
91 Default: ''
92 The UUID identifying this session.
93 .TP
94 .B \-\-log-to-file=<Bool> (BaseParallelApplication.log_to_file)
95 Default: False
96 whether to log to a file
97 .TP
98 .B \-\-ipython-dir=<Unicode> (BaseIPythonApplication.ipython_dir)
99 Default: u'/Users/minrk/.ipython'
100 The name of the IPython directory. This directory is used for logging
101 configuration (through profiles), history storage, etc. The default is
102 usually $HOME/.ipython. This options can also be specified through the
103 environment variable IPYTHON_DIR.
104 .TP
105 .B \-\-url=<Unicode> (HubFactory.url)
106 Default: ''
107 The 0MQ url used for registration. This sets transport, ip, and port in one
108 variable. For example: url='tcp://127.0.0.1:12345' or url='epgm://*:90210'
109 .TP
110 .B \-\-user=<Unicode> (Session.username)
111 Default: 'minrk'
112 Username for the Session. Default is your system username.
113 .TP
114 .B \-\-ping=<CFloat> (HeartMonitor.period)
115 Default: 1000
116 The frequency at which the Hub pings the engines for heartbeats (in ms)
117 .TP
118 .B \-\-log-level=<Enum> (Application.log_level)
119 Default: 30
120 Choices: (0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL')
121 Set the log level by value or name.
122 .TP
123 .B \-\-location=<Unicode> (IPControllerApp.location)
124 Default: u''
125 The external IP or domain name of the Controller, used for disambiguating
126 engine and client connections.
127 .TP
128 .B \-\-clean-logs=<Bool> (BaseParallelApplication.clean_logs)
129 Default: False
130 whether to cleanup old logfiles before starting
131 .TP
132 .B \-\-scheme=<Enum> (TaskScheduler.scheme_name)
133 Default: 'leastload'
134 Choices: ('leastload', 'pure', 'lru', 'plainrandom', 'weighted', 'twobin')
135 select the task scheduler scheme [default: Python LRU] Options are: 'pure',
136 'lru', 'plainrandom', 'weighted', 'twobin','leastload'
137 .TP
138 .B \-\-keyfile=<Unicode> (Session.keyfile)
139 Default: ''
140 path to file containing execution key.
141 .TP
142 .B \-\-transport=<Unicode> (HubFactory.transport)
143 Default: 'tcp'
144 The 0MQ transport for communications. This will likely be the default of
145 'tcp', but other values include 'ipc', 'epgm', 'inproc'.
146 .TP
147 .B \-\-ssh=<Unicode> (IPControllerApp.ssh_server)
148 Default: u''
149 ssh url for clients to use when connecting to the Controller processes. It
150 should be of the form: [user@]server[:port]. The Controller's listening
151 addresses must be accessible from the ssh server
78 .SH SEE ALSO
152 .SH SEE ALSO
79 .BR ipython(1), ipcluster(1), ipengine(1)
153 .BR ipython(1), ipcluster(1), ipengine(1)
80 .br
154 .br
@@ -84,4 +158,5 b' the IPython Development Team.'
84 .PP
158 .PP
85 This manual page was written by Stephan Peijnik <debian@sp.or.at>,
159 This manual page was written by Stephan Peijnik <debian@sp.or.at>,
86 for the Debian project (but may be used by others). Modified by Fernando Perez
160 for the Debian project (but may be used by others). Modified by Fernando Perez
87 <Fernando.Perez@berkeley.edu> for inclusion in IPython.
161 <Fernando.Perez@berkeley.edu> for inclusion in IPython, and updated by
162 Min Ragan-Kelley <benjaminrk@gmail.com> for 0.11.
@@ -1,4 +1,4 b''
1 .TH IPENGINE 1 "October 28, 2008" "" ""
1 .TH IPENGINE 1 "July 15, 2011" "" ""
2 .SH NAME
2 .SH NAME
3 \fBipengine \- IPython parallel computing engine control tool
3 \fBipengine \- IPython parallel computing engine control tool
4 .SH SYNOPSIS
4 .SH SYNOPSIS
@@ -16,8 +16,12 b" ipengine is a control tool for IPython's parallel computing functions."
16 show this help message and exit
16 show this help message and exit
17 .TP
17 .TP
18 .B
18 .B
19 \-\-furl\-file=FURL_FILE
19 \-\-profile=name
20 The filename containing the FURL of the controller
20 The name of the IPython configuration profile to use.
21 .TP
22 .B
23 \-\-file=URL_FILE
24 The JSON file containing the connection information of the controller.
21 .TP
25 .TP
22 .B
26 .B
23 \-\-mpi=MPI
27 \-\-mpi=MPI
@@ -33,293 +33,194 b' completion, access to the system shell, integration with numerical and'
33 scientific computing tools, and more.
33 scientific computing tools, and more.
34 .
34 .
35 .SH REGULAR OPTIONS
35 .SH REGULAR OPTIONS
36 After the above threading options have been given, regular options can follow
36 All options that take values, must be of the form '\-\-name=value', but
37 in any order. All options can be abbreviated to their shortest non-ambiguous
37 flags that take no arguments are allowed a single '\-' to allow common
38 form and are case-sensitive. One or two dashes can be used. Some options
38 patterns like: 'ipython -i myscript.py'. To pass arguments to scripts,
39 have an alternate short form, indicated after a |.
39 rather than to IPython, specify them after '--'.
40 .br
40 .br
41 .sp 1
41 .sp 1
42 Most options can also be set from your ipythonrc configuration file.
42 All options can also be set from your ipython_config.py configuration file.
43 See the provided examples for assistance. Options given on the
43 See the provided examples for assistance. Options given on the
44 commandline override the values set in the ipythonrc file.
44 commandline override the values set in ipython_config.py. To generate
45 the default config file, do `ipython profile create`.
45 .br
46 .br
46 .sp 1
47 .sp 1
47 All options with a [no] prepended can be specified in negated form
48 All options with a [no] prepended can be specified in negated form
48 (\-nooption instead of \-option) to turn the feature off.
49 (\\--no\-option instead of \-\-option) to turn the feature off.
49 .TP
50 .TP
50 .B \-h, \-\-help
51 .B \-h, \-\-help
51 Show summary of options.
52 Show summary of options.
52 .TP
53 .B \-\-no-autoindent
53 .B \-autocall <val>
54 Turn off autoindenting.
54 Make IPython automatically call any callable object even if you didn't type
55 .TP
55 explicit parentheses. For example, 'str 43' becomes
56 .B \-\-autoedit-syntax
56 str(43) automatically. The value can be '0' to disable the
57 Turn on auto editing of files with syntax errors.
57 feature, '1' for 'smart' autocall, where it is not applied if
58 .TP
58 there are no more arguments on the line, and '2' for 'full'
59 .B \-\-pylab
59 autocall, where all callable objects are automatically called
60 Pre-load matplotlib and numpy for interactive use with
60 (even if no arguments are present). The default is '1'.
61 the default matplotlib backend.
61 .TP
62 .TP
62 .B \-[no]autoindent
63 .B \-\-confirm-exit
63 Turn automatic indentation on/off.
64 Set to confirm when you try to exit IPython with an EOF (Control-D
64 .TP
65 in Unix, Control-Z/Enter in Windows). By typing 'exit' or 'quit',
65 .B \-[no]automagic
66 you can force a direct exit without any confirmation.
66 Make magic commands automatic (without needing their first character
67 .TP
67 to be %). Type %magic at the IPython prompt for more information.
68 .B \-\-deep-reload
68 .TP
69 Enable deep (recursive) reloading by default. IPython can use the
69 .B \-[no]autoedit_syntax
70 deep_reload module which reloads changes in modules recursively (it
70 When a syntax error occurs after editing a file, automatically open the file
71 replaces the reload() function, so you don't need to change anything to
71 to the trouble causing line for convenient fixing.
72 use it). deep_reload() forces a full reload of modules whose code may
72 .TP
73 have changed, which the default reload() function does not. When
73 .B \-[no]banner
74 deep_reload is off, IPython will use the normal reload(), but
74 Print the intial information banner (default on).
75 .TP
76 .B \-c <command>
77 Execute the given command string, and set sys.argv to ['c']. This is similar
78 to the \-c option in the normal Python interpreter.
79 .TP
80 .B \-cache_size|cs <n>
81 Size of the output cache (maximum number of entries to hold in
82 memory). The default is 1000, you can change it permanently in your
83 config file. Setting it to 0 completely disables the caching system,
84 and the minimum value accepted is 20 (if you provide a value less than
85 20, it is reset to 0 and a warning is issued). This limit is defined
86 because otherwise you'll spend more time re-flushing a too small cache
87 than working.
88 .TP
89 .B \-classic|cl
90 Gives IPython a similar feel to the classic Python prompt.
91 .TP
92 .B \-colors <scheme>
93 Color scheme for prompts and exception reporting. Currently
94 implemented: NoColor, Linux, and LightBG.
95 .TP
96 .B \-[no]color_info
97 IPython can display information about objects via a set of functions,
98 and optionally can use colors for this, syntax highlighting source
99 code and various other elements. However, because this information is
100 passed through a pager (like 'less') and many pagers get confused with
101 color codes, this option is off by default. You can test it and turn
102 it on permanently in your ipythonrc file if it works for you. As a
103 reference, the 'less' pager supplied with Mandrake 8.2 works ok, but
104 that in RedHat 7.2 doesn't.
105 .br
106 .sp 1
107 Test it and turn it on permanently if it works with your system. The
108 magic function @color_info allows you to toggle this interactively for
109 testing.
110 .TP
111 .B \-[no]confirm_exit
112 Set to confirm when you try to exit IPython with an EOF (Control-D in
113 Unix, Control-Z/Enter in Windows). Note that using the magic functions
114 @Exit or @Quit you can force a direct exit, bypassing any
115 confirmation.
116 .TP
117 .B \-[no]debug
118 Show information about the loading process. Very useful to pin down
119 problems with your configuration files or to get details about session
120 restores.
121 .TP
122 .B \-[no]deep_reload
123 IPython can use the deep_reload module which reloads changes in
124 modules recursively (it replaces the reload() function, so you don't
125 need to change anything to use it). deep_reload() forces a full reload
126 of modules whose code may have changed, which the default reload()
127 function does not.
128 .br
129 .sp 1
130 When deep_reload is off, IPython will use the normal reload(), but
131 deep_reload will still be available as dreload(). This feature is off
75 deep_reload will still be available as dreload(). This feature is off
132 by default [which means that you have both normal reload() and
76 by default [which means that you have both normal reload() and
133 dreload()].
77 dreload()].
134 .TP
78 .TP
135 .B \-editor <name>
79 .B \-\-no-autoedit-syntax
136 Which editor to use with the @edit command. By default, IPython will
80 Turn off auto editing of files with syntax errors.
137 honor your EDITOR environment variable (if not set, vi is the Unix
81 .TP
138 default and notepad the Windows one). Since this editor is invoked on
82 .B \-\-term-title
139 the fly by IPython and is meant for editing small code snippets, you
83 Enable auto setting the terminal title.
140 may want to use a small, lightweight editor here (in case your default
84 .TP
141 EDITOR is something like Emacs).
85 .B \-\-no-confirm-exit
142 .TP
86 Don't prompt the user when exiting.
143 .B \-ipythondir <name>
87 .TP
144 The name of your IPython configuration directory IPYTHON_DIR. This can
88 .B \-\-autoindent
145 also be specified through the environment variable IPYTHON_DIR.
89 Turn on autoindenting.
146 .TP
90 .TP
147 .B \-log|l
91 .B \-\-classic
148 Generate a log file of all input. The file is named ipython_log.py in your
92 Gives IPython a similar feel to the classic Python prompt.
149 current directory (which prevents logs from multiple IPython sessions from
93 .TP
150 trampling each other). You can use this to later restore a session by loading
94 .B \-\-no-automagic
151 your logfile as a file to be executed with option -logplay (see below).
95 Turn off the auto calling of magic commands.
152 .TP
96 .TP
153 .B \-logfile|lf
97 .B \-\-banner
154 Specify the name of your logfile.
98 Display a banner upon starting IPython.
155 .TP
99 .TP
156 .B \-logplay|lp
100 .B \-\-automagic
157 Replay a previous log. For restoring a session as close as possible to
101 Turn on the auto calling of magic commands. Type %%magic at the
158 the state you left it in, use this option (don't just run the
102 IPython prompt for more information.
159 logfile). With \-logplay, IPython will try to reconstruct the previous
103 .TP
160 working environment in full, not just execute the commands in the
104 .B \-\-no-deep-reload
161 logfile.
105 Disable deep (recursive) reloading by default.
162 .br
106 .TP
163 .sp 1
107 .B \-\-no-term-title
164 When a session is restored, logging is automatically turned on again
108 Disable auto setting the terminal title.
165 with the name of the logfile it was invoked with (it is read from the
109 .TP
166 log header). So once you've turned logging on for a session, you can
110 .B \-\-nosep
167 quit IPython and reload it as many times as you want and it will
111 Eliminate all spacing between prompts.
168 continue to log its history and restore from the beginning every time.
112 .TP
169 .br
113 .B \-\-i
170 .sp 1
114 also works as '-i'
171 Caveats: there are limitations in this option. The history variables
115 If running code from the command line, become interactive afterwards.
172 _i*,_* and _dh don't get restored properly. In the future we will try
116 .TP
173 to implement full session saving by writing and retrieving a
117 .B \-\-debug
174 snapshot of the memory state of IPython. But our first attempts
118 set log level to logging.DEBUG (maximize logging output)
175 failed because of inherent limitations of Python's Pickle module, so
119 .TP
176 this may have to wait.
120 .B \-\-pprint
177 .TP
121 Enable auto pretty printing of results.
178 .B \-[no]messages
122 .TP
179 Print messages which IPython collects about its startup process
123 .B \-\-quiet
180 (default on).
124 set log level to logging.CRITICAL (minimize logging output)
181 .TP
125 .TP
182 .B \-[no]pdb
126 .B \-\-pdb
183 Automatically call the pdb debugger after every uncaught exception. If
127 Enable auto calling the pdb debugger after every exception.
184 you are used to debugging using pdb, this puts you automatically
128 .TP
185 inside of it after any call (either in IPython or in code called by
129 .B \-\-color-info
186 it) which triggers an exception which goes uncaught.
130 IPython can display information about objects via a set of func-
187 .TP
131 tions, and optionally can use colors for this, syntax highlighting
188 .B \-pydb
132 source code and various other elements. However, because this
189 Makes IPython use the third party "pydb" package as debugger,
133 information is passed through a pager (like 'less') and many pagers get
190 instead of pdb. Requires that pydb is installed.
134 confused with color codes, this option is off by default. You can test
191 .TP
135 it and turn it on permanently in your ipython_config.py file if it
192 .B \-[no]pprint
136 works for you. Test it and turn it on permanently if it works with
193 IPython can optionally use the pprint (pretty printer) module for
137 your system. The magic function %%color_info allows you to toggle this
194 displaying results. pprint tends to give a nicer display of nested
138 interactively for testing.
195 data structures. If you like it, you can turn it on permanently in
139 .TP
196 your config file (default off).
140 .B \-\-init
197 .TP
141 Initialize profile with default config files
198 .B \-profile|p <name>
142 .TP
199 Assume that your config file is ipythonrc-<name> (looks in current dir
143 .B \-\-no-pdb
200 first, then in IPYTHON_DIR). This is a quick way to keep and load
144 Disable auto calling the pdb debugger after every exception.
201 multiple config files for different tasks, especially if you use the
145 .TP
202 include option of config files. You can keep a basic
146 .B \-\-quick
203 IPYTHON_DIR/ipythonrc file and then have other 'profiles' which include
147 Enable quick startup with no config files.
204 this one and load extra things for particular tasks. For example:
148 .TP
205 .br
149 .B \-\-no-color-info
206 .sp 1
150 Disable using colors for info related things.
207 1) $HOME/.ipython/ipythonrc : load basic things you always want.
151 .TP
208 .br
152 .B \-\-no-pprint
209 2) $HOME/.ipython/ipythonrc-math : load (1) and basic math-related
153 Disable auto auto pretty printing of results.
210 modules.
154 .TP
211 .br
155 .B \-\-no-banner
212 3) $HOME/.ipython/ipythonrc-numeric : load (1) and Numeric and
156 Don't display a banner upon starting IPython.
213 plotting modules.
157 .TP
214 .br
158 .B \-\-profile=<Unicode> (BaseIPythonApplication.profile)
215 .sp 1
159 Default: u'default'
216 Since it is possible to create an endless loop by having circular file
160 The IPython profile to use.
217 inclusions, IPython will stop if it reaches 15 recursive inclusions.
161 .TP
218 .TP
162 .B \-\-c=<Unicode> (InteractiveShellApp.code_to_run)
219 .B \-prompt_in1|pi1 <string>
163 Default: ''
220 Specify the string used for input prompts. Note that if you are using
164 Execute the given command string.
221 numbered prompts, the number is represented with a '\\#' in the
165 .TP
222 string. Don't forget to quote strings with spaces embedded in
166 .B \-\-logappend=<Unicode> (InteractiveShell.logappend)
223 them. Default: 'In [\\#]: '.
167 Default: ''
224 .br
168 Start logging to the given file in append mode.
225 .sp 1
169 .TP
226 Most bash-like escapes can be used to customize IPython's prompts, as well as
170 .B \-\-autocall=<Enum> (InteractiveShell.autocall)
227 a few additional ones which are IPython-specific. All valid prompt escapes
171 Default: 1
228 are described in detail in the Customization section of the IPython HTML/PDF
172 Choices: (0, 1, 2)
229 manual.
173 Make IPython automatically call any callable object even if you didn't type
230 .TP
174 explicit parentheses. For example, 'str 43' becomes 'str(43)' automatically.
231 .B \-prompt_in2|pi2 <string>
175 The value can be '0' to disable the feature, '1' for 'smart' autocall, where
232 Similar to the previous option, but used for the continuation prompts. The
176 it is not applied if there are no more arguments on the line, and '2' for
233 special sequence '\\D' is similar to '\\#', but with all digits replaced dots
177 'full' autocall, where all callable objects are automatically called (even
234 (so you can have your continuation prompt aligned with your input
178 if no arguments are present). The default is '1'.
235 prompt). Default: ' .\\D.: ' (note three spaces at the start for alignment
179 .TP
236 with 'In [\\#]').
180 .B \-\-ipython-dir=<Unicode> (BaseIPythonApplication.ipython_dir)
237 .TP
181 Default: u'/Users/minrk/.ipython'
238 .B \-prompt_out|po <string>
182 The name of the IPython directory. This directory is used for logging
239 String used for output prompts, also uses numbers like prompt_in1.
183 configuration (through profiles), history storage, etc. The default is
240 Default: 'Out[\\#]:'.
184 usually $HOME/.ipython. This options can also be specified through the
241 .TP
185 environment variable IPYTHON_DIR.
242 .B \-quick
186 .TP
243 Start in bare bones mode (no config file loaded).
187 .B \-\-gui=<CaselessStrEnum> (TerminalIPythonApp.gui)
244 .TP
188 Default: None
245 .B \-rcfile <name>
189 Choices: ('qt', 'wx', 'gtk')
246 Name of your IPython resource configuration file. normally IPython
190 Enable GUI event loop integration ('qt', 'wx', 'gtk').
247 loads ipythonrc (from current directory) or IPYTHON_DIR/ipythonrc. If
191 .TP
248 the loading of your config file fails, IPython starts with a bare
192 .B \-\-pylab=<CaselessStrEnum> (TerminalIPythonApp.pylab)
249 bones configuration (no modules loaded at all).
193 Default: None
250 .TP
194 Choices: ['tk', 'qt', 'wx', 'gtk', 'osx', 'auto']
251 .B \-[no]readline
195 Pre-load matplotlib and numpy for interactive use, selecting a particular
252 Use the readline library, which is needed to support name completion
196 matplotlib backend and loop integration.
253 and command history, among other things. It is enabled by default, but
197 .TP
254 may cause problems for users of X/Emacs in Python comint or shell
198 .B \-\-ext=<Unicode> (InteractiveShellApp.extra_extension)
255 buffers.
199 Default: ''
256 .br
200 dotted module name of an IPython extension to load.
257 .sp 1
201 .TP
258 Note that emacs 'eterm' buffers (opened with M-x term) support
202 .B \-\-log-level=<Enum> (Application.log_level)
259 IPython's readline and syntax coloring fine, only 'emacs' (M-x shell
203 Default: 30
260 and C-c !) buffers do not.
204 Choices: (0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL')
261 .TP
205 Set the log level by value or name.
262 .B \-screen_length|sl <n>
206 .TP
263 Number of lines of your screen. This is used to control printing of
207 .B \-\-colors=<CaselessStrEnum> (InteractiveShell.colors)
264 very long strings. Strings longer than this number of lines will be
208 Default: 'LightBG'
265 sent through a pager instead of directly printed.
209 Choices: ('NoColor', 'LightBG', 'Linux')
266 .br
210 Set the color scheme (NoColor, Linux, or LightBG).
267 .sp 1
211 .TP
268 The default value for this is 0, which means IPython will auto-detect
212 .B \-\-cache-size=<Int> (InteractiveShell.cache_size)
269 your screen size every time it needs to print certain potentially long
213 Default: 1000
270 strings (this doesn't change the behavior of the 'print' keyword, it's
214 Set the size of the output cache. The default is 1000, you can change it
271 only triggered internally). If for some reason this isn't working well
215 permanently in your config file. Setting it to 0 completely disables the
272 (it needs curses support), specify it yourself. Otherwise don't change
216 caching system, and the minimum value accepted is 20 (if you provide a value
273 the default.
217 less than 20, it is reset to 0 and a warning is issued). This limit is
274 .TP
218 defined because otherwise you'll spend more time re-flushing a too small
275 .B \-separate_in|si <string>
219 cache than working
276 Separator before input prompts. Default '\n'.
220 .TP
277 .TP
221 .B \-\-logfile=<Unicode> (InteractiveShell.logfile)
278 .B \-separate_out|so <string>
222 Default: ''
279 Separator before output prompts. Default: 0 (nothing).
223 The name of the logfile to use.
280 .TP
281 .B \-separate_out2|so2 <string>
282 Separator after output prompts. Default: 0 (nothing).
283 .TP
284 .B \-nosep
285 Shorthand for '\-separate_in 0 \-separate_out 0 \-separate_out2 0'.
286 Simply removes all input/output separators.
287 .TP
288 .B \-upgrade
289 Allows you to upgrade your IPYTHON_DIR configuration when you install a
290 new version of IPython. Since new versions may include new command
291 lines options or example files, this copies updated ipythonrc-type
292 files. However, it backs up (with a .old extension) all files which
293 it overwrites so that you can merge back any custimizations you might
294 have in your personal files.
295 .TP
296 .B \-Version
297 Print version information and exit.
298 .TP
299 .B -wxversion <string>
300 Select a specific version of wxPython (used in conjunction with
301 \-wthread). Requires the wxversion module, part of recent wxPython
302 distributions.
303 .TP
304 .B \-xmode <modename>
305 Mode for exception reporting. The valid modes are Plain, Context, and
306 Verbose.
307 .br
308 .sp 1
309 \- Plain: similar to python's normal traceback printing.
310 .br
311 .sp 1
312 \- Context: prints 5 lines of context source code around each line in the
313 traceback.
314 .br
315 .sp 1
316 \- Verbose: similar to Context, but additionally prints the variables
317 currently visible where the exception happened (shortening their strings if
318 too long). This can potentially be very slow, if you happen to have a huge
319 data structure whose string representation is complex to compute. Your
320 computer may appear to freeze for a while with cpu usage at 100%. If this
321 occurs, you can cancel the traceback with Ctrl-C (maybe hitting it more than
322 once).
323 .
224 .
324 .SH EMBEDDING
225 .SH EMBEDDING
325 It is possible to start an IPython instance inside your own Python
226 It is possible to start an IPython instance inside your own Python
@@ -336,4 +237,5 b" values because you won't break your code in bizarre ways by doing so."
336 IPython was written by Fernando Perez <fperez@colorado.edu>, based on earlier
237 IPython was written by Fernando Perez <fperez@colorado.edu>, based on earlier
337 code by Janko Hauser <jh@comunit.de> and Nathaniel Gray
238 code by Janko Hauser <jh@comunit.de> and Nathaniel Gray
338 <n8gray@caltech.edu>. This manual page was written by Jack Moffitt
239 <n8gray@caltech.edu>. This manual page was written by Jack Moffitt
339 <jack@xiph.org>, for the Debian project (but may be used by others).
240 <jack@xiph.org>, for the Debian project (but may be used by others), and updated by
241 Min Ragan-Kelley <benjaminrk@gmail.com> for 0.11.
General Comments 0
You need to be logged in to leave comments. Login now