From e330dc208fa4f900ca1f79aa62da7f2a8bb977c0 2005-12-01 18:14:21 From: fperez Date: 2005-12-01 18:14:21 Subject: [PATCH] Updated manpage and docs to clarify negated options usage. Thanks to Stefan van der Walt for the heads-up. --- diff --git a/IPython/usage.py b/IPython/usage.py index 495fef8..c324874 100644 --- a/IPython/usage.py +++ b/IPython/usage.py @@ -6,7 +6,7 @@ # the file COPYING, distributed as part of this software. #***************************************************************************** -# $Id: usage.py 578 2005-05-13 21:16:51Z fperez $ +# $Id: usage.py 926 2005-12-01 18:14:21Z fperez $ from IPython import Release __author__ = '%s <%s>' % Release.authors['Fernando'] @@ -128,8 +128,8 @@ REGULAR OPTIONS See the provided examples for assistance. Options given on the comman- dline override the values set in the ipythonrc file. - All options with a no| prepended can be specified in ’no’ form (-noop- - tion instead of -option) to turn the feature off. + All options with a [no] prepended can be specified in negated form + (using -nooption instead of -option) to turn the feature off. -h, --help Show summary of options. @@ -144,25 +144,25 @@ REGULAR OPTIONS to correctly execute (without blocking) any matplotlib-based script which calls show() at the end. - -no|autocall + -[no]autocall Make IPython automatically call any callable object even if you didn’t type explicit parentheses. For example, ’str 43’ becomes ’str(43)’ automatically. - -no|autoindent + -[no]autoindent Turn automatic indentation on/off. - -no|automagic + -[no]automagic Make magic commands automatic (without needing their first char- acter to be @). Type @magic at the IPython prompt for more information. - -no|autoparens + -[no]autoparens Make IPython automatically call any callable object even if you didn’t type explicit parentheses. For example, ’str 43’ becomes ’str(43)’ automatically. - -no|banner + -[no]banner Print the intial information banner (default on). -c @@ -186,7 +186,7 @@ REGULAR OPTIONS Color scheme for prompts and exception reporting. Currently implemented: NoColor, Linux, and LightBG. - -no|color_info + -[no]color_info IPython can display information about objects via a set of func- tions, and optionally can use colors for this, syntax highlight- ing source code and various other elements. However, because @@ -201,18 +201,18 @@ REGULAR OPTIONS The magic function @color_info allows you to toggle this inter- actively for testing. - -no|confirm_exit + -[no]confirm_exit Set to confirm when you try to exit IPython with an EOF (Con- trol-D in Unix, Control-Z/Enter in Windows). Note that using the magic functions @Exit or @Quit you can force a direct exit, bypassing any confirmation. - -no|debug + -[no]debug Show information about the loading process. Very useful to pin down problems with your configuration files or to get details about session restores. - -no|deep_reload + -[no]deep_reload IPython can use the deep_reload module which reloads changes in modules recursively (it replaces the reload() function, so you don’t need to change anything to use it). deep_reload() forces a @@ -265,18 +265,18 @@ REGULAR OPTIONS retrieving a failed because of inherent limitations of Python’s Pickle module, so this may have to wait. - -no|messages + -[no]messages Print messages which IPython collects about its startup process (default on). - -no|pdb + -[no]pdb Automatically call the pdb debugger after every uncaught excep- tion. If you are used to debugging using pdb, this puts you automatically inside of it after any call (either in IPython or in code called by it) which triggers an exception which goes uncaught. - -no|pprint + -[no]pprint IPython can optionally use the pprint (pretty printer) module for displaying results. pprint tends to give a nicer display of nested data structures. If you like it, you can turn it on per- @@ -332,7 +332,7 @@ REGULAR OPTIONS IPython starts with a bare bones configuration (no modules loaded at all). - -no|readline + -[no]readline Use the readline library, which is needed to support name com- pletion and command history, among other things. It is enabled by default, but may cause problems for users of X/Emacs in diff --git a/doc/ipython.1 b/doc/ipython.1 index ac873a3..b68cba3 100644 --- a/doc/ipython.1 +++ b/doc/ipython.1 @@ -109,29 +109,29 @@ See the provided examples for assistance. Options given on the commandline override the values set in the ipythonrc file. .br .sp 1 -All options with a no| prepended can be specified in 'no' form +All options with a [no] prepended can be specified in negated form (\-nooption instead of \-option) to turn the feature off. .TP .B \-h, \-\-help Show summary of options. .TP -.B \-no|autocall +.B \-[no]autocall Make IPython automatically call any callable object even if you didn't type explicit parentheses. For example, 'str 43' becomes 'str(43)' automatically. .TP -.B \-no|autoindent +.B \-[no]autoindent Turn automatic indentation on/off. .TP -.B \-no|automagic +.B \-[no]automagic Make magic commands automatic (without needing their first character to be @). Type @magic at the IPython prompt for more information. .TP -.B \-no|autoparens +.B \-[no]autoparens Make IPython automatically call any callable object even if you didn't type explicit parentheses. For example, 'str 43' becomes 'str(43)' automatically. .TP -.B \-no|banner +.B \-[no]banner Print the intial information banner (default on). .TP .B \-c @@ -154,7 +154,7 @@ Gives IPython a similar feel to the classic Python prompt. Color scheme for prompts and exception reporting. Currently implemented: NoColor, Linux, and LightBG. .TP -.B \-no|color_info +.B \-[no]color_info IPython can display information about objects via a set of functions, and optionally can use colors for this, syntax highlighting source code and various other elements. However, because this information is @@ -169,18 +169,18 @@ Test it and turn it on permanently if it works with your system. The magic function @color_info allows you to toggle this interactively for testing. .TP -.B \-no|confirm_exit +.B \-[no]confirm_exit Set to confirm when you try to exit IPython with an EOF (Control-D in Unix, Control-Z/Enter in Windows). Note that using the magic functions @Exit or @Quit you can force a direct exit, bypassing any confirmation. .TP -.B \-no|debug +.B \-[no]debug Show information about the loading process. Very useful to pin down problems with your configuration files or to get details about session restores. .TP -.B \-no|deep_reload +.B \-[no]deep_reload IPython can use the deep_reload module which reloads changes in modules recursively (it replaces the reload() function, so you don't need to change anything to use it). deep_reload() forces a full reload @@ -237,17 +237,17 @@ to implement full session saving by writing and retrieving a failed because of inherent limitations of Python's Pickle module, so this may have to wait. .TP -.B \-no|messages +.B \-[no]messages Print messages which IPython collects about its startup process (default on). .TP -.B \-no|pdb +.B \-[no]pdb Automatically call the pdb debugger after every uncaught exception. If you are used to debugging using pdb, this puts you automatically inside of it after any call (either in IPython or in code called by it) which triggers an exception which goes uncaught. .TP -.B \-no|pprint +.B \-[no]pprint IPython can optionally use the pprint (pretty printer) module for displaying results. pprint tends to give a nicer display of nested data structures. If you like it, you can turn it on permanently in @@ -306,7 +306,7 @@ loads ipythonrc (from current directory) or IPYTHONDIR/ipythonrc. If the loading of your config file fails, IPython starts with a bare bones configuration (no modules loaded at all). .TP -.B \-no|readline +.B \-[no]readline Use the readline library, which is needed to support name completion and command history, among other things. It is enabled by default, but may cause problems for users of X/Emacs in Python comint or shell diff --git a/doc/manual_base.lyx b/doc/manual_base.lyx index 6cd020f..49b2eec 100644 --- a/doc/manual_base.lyx +++ b/doc/manual_base.lyx @@ -2614,9 +2614,9 @@ Most options can also be set from your ipythonrc configuration file. All options with a \family typewriter -no| +[no] \family default - prepended can be specified in 'no' form ( + prepended can be specified in negated form ( \family typewriter -nooption \family default @@ -2689,7 +2689,7 @@ show() \family typewriter \series bold --no|automagic +-[no]automagic \series default : \family default @@ -2710,7 +2710,7 @@ show() \family typewriter \series bold --no|banner +-[no]banner \series default : \family default @@ -2782,7 +2782,7 @@ show() \family typewriter \series bold --no|color_info: +-[no]color_info: \family default \series default IPython can display information about objects via a set of functions, and @@ -2810,7 +2810,7 @@ show() \family typewriter \series bold --no|debug +-[no]debug \family default \series default : Show information about the loading process. @@ -2822,7 +2822,7 @@ show() \family typewriter \series bold --no|deep_reload +-[no]deep_reload \series default : \family default @@ -3006,7 +3006,7 @@ _dh \family typewriter \series bold --no|messages +-[no]messages \series default : \family default @@ -3018,7 +3018,7 @@ _dh \family typewriter \series bold --no|pdb +-[no]pdb \family default \series default : Automatically call the pdb debugger after every uncaught exception. @@ -3031,7 +3031,7 @@ _dh \family typewriter \series bold --no|pprint +-[no]pprint \series default : \family default @@ -3251,7 +3251,7 @@ Out[ \family typewriter \series bold --no|readline +-[no]readline \family default \series default : use the readline library, which is needed to support name completion and diff --git a/setup.py b/setup.py index d11fee8..de5a746 100755 --- a/setup.py +++ b/setup.py @@ -96,6 +96,9 @@ def file_doesnt_endwith(test,endings): # I can't find how to make distutils create a nested dir. structure, so # in the meantime do it manually. Butt ugly. +# Note that http://www.redbrick.dcu.ie/~noel/distutils.html, ex. 2/3, contain +# information on how to do this more cleanly once python 2.4 can be assumed. +# Thanks to Noel for the tip. docdirbase = 'share/doc/ipython-%s' % version manpagebase = 'share/man/man1'