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