blob: 63327d7d81f68d3c13bd2dca89553e9aae0090a7 [file] [log] [blame]
Guido van Rossum504b0bf1999-01-02 21:28:54 +00001[See end for tips.]
2
Guido van Rossumdd0d3351999-01-09 21:57:56 +00003Click on the dotted line at the top of a menu to "tear it off": a
4separate window containing the menu is created.
Guido van Rossum3b4ca0d1998-10-10 18:48:31 +00005
Guido van Rossumdd0d3351999-01-09 21:57:56 +00006File menu:
Guido van Rossum06b787b1999-04-22 23:20:17 +00007
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)
Guido van Rossum3b4ca0d1998-10-10 18:48:31 +000025
Guido van Rossumca5619c1998-10-13 17:32:27 +000026Edit menu:
Guido van Rossum3b4ca0d1998-10-10 18:48:31 +000027
Guido van Rossumca5619c1998-10-13 17:32:27 +000028 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
Guido van Rossumdd0d3351999-01-09 21:57:56 +000034 Select All -- Select the entire contents of the edit buffer
Guido van Rossumca5619c1998-10-13 17:32:27 +000035 ---
Guido van Rossumdd0d3351999-01-09 21:57:56 +000036 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
Guido van Rossumca5619c1998-10-13 17:32:27 +000041 Go to line -- Ask for a line number and show that line
42 ---
Guido van Rossumca5619c1998-10-13 17:32:27 +000043 Indent region -- Shift selected lines right 4 spaces
Guido van Rossumdd0d3351999-01-09 21:57:56 +000044 Dedent region -- Shift selected lines left 4 spaces
Guido van Rossumca5619c1998-10-13 17:32:27 +000045 Comment out region -- Insert ## in front of selected lines
46 Uncomment region -- Remove leading # or ## from selected lines
Guido van Rossumdd0d3351999-01-09 21:57:56 +000047 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 ---
Guido van Rossum06b787b1999-04-22 23:20:17 +000053 Import module -- Import or reload the current module
54 Run script -- Execute the current file in the __main__ namespace
Guido van Rossumca5619c1998-10-13 17:32:27 +000055
56Windows menu:
57
Guido van Rossumdd0d3351999-01-09 21:57:56 +000058 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).
Guido van Rossumca5619c1998-10-13 17:32:27 +000064
65Debug menu (in the Python Shell window only):
66
Guido van Rossumdd0d3351999-01-09 21:57:56 +000067 Go to file/line -- look around the insert point for a filename
68 and linenumber, open the file, and show the line
Guido van Rossumca5619c1998-10-13 17:32:27 +000069 Open stack viewer -- show the stack traceback of the last exception
Guido van Rossumdd0d3351999-01-09 21:57:56 +000070 Debugger toggle -- Run commands in the shell under the debugger
71 JIT Stack viewer toggle -- Open stack viewer on traceback
Guido van Rossumca5619c1998-10-13 17:32:27 +000072
73Basic editing and navigation:
74
75 Backspace deletes to the left; DEL deletes to the right
Guido van Rossum3b4ca0d1998-10-10 18:48:31 +000076 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
Guido van Rossumdd0d3351999-01-09 21:57:56 +000079 Some Emacs bindings may also work, e.g. ^B/^P/^A/^E/^D/^L
Guido van Rossum3b4ca0d1998-10-10 18:48:31 +000080
Guido van Rossumdd0d3351999-01-09 21:57:56 +000081Automatic indentation:
Guido van Rossum423938a1998-10-13 17:38:03 +000082
Guido van Rossumdd0d3351999-01-09 21:57:56 +000083 After a block-opening statement, the next line is indented by
Guido van Rossum06b787b1999-04-22 23:20:17 +000084 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.
Guido van Rossum423938a1998-10-13 17:38:03 +000090
Guido van Rossumca5619c1998-10-13 17:32:27 +000091Python Shell window:
Guido van Rossum3b4ca0d1998-10-10 18:48:31 +000092
93 ^C interrupts executing command
Guido van Rossumca5619c1998-10-13 17:32:27 +000094 ^D sends end-of-file; closes window if typed at >>> prompt
Guido van Rossum3b4ca0d1998-10-10 18:48:31 +000095
Guido van Rossum423938a1998-10-13 17:38:03 +000096 Command history:
97
98 Alt-p retrieves previous command matching what you have typed
99 Alt-n retrieves next
Guido van Rossumdd0d3351999-01-09 21:57:56 +0000100 Return while on any previous command retrieves that command
101 Alt-/ (Expand word) is also useful here
Guido van Rossum423938a1998-10-13 17:38:03 +0000102
Guido van Rossum06b787b1999-04-22 23:20:17 +0000103Syntax colors:
104
105 The coloring is applied in a background "thread", so you may
106 occasionally see uncolorized text. To change the color
Guido van Rossum9d593a52001-01-19 03:30:58 +0000107 scheme, edit the [Colors] section in config.txt (or add a
108 [Colors] section to ~/.idle).
Guido van Rossum06b787b1999-04-22 23:20:17 +0000109
110 Python syntax colors:
Guido van Rossum3b4ca0d1998-10-10 18:48:31 +0000111
112 Keywords orange
113 Strings green
114 Comments red
115 Definitions blue
116
Guido van Rossum06b787b1999-04-22 23:20:17 +0000117 Shell colors:
Guido van Rossum3b4ca0d1998-10-10 18:48:31 +0000118
Guido van Rossumdd0d3351999-01-09 21:57:56 +0000119 Console output brown
Guido van Rossum3b4ca0d1998-10-10 18:48:31 +0000120 stdout blue
121 stderr dark green
Guido van Rossum504b0bf1999-01-02 21:28:54 +0000122 stdin black
123
Guido van Rossum06b787b1999-04-22 23:20:17 +0000124Other preferences:
125
Guido van Rossum342d8f72001-10-08 22:49:12 +0000126 Most preferences can be changed by editing one of the
127 configuration text files: config.txt (generic) or one of
128 config-unix.txt, config-win.txt, config.mac.txt (platform
129 specific). User-specific preferences can be stored in
130 $HOME/.idle, which overrides the config*.txt files.
Guido van Rossum504b0bf1999-01-02 21:28:54 +0000131
Guido van Rossum06b787b1999-04-22 23:20:17 +0000132 To change keyboard bindings, edit Bindings.py
133
134Command line usage:
135
136 idle.py [-c command] [-d] [-e] [-s] [-t title] [arg] ...
137
138 -c command run this command
139 -d enable debugger
140 -e edit mode; arguments are files to be edited
141 -s run $IDLESTARTUP or $PYTHONSTARTUP first
142 -t title set title of shell window
143
144 If there are arguments:
145
146 If -e is used, arguments are files opened for editing and
147 sys.argv reflects the arguments passed to IDLE itself.
148
149 Otherwise, if -c is used, all arguments are placed in
150 sys.argv[1:...], with sys.argv[0] set to '-c'.
151
152 Otherwise, if neither -e nor -c is used, the first
153 argument is a script which is executed with the remaining
154 arguments in sys.argv[1:...] and sys.argv[0] set to the
155 script name. If the script name is '-', no script is
156 executed but an interactive Python session is started; the
157 arguments are still available in sys.argv.