Tools/idle/help.txt

   1 [See end for tips.]
   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         Open module... -- open an existing module (searches sys.path)
  11         Class browser -- show classes and methods in current file
  12         Path browser -- show sys.path directories, modules, classes
  13                 and methods
  14         ---
  15         Save -- save current window to the associated file (unsaved
  16                 windows have a * before and after the window title)
  17
  18         Save As... -- save current window to new file, which becomes
  19                 the associated file
  20         Save Copy As... -- save current window to different file
  21                 without changing the associated file
  22         ---
  23         Close -- close current window (asks to save if unsaved)
  24         Exit -- close all windows and quit IDLE (asks to save if unsaved)
  25
  26 Edit menu:
  27
  28         Undo -- Undo last change to current window (max 1000 changes)
  29         Redo -- Redo last undone change to current window
  30         ---
  31         Cut -- Copy selection into system-wide clipboard; then delete selection
  32         Copy -- Copy selection into system-wide clipboard
  33         Paste -- Insert system-wide clipboard into window
  34         Select All -- Select the entire contents of the edit buffer
  35         ---
  36         Find... -- Open a search dialog box with many options
  37         Find again -- Repeat last search
  38         Find selection -- Search for the string in the selection
  39         Find in Files... -- Open a search dialog box for searching files
  40         Replace... -- Open a search-and-replace dialog box
  41         Go to line -- Ask for a line number and show that line
  42         ---
  43         Indent region -- Shift selected lines right 4 spaces
  44         Dedent region -- Shift selected lines left 4 spaces
  45         Comment out region -- Insert ## in front of selected lines
  46         Uncomment region -- Remove leading # or ## from selected lines
  47         Tabify region -- Turns *leading* stretches of spaces into tabs
  48         Untabify region -- Turn *all* tabs into the right number of spaces
  49         Expand word -- Expand the word you have typed to match another
  50                 word in the same buffer; repeat to get a different expansion
  51         Format Paragraph -- Reformat the current blank-line-separated paragraph
  52         ---
  53         Import module -- Import or reload the current module
  54         Run script -- Execute the current file in the __main__ namespace
  55
  56 Windows menu:
  57
  58         Zoom Height -- toggles the window between normal size (24x80)
  59         and maximum height.
  60         ---
  61         The rest of this menu lists the names of all open windows;
  62         select one to bring it to the foreground (deiconifying it if
  63         necessary).
  64
  65 Debug menu (in the Python Shell window only):
  66
  67         Go to file/line -- look around the insert point for a filename
  68                 and linenumber, open the file, and show the line
  69         Open stack viewer -- show the stack traceback of the last exception
  70         Debugger toggle -- Run commands in the shell under the debugger
  71         JIT Stack viewer toggle -- Open stack viewer on traceback
  72
  73 Basic editing and navigation:
  74
  75         Backspace deletes to the left; DEL deletes to the right
  76         Arrow keys and Page Up/Down to move around
  77         Home/End go to begin/end of line
  78         Control-Home/End go to begin/end of file
  79         Some Emacs bindings may also work, e.g. ^B/^P/^A/^E/^D/^L
  80
  81 Automatic indentation:
  82
  83         After a block-opening statement, the next line is indented by
  84         4 spaces (in the Python Shell window by one tab).  After
  85         certain keywords (break, return etc.) the next line is
  86         dedented.  In leading indentation, Backspace deletes up to 4
  87         spaces if they are there.  Tab inserts 1-4 spaces (in the
  88         Python Shell window one tab).  See also the indent/dedent
  89         region commands in the edit menu.
  90
  91 Python Shell window:
  92
  93         ^C interrupts executing command
  94         ^D sends end-of-file; closes window if typed at >>> prompt
  95
  96     Command history:
  97
  98         Alt-p retrieves previous command matching what you have typed
  99         Alt-n retrieves next
 100         Return while on any previous command retrieves that command
 101         Alt-/ (Expand word) is also useful here
 102
 103 Syntax colors:
 104
 105         The coloring is applied in a background "thread", so you may
 106         occasionally see uncolorized text.  To change the color
 107         scheme, edit the [Colors] section in config.txt (or add a
 108         [Colors] section to ~/.idle).
 109
 110     Python syntax colors:
 111
 112         Keywords        orange
 113         Strings         green
 114         Comments        red
 115         Definitions     blue
 116
 117     Shell colors:
 118
 119         Console output  brown
 120         stdout          blue
 121         stderr          dark green
 122         stdin           black
 123
 124 Other preferences:
 125
 126         To change the font on Windows, open EditorWindow.py and change
 127             text['font'] = ("lucida console", 8)
 128         to, e.g.,
 129             text['font'] = ("courier new", 10)
 130
 131         To change keyboard bindings, edit Bindings.py
 132
 133 Command line usage:
 134
 135         idle.py [-c command] [-d] [-e] [-s] [-t title] [arg] ...
 136
 137         -c command  run this command
 138         -d          enable debugger
 139         -e          edit mode; arguments are files to be edited
 140         -s          run $IDLESTARTUP or $PYTHONSTARTUP first
 141         -t title    set title of shell window
 142
 143         If there are arguments:
 144
 145             If -e is used, arguments are files opened for editing and
 146             sys.argv reflects the arguments passed to IDLE itself.
 147
 148             Otherwise, if -c is used, all arguments are placed in
 149             sys.argv[1:...], with sys.argv[0] set to '-c'.
 150
 151             Otherwise, if neither -e nor -c is used, the first
 152             argument is a script which is executed with the remaining
 153             arguments in sys.argv[1:...]  and sys.argv[0] set to the
 154             script name.  If the script name is '-', no script is
 155             executed but an interactive Python session is started; the
 156             arguments are still available in sys.argv.