##// END OF EJS Templates
ipython.rst: option list restification attempt, still slightly botched
Ville M. Vainio -
Show More
This diff has been collapsed as it changes many lines, (564 lines changed) Show them Hide them
@@ -992,50 +992,58 b' command line, and not later. This is because they control the initial-'
992 ization of ipython itself, before the normal option-handling mechanism
992 ization of ipython itself, before the normal option-handling mechanism
993 is active.
993 is active.
994
994
995 * [-gthread, -qthread, -q4thread, -wthread, -pylab:] Only one of
995 -gthread, -qthread, -q4thread, -wthread, -pylab:
996 these can be given, and it can only be given as the first option
996 Only one of these can be given, and it can only be given as
997 passed to IPython (it will have no effect in any other position).
997 the first option passed to IPython (it will have no effect in
998 They provide threading support for the GTK, Qt (versions 3 and 4)
998 any other position). They provide threading support for the
999 and WXPython toolkits, and for the matplotlib library.
999 GTK, Qt (versions 3 and 4) and WXPython toolkits, and for the
1000 * [ ] With any of the first four options, IPython starts running a
1000 matplotlib library.
1001 separate thread for the graphical toolkit's operation, so that you
1001
1002 can open and control graphical elements from within an IPython
1002 With any of the first four options, IPython starts running a
1003 command line, without blocking. All four provide essentially the
1003 separate thread for the graphical toolkit's operation, so that
1004 same functionality, respectively for GTK, Qt3, Qt4 and WXWidgets
1004 you can open and control graphical elements from within an
1005 (via their Python interfaces).
1005 IPython command line, without blocking. All four provide
1006 * [ ] Note that with -wthread, you can additionally use the
1006 essentially the same functionality, respectively for GTK, Qt3,
1007 -wxversion option to request a specific version of wx to be used.
1007 Qt4 and WXWidgets (via their Python interfaces).
1008 This requires that you have the wxversion Python module installed,
1008
1009 which is part of recent wxPython distributions.
1009 Note that with -wthread, you can additionally use the
1010 * [ ] If -pylab is given, IPython loads special support for the mat
1010 -wxversion option to request a specific version of wx to be
1011 plotlib library (http://matplotlib.sourceforge.net), allowing
1011 used. This requires that you have the wxversion Python module
1012 interactive usage of any of its backends as defined in the user's
1012 installed, which is part of recent wxPython distributions.
1013 ~/.matplotlib/matplotlibrc file. It automatically activates GTK,
1013
1014 Qt or WX threading for IPyhton if the choice of matplotlib backend
1014 If -pylab is given, IPython loads special support for the mat
1015 requires it. It also modifies the %run command to correctly
1015 plotlib library (http://matplotlib.sourceforge.net), allowing
1016 execute (without blocking) any matplotlib-based script which calls
1016 interactive usage of any of its backends as defined in the
1017 show() at the end.
1017 user's ~/.matplotlib/matplotlibrc file. It automatically
1018 * [-tk] The -g/q/q4/wthread options, and -pylab (if matplotlib is
1018 activates GTK, Qt or WX threading for IPyhton if the choice of
1019 configured to use GTK, Qt3, Qt4 or WX), will normally block Tk
1019 matplotlib backend requires it. It also modifies the %run
1020 graphical interfaces. This means that when either GTK, Qt or WX
1020 command to correctly execute (without blocking) any
1021 threading is active, any attempt to open a Tk GUI will result in a
1021 matplotlib-based script which calls show() at the end.
1022 dead window, and possibly cause the Python interpreter to crash.
1022
1023 An extra option, -tk, is available to address this issue. It can
1023 -tk
1024 only be given as a second option after any of the above (-gthread,
1024 The -g/q/q4/wthread options, and -pylab (if matplotlib is
1025 -wthread or -pylab).
1025 configured to use GTK, Qt3, Qt4 or WX), will normally block Tk
1026 * [ ] If -tk is given, IPython will try to coordinate Tk threading
1026 graphical interfaces. This means that when either GTK, Qt or WX
1027 with GTK, Qt or WX. This is however potentially unreliable, and
1027 threading is active, any attempt to open a Tk GUI will result in a
1028 you will have to test on your platform and Python configuration to
1028 dead window, and possibly cause the Python interpreter to crash.
1029 determine whether it works for you. Debian users have reported
1029 An extra option, -tk, is available to address this issue. It can
1030 success, apparently due to the fact that Debian builds all of Tcl,
1030 only be given as a second option after any of the above (-gthread,
1031 Tk, Tkinter and Python with pthreads support. Under other Linux
1031 -wthread or -pylab).
1032 environments (such as Fedora Core 2/3), this option has caused
1032
1033 random crashes and lockups of the Python interpreter. Under other
1033 If -tk is given, IPython will try to coordinate Tk threading
1034 operating systems (Mac OSX and Windows), you'll need to try it to
1034 with GTK, Qt or WX. This is however potentially unreliable, and
1035 find out, since currently no user reports are available.
1035 you will have to test on your platform and Python configuration to
1036 * [ ] There is unfortunately no way for IPython to determine at run
1036 determine whether it works for you. Debian users have reported
1037 time whether -tk will work reliably or not, so you will need to do
1037 success, apparently due to the fact that Debian builds all of Tcl,
1038 some experiments before relying on it for regular work.
1038 Tk, Tkinter and Python with pthreads support. Under other Linux
1039 environments (such as Fedora Core 2/3), this option has caused
1040 random crashes and lockups of the Python interpreter. Under other
1041 operating systems (Mac OSX and Windows), you'll need to try it to
1042 find out, since currently no user reports are available.
1043
1044 There is unfortunately no way for IPython to determine at run time
1045 whether -tk will work reliably or not, so you will need to do some
1046 experiments before relying on it for regular work.
1039
1047
1040
1048
1041
1049
@@ -1054,199 +1062,283 b' given at the command line override the values set in the ipythonrc file.'
1054 All options with a [no] prepended can be specified in negated form
1062 All options with a [no] prepended can be specified in negated form
1055 (-nooption instead of -option) to turn the feature off.
1063 (-nooption instead of -option) to turn the feature off.
1056
1064
1057 * [-help:] print a help message and exit.
1065 -help print a help message and exit.
1058 * [-pylab:] this can only be given as the first option passed to
1066
1059 IPython (it will have no effect in any other position). It adds
1067 -pylab
1060 special support for the matplotlib library
1068 this can only be given as the first option passed to IPython
1061 (http://matplotlib.sourceforge.net
1069 (it will have no effect in any other position). It adds
1062 http://matplotlib.sourceforge.net), allowing interactive usage of
1070 special support for the matplotlib library
1063 any of its backends as defined in the user's .matplotlibrc file.
1071 (http://matplotlib.sourceforge.ne), allowing interactive usage
1064 It automatically activates GTK or WX threading for IPyhton if the
1072 of any of its backends as defined in the user's .matplotlibrc
1065 choice of matplotlib backend requires it. It also modifies the
1073 file. It automatically activates GTK or WX threading for
1066 %run command to correctly execute (without blocking) any
1074 IPyhton if the choice of matplotlib backend requires it. It
1067 matplotlib-based script which calls show() at the end. See
1075 also modifies the %run command to correctly execute (without
1068 `Matplotlib support`_ for more details.
1076 blocking) any matplotlib-based script which calls show() at
1069 * [-autocall] <val>: Make IPython automatically call any callable
1077 the end. See `Matplotlib support`_ for more details.
1070 object even if you didn't type explicit parentheses. For example,
1078
1071 'str 43' becomes 'str(43)' automatically. The value can be '0' to
1079 -autocall <val>
1072 disable the feature, '1' for smart autocall, where it is not
1080 Make IPython automatically call any callable object even if you
1073 applied if there are no more arguments on the line, and '2' for
1081 didn't type explicit parentheses. For example, 'str 43' becomes
1074 full autocall, where all callable objects are automatically called
1082 'str(43)' automatically. The value can be '0' to disable the feature,
1075 (even if no arguments are present). The default is '1'.
1083 '1' for smart autocall, where it is not applied if there are no more
1076 * [-[no]autoindent:] Turn automatic indentation on/off.
1084 arguments on the line, and '2' for full autocall, where all callable
1077 * [-[no]automagic:] make magic commands automatic (without needing
1085 objects are automatically called (even if no arguments are
1078 their first character to be %). Type %magic at the IPython prompt
1086 present). The default is '1'.
1079 for more information.
1087
1080 * [-[no]autoedit_syntax:] When a syntax error occurs after editing a
1088 -[no]autoindent
1081 file, automatically open the file to the trouble causing line for
1089 Turn automatic indentation on/off.
1082 convenient fixing.
1090
1083 * [-[no]banner:] Print the initial information banner (default on).
1091 -[no]automagic
1084 * [-c <command>:] execute the given command string, and set sys.argv
1092 make magic commands automatic (without needing their first character
1085 to ['c']. This is similar to the -c option in the normal Python
1093 to be %). Type %magic at the IPython prompt for more information.
1086 interpreter.
1094
1087 * [-cache_size|cs <n>:] size of the output cache (maximum number of
1095 -[no]autoedit_syntax
1088 entries to hold in memory). The default is 1000, you can change it
1096 When a syntax error occurs after editing a file, automatically
1089 permanently in your config file. Setting it to 0 completely
1097 open the file to the trouble causing line for convenient
1090 disables the caching system, and the minimum value accepted is 20
1098 fixing.
1091 (if you provide a value less than 20, it is reset to 0 and a
1099
1092 warning is issued) This limit is defined because otherwise you'll
1100 -[no]banner Print the initial information banner (default on).
1093 spend more time re-flushing a too small cache than working.
1101
1094 * [-classic|cl:] Gives IPython a similar feel to the classic Python
1102 -c <command>
1095 prompt.
1103 execute the given command string. This is similar to the -c
1096 * [-colors <scheme>:] Color scheme for prompts and exception
1104 option in the normal Python interpreter.
1097 reporting. Currently implemented: NoColor, Linux and LightBG.
1105
1098 * [-[no]color_info:] IPython can display information about objects
1106 -cache_size, cs <n>
1099 via a set of functions, and optionally can use colors for this,
1107 size of the output cache (maximum number of entries to hold in
1100 syntax highlighting source code and various other elements.
1108 memory). The default is 1000, you can change it permanently in your
1101 However, because this information is passed through a pager (like
1109 config file. Setting it to 0 completely disables the caching system,
1102 'less') and many pagers get confused with color codes, this option
1110 and the minimum value accepted is 20 (if you provide a value less than
1103 is off by default. You can test it and turn it on permanently in
1111 20, it is reset to 0 and a warning is issued) This limit is defined
1104 your ipythonrc file if it works for you. As a reference, the
1112 because otherwise you'll spend more time re-flushing a too small cache
1105 'less' pager supplied with Mandrake 8.2 works ok, but that in
1113 than working.
1106 RedHat 7.2 doesn't.
1114
1107 * [ ] Test it and turn it on permanently if it works with your
1115 -classic, cl
1108 system. The magic function %color_info allows you to toggle this
1116 Gives IPython a similar feel to the classic Python
1109 interactively for testing.
1117 prompt.
1110 * [-[no]debug:] Show information about the loading process. Very
1118
1111 useful to pin down problems with your configuration files or to
1119 -colors <scheme>
1112 get details about session restores.
1120 Color scheme for prompts and exception reporting. Currently
1113 * [-[no]deep_reload:] IPython can use the deep_reload module which
1121 implemented: NoColor, Linux and LightBG.
1114 reloads changes in modules recursively (it replaces the reload()
1122
1115 function, so you don't need to change anything to use it).
1123 -[no]color_info
1116 deep_reload() forces a full reload of modules whose code may have
1124 IPython can display information about objects via a set of functions,
1117 changed, which the default reload() function does not.
1125 and optionally can use colors for this, syntax highlighting source
1118 * [ ] When deep_reload is off, IPython will use the normal reload(),
1126 code and various other elements. However, because this information is
1119 but deep_reload will still be available as dreload(). This feature
1127 passed through a pager (like 'less') and many pagers get confused with
1120 is off by default [which means that you have both normal reload()
1128 color codes, this option is off by default. You can test it and turn
1121 and dreload()].
1129 it on permanently in your ipythonrc file if it works for you. As a
1122 * [-editor <name>:] Which editor to use with the %edit command. By
1130 reference, the 'less' pager supplied with Mandrake 8.2 works ok, but
1123 default, IPython will honor your EDITOR environment variable (if
1131 that in RedHat 7.2 doesn't.
1124 not set, vi is the Unix default and notepad the Windows one).
1132
1125 Since this editor is invoked on the fly by IPython and is meant
1133 Test it and turn it on permanently if it works with your
1126 for editing small code snippets, you may want to use a small,
1134 system. The magic function %color_info allows you to toggle this
1127 lightweight editor here (in case your default EDITOR is something
1135 interactively for testing.
1128 like Emacs).
1136
1129 * [-ipythondir <name>:] name of your IPython configuration directory
1137 -[no]debug
1130 IPYTHONDIR. This can also be specified through the environment
1138 Show information about the loading process. Very useful to pin down
1131 variable IPYTHONDIR.
1139 problems with your configuration files or to get details about
1132 * [-log|l:] generate a log file of all input. The file is named
1140 session restores.
1133 ipython_log.py in your current directory (which prevents logs from
1141
1134 multiple IPython sessions from trampling each other). You can use
1142 -[no]deep_reload:
1135 this to later restore a session by loading your logfile as a file
1143 IPython can use the deep_reload module which reloads changes in
1136 to be executed with option -logplay (see below).
1144 modules recursively (it replaces the reload() function, so you don't
1137 * [-logfile|lf <name>:] specify the name of your logfile.
1145 need to change anything to use it). deep_reload() forces a full
1138 * [-logplay|lp <name>:] you can replay a previous log. For restoring
1146 reload of modules whose code may have changed, which the default
1139 a session as close as possible to the state you left it in, use
1147 reload() function does not.
1140 this option (don't just run the logfile). With -logplay, IPython
1148
1141 will try to reconstruct the previous working environment in full,
1149 When deep_reload is off, IPython will use the normal reload(),
1142 not just execute the commands in the logfile.
1150 but deep_reload will still be available as dreload(). This
1143 * [ ] When a session is restored, logging is automatically turned on
1151 feature is off by default [which means that you have both
1144 again with the name of the logfile it was invoked with (it is read
1152 normal reload() and dreload()].
1145 from the log header). So once you've turned logging on for a
1153
1146 session, you can quit IPython and reload it as many times as you
1154 -editor <name>
1147 want and it will continue to log its history and restore from the
1155 Which editor to use with the %edit command. By default,
1148 beginning every time.
1156 IPython will honor your EDITOR environment variable (if not
1149 * [ ] Caveats: there are limitations in this option. The history
1157 set, vi is the Unix default and notepad the Windows one).
1158 Since this editor is invoked on the fly by IPython and is
1159 meant for editing small code snippets, you may want to use a
1160 small, lightweight editor here (in case your default EDITOR is
1161 something like Emacs).
1162
1163 -ipythondir <name>
1164 name of your IPython configuration directory IPYTHONDIR. This
1165 can also be specified through the environment variable
1166 IPYTHONDIR.
1167
1168 -log, l
1169 generate a log file of all input. The file is named
1170 ipython_log.py in your current directory (which prevents logs
1171 from multiple IPython sessions from trampling each other). You
1172 can use this to later restore a session by loading your
1173 logfile as a file to be executed with option -logplay (see
1174 below).
1175
1176 -logfile, lf <name> specify the name of your logfile.
1177
1178 -logplay, lp <name>
1179
1180 you can replay a previous log. For restoring a session as close as
1181 possible to the state you left it in, use this option (don't just run
1182 the logfile). With -logplay, IPython will try to reconstruct the
1183 previous working environment in full, not just execute the commands in
1184 the logfile.
1185
1186 When a session is restored, logging is automatically turned on
1187 again with the name of the logfile it was invoked with (it is
1188 read from the log header). So once you've turned logging on for
1189 a session, you can quit IPython and reload it as many times as
1190 you want and it will continue to log its history and restore
1191 from the beginning every time.
1192
1193 Caveats: there are limitations in this option. The history
1150 variables _i*,_* and _dh don't get restored properly. In the
1194 variables _i*,_* and _dh don't get restored properly. In the
1151 future we will try to implement full session saving by writing and
1195 future we will try to implement full session saving by writing
1152 retrieving a 'snapshot' of the memory state of IPython. But our
1196 and retrieving a 'snapshot' of the memory state of IPython. But
1153 first attempts failed because of inherent limitations of Python's
1197 our first attempts failed because of inherent limitations of
1154 Pickle module, so this may have to wait.
1198 Python's Pickle module, so this may have to wait.
1155 * [-[no]messages:] Print messages which IPython collects about its
1199
1156 startup process (default on).
1200 -[no]messages
1157 * [-[no]pdb:] Automatically call the pdb debugger after every
1201 Print messages which IPython collects about its startup
1158 uncaught exception. If you are used to debugging using pdb, this
1202 process (default on).
1159 puts you automatically inside of it after any call (either in
1203
1160 IPython or in code called by it) which triggers an exception which
1204 -[no]pdb
1161 goes uncaught.
1205 Automatically call the pdb debugger after every uncaught
1162 * [-[no]pprint:] ipython can optionally use the pprint (pretty
1206 exception. If you are used to debugging using pdb, this puts
1163 printer) module for displaying results. pprint tends to give a
1207 you automatically inside of it after any call (either in
1164 nicer display of nested data structures. If you like it, you can
1208 IPython or in code called by it) which triggers an exception
1165 turn it on permanently in your config file (default off).
1209 which goes uncaught.
1166 * [-profile|p] <name>: assume that your config file is
1210
1167 ipythonrc-<name> (looks in current dir first, then in IPYTHONDIR).
1211 -[no]pprint
1168 This is a quick way to keep and load multiple config files for
1212 ipython can optionally use the pprint (pretty printer) module
1169 different tasks, especially if you use the include option of
1213 for displaying results. pprint tends to give a nicer display
1170 config files. You can keep a basic IPYTHONDIR/ipythonrc file and
1214 of nested data structures. If you like it, you can turn it on
1171 then have other 'profiles' which include this one and load extra
1215 permanently in your config file (default off).
1172 things for particular tasks. For example:
1216
1173 * [ ] 1. $HOME/.ipython/ipythonrc : load basic things you always want.
1217 -profile, p <name>
1174 * [ ] 2. $HOME/.ipython/ipythonrc-math : load (1) and basic
1218
1175 math-related modules.
1219 assume that your config file is ipythonrc-<name> or
1176 * [ ] 3. $HOME/.ipython/ipythonrc-numeric : load (1) and Numeric and
1220 ipy_profile_<name>.py (looks in current dir first, then in
1177 plotting modules.
1221 IPYTHONDIR). This is a quick way to keep and load multiple
1178 * [ ] Since it is possible to create an endless loop by having
1222 config files for different tasks, especially if you use the
1179 circular file inclusions, IPython will stop if it reaches 15
1223 include option of config files. You can keep a basic
1180 recursive inclusions.
1224 IPYTHONDIR/ipythonrc file and then have other 'profiles' which
1181 * [-prompt_in1|pi1 <string>:] Specify the string used for input
1225 include this one and load extra things for particular
1182 prompts. Note that if you are using numbered prompts, the number
1226 tasks. For example:
1183 is represented with a '\#' in the string. Don't forget to quote
1227
1184 strings with spaces embedded in them. Default: 'In [\#]:'.
1228 1. $HOME/.ipython/ipythonrc : load basic things you always want.
1185 Sec. Prompts_ discusses in detail all the
1229 2. $HOME/.ipython/ipythonrc-math : load (1) and basic math-related modules.
1186 available escapes to customize your prompts.
1230 3. $HOME/.ipython/ipythonrc-numeric : load (1) and Numeric and plotting modules.
1187 * [-prompt_in2|pi2 <string>:] Similar to the previous option, but
1231
1188 used for the continuation prompts. The special sequence '\D' is
1232 Since it is possible to create an endless loop by having
1189 similar to '\#', but with all digits replaced dots (so you can
1233 circular file inclusions, IPython will stop if it reaches 15
1190 have your continuation prompt aligned with your input prompt).
1234 recursive inclusions.
1191 Default: ' .\D.:' (note three spaces at the start for alignment
1235
1192 with 'In [\#]').
1236 -prompt_in1, pi1 <string>
1193 * [-prompt_out|po <string>:] String used for output prompts, also
1237 Specify the string used for input prompts. Note that if you
1194 uses numbers like prompt_in1. Default: 'Out[\#]:'
1238 are using numbered prompts, the number is represented with a
1195 * [-quick:] start in bare bones mode (no config file loaded).
1239 '\#' in the string. Don't forget to quote strings with spaces
1196 * [-rcfile <name>:] name of your IPython resource configuration
1240 embedded in them. Default: 'In [\#]:'. Sec. Prompts_
1197 file. Normally IPython loads ipythonrc (from current directory) or
1241 discusses in detail all the available escapes to customize
1198 IPYTHONDIR/ipythonrc.
1242 your prompts.
1199 * [ ] If the loading of your config file fails, IPython starts with
1243
1200 a bare bones configuration (no modules loaded at all).
1244 -prompt_in2, pi2 <string>
1201 * [-[no]readline:] use the readline library, which is needed to
1245 Similar to the previous option, but used for the continuation
1202 support name completion and command history, among other things.
1246 prompts. The special sequence '\D' is similar to '\#', but
1203 It is enabled by default, but may cause problems for users of
1247 with all digits replaced dots (so you can have your
1204 X/Emacs in Python comint or shell buffers.
1248 continuation prompt aligned with your input prompt). Default:
1205 * [ ] Note that X/Emacs 'eterm' buffers (opened with M-x term)
1249 ' .\D.:' (note three spaces at the start for alignment with
1206 support IPython's readline and syntax coloring fine, only 'emacs'
1250 'In [\#]').
1207 (M-x shell and C-c !) buffers do not.
1251
1208 * [-screen_length|sl <n>:] number of lines of your screen. This is
1252 -prompt_out,po <string>
1209 used to control printing of very long strings. Strings longer than
1253 String used for output prompts, also uses numbers like
1210 this number of lines will be sent through a pager instead of
1254 prompt_in1. Default: 'Out[\#]:'
1211 directly printed.
1255
1212 * [ ] The default value for this is 0, which means IPython will
1256 -quick start in bare bones mode (no config file loaded).
1213 auto-detect your screen size every time it needs to print certain
1257
1214 potentially long strings (this doesn't change the behavior of the
1258 -rcfile <name>
1215 'print' keyword, it's only triggered internally). If for some
1259 name of your IPython resource configuration file. Normally
1216 reason this isn't working well (it needs curses support), specify
1260 IPython loads ipythonrc (from current directory) or
1217 it yourself. Otherwise don't change the default.
1261 IPYTHONDIR/ipythonrc.
1218 * [-separate_in|si <string>:] separator before input prompts.
1262
1219 Default: '\n'
1263 If the loading of your config file fails, IPython starts with
1220 * [-separate_out|so <string>:] separator before output prompts.
1264 a bare bones configuration (no modules loaded at all).
1221 Default: nothing.
1265
1222 * [-separate_out2|so2 <string>:] separator after output prompts.
1266 -[no]readline
1223 Default: nothing.
1267 use the readline library, which is needed to support name
1224 * [ ] For these three options, use the value 0 to specify no separator.
1268 completion and command history, among other things. It is
1225 * [-nosep:] shorthand for '-SeparateIn 0 -SeparateOut 0
1269 enabled by default, but may cause problems for users of
1226 -SeparateOut2 0'. Simply removes all input/output separators.
1270 X/Emacs in Python comint or shell buffers.
1227 * [-upgrade:] allows you to upgrade your IPYTHONDIR configuration
1271
1228 when you install a new version of IPython. Since new versions may
1272 Note that X/Emacs 'eterm' buffers (opened with M-x term) support
1229 include new command line options or example files, this copies
1273 IPython's readline and syntax coloring fine, only 'emacs' (M-x
1230 updated ipythonrc-type files. However, it backs up (with a .old
1274 shell and C-c !) buffers do not.
1231 extension) all files which it overwrites so that you can merge
1275
1232 back any customizations you might have in your personal files.
1276 -screen_length, sl <n>
1233 * [-Version:] print version information and exit.
1277 number of lines of your screen. This is used to control
1234 * [-wxversion <string>:] Select a specific version of wxPython (used
1278 printing of very long strings. Strings longer than this number
1235 in conjunction with -wthread). Requires the wxversion module, part
1279 of lines will be sent through a pager instead of directly
1236 of recent wxPython distributions
1280 printed.
1237 * [-xmode <modename>:] Mode for exception reporting.
1281
1238 * [ ] Valid modes: Plain, Context and Verbose.
1282 The default value for this is 0, which means IPython will
1239 * [ ] Plain: similar to python's normal traceback printing.
1283 auto-detect your screen size every time it needs to print certain
1240 * [ ] Context: prints 5 lines of context source code around each
1284 potentially long strings (this doesn't change the behavior of the
1241 line in the traceback.
1285 'print' keyword, it's only triggered internally). If for some
1242 * [ ] Verbose: similar to Context, but additionally prints the
1286 reason this isn't working well (it needs curses support), specify
1243 variables currently visible where the exception happened
1287 it yourself. Otherwise don't change the default.
1244 (shortening their strings if too long). This can potentially be
1288
1245 very slow, if you happen to have a huge data structure whose
1289 -separate_in, si <string>
1246 string representation is complex to compute. Your computer may
1290
1247 appear to freeze for a while with cpu usage at 100%. If this
1291 separator before input prompts.
1248 occurs, you can cancel the traceback with Ctrl-C (maybe hitting it
1292 Default: '\n'
1249 more than once).
1293
1294 -separate_out, so <string>
1295 separator before output prompts.
1296 Default: nothing.
1297
1298 -separate_out2, so2
1299 separator after output prompts.
1300 Default: nothing.
1301 For these three options, use the value 0 to specify no separator.
1302
1303 -nosep
1304 shorthand for '-SeparateIn 0 -SeparateOut 0 -SeparateOut2
1305 0'. Simply removes all input/output separators.
1306
1307 -upgrade
1308 allows you to upgrade your IPYTHONDIR configuration when you
1309 install a new version of IPython. Since new versions may
1310 include new command line options or example files, this copies
1311 updated ipythonrc-type files. However, it backs up (with a
1312 .old extension) all files which it overwrites so that you can
1313 merge back any customizations you might have in your personal
1314 files. Note that you should probably use %upgrade instead,
1315 it's a safer alternative.
1316
1317
1318 -Version print version information and exit.
1319
1320 -wxversion <string>
1321 Select a specific version of wxPython (used in conjunction
1322 with -wthread). Requires the wxversion module, part of recent
1323 wxPython distributions
1324
1325 -xmode <modename>
1326
1327 Mode for exception reporting.
1328
1329 Valid modes: Plain, Context and Verbose.
1330
1331 * Plain: similar to python's normal traceback printing.
1332 * Context: prints 5 lines of context source code around each
1333 line in the traceback.
1334 * Verbose: similar to Context, but additionally prints the
1335 variables currently visible where the exception happened
1336 (shortening their strings if too long). This can potentially be
1337 very slow, if you happen to have a huge data structure whose
1338 string representation is complex to compute. Your computer may
1339 appear to freeze for a while with cpu usage at 100%. If this
1340 occurs, you can cancel the traceback with Ctrl-C (maybe hitting it
1341 more than once).
1250
1342
1251 Interactive use
1343 Interactive use
1252 ===============
1344 ===============
General Comments 0
You need to be logged in to leave comments. Login now