Lib/idlelib/help.txt

   1 [See the end of this file for ** TIPS ** on using IDLE !!]
   2
   3 Click on the dotted line at the top of a menu to "tear it off": a
   4 separate window containing the menu is created.
   5
   6 File Menu:
   7
   8         New Window       -- Create a new editing window
   9         Open...          -- Open an existing file
  10         Recent Files...  -- Open a list of recent files
  11         Open Module...   -- Open an existing module (searches sys.path)
  12         Class Browser    -- Show classes and methods in current file
  13         Path Browser     -- Show sys.path directories, modules, classes
  14                             and methods
  15         ---
  16         Save             -- Save current window to the associated file (unsaved
  17                             windows have a * before and after the window title)
  18
  19         Save As...       -- Save current window to new file, which becomes
  20                             the associated file
  21         Save Copy As...  -- Save current window to different file
  22                             without changing the associated file
  23         ---
  24         Print Window     -- Print the current window
  25         ---
  26         Close            -- Close current window (asks to save if unsaved)
  27         Exit             -- Close all windows, quit (asks to save if unsaved)
  28
  29 Edit Menu:
  30
  31         Undo             -- Undo last change to current window
  32                             (A maximum of 1000 changes may be undone)
  33         Redo             -- Redo last undone change to current window
  34         ---
  35         Cut              -- Copy a selection into system-wide clipboard,
  36                             then delete the selection
  37         Copy             -- Copy selection into system-wide clipboard
  38         Paste            -- Insert system-wide clipboard into window
  39         Select All       -- Select the entire contents of the edit buffer
  40         ---
  41         Find...          -- Open a search dialog box with many options
  42         Find Again       -- Repeat last search
  43         Find Selection   -- Search for the string in the selection
  44         Find in Files... -- Open a search dialog box for searching files
  45         Replace...       -- Open a search-and-replace dialog box
  46         Go to Line       -- Ask for a line number and show that line
  47         Expand Word      -- Expand the word you have typed to match another
  48                             word in the same buffer; repeat to get a
  49                             different expansion
  50
  51 Format Menu (only in Edit window):
  52
  53         Indent Region       -- Shift selected lines right 4 spaces
  54         Dedent Region       -- Shift selected lines left 4 spaces
  55         Comment Out Region  -- Insert ## in front of selected lines
  56         Uncomment Region    -- Remove leading # or ## from selected lines
  57         Tabify Region       -- Turns *leading* stretches of spaces into tabs
  58         Untabify Region     -- Turn *all* tabs into the right number of spaces
  59         New Indent Width... -- Open dialog to change indent width
  60         Format Paragraph    -- Reformat the current blank-line-separated
  61                                paragraph
  62
  63 Run Menu (only in Edit window):
  64
  65         Python Shell -- Open or wake up the Python shell window
  66         ---
  67         Check Module -- Run a syntax check on the module
  68         Run Module   -- Execute the current file in the __main__ namespace
  69
  70 Shell Menu (only in Shell window):
  71
  72         View Last Restart -- Scroll the shell window to the last restart
  73         Restart Shell     -- Restart the interpreter with a fresh environment
  74
  75 Debug Menu (only in Shell window):
  76
  77         Go to File/Line   -- look around the insert point for a filename
  78                              and linenumber, open the file, and show the line
  79         Debugger (toggle) -- Run commands in the shell under the debugger
  80         Stack Viewer      -- Show the stack traceback of the last exception
  81         Auto-open Stack Viewer (toggle) -- Open stack viewer on traceback
  82
  83 Options Menu:
  84
  85         Configure IDLE -- Open a configuration dialog.  Fonts, indentation,
  86                           keybindings, and color themes may be altered.
  87                           Startup Preferences may be set, and Additional Help
  88                           Souces can be specified.
  89         ---
  90         Revert to Default Settings -- Restore original settings.  Not
  91                                       currently implemented - simply delete
  92                                       your .idlerc file.
  93
  94 Windows Menu:
  95
  96         Zoom Height -- toggles the window between configured size
  97         and maximum height.
  98         ---
  99         The rest of this menu lists the names of all open windows;
 100         select one to bring it to the foreground (deiconifying it if
 101         necessary).
 102
 103 Help Menu:
 104
 105         About IDLE  -- Version, copyright, license, credits
 106         IDLE Readme -- Background discussion and change details
 107         ---
 108         IDLE Help   -- Display this file
 109         Python Docs -- Access local Python documentation, if
 110                        installed.  Otherwise, access www.python.org.
 111         ---
 112         (Additional Help Sources may be added here)
 113
 114
 115 ** TIPS **
 116 ==========
 117
 118 Additional Help Sources:
 119
 120         Windows users can Google on pythlp.chm and zopeshelf.chm to access help
 121         files in the Windows help format.  The Additional Help Sources feature
 122         of the configuration GUI supports .chm, along with any other filetypes
 123         supported by your browser.  Supply a Menu Item title, and enter the
 124         location in the Help File Path slot of the New Help Source dialog.  Use
 125         http:// and/or www. to identify external URLs, or download the file and
 126         browse for its path on your machine using the Browse button.
 127
 128         All users can access the extensive sources of help, including
 129         tutorials, available at www.python.org/doc.  Selected URLs can be added
 130         or removed from the Help menu at any time using Configure IDLE.
 131
 132 Basic editing and navigation:
 133
 134         Backspace deletes to the left; DEL deletes to the right
 135         Arrow keys and Page Up/Down to move around
 136         Home/End go to begin/end of line
 137         Control-Home/End go to begin/end of file
 138         Some Emacs or standard Windows bindings may work.
 139         Keybindings are selected in the Settings Dialog, look there.
 140
 141 Automatic indentation:
 142
 143         After a block-opening statement, the next line is indented by
 144         4 spaces (in the Python Shell window by one tab).  After
 145         certain keywords (break, return etc.) the next line is
 146         dedented.  In leading indentation, Backspace deletes up to 4
 147         spaces if they are there.  Tab inserts spaces (in the
 148         Python Shell window one tab), number depends on Indent Width.
 149         (N.B. Currently tabs are restricted to four spaces due to Tcl/Tk
 150         issues.)
 151
 152         See also the indent/dedent region commands in the edit menu.
 153
 154 Python Shell window:
 155
 156         ^C interrupts executing command
 157         ^D sends end-of-file; closes window if typed at >>> prompt
 158
 159     Command history:
 160
 161         Alt-p retrieves previous command matching what you have typed
 162         Alt-n retrieves next
 163         Return while on any previous command retrieves that command
 164         Alt-/ (Expand word) is also useful here
 165
 166     Syntax colors:
 167
 168         The coloring is applied in a background "thread", so you may
 169         occasionally see uncolorized text.  To change the color
 170         scheme, use the Settings/Highlighting dialog.
 171
 172     Python default syntax colors:
 173
 174         Keywords        orange
 175         Strings         green
 176         Comments        red
 177         Definitions     blue
 178
 179     Shell default colors:
 180
 181         Console output  brown
 182         stdout          blue
 183         stderr          dark green
 184         stdin           black
 185
 186 Other preferences:
 187
 188         The font preferences, keybinding, and startup preferences can
 189         be changed using the Settings dialog.
 190
 191 Command line usage:
 192
 193         Enter idle -h at the command prompt to get a usage message.