[OpenSPARC-T2-SAM] / sam-t2 / devtools / v8plus / lib / python2.4 / idlelib / help.txt

[See the end of this file for ** TIPS ** on using IDLE !!]

Click on the dotted line at the top of a menu to "tear it off": a
separate window containing the menu is created.

File Menu:

	New Window       -- Create a new editing window
	Open...          -- Open an existing file
	Recent Files...  -- Open a list of recent files
	Open Module...   -- Open an existing module (searches sys.path)
	Class Browser    -- Show classes and methods in current file
	Path Browser     -- Show sys.path directories, modules, classes
                            and methods
	---
	Save             -- Save current window to the associated file (unsaved
		            windows have a * before and after the window title)

	Save As...       -- Save current window to new file, which becomes
		            the associated file
	Save Copy As...  -- Save current window to different file
		            without changing the associated file
	---
	Print Window     -- Print the current window
	---
	Close            -- Close current window (asks to save if unsaved)
	Exit             -- Close all windows, quit (asks to save if unsaved)

Edit Menu:

	Undo             -- Undo last change to current window
                            (A maximum of 1000 changes may be undone)
	Redo             -- Redo last undone change to current window
	---
	Cut              -- Copy a selection into system-wide clipboard,
                            then delete the selection
	Copy             -- Copy selection into system-wide clipboard
	Paste            -- Insert system-wide clipboard into window
	Select All       -- Select the entire contents of the edit buffer
	---
	Find...          -- Open a search dialog box with many options
	Find Again       -- Repeat last search
	Find Selection   -- Search for the string in the selection
	Find in Files... -- Open a search dialog box for searching files
	Replace...       -- Open a search-and-replace dialog box
	Go to Line       -- Ask for a line number and show that line
	Expand Word      -- Expand the word you have typed to match another
		            word in the same buffer; repeat to get a
                            different expansion

Format Menu (only in Edit window):

	Indent Region       -- Shift selected lines right 4 spaces
	Dedent Region       -- Shift selected lines left 4 spaces
	Comment Out Region  -- Insert ## in front of selected lines
	Uncomment Region    -- Remove leading # or ## from selected lines
	Tabify Region       -- Turns *leading* stretches of spaces into tabs
		(Note: We recommend using 4 space blocks to indent Python code.)
	Untabify Region     -- Turn *all* tabs into the right number of spaces
	New Indent Width... -- Open dialog to change indent width
	Format Paragraph    -- Reformat the current blank-line-separated
                               paragraph

Run Menu (only in Edit window):

	Python Shell -- Open or wake up the Python shell window
	---
	Check Module -- Run a syntax check on the module
	Run Module   -- Execute the current file in the __main__ namespace

Shell Menu (only in Shell window):

	View Last Restart -- Scroll the shell window to the last restart
	Restart Shell     -- Restart the interpreter with a fresh environment

Debug Menu (only in Shell window):

	Go to File/Line   -- look around the insert point for a filename
		             and linenumber, open the file, and show the line
	Debugger (toggle) -- Run commands in the shell under the debugger
	Stack Viewer      -- Show the stack traceback of the last exception
	Auto-open Stack Viewer (toggle) -- Open stack viewer on traceback

Options Menu:

	Configure IDLE -- Open a configuration dialog.  Fonts, indentation,
                          keybindings, and color themes may be altered.
                          Startup Preferences may be set, and Additional Help
                          Souces can be specified.
	---
	Code Context --	  Open a pane at the top of the edit window which
			  shows the block context of the section of code
			  which is scrolling off the top or the window.

Windows Menu:

	Zoom Height -- toggles the window between configured size
	and maximum height.
	---
	The rest of this menu lists the names of all open windows;
	select one to bring it to the foreground (deiconifying it if
	necessary).

Help Menu:

	About IDLE  -- Version, copyright, license, credits
	IDLE Readme -- Background discussion and change details
	---
	IDLE Help   -- Display this file
	Python Docs -- Access local Python documentation, if
		       installed.  Otherwise, access www.python.org.
	---
	(Additional Help Sources may be added here)


** TIPS **
==========

