##// END OF EJS Templates
Simplify interactive usage help...
anatoly techtonik -
Show More
@@ -67,11 +67,9 b' interactive_usage = """'
67 IPython -- An enhanced Interactive Python
67 IPython -- An enhanced Interactive Python
68 =========================================
68 =========================================
69
69
70 IPython offers a combination of convenient shell features, special commands
70 IPython offers fully compatible replacement for the standard Python
71 and a history mechanism for both input (command history) and output (results
71 interpreter with convenient shell features, special commands, command
72 caching, similar to Mathematica). It is intended to be a fully compatible
72 history mechanism and output results caching.
73 replacement for the standard Python interpreter, while offering vastly
74 improved functionality and flexibility.
75
73
76 At your system command line, type 'ipython -h' to see the command line
74 At your system command line, type 'ipython -h' to see the command line
77 options available. This document only describes interactive features.
75 options available. This document only describes interactive features.
@@ -93,9 +91,8 b' If you are in terminal IPython you can quit this screen by pressing `q`.'
93 MAIN FEATURES
91 MAIN FEATURES
94 -------------
92 -------------
95
93
96 * Access to the standard Python help. As of Python 2.1, a help system is
94 * Access to the standard Python help with object docstrings and the Python
97 available with access to object docstrings and the Python manuals. Simply
95 manuals. Simply type 'help' (no quotes) to invoke it.
98 type 'help' (no quotes) to access it.
99
96
100 * Magic commands: type %magic for information on the magic subsystem.
97 * Magic commands: type %magic for information on the magic subsystem.
101
98
@@ -103,13 +100,12 b' MAIN FEATURES'
103
100
104 * Dynamic object information:
101 * Dynamic object information:
105
102
106 Typing ?word or word? prints detailed information about an object. If
103 Typing ?word or word? prints detailed information about an object. Long
107 certain strings in the object are too long (docstrings, code, etc.) they get
104 strings (docstrings, code, etc.) get snipped in the center for brevity.
108 snipped in the center for brevity.
109
105
110 Typing ??word or word?? gives access to the full information without
106 Typing ??word or word?? gives access to the full information without
111 snipping long strings. Long strings are sent to the screen through the less
107 snipping long strings. Strings that are longer than the screen are printed
112 pager if longer than the screen, printed otherwise.
108 through the less pager.
113
109
114 The ?/?? system gives access to the full source code for any object (if
110 The ?/?? system gives access to the full source code for any object (if
115 available), shows function prototypes and other useful information.
111 available), shows function prototypes and other useful information.
@@ -117,18 +113,17 b' MAIN FEATURES'
117 If you just want to see an object's docstring, type '%pdoc object' (without
113 If you just want to see an object's docstring, type '%pdoc object' (without
118 quotes, and without % if you have automagic on).
114 quotes, and without % if you have automagic on).
119
115
120 * Completion in the local namespace, by typing TAB at the prompt.
116 * Tab completion in the local namespace:
121
117
122 At any time, hitting tab will complete any available python commands or
118 At any time, hitting tab will complete any available python commands or
123 variable names, and show you a list of the possible completions if there's
119 variable names, and show you a list of the possible completions if there's
124 no unambiguous one. It will also complete filenames in the current directory.
120 no unambiguous one. It will also complete filenames in the current directory.
125
121
126 * Search previous command history in two ways:
122 * Search previous command history in multiple ways:
127
123
128 - Start typing, and then use Ctrl-p (previous, up) and Ctrl-n (next,down) to
124 - Start typing, and then use Ctrl-p (previous, up) and Ctrl-n (next, down)
129 search through only the history items that match what you've typed so
125 to search through the history items that match what you've typed so
130 far. If you use Ctrl-p/Ctrl-n at a blank prompt, they just behave like
126 far. At a blank prompt, Ctrl-p/Ctrl-n behave like normal arrow keys.
131 normal arrow keys.
132
127
133 - Hit Ctrl-r: opens a search prompt. Begin typing and the system searches
128 - Hit Ctrl-r: opens a search prompt. Begin typing and the system searches
134 your history for lines that match what you've typed so far, completing as
129 your history for lines that match what you've typed so far, completing as
@@ -140,7 +135,7 b' MAIN FEATURES'
140
135
141 * Logging of input with the ability to save and restore a working session.
136 * Logging of input with the ability to save and restore a working session.
142
137
143 * System escape with !. Typing !ls will run 'ls' in the current directory.
138 * System shell with !. Typing !ls will run 'ls' in the current directory.
144
139
145 * The reload command does a 'deep' reload of a module: changes made to the
140 * The reload command does a 'deep' reload of a module: changes made to the
146 module since you imported will actually be available without having to exit.
141 module since you imported will actually be available without having to exit.
General Comments 0
You need to be logged in to leave comments. Login now