Additional Help Sources:

	Windows users can Google on zopeshelf.chm to access Zope help files in
	the Windows help format.  The Additional Help Sources feature of the
	configuration GUI supports .chm, along with any other filetypes
	supported by your browser.  Supply a Menu Item title, and enter the
	location in the Help File Path slot of the New Help Source dialog.  Use
	http:// and/or www. to identify external URLs, or download the file and
	browse for its path on your machine using the Browse button.

	All users can access the extensive sources of help, including
	tutorials, available at www.python.org/doc.  Selected URLs can be added
	or removed from the Help menu at any time using Configure IDLE.

Basic editing and navigation:

	Backspace deletes to the left; DEL deletes to the right.
	Arrow keys and Page Up/Down move around.
	Control-left/right Arrow moves by words in a strange but useful way.
	Home/End go to begin/end of line.
	Control-Home/End go to begin/end of file.
	Some useful Emacs bindings (Control-a, Control-e, Control-k, etc.)
		are inherited from Tcl/Tk.
	Standard Windows bindings may work on that platform.
	Keybindings are selected in the Settings Dialog, look there.

Automatic indentation:

	After a block-opening statement, the next line is indented by 4 spaces
	(in the Python Shell window by one tab).  After certain keywords
	(break, return etc.) the next line is dedented.  In leading
	indentation, Backspace deletes up to 4 spaces if they are there.  Tab
	inserts spaces (in the Python Shell window one tab), number depends on
	Indent Width.  (N.B. Currently tabs are restricted to four spaces due
	to Tcl/Tk issues.)

        See also the indent/dedent region commands in the edit menu.

Python Shell window:

	Control-c interrupts executing command.
	Control-d sends end-of-file; closes window if typed at >>> prompt
		(this is Control-z on Windows).

    Command history:

	Alt-p retrieves previous command matching what you have typed.
	Alt-n retrieves next.
	      (These are Control-p, Control-n on the Mac)      
	Return while cursor is on a previous command retrieves that command.
	Expand word is also useful to reduce typing.

    Syntax colors:

	The coloring is applied in a background "thread", so you may
	occasionally see uncolorized text.  To change the color
	scheme, use the Configure IDLE / Highlighting dialog.

    Python default syntax colors:

	Keywords	orange
	Builtins	royal purple
	Strings		green
	Comments	red
	Definitions	blue

    Shell default colors:

	Console output	brown
	stdout		blue
	stderr		red
	stdin		black

Other preferences:

	The font preferences, keybinding, and startup preferences can
	be changed using the Settings dialog.

Command line usage:
	
	Enter idle -h at the command prompt to get a usage message.

Running without a subprocess:

	If IDLE is started with the -n command line switch it will run in a
	single process and will not create the subprocess which runs the RPC
	Python execution server.  This can be useful if Python cannot create
	the subprocess or the RPC socket interface on your platform.  However,
	in this mode user code is not isolated from IDLE itself.  Also, the
	environment is not restarted when Run/Run Module (F5) is selected.  If
	your code has been modified, you must reload() the affected modules and
	re-import any specific items (e.g. from foo import baz) if the changes
	are to take effect.  For these reasons, it is preferable to run IDLE
	with the default subprocess if at all possible.
Commit	Line	Data
920dae64 AT	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	(Note: We recommend using 4 space blocks to indent Python code.)
	59	Untabify Region -- Turn all tabs into the right number of spaces
	60	New Indent Width... -- Open dialog to change indent width
	61	Format Paragraph -- Reformat the current blank-line-separated
	62	paragraph
	63
	64	Run Menu (only in Edit window):
65
66	Python Shell -- Open or wake up the Python shell window
67	---
68	Check Module -- Run a syntax check on the module
69	Run Module -- Execute the current file in the __main__ namespace
70
71	Shell Menu (only in Shell window):
72
73	View Last Restart -- Scroll the shell window to the last restart
74	Restart Shell -- Restart the interpreter with a fresh environment
75
76	Debug Menu (only in Shell window):
77
78	Go to File/Line -- look around the insert point for a filename
79	and linenumber, open the file, and show the line
80	Debugger (toggle) -- Run commands in the shell under the debugger
81	Stack Viewer -- Show the stack traceback of the last exception
82	Auto-open Stack Viewer (toggle) -- Open stack viewer on traceback
83
84	Options Menu:
85
86	Configure IDLE -- Open a configuration dialog. Fonts, indentation,
87	keybindings, and color themes may be altered.
88	Startup Preferences may be set, and Additional Help
89	Souces can be specified.
90	---
91	Code Context -- Open a pane at the top of the edit window which
92	shows the block context of the section of code
93	which is scrolling off the top or the window.
94
95	Windows Menu:
96
97	Zoom Height -- toggles the window between configured size
98	and maximum height.
99	---
100	The rest of this menu lists the names of all open windows;
101	select one to bring it to the foreground (deiconifying it if
102	necessary).
103
104	Help Menu:
105
106	About IDLE -- Version, copyright, license, credits
107	IDLE Readme -- Background discussion and change details
108	---
109	IDLE Help -- Display this file
110	Python Docs -- Access local Python documentation, if
111	installed. Otherwise, access www.python.org.
112	---
113	(Additional Help Sources may be added here)
114
115
116	TIPS
117	==========
118
119	Additional Help Sources:
120
121	Windows users can Google on zopeshelf.chm to access Zope help files in
122	the Windows help format. The Additional Help Sources feature of the
123	configuration GUI supports .chm, along with any other filetypes
124	supported by your browser. Supply a Menu Item title, and enter the
125	location in the Help File Path slot of the New Help Source dialog. Use
126	http:// and/or www. to identify external URLs, or download the file and
127	browse for its path on your machine using the Browse button.
128
129	All users can access the extensive sources of help, including
130	tutorials, available at www.python.org/doc. Selected URLs can be added
131	or removed from the Help menu at any time using Configure IDLE.
132
133	Basic editing and navigation:
134
135	Backspace deletes to the left; DEL deletes to the right.
136	Arrow keys and Page Up/Down move around.
137	Control-left/right Arrow moves by words in a strange but useful way.
138	Home/End go to begin/end of line.
139	Control-Home/End go to begin/end of file.
140	Some useful Emacs bindings (Control-a, Control-e, Control-k, etc.)
141	are inherited from Tcl/Tk.
142	Standard Windows bindings may work on that platform.
143	Keybindings are selected in the Settings Dialog, look there.
144
145	Automatic indentation:
146
147	After a block-opening statement, the next line is indented by 4 spaces
148	(in the Python Shell window by one tab). After certain keywords
149	(break, return etc.) the next line is dedented. In leading
150	indentation, Backspace deletes up to 4 spaces if they are there. Tab
151	inserts spaces (in the Python Shell window one tab), number depends on
152	Indent Width. (N.B. Currently tabs are restricted to four spaces due
153	to Tcl/Tk issues.)
154
155	See also the indent/dedent region commands in the edit menu.
156
157	Python Shell window:
158
159	Control-c interrupts executing command.
160	Control-d sends end-of-file; closes window if typed at >>> prompt
161	(this is Control-z on Windows).
162
163	Command history:
164
165	Alt-p retrieves previous command matching what you have typed.
166	Alt-n retrieves next.
167	(These are Control-p, Control-n on the Mac)
168	Return while cursor is on a previous command retrieves that command.
169	Expand word is also useful to reduce typing.
170
171	Syntax colors:
172
173	The coloring is applied in a background "thread", so you may
174	occasionally see uncolorized text. To change the color
175	scheme, use the Configure IDLE / Highlighting dialog.
176
177	Python default syntax colors:
178
179	Keywords orange
180	Builtins royal purple
181	Strings green
182	Comments red
183	Definitions blue
184
185	Shell default colors:
186
187	Console output brown
188	stdout blue
189	stderr red
190	stdin black
191
192	Other preferences:
193
194	The font preferences, keybinding, and startup preferences can
195	be changed using the Settings dialog.
196
197	Command line usage:
198
199	Enter idle -h at the command prompt to get a usage message.
200
201	Running without a subprocess:
202
203	If IDLE is started with the -n command line switch it will run in a
204	single process and will not create the subprocess which runs the RPC
205	Python execution server. This can be useful if Python cannot create
206	the subprocess or the RPC socket interface on your platform. However,
207	in this mode user code is not isolated from IDLE itself. Also, the
208	environment is not restarted when Run/Run Module (F5) is selected. If
209	your code has been modified, you must reload() the affected modules and
210	re-import any specific items (e.g. from foo import baz) if the changes
211	are to take effect. For these reasons, it is preferable to run IDLE
212	with the default subprocess if at all possible.