source: trunk/j/doc/commands.html @ 2

Last change on this file since 2 was 2, checked in by piso, 18 years ago

Initial checkin.

File size: 143.2 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2
3<html>
4
5<head>
6<title>J User's Guide - Commands</title>
7<LINK REL="stylesheet" HREF="j.css" TYPE="text/css">
8</head>
9
10<body link=blue vlink=blue>
11
12<a href="contents.html">Top</a>
13
14<hr>
15
16<h1>Commands</h1>
17
18<hr>
19
20<ul>
21    <li><a href="commands.html#about">about</a></li>
22    <li><a href="commands.html#alias">alias</a></li>
23    <li><a href="commands.html#alignStrings">alignStrings</a></li>
24    <li><a href="commands.html#archiveOpenFile">archiveOpenFile</a></li>
25    <li><a href="commands.html#attachFile">attachFile</a></li>
26    <li><a href="commands.html#backspace">backspace</a></li>
27    <li><a href="commands.html#binaryMode">binaryMode</a></li>
28    <li><a href="commands.html#bob">bob</a></li>
29    <li><a href="commands.html#bol">bol</a></li>
30    <li><a href="commands.html#bottom">bottom</a></li>
31    <li><a href="commands.html#bounceMessage">bounceMessage</a></li>
32    <li><a href="commands.html#browseFileAtDot">browseFileAtDot</a></li>
33    <li><a href="commands.html#ccGroup">ccGroup</a></li>
34    <li><a href="commands.html#centerTag">centerTag</a></li>
35    <li><a href="commands.html#changes">changes</a></li>
36    <li><a href="commands.html#checkPath">checkPath</a></li>
37    <li><a href="commands.html#clearRegister">clearRegister</a></li>
38    <li><a href="commands.html#closeAll">closeAll</a></li>
39    <li><a href="commands.html#closeOthers">closeOthers</a></li>
40    <li><a href="commands.html#closeParen">closeParen</a></li>
41    <li><a href="commands.html#commentRegion">commentRegion</a></li>
42    <li><a href="commands.html#compile">compile</a></li>
43    <li><a href="commands.html#compose">compose</a></li>
44    <li><a href="commands.html#copyAppend">copyAppend</a></li>
45    <li><a href="commands.html#copyLink">copyLink</a></li>
46    <li><a href="commands.html#copyPath">copyPath</a></li>
47    <li><a href="commands.html#copyRegion">copyRegion</a></li>
48    <li><a href="commands.html#copyXPath">copyXPath</a></li>
49    <li><a href="commands.html#cppFindMatch">cppFindMatch</a></li>
50    <li><a href="commands.html#cvs">cvs</a></li>
51    <li><a href="commands.html#cvsAdd">cvsAdd</a></li>
52    <li><a href="commands.html#cvsCommit">cvsCommit</a></li>
53    <li><a href="commands.html#cvsDiff">cvsDiff</a></li>
54    <li><a href="commands.html#cvsDiffDir">cvsDiffDir</a></li>
55    <li><a href="commands.html#cvsLog">cvsLog</a></li>
56    <li><a href="commands.html#cycleIndentSize">cycleIndentSize</a></li>
57    <li><a href="commands.html#cyclePaste">cyclePaste</a></li>
58    <li><a href="commands.html#cycleTabWidth">cycleTabWidth</a></li>
59    <li><a href="commands.html#decodeRegion">decodeRegion</a></li>
60    <li><a href="commands.html#defaultMode">defaultMode</a></li>
61    <li><a href="commands.html#delete">delete</a></li>
62    <li><a href="commands.html#deleteWordLeft">deleteWordLeft</a></li>
63    <li><a href="commands.html#deleteWordRight">deleteWordRight</a></li>
64    <li><a href="commands.html#describeKey">describeKey</a></li>
65    <li><a href="commands.html#detabRegion">detabRegion</a></li>
66    <li><a href="commands.html#diffGotoFile">diffGotoFile</a></li>
67    <li><a href="commands.html#dir">dir</a></li>
68    <li><a href="commands.html#dirBack">dirBack</a></li>
69    <li><a href="commands.html#dirBrowseFile">dirBrowseFile</a></li>
70    <li><a href="commands.html#dirCopyFile">dirCopyFile</a></li>
71    <li><a href="commands.html#dirCycleSortBy">dirCycleSortBy</a></li>
72    <li><a href="commands.html#dirDeleteFiles">dirDeleteFiles</a></li>
73    <li><a href="commands.html#dirDoShellCommand">dirDoShellCommand</a></li>
74    <li><a href="commands.html#dirForward">dirForward</a></li>
75    <li><a href="commands.html#dirHome">dirHome</a></li>
76    <li><a href="commands.html#dirHomeDir">dirHomeDir</a></li>
77    <li><a href="commands.html#dirLimit">dirLimit</a></li>
78    <li><a href="commands.html#dirMoveFile">dirMoveFile</a></li>
79    <li><a href="commands.html#dirOpenFile">dirOpenFile</a></li>
80    <li><a href="commands.html#dirRescan">dirRescan</a></li>
81    <li><a href="commands.html#dirTagFile">dirTagFile</a></li>
82    <li><a href="commands.html#dirUnlimit">dirUnlimit</a></li>
83    <li><a href="commands.html#dirUpDir">dirUpDir</a></li>
84    <li><a href="commands.html#doShellCommandOnRegion">doShellCommandOnRegion</a></li>
85    <li><a href="commands.html#down">down</a></li>
86    <li><a href="commands.html#dropBookmark">dropBookmark</a></li>
87    <li><a href="commands.html#editRegister">editRegister</a></li>
88    <li><a href="commands.html#electricCloseAngleBracket">electricCloseAngleBracket</a></li>
89    <li><a href="commands.html#electricCloseBrace">electricCloseBrace</a></li>
90    <li><a href="commands.html#electricColon">electricColon</a></li>
91    <li><a href="commands.html#electricOpenBrace">electricOpenBrace</a></li>
92    <li><a href="commands.html#electricPound">electricPound</a></li>
93    <li><a href="commands.html#electricSemi">electricSemi</a></li>
94    <li><a href="commands.html#electricStar">electricStar</a></li>
95    <li><a href="commands.html#end">end</a></li>
96    <li><a href="commands.html#entabRegion">entabRegion</a></li>
97    <li><a href="commands.html#eob">eob</a></li>
98    <li><a href="commands.html#escape">escape</a></li>
99    <li><a href="commands.html#evalBuffer">evalBuffer</a></li>
100    <li><a href="commands.html#executeCommand">executeCommand</a></li>
101    <li><a href="commands.html#expand">expand</a></li>
102    <li><a href="commands.html#find">find</a></li>
103    <li><a href="commands.html#findFirstOccurrence">findFirstOccurrence</a></li>
104    <li><a href="commands.html#findInFiles">findInFiles</a></li>
105    <li><a href="commands.html#findMatchingChar">findMatchingChar</a></li>
106    <li><a href="commands.html#findNext">findNext</a></li>
107    <li><a href="commands.html#findNextWord">findNextWord</a></li>
108    <li><a href="commands.html#findOccurrenceAtDot">findOccurrenceAtDot</a></li>
109    <li><a href="commands.html#findPrev">findPrev</a></li>
110    <li><a href="commands.html#findPrevWord">findPrevWord</a></li>
111    <li><a href="commands.html#findTag">findTag</a></li>
112    <li><a href="commands.html#findTagAtDot">findTagAtDot</a></li>
113    <li><a href="commands.html#findTagAtDotOtherWindow">findTagAtDotOtherWindow</a></li>
114    <li><a href="commands.html#finish">finish</a></li>
115    <li><a href="commands.html#fold">fold</a></li>
116    <li><a href="commands.html#foldMethods">foldMethods</a></li>
117    <li><a href="commands.html#foldRegion">foldRegion</a></li>
118    <li><a href="commands.html#gotoBookmark">gotoBookmark</a></li>
119    <li><a href="commands.html#gotoFile">gotoFile</a></li>
120    <li><a href="commands.html#help">help</a></li>
121    <li><a href="commands.html#home">home</a></li>
122    <li><a href="commands.html#htmlBold">htmlBold</a></li>
123    <li><a href="commands.html#htmlElectricEquals">htmlElectricEquals</a></li>
124    <li><a href="commands.html#htmlEndTag">htmlEndTag</a></li>
125    <li><a href="commands.html#htmlFindMatch">htmlFindMatch</a></li>
126    <li><a href="commands.html#htmlInsertMatchingEndTag">htmlInsertMatchingEndTag</a></li>
127    <li><a href="commands.html#htmlInsertTag">htmlInsertTag</a></li>
128    <li><a href="commands.html#htmlStartTag">htmlStartTag</a></li>
129    <li><a href="commands.html#httpShowHeaders">httpShowHeaders</a></li>
130    <li><a href="commands.html#iList">iList</a></li>
131    <li><a href="commands.html#imageCycleBackground">imageCycleBackground</a></li>
132    <li><a href="commands.html#imageFit">imageFit</a></li>
133    <li><a href="commands.html#imageRestore">imageRestore</a></li>
134    <li><a href="commands.html#imageZoomIn">imageZoomIn</a></li>
135    <li><a href="commands.html#imageZoomOut">imageZoomOut</a></li>
136    <li><a href="commands.html#inbox">inbox</a></li>
137    <li><a href="commands.html#incrementalFind">incrementalFind</a></li>
138    <li><a href="commands.html#indentLine">indentLine</a></li>
139    <li><a href="commands.html#indentLineOrRegion">indentLineOrRegion</a></li>
140    <li><a href="commands.html#indentRegion">indentRegion</a></li>
141    <li><a href="commands.html#insertBraces">insertBraces</a></li>
142    <li><a href="commands.html#insertByte">insertByte</a></li>
143    <li><a href="commands.html#insertChar">insertChar</a></li>
144    <li><a href="commands.html#insertKeyText">insertKeyText</a></li>
145    <li><a href="commands.html#insertParentheses">insertParentheses</a></li>
146    <li><a href="commands.html#insertRegister">insertRegister</a></li>
147    <li><a href="commands.html#insertString">insertString</a></li>
148    <li><a href="commands.html#insertTab">insertTab</a></li>
149    <li><a href="commands.html#jdkHelp">jdkHelp</a></li>
150    <li><a href="commands.html#jmips">jmips</a></li>
151    <li><a href="commands.html#jumpToColumn">jumpToColumn</a></li>
152    <li><a href="commands.html#jumpToLine">jumpToLine</a></li>
153    <li><a href="commands.html#jumpToOffset">jumpToOffset</a></li>
154    <li><a href="commands.html#killAppend">killAppend</a></li>
155    <li><a href="commands.html#killBuffer">killBuffer</a></li>
156    <li><a href="commands.html#killFrame">killFrame</a></li>
157    <li><a href="commands.html#killLine">killLine</a></li>
158    <li><a href="commands.html#killRegion">killRegion</a></li>
159    <li><a href="commands.html#killWordLeft">killWordLeft</a></li>
160    <li><a href="commands.html#killWordRight">killWordRight</a></li>
161    <li><a href="commands.html#left">left</a></li>
162    <li><a href="commands.html#listBindings">listBindings</a></li>
163    <li><a href="commands.html#listFiles">listFiles</a></li>
164    <li><a href="commands.html#listIncludes">listIncludes</a></li>
165    <li><a href="commands.html#listOccurrences">listOccurrences</a></li>
166    <li><a href="commands.html#listOccurrencesOfPatternAtDot">listOccurrencesOfPatternAtDot</a></li>
167    <li><a href="commands.html#listRegisters">listRegisters</a></li>
168    <li><a href="commands.html#listTags">listTags</a></li>
169    <li><a href="commands.html#loadSession">loadSession</a></li>
170    <li><a href="commands.html#lowerCaseRegion">lowerCaseRegion</a></li>
171    <li><a href="commands.html#mailboxCreateFolder">mailboxCreateFolder</a></li>
172    <li><a href="commands.html#mailboxDelete">mailboxDelete</a></li>
173    <li><a href="commands.html#mailboxDeleteFolder">mailboxDeleteFolder</a></li>
174    <li><a href="commands.html#mailboxExpunge">mailboxExpunge</a></li>
175    <li><a href="commands.html#mailboxFlag">mailboxFlag</a></li>
176    <li><a href="commands.html#mailboxGetNewMessages">mailboxGetNewMessages</a></li>
177    <li><a href="commands.html#mailboxLastMessage">mailboxLastMessage</a></li>
178    <li><a href="commands.html#mailboxLimit">mailboxLimit</a></li>
179    <li><a href="commands.html#mailboxMarkRead">mailboxMarkRead</a></li>
180    <li><a href="commands.html#mailboxMarkUnread">mailboxMarkUnread</a></li>
181    <li><a href="commands.html#mailboxMoveToFolder">mailboxMoveToFolder</a></li>
182    <li><a href="commands.html#mailboxReadMessage">mailboxReadMessage</a></li>
183    <li><a href="commands.html#mailboxSaveToFolder">mailboxSaveToFolder</a></li>
184    <li><a href="commands.html#mailboxStop">mailboxStop</a></li>
185    <li><a href="commands.html#mailboxTag">mailboxTag</a></li>
186    <li><a href="commands.html#mailboxTagPattern">mailboxTagPattern</a></li>
187    <li><a href="commands.html#mailboxToggleRaw">mailboxToggleRaw</a></li>
188    <li><a href="commands.html#mailboxUndelete">mailboxUndelete</a></li>
189    <li><a href="commands.html#mailboxUnlimit">mailboxUnlimit</a></li>
190    <li><a href="commands.html#mailboxUntagAll">mailboxUntagAll</a></li>
191    <li><a href="commands.html#makeTagFile">makeTagFile</a></li>
192    <li><a href="commands.html#man">man</a></li>
193    <li><a href="commands.html#manFollowLink">manFollowLink</a></li>
194    <li><a href="commands.html#messageDelete">messageDelete</a></li>
195    <li><a href="commands.html#messageFlag">messageFlag</a></li>
196    <li><a href="commands.html#messageForward">messageForward</a></li>
197    <li><a href="commands.html#messageIndex">messageIndex</a></li>
198    <li><a href="commands.html#messageMoveToFolder">messageMoveToFolder</a></li>
199    <li><a href="commands.html#messageNext">messageNext</a></li>
200    <li><a href="commands.html#messageNextInThread">messageNextInThread</a></li>
201    <li><a href="commands.html#messagePrevious">messagePrevious</a></li>
202    <li><a href="commands.html#messagePreviousInThread">messagePreviousInThread</a></li>
203    <li><a href="commands.html#messageReplyToGroup">messageReplyToGroup</a></li>
204    <li><a href="commands.html#messageReplyToSender">messageReplyToSender</a></li>
205    <li><a href="commands.html#messageSaveAttachment">messageSaveAttachment</a></li>
206    <li><a href="commands.html#messageToggleHeaders">messageToggleHeaders</a></li>
207    <li><a href="commands.html#messageToggleRaw">messageToggleRaw</a></li>
208    <li><a href="commands.html#messageViewAttachment">messageViewAttachment</a></li>
209    <li><a href="commands.html#mouseFindOccurrence">mouseFindOccurrence</a></li>
210    <li><a href="commands.html#mouseFindTag">mouseFindTag</a></li>
211    <li><a href="commands.html#mouseMoveDotToPoint">mouseMoveDotToPoint</a></li>
212    <li><a href="commands.html#mousePaste">mousePaste</a></li>
213    <li><a href="commands.html#mouseSelect">mouseSelect</a></li>
214    <li><a href="commands.html#mouseShowContextMenu">mouseShowContextMenu</a></li>
215    <li><a href="commands.html#movePastCloseAndReindent">movePastCloseAndReindent</a></li>
216    <li><a href="commands.html#newBuffer">newBuffer</a></li>
217    <li><a href="commands.html#newFrame">newFrame</a></li>
218    <li><a href="commands.html#newline">newline</a></li>
219    <li><a href="commands.html#newlineAndIndent">newlineAndIndent</a></li>
220    <li><a href="commands.html#nextBuffer">nextBuffer</a></li>
221    <li><a href="commands.html#nextChange">nextChange</a></li>
222    <li><a href="commands.html#nextComment">nextComment</a></li>
223    <li><a href="commands.html#nextError">nextError</a></li>
224    <li><a href="commands.html#nextFrame">nextFrame</a></li>
225    <li><a href="commands.html#offset">offset</a></li>
226    <li><a href="commands.html#openFile">openFile</a></li>
227    <li><a href="commands.html#openFileInOtherFrame">openFileInOtherFrame</a></li>
228    <li><a href="commands.html#openFileInOtherWindow">openFileInOtherWindow</a></li>
229    <li><a href="commands.html#openMailbox">openMailbox</a></li>
230    <li><a href="commands.html#otherWindow">otherWindow</a></li>
231    <li><a href="commands.html#p4">p4</a></li>
232    <li><a href="commands.html#pageDown">pageDown</a></li>
233    <li><a href="commands.html#pageUp">pageUp</a></li>
234    <li><a href="commands.html#paste">paste</a></li>
235    <li><a href="commands.html#pasteColumn">pasteColumn</a></li>
236    <li><a href="commands.html#pastePrimarySelection">pastePrimarySelection</a></li>
237    <li><a href="commands.html#playbackMacro">playbackMacro</a></li>
238    <li><a href="commands.html#popPosition">popPosition</a></li>
239    <li><a href="commands.html#prevBuffer">prevBuffer</a></li>
240    <li><a href="commands.html#previousChange">previousChange</a></li>
241    <li><a href="commands.html#previousComment">previousComment</a></li>
242    <li><a href="commands.html#print">print</a></li>
243    <li><a href="commands.html#properties">properties</a></li>
244    <li><a href="commands.html#pushPosition">pushPosition</a></li>
245    <li><a href="commands.html#quit">quit</a></li>
246    <li><a href="commands.html#recompile">recompile</a></li>
247    <li><a href="commands.html#recordMacro">recordMacro</a></li>
248    <li><a href="commands.html#replace">replace</a></li>
249    <li><a href="commands.html#replaceInFiles">replaceInFiles</a></li>
250    <li><a href="commands.html#resetDisplay">resetDisplay</a></li>
251    <li><a href="commands.html#revertBuffer">revertBuffer</a></li>
252    <li><a href="commands.html#right">right</a></li>
253    <li><a href="commands.html#save">save</a></li>
254    <li><a href="commands.html#saveAll">saveAll</a></li>
255    <li><a href="commands.html#saveAllExit">saveAllExit</a></li>
256    <li><a href="commands.html#saveAs">saveAs</a></li>
257    <li><a href="commands.html#saveCopy">saveCopy</a></li>
258    <li><a href="commands.html#saveSession">saveSession</a></li>
259    <li><a href="commands.html#saveToRegister">saveToRegister</a></li>
260    <li><a href="commands.html#selectAll">selectAll</a></li>
261    <li><a href="commands.html#selectBob">selectBob</a></li>
262    <li><a href="commands.html#selectDown">selectDown</a></li>
263    <li><a href="commands.html#selectEnd">selectEnd</a></li>
264    <li><a href="commands.html#selectEob">selectEob</a></li>
265    <li><a href="commands.html#selectHome">selectHome</a></li>
266    <li><a href="commands.html#selectLeft">selectLeft</a></li>
267    <li><a href="commands.html#selectPageDown">selectPageDown</a></li>
268    <li><a href="commands.html#selectPageUp">selectPageUp</a></li>
269    <li><a href="commands.html#selectRight">selectRight</a></li>
270    <li><a href="commands.html#selectUp">selectUp</a></li>
271    <li><a href="commands.html#selectWord">selectWord</a></li>
272    <li><a href="commands.html#selectWordLeft">selectWordLeft</a></li>
273    <li><a href="commands.html#selectWordRight">selectWordRight</a></li>
274    <li><a href="commands.html#send">send</a></li>
275    <li><a href="commands.html#sendMailBackTab">sendMailBackTab</a></li>
276    <li><a href="commands.html#sendMailTab">sendMailTab</a></li>
277    <li><a href="commands.html#setEncoding">setEncoding</a></li>
278    <li><a href="commands.html#shellEscape">shellEscape</a></li>
279    <li><a href="commands.html#shellHome">shellHome</a></li>
280    <li><a href="commands.html#shellTab">shellTab</a></li>
281    <li><a href="commands.html#showMessage">showMessage</a></li>
282    <li><a href="commands.html#sidebarListBuffers">sidebarListBuffers</a></li>
283    <li><a href="commands.html#sidebarListTags">sidebarListTags</a></li>
284    <li><a href="commands.html#slideIn">slideIn</a></li>
285    <li><a href="commands.html#slideOut">slideOut</a></li>
286    <li><a href="commands.html#sortByDateSent">sortByDateSent</a></li>
287    <li><a href="commands.html#sortByThread">sortByThread</a></li>
288    <li><a href="commands.html#sortLines">sortLines</a></li>
289    <li><a href="commands.html#source">source</a></li>
290    <li><a href="commands.html#splitWindow">splitWindow</a></li>
291    <li><a href="commands.html#stamp">stamp</a></li>
292    <li><a href="commands.html#tab">tab</a></li>
293    <li><a href="commands.html#thisError">thisError</a></li>
294    <li><a href="commands.html#toCenter">toCenter</a></li>
295    <li><a href="commands.html#toggleSidebar">toggleSidebar</a></li>
296    <li><a href="commands.html#toggleWrap">toggleWrap</a></li>
297    <li><a href="commands.html#top">top</a></li>
298    <li><a href="commands.html#toTop">toTop</a></li>
299    <li><a href="commands.html#uncommentRegion">uncommentRegion</a></li>
300    <li><a href="commands.html#undo">undo</a></li>
301    <li><a href="commands.html#unfold">unfold</a></li>
302    <li><a href="commands.html#unfoldAll">unfoldAll</a></li>
303    <li><a href="commands.html#unsplitWindow">unsplitWindow</a></li>
304    <li><a href="commands.html#unwrapParagraph">unwrapParagraph</a></li>
305    <li><a href="commands.html#up">up</a></li>
306    <li><a href="commands.html#upperCaseRegion">upperCaseRegion</a></li>
307    <li><a href="commands.html#visibleTabs">visibleTabs</a></li>
308    <li><a href="commands.html#whatChar">whatChar</a></li>
309    <li><a href="commands.html#whereIs">whereIs</a></li>
310    <li><a href="commands.html#windowDown">windowDown</a></li>
311    <li><a href="commands.html#windowUp">windowUp</a></li>
312    <li><a href="commands.html#wordLeft">wordLeft</a></li>
313    <li><a href="commands.html#wordRight">wordRight</a></li>
314    <li><a href="commands.html#wrapComment">wrapComment</a></li>
315    <li><a href="commands.html#wrapParagraph">wrapParagraph</a></li>
316    <li><a href="commands.html#wrapRegion">wrapRegion</a></li>
317    <li><a href="commands.html#writeGlobalKeyMap">writeGlobalKeyMap</a></li>
318    <li><a href="commands.html#writeLocalKeyMap">writeLocalKeyMap</a></li>
319    <li><a href="commands.html#xmlElectricEquals">xmlElectricEquals</a></li>
320    <li><a href="commands.html#xmlElectricSlash">xmlElectricSlash</a></li>
321    <li><a href="commands.html#xmlFindCurrentNode">xmlFindCurrentNode</a></li>
322    <li><a href="commands.html#xmlFindMatch">xmlFindMatch</a></li>
323    <li><a href="commands.html#xmlInsertEmptyElementTag">xmlInsertEmptyElementTag</a></li>
324    <li><a href="commands.html#xmlInsertMatchingEndTag">xmlInsertMatchingEndTag</a></li>
325    <li><a href="commands.html#xmlInsertTag">xmlInsertTag</a></li>
326    <li><a href="commands.html#xmlParseBuffer">xmlParseBuffer</a></li>
327</ul>
328
329<hr>
330
331<a name="about">about</a><dl><dd>
332<p>
333Displays the about box.
334<br><br>
335<b>Default key mapping:</b> None
336<br><br>
337</dl><!--<hr>-->
338
339<a name="alias">alias</a><dl><dd>
340<p>
341Sets or modifies an alias. See <a href="aliases.html">Aliases</a>.
342<p>
343<b>Default key mapping:</b> None
344<br><br>
345</dl><!--<hr>-->
346
347<a name="alignStrings">alignStrings</a><dl><dd>
348<p>
349Prompts for a regular expression and aligns the first occurrence of the
350specified regular expression in each line of the selected region.
351<p>
352For example, suppose you start with a region that looks like this:
353<pre>
354        private static final int STATE_VARIABLE = STATE_LAST + 1;
355        private static final int STATE_HERE_DOCUMENT = STATE_LAST + 2;
356        private static final int STATE_POD = STATE_LAST + 3;
357        private static final int STATE_REGEXP_DELIMITER = STATE_LAST + 4;
358        private static final int STATE_REGEXP = STATE_LAST + 5;
359        private static final int STATE_SUBST = STATE_LAST + 6;
360</pre>
361If you specify "=" as the regular expression, alignStrings will reformat the
362region like this:
363<pre>
364        private static final int STATE_VARIABLE         = STATE_LAST + 1;
365        private static final int STATE_HERE_DOCUMENT    = STATE_LAST + 2;
366        private static final int STATE_POD              = STATE_LAST + 3;
367        private static final int STATE_REGEXP_DELIMITER = STATE_LAST + 4;
368        private static final int STATE_REGEXP           = STATE_LAST + 5;
369        private static final int STATE_SUBST            = STATE_LAST + 6;
370</pre>
371<p>
372<b>Default key mapping:</b> None
373<br><br>
374</dl><!--<hr>-->
375
376<a name="archiveOpenFile">archiveOpenFile</a><dl><dd>
377<p>
378Opens the file at the location of the caret or mouse click.
379<p>
380<b>Default key mapping:</b> Enter, Ctrl Shift G, Double Mouse-1, or Mouse-2 in Archive mode
381<br><br>
382</dl><!--<hr>-->
383
384<a name="attachFile">attachFile</a><dl><dd>
385<p>
386Attaches a file to the message in the current mail composition buffer.
387<br><br>
388<b>Default key mapping:</b> None
389<br><br>
390<b>See also:</b> <a href="mail.html">Mail</a>
391<br><br>
392</dl><!--<hr>-->
393
394<a name="backspace">backspace</a><dl><dd>
395<p>
396If a region is marked, deletes it.  Otherwise, deletes the character to the
397left of the caret.
398<br><br>
399<b>Default key mapping:</b> Backspace, Shift Backspace
400<br><br>
401</dl><!--<hr>-->
402
403<a name="binaryMode">binaryMode</a><dl><dd>
404<p>
405Reloads the current buffer in binary mode.
406<br><br>
407<b>Default key mapping:</b> None
408<br><br>
409<b>See also:</b> <a href="#defaultMode">defaultMode</a>
410<br><br>
411</dl><!--<hr>-->
412
413<a name="bob">bob</a><dl><dd>
414<p>
415Moves to the beginning of the buffer.
416<br><br>
417<b>Default key mapping:</b> Ctrl Home
418<br><br>
419</dl><!--<hr>-->
420
421<a name="bol">bol</a><dl><dd>
422<p>
423Moves the caret to the beginning of the line.
424<br><br>
425<b>Default key mapping:</b> None
426<br><br>
427</dl><!--<hr>-->
428
429<a name="bottom">bottom</a><dl><dd>
430<p>
431Moves the caret to the bottom line of the display, keeping it in the same column.
432<br><br>
433<b>Default key mapping:</b> Ctrl Page Down
434<br><br>
435</dl><!--<hr>-->
436
437<a name="bounceMessage">bounceMessage</a><dl><dd>
438<p>
439Resends the current message to one or more specified addresses.
440<br><br>
441<b>Default key mapping:</b> 'b' in message buffers
442<br><br>
443<b>See also:</b> <a href="mail.html">Mail</a>
444<br><br>
445</dl><!--<hr>-->
446
447<a name="browseFileAtDot">browseFileAtDot</a><dl><dd>
448<p>
449Uses the default browser to view the file at the location of the caret.
450<p>
451For this command to work, you need to specify the properties
452<a href="preferences.html#browser">browser</a> and (optionally)
453<a href="preferences.html#browserOpts">browserOpts</a> in your
454<a href="preferences.html">preferences</a> file.
455<p>
456<b>Default key mapping:</b> Ctrl Shift B
457<br><br>
458</dl><!--<hr>-->
459
460<a name="ccGroup">ccGroup</a><dl><dd>
461<p>
462This command is available in mail composition buffers when you're replying to
463a message. It adds all of the recipients of the original message
464to the "Cc:" header of your reply, just as if you had initiated the reply with
465<a href="#messageReplyToGroup">messageReplyToGroup</a> instead of
466<a href="#messageReplyToSender">messageReplyToSender</a>.
467<p>
468<b>Default key mapping:</b> None
469<br><br>
470</dl><!--<hr>-->
471
472<a name="centerTag">centerTag</a><dl><dd>
473<p>
474Centers the current function vertically in the edit window.
475<br><br>
476<b>Default key mapping:</b> None
477<br><br>
478</dl><!--<hr>-->
479
480<a name="changes">changes</a><dl><dd>
481<p>
482Runs diff to display unsaved changes to the current buffer (if any). In the
483resulting output buffer, you can use <a href="#diffGotoFile">diffGotoFile</a>,
484mapped by default to Enter, to jump to the location of a particular change.
485<p>
486Because it uses diff, this command will not work unless diff is installed and
487in your path, which is more likely to be the case on Unix than Windows.
488<p>
489<b>Default key mapping:</b> None
490<br><br>
491</dl><!--<hr>-->
492
493<a name="checkPath">checkPath</a><dl><dd>
494<p>
495Examines all the lines in the current buffer that start with "#include" and
496reports which included files can't be found in your
497<a href="preferences.html#includePath">include path</a> (or in the current
498directory, if the filename is enclosed in quotes rather than in angle
499brackets). This command also recursively checks all the included files that it
500can find, and reports which (if any) of the files included by those files
501can't be found.
502<p>
503<b>Default key mapping:</b> None
504<p>
505<b>See also:</b> <a href="preferences.html#includePath">includePath</a>,
506<a href="#listIncludes">listIncludes</a>, <a href="#iList">iList</a>
507<br><br>
508</dl><!--<hr>-->
509
510<a name="clearRegister">clearRegister</a><dl><dd>
511<p>
512Prompts for a register name and erases the contents of the specified register.
513<p>
514Register names must be lower case letters (a-z). The contents of registers
515persist automatically from one j session to the next.
516<p>
517<b>Default key mapping:</b> None
518<p>
519<b>See also:</b>
520<a href="#editRegister">editRegister</a>,
521<a href="#insertRegister">insertRegister</a>,
522<a href="#listRegisters">listRegisters</a>,
523<a href="#saveToRegister">saveToRegister</a>
524<br><br>
525</dl><!--<hr>-->
526
527<a name="closeAll">closeAll</a><dl><dd>
528<p>
529Closes all open buffers, leaving a directory buffer looking at the current
530directory.
531<p>
532<b>Default key mapping:</b> None
533<p>
534<b>See also:</b> <a href="#closeOthers">closeOthers</a>
535<br><br>
536</dl><!--<hr>-->
537
538<a name="closeOthers">closeOthers</a><dl><dd>
539<p>
540Closes all open buffers except the current one.
541<br><br>
542<b>Default key mapping:</b> None
543<br><br>
544</dl><!--<hr>-->
545
546<a name="closeParen">closeParen</a><dl><dd>
547<p>
548Inserts a closing parenthesis and briefly moves the caret to the matching
549opening parenthesis.
550<br><br>
551<b>Default key mapping:</b> ')' in Java mode
552<br><br>
553</dl><!--<hr>-->
554
555<a name="commentRegion">commentRegion</a><dl><dd>
556<p>
557Comments out each line in the selected region, or the current line if no region is selected.
558<br><br>
559<b>Default key mapping:</b> F11
560<br><br>
561<b>See also:</b> <a href="#uncommentRegion">uncommentRegion</a>
562<br><br>
563</dl><!--<hr>-->
564
565<a name="compile">compile</a><dl><dd>
566<p>
567Compiles the source file in the current buffer. You will be prompted for the
568compile command. (On Windows, this command is only supported for Windows 2000
569and Windows XP.)
570<p>
571<b>Default key mapping:</b>
572<p>
573<b>See also:</b> <a href="#recompile">recompile</a>,
574<a href="compilation.html">Compilation Buffers</a>
575<br><br>
576</dl><!--<hr>-->
577
578<a name="compose">compose</a><dl><dd>
579<p>
580Opens a new mail composition buffer.
581<br><br>
582<b>Default key mapping:</b> 'c' in Mailbox mode
583<br><br>
584<b>See also:</b> <a href="mail.html">Mail</a>
585<br><br>
586</dl><!--<hr>-->
587
588<a name="copyAppend">copyAppend</a><dl><dd>
589<p>
590Appends the selected region (or the current line if no region is selected)
591to last entry in the <a href="killring.html">kill ring</a>.
592<br><br>
593<b>Default key mapping:</b> Ctrl Shift C
594<br><br>
595<b>See also:</b> <a href="#copyRegion">copyRegion</a>,
596<a href="#killAppend">killAppend</a>
597<br><br>
598</dl><!--<hr>-->
599
600<a name="copyLink">copyLink</a><dl><dd>
601<p>
602In web mode, copies to the <a href="killring.html">kill ring</a> (and to the
603system clipboard) the link at the location of the caret.
604<p>
605<b>Default key mapping:</b> None
606<br><br>
607</dl><!--<hr>-->
608
609<a name="copyPath">copyPath</a><dl><dd>
610<p>
611In directory buffers, copies to the <a href="killring.html">kill ring</a> (and
612to the system clipboard) the full pathname of the file on the line containing
613the caret.
614<br><br>
615<b>Default key mapping:</b> None
616<br><br>
617</dl><!--<hr>-->
618
619<a name="copyRegion">copyRegion</a><dl><dd>
620<p>
621Copies the contents of the selected region (or the current line if no region
622is selected). For normal regions, the copied text is placed in the
623<a href="killring.html">kill ring</a>. If the selected region is a column, the
624text is saved but not placed in the kill ring; it can be retrieved with the
625command <a href="#pasteColumn">pasteColumn</a>.
626<p>
627<b>Default key mapping:</b> Ctrl C
628<p>
629<b>See also:</b> <a href="#copyAppend">copyAppend</a>,
630<a href="#killRegion">killRegion</a>, <a href="#paste">paste</a>,
631<a href="columns.html">Columns</a>
632<br><br>
633</dl><!--<hr>-->
634
635<a name="copyXPath">copyXPath</a><dl><dd>
636<p>
637In XML mode, copies to the <a href="killring.html">kill ring</a> (and to the
638system clipboard) the path of the element at the current location of the caret.
639<p>
640<b>Default key mapping:</b> None
641<br><br>
642</dl><!--<hr>-->
643
644<a name="cppFindMatch">cppFindMatch</a><dl><dd>
645<p>
646If the caret is on a line that starts with <code>#if</code>,
647<code>#else</code>, <code>#elif</code> or <code>#endif</code>, finds the
648matching expression. Otherwise, finds the match of the brace, parenthesis or
649bracket at the location of the caret.
650<br><br>
651<b>Default key mapping:</b> Ctrl M in C++ mode
652<br><br>
653</dl><!--<hr>-->
654
655<a name="cvs">cvs</a><dl><dd>
656<p>
657Executes an arbitrary CVS command. The CVS command, together with any required
658flags, must be supplied as an argument. The name of the file associated with
659the current buffer is automatically appended to the command line, unless the
660argument you supply begins with "-H". For example:
661<pre>
662        cvs status -v
663</pre>
664<p>
665or:
666<pre>
667        cvs -H admin
668</pre>
669<p>
670<b>Default key mapping:</b> None
671<p>
672<b>See also:</b> <a href="cvs.html">CVS Support</a>
673<br><br>
674</dl><!--<hr>-->
675
676<a name="cvsAdd">cvsAdd</a><dl><dd>
677<p>
678Adds the file associated with the current buffer to CVS. The file is not
679actually placed in the CVS repository until you use
680<a href="#cvsCommit">cvsCommit</a> to make the change permanent.
681<p>
682<b>Default key mapping:</b> None
683<p>
684<b>See also:</b> <a href="cvs.html">CVS Support</a>
685<br><br>
686</dl><!--<hr>-->
687
688<a name="cvsCommit">cvsCommit</a><dl><dd>
689<p>
690Opens a checkin buffer in which you can compose a CVS checkin comment for the
691file associated with the current buffer.
692<p>
693When your comment is ready, you can use the command
694<a href="commands.html#finish">finish</a>, mapped by default to Ctrl Enter in
695the checkin buffer, to complete the checkin operation.
696<p>
697The file associated with the current buffer must already have been registered
698with CVS using <a href="#cvsAdd">cvsAdd</a> or the CVS "add" command.
699<p>
700<b>Default key mapping:</b> None
701<p>
702<b>See also:</b> <a href="cvs.html">CVS Support</a>
703<br><br>
704</dl><!--<hr>-->
705
706<a name="cvsDiff">cvsDiff</a><dl><dd>
707<p>
708Opens a diff output buffer showing the changes between the checked-in version
709of the file associated with the current buffer and your local copy.
710<p>
711<b>Default key mapping:</b> None
712<p>
713<b>See also:</b> <a href="cvs.html">CVS Support</a>
714<br><br>
715</dl><!--<hr>-->
716
717<a name="cvsDiffDir">cvsDiffDir</a><dl><dd>
718<p>
719Opens a diff output buffer showing the changes between the checked-in version
720and your local copy for all the files in the current directory and its
721subdirectories.
722<p>
723<b>Default key mapping:</b> None
724<p>
725<b>See also:</b> <a href="cvs.html">CVS Support</a>
726<br><br>
727</dl><!--<hr>-->
728
729<a name="cvsLog">cvsLog</a><dl><dd>
730<p>
731Runs the CVS "log" command on the file associated with the current buffer. The
732output is displayed in a transient output buffer.
733<p>
734<b>Default key mapping:</b> None
735<p>
736<b>See also:</b> <a href="cvs.html">CVS Support</a>
737<br><br>
738</dl><!--<hr>-->
739
740<a name="cycleIndentSize">cycleIndentSize</a><dl><dd>
741<p>
742Cycles through the most plausible possibilities for the indent size of the
743current buffer (2, 4 and 8 spaces).  The value that is currently in effect is
744shown in the status bar.
745<br><br>
746If you use cycleIndentSize to set the indent size, j will try to
747remember the setting the next time you open the same file.
748<br><br>
749<b>Default key mapping:</b> Alt I in most programming modes
750<br><br>
751</dl><!--<hr>-->
752
753<a name="cyclePaste">cyclePaste</a><dl><dd>
754<p>
755If the last command to be executed was not paste or cyclePaste, cyclePaste does
756exactly the same thing as <a href="#paste">paste</a>.
757<br><br>
758If the last command to be executed was paste or cyclePaste, cyclePaste fetches
759the next item from the <a href="killring.html">kill ring</a> and inserts it in
760place of the text inserted by the last paste or cyclePaste.
761<br><br>
762What this means in practice is that you can invoke cyclePaste repeatedly to
763cycle through the contents of the kill ring, stopping when you see that the
764text you want has been inserted. If you can't find what you want and
765would like to cancel the operation, use <a href="#undo">undo</a>.
766<br><br>
767<b>Default key mapping:</b> Ctrl Shift V
768<br><br>
769</dl><!--<hr>-->
770
771<a name="cycleTabWidth">cycleTabWidth</a><dl><dd>
772<p>
773Cycles through the most plausible possibilities for the tab width of the
774current buffer (2, 4 and 8 spaces). The value that is currently in effect is
775shown in the status bar.
776<p>
777This is intended to be a quick way to figure out the proper tab width to use
778when you've loaded a file for the first time and the indentation looks goofy.
779Just press Alt T repeatedly until things look right. Of course that may not
780happen; bear in mind that cycleTabWidth only considers the three most common
781possibilities.
782<p>
783If you use cycleTabWidth to set the tab width, j will try to remember the
784setting the next time you open the same file.
785<p>
786<b>Default key mapping:</b> Alt T
787<br><br>
788</dl><!--<hr>-->
789
790<a name="decodeRegion">decodeRegion</a><dl><dd>
791<p>
792Base 64 decodes the selected region (or the line containing the caret if no
793region is selected). If the resulting output is text, it is displayed in a new
794buffer; otherwise, you are prompted for a filename and the output is saved in
795the specified file.
796<p>
797<b>Default key mapping:</b> None
798<br><br>
799</dl><!--<hr>-->
800
801<a name="defaultMode">defaultMode</a><dl><dd>
802<p>
803Reloads the current buffer in its default mode.
804<p>
805<b>Default key mapping:</b> Ctrl Alt B in binary mode
806<p>
807<b>See also:</b> <a href="#binaryMode">binaryMode</a>
808<br><br>
809</dl><!--<hr>-->
810
811<a name="delete">delete</a><dl><dd>
812<p>
813If a region is marked, deletes it.  Otherwise, deletes the character at the
814location of the caret.
815<p>
816<b>Default key mapping:</b> Delete
817<br><br>
818</dl><!--<hr>-->
819
820<a name="detabRegion">detabRegion</a><dl><dd>
821<p>
822Replaces tab characters in the selected region with the appropriate number of
823spaces, based on the tab width of the buffer. Buffer-specific settings such as
824<a href="preferences.html#tabWidth">tabWidth</a> may be inspected and modified
825in the Properties dialog (see <a href="#properties">properties</a>).
826<br><br>
827<b>Default key mapping:</b> None
828<br><br>
829<b>See also:</b> <a href="#entabRegion">entabRegion</a>
830<br><br>
831</dl><!--<hr>-->
832
833<a name="deleteWordLeft">deleteWordLeft</a><dl><dd>
834<p>
835Deletes the word to the left of the caret.
836<br><br>
837<b>Default key mapping:</b> Ctrl Backspace
838<p>
839<b>See also:</b> <a href="#killWordLeft">killWordLeft</a>
840<br><br>
841</dl><!--<hr>-->
842
843<a name="deleteWordRight">deleteWordRight</a><dl><dd>
844<p>
845Deletes the word to the right of the caret.
846<br><br>
847<b>Default key mapping:</b> Ctrl Delete
848<p>
849<b>See also:</b> <a href="#killWordRight">killWordRight</a>
850<br><br>
851</dl><!--<hr>-->
852
853<a name="describeKey">describeKey</a><dl><dd>
854<p>
855Displays information about the command mapped to a particular key or key combination.
856<br><br>
857<b>Default key mapping:</b> Alt K
858<br><br>
859</dl><!--<hr>-->
860
861<a name="diffGotoFile">diffGotoFile</a><dl><dd>
862<p>
863Jumps to the location in the source buffer corresponding to the current line
864in the diff output buffer.
865<p>
866<b>Default key mapping:</b> Enter, Ctrl Shift G, Double Mouse-1, or Mouse-2 in
867Diff mode
868<p>
869<b>See also:</b> <a href="#changes">changes</a>
870<br><br>
871</dl><!--<hr>-->
872
873<a name="dir">dir</a><dl><dd>
874<p>
875Opens a directory buffer on the current directory.  The current directory is
876normally the parent directory of the file that is open in the current editor
877window.
878<br><br>
879<b>Default key mapping:</b> Ctrl D
880<br><br>
881<b>See also:</b> <a href="directories.html">Directory Buffers</a>.
882<br><br>
883</dl><!--<hr>-->
884
885<a name="dirBack">dirBack</a><dl><dd>
886<p>
887Changes to the previous directory in the history list for the current directory buffer.
888<br><br>
889<b>Default key mapping:</b> 'b' in directory buffers
890<br><br>
891<b>See also:</b> <a href="directories.html">Directory Buffers</a>.
892<br><br>
893</dl><!--<hr>-->
894
895<a name="dirBrowseFile">dirBrowseFile</a><dl><dd>
896<p>
897Uses the default browser to view the file at the location of the caret.
898<p>
899For this command to work, you need to specify the properties
900<a href="preferences.html#browser">browser</a> and (optionally)
901<a href="preferences.html#browserOpts">browserOpts</a> in your
902<a href="preferences.html">preferences</a> file.
903<p>
904<b>Default key mapping:</b> Ctrl Shift B in directory buffers
905<p>
906<b>See also:</b> <a href="directories.html">Directory Buffers</a>.
907<br><br>
908</dl><!--<hr>-->
909
910<a name="dirCopyFile">dirCopyFile</a><dl><dd>
911<p>
912Copies the file at the current location of the caret to a specified destination.
913You can specify either a filename or a directory as the destination.
914<p>
915<b>Default key mapping:</b> Alt C in directory buffers
916<p>
917<b>See also:</b> <a href="directories.html">Directory Buffers</a>.
918<br><br>
919</dl><!--<hr>-->
920
921<a name="dirCycleSortBy">dirCycleSortBy</a><dl><dd>
922<p>
923Cycles through the possibilities (name, date, size) for the sort order of the
924directory listing. The sort order that is currently in effect is displayed in
925the title bar of the editor window.
926<br><br>
927<b>Default key mapping:</b> S in directory buffers
928<br><br>
929<b>See also:</b> <a href="directories.html">Directory Buffers</a>.
930<br><br>
931</dl><!--<hr>-->
932
933<a name="dirDeleteFiles">dirDeleteFiles</a><dl><dd>
934<p>
935Deletes the marked files, or, if no files are marked, deletes the file at the
936current location of the caret.
937<br><br>
938<b>Default key mapping:</b> Delete in directory buffers
939<br><br>
940<b>See also:</b> <a href="directories.html">Directory Buffers</a>.
941<br><br>
942</dl><!--<hr>-->
943
944<a name="dirDoShellCommand">dirDoShellCommand</a><dl><dd>
945<p>
946Prompts for a shell command and executes the specified command on all the
947marked files in the current directory buffer.
948<p>
949If no files are marked, the command is executed on the file at the current
950location of the caret.
951<p>
952If the command string contains '*', the command runs once, with the list of
953marked files in place of the '*'. The order of the list is the order of
954appearance in the directory buffer.
955<p>
956If the command string does not contain '*', the command runs separately for
957each file, with the file name added at the end of the command string.
958<p>
959In all cases, the command is executed in the current directory (the directory
960displayed in the directory buffer).
961<p>
962<b>Default key mapping:</b> '!' in directory buffers
963<p>
964<b>See also:</b> <a href="directories.html">Directory Buffers</a>.
965<br><br>
966</dl><!--<hr>-->
967
968<a name="dirForward">dirForward</a><dl><dd>
969<p>
970Changes to the next directory in the history list for the current directory buffer.
971<p>
972<b>Default key mapping:</b> 'f' in directory buffers
973<p>
974<b>See also:</b> <a href="directories.html">Directory Buffers</a>.
975<br><br>
976</dl><!--<hr>-->
977
978<a name="dirGetFile">dirGetFile</a><dl><dd>
979<p>
980Copies the remote file at the current location of the caret to a specified
981destination on the local machine. You can specify either a filename or a
982directory as the destination.
983<br><br>
984<b>Default key mapping:</b> G in remote directory buffers
985<br><br>
986<b>See also:</b> <a href="directories.html">Directory Buffers</a>.
987<br><br>
988</dl><!--<hr>-->
989
990<a name="dirHome">dirHome</a><dl><dd>
991<p>
992If the caret is to the right of the first character of the filename on the
993current line, moves the caret to the first character of the filename.
994Otherwise, moves the caret to the beginning of the line.
995<br><br>
996<b>Default key mapping:</b> Home in directory buffers
997<br><br>
998<b>See also:</b> <a href="directories.html">Directory Buffers</a>.
999<br><br>
1000</dl><!--<hr>-->
1001
1002<a name="dirHomeDir">dirHomeDir</a><dl><dd>
1003<p>
1004If the current buffer is a directory buffer, changes to the home directory of
1005the current user. Otherwise, finds an existing directory buffer or opens a new
1006one on the home directory of the current user.
1007<br><br>
1008<b>Default key mapping:</b> None
1009<br><br>
1010<b>See also:</b> <a href="directories.html">Directory Buffers</a>.
1011<br><br>
1012</dl><!--<hr>-->
1013
1014<a name="dirMoveFile">dirMoveFile</a><dl><dd>
1015<p>
1016Moves the file at the current location of the caret to a specified destination.
1017You can specify either a filename or a directory as the destination.
1018<br><br>
1019<b>Default key mapping:</b> Alt M in directory buffers
1020<br><br>
1021<b>See also:</b> <a href="directories.html">Directory Buffers</a>.
1022<br><br>
1023</dl><!--<hr>-->
1024
1025<a name="dirOpenFile">dirOpenFile</a><dl><dd>
1026<p>
1027Opens the file or directory at the location of the caret or mouse click.
1028<p>
1029<b>Default key mapping:</b> Enter, Ctrl Shift G, Double Mouse-1, or Mouse-2 in directory buffers
1030<p>
1031<b>See also:</b> <a href="directories.html">Directory Buffers</a>.
1032<br><br>
1033</dl><!--<hr>-->
1034
1035<a name="dirRescan">dirRescan</a><dl><dd>
1036<p>
1037Refreshes the directory listing for the current directory buffer and rescans the
1038directory tree.
1039<br><br>
1040<b>Default key mapping:</b> None
1041<br><br>
1042<b>See also:</b> <a href="directories.html">Directory Buffers</a>.
1043<br><br>
1044</dl><!--<hr>-->
1045
1046<a name="dirLimit">dirLimit</a><dl><dd>
1047<p>
1048Sets a limit pattern (something like "*.java") to control what files are
1049displayed in the directory listing. Entering a blank string removes the limit,
1050so that all files are displayed.
1051<br><br>
1052<b>Default key mapping:</b> 'l' in directory buffers.
1053<br><br>
1054<b>See also:</b> <a href="#dirUnlimit">dirUnlimit</a>,
1055<a href="directories.html">Directory Buffers</a>.
1056<br><br>
1057</dl><!--<hr>-->
1058
1059<a name="dirTagFile">dirTagFile</a><dl><dd>
1060<p>
1061Tags or untags the file at the current location of the caret.
1062<p>
1063<b>Default key mapping:</b> 't' in directory buffers
1064<p>
1065<b>See also:</b> <a href="directories.html">Directory Buffers</a>.
1066<br><br>
1067</dl><!--<hr>-->
1068
1069<a name="dirUnlimit">dirUnlimit</a><dl><dd>
1070<p>
1071Removes any limit pattern that may be in effect for the current directory
1072buffer, so that all files are displayed.
1073<br><br>
1074<b>Default key mapping:</b> 'L' in directory buffers.
1075<br><br>
1076<b>See also:</b> <a href="#dirUnlimit">dirUnlimit</a>,
1077<a href="directories.html">Directory Buffers</a>.
1078<br><br>
1079</dl><!--<hr>-->
1080
1081<a name="dirUpDir">dirUpDir</a><dl><dd>
1082<p>
1083Navigates to the parent of the current directory.
1084<br><br>
1085<b>Default key mapping:</b> 'u' and Backspace in directory buffers
1086<br><br>
1087<b>See also:</b> <a href="directories.html">Directory Buffers</a>.
1088<br><br>
1089</dl><!--<hr>-->
1090
1091<a name="doShellCommandOnRegion">doShellCommandOnRegion</a><dl><dd>
1092<p>
1093Prompts for a shell command and then executes that command, using the selected
1094region as input. The contents of the selected region are replaced by the
1095output of the command. If an error occurs, you can use
1096<a href="commands.html#undo">undo</a> to restore the previous contents.
1097<br><br>
1098<code>doShellCommandOnRegion</code> is an experimental command, not enabled by
1099default. On Windows, you need to have the
1100<a href="http://sources.redhat.com/cygwin/">Cygwin</a> tools installed, and
1101sh.exe must be in your path.
1102<br><br>
1103<b>Default key mapping:</b> None
1104<br><br>
1105</dl><!--<hr>-->
1106
1107<a name="down">down</a><dl><dd>
1108<p>
1109Moves the caret down one line.
1110<br><br>
1111<b>Default key mapping:</b> Down arrow
1112<br><br>
1113</dl><!--<hr>-->
1114
1115<a name="dropBookmark">dropBookmark</a><dl><dd>
1116<p>
1117Drops a numbered bookmark at the location of the caret in the current buffer. By
1118default, <code>dropBookmark</code> is mapped to the ten keystrokes Alt 0 through Alt
11199, and <code>gotoBookmark</code> is mapped by default to the ten keystrokes Ctrl 0
1120through Ctrl 9. When you drop a bookmark with Alt n, you can return to it with
1121Ctrl n. It's possible to unmap these keystrokes or map other commands to them,
1122but the current implementation of <code>dropBookmark</code> and <code>gotoBookmark</code>
1123only works with these key mappings.
1124<br><br>
1125You can still return to a bookmark even if the buffer it refers to has been
1126closed (in that case the buffer will be re-opened in the current frame), but
1127bookmarks are not retained from one session to the next.
1128<br><br>
1129<b>Default key mapping:</b> Alt 0 through Alt 9 (bookmarks 0-9)
1130<br><br>
1131<b>See also:</b> <a href="#gotoBookmark">gotoBookmark</a>
1132<br><br>
1133</dl><!--<hr>-->
1134
1135<a name="editRegister">editRegister</a><dl><dd>
1136<p>
1137Prompts for a register name and opens a buffer so you can edit the contents of
1138the specified register.
1139<p>
1140Register names must be lower case letters (a-z). The contents of registers
1141persist automatically from one j session to the next.
1142<p>
1143<b>Default key mapping:</b> None
1144<p>
1145<b>See also:</b>
1146<a href="#clearRegister">clearRegister</a>,
1147<a href="#insertRegister">insertRegister</a>,
1148<a href="#listRegisters">listRegisters</a>,
1149<a href="#saveToRegister">saveToRegister</a>
1150<br><br>
1151</dl><!--<hr>-->
1152
1153<a name="electricCloseAngleBracket">electricCloseAngleBracket</a><dl><dd>
1154<p>
1155Inserts '>' and, if the property
1156<a href="preferences.html#autoIndent">autoIndent</a> is <code>true</code>,
1157re-indents the current line according to context.
1158<br><br>
1159<b>Default key mapping:</b> '>' in HTML and XML modes
1160<br><br>
1161</dl><!--<hr>-->
1162
1163<a name="electricCloseBrace">electricCloseBrace</a><dl><dd>
1164<p>
1165Inserts '}' and re-indents the current line according to context. If
1166the property <a href="preferences.html#autoNewline">autoNewline</a>
1167is <code>true</code>, also inserts a line separator
1168and moves the caret to the appropriate column on the new line.
1169<br><br>
1170<b>Default key mapping:</b> '}' in Java, JavaScript, C and C++ modes
1171<br><br>
1172<b>See also:</b> <a href="#electricOpenBrace">electricOpenBrace</a>
1173<br><br>
1174</dl><!--<hr>-->
1175
1176<a name="electricColon">electricColon</a><dl><dd>
1177<p>
1178Inserts a colon at the current location of the caret and re-indents the current
1179line according to context.  If the property
1180<a href="preferences.html#autoNewline">autoNewline</a> is <code>true</code>,
1181also inserts a line separator and moves the caret to the appropriate column on
1182the new line.
1183<br><br>
1184<b>Default key mapping:</b> ':' in Java mode
1185<br><br>
1186</dl><!--<hr>-->
1187
1188<a name="electricOpenBrace">electricOpenBrace</a><dl><dd>
1189<p>
1190Inserts '{' and re-indents the current line according to context. If
1191the property <a href="preferences.html#autoNewline">autoNewline</a>
1192is <code>true</code>, also inserts a line separator
1193and moves the caret to the appropriate column on the new line.
1194<br><br>
1195<b>Default key mapping:</b> '{' in Java, JavaScript, C and C++ modes
1196<br><br>
1197<b>See also:</b> <a href="#electricCloseBrace">electricCloseBrace</a>
1198<br><br>
1199</dl><!--<hr>-->
1200
1201<a name="electricPound">electricPound</a><dl><dd>
1202<p>
1203Inserts a '#' character at the current location of the caret.  If the line
1204contains only whitespace, the '#' will be forced into the first column.
1205<br><br>
1206<b>Default key mapping:</b> '#' in C and C++ modes
1207<br><br>
1208</dl><!--<hr>-->
1209
1210<a name="electricSemi">electricSemi</a><dl><dd>
1211<p>
1212Inserts a semicolon at the current location of the caret and re-indents the
1213current line according to context.  If the property <a href="preferences.html#autoNewline">autoNewline</a> is
1214<code>true</code>, also inserts a line separator and moves the caret to the
1215appropriate column on the new line.
1216<br><br>
1217<b>Default key mapping:</b> ';' in Java, JavaScript, C and C++ modes
1218<br><br>
1219</dl><!--<hr>-->
1220
1221<a name="electricStar">electricStar</a><dl><dd>
1222<p>
1223Inserts '*' at the current location of the caret and, if the current line is
1224otherwise blank, re-indents the line according to context.
1225<br><br>
1226<b>Default key mapping:</b> '*' in Java, JavaScript, C and C++ modes
1227<br><br>
1228</dl><!--<hr>-->
1229
1230<a name="end">end</a><dl><dd>
1231<p>
1232Moves the caret to the end of the current line.
1233<p>
1234If the preference <a href="preferences.html#extendEnd">extendEnd</a> is true,
1235invoking <b>end</b> repeatedly in quick sequence triggers special behavior
1236after the caret reaches the end of the current line: the caret is first moved
1237to the bottom of the edit window, and then to the end of the buffer. There is
1238a one-second timeout on this operation, meaning that if one second elapses
1239between invocations of <b>end</b>, the second invocation is viewed as an
1240independent event rather than a repetition of the first, and the special
1241behavior is not triggered.
1242<p>
1243<b>Default key mapping:</b> End
1244<p>
1245<b>See also:</b> <a href="#home">home</a>
1246<br><br>
1247</dl><!--<hr>-->
1248
1249<a name="entabRegion">entabRegion</a><dl><dd>
1250<p>
1251Replaces spaces with tab characters in the selected region, based on the tab
1252width of the buffer. Buffer-specific settings such as <code>tabWidth</code> may
1253be inspected and modified in the Properties dialog (see <a href="#properties">properties</a>).
1254<br><br>
1255<b>Default key mapping:</b> None
1256<br><br>
1257<b>See also:</b> <a href="#detabRegion">detabRegion</a>
1258<br><br>
1259</dl><!--<hr>-->
1260
1261<a name="eob">eob</a><dl><dd>
1262<p>
1263Moves the caret to the end of the buffer.
1264<br><br>
1265<b>Default key mapping:</b> Ctrl End
1266<br><br>
1267</dl><!--<hr>-->
1268
1269<a name="eol">eol</a><dl><dd>
1270<p>
1271Moves the caret to the end of the line.
1272<br><br>
1273<b>Default key mapping:</b> None
1274<br><br>
1275</dl><!--<hr>-->
1276
1277<a name="evalBuffer">evalBuffer</a><dl><dd>
1278<p>
1279Executes the <a href="http://www.beanshell.org">BeanShell</a> script in the
1280current buffer.
1281<p>
1282<b>Default key mapping:</b> None
1283<br><br>
1284</dl><!--<hr>-->
1285
1286<a name="escape">escape</a><dl><dd>
1287<p>
1288Escapes from the last operation.
1289<p>
1290More specifically, closes the most recently visited transient buffer (and
1291possibly unsplits the window). Transient buffers include help buffers, list
1292occurrencess buffers, and compilation buffers.
1293<p>
1294If no transient buffer is currently displayed, clears the selection
1295(if any) in the current buffer.
1296<p>
1297Otherwise, cancels any background process associated with the current buffer.
1298<p>
1299Each invocation of <code>escape</code> does at most one thing.
1300<p>
1301<b>Default key mapping:</b> Escape
1302<br><br>
1303</dl><!--<hr>-->
1304
1305<a name="executeCommand">executeCommand</a><dl><dd>
1306<p>
1307Executes an editor command by name. The "Command:" textfield in the location
1308bar supports both history (using the up and down arrow keys) and completion
1309(using Tab and Shift Tab).
1310<p>
1311Some commands (for example, <a href="#insertString">insertString</a>,
1312<a href="#help">help</a>, <a href="#jdkHelp">jdkHelp</a>, and
1313<a href="#source">source</a>) require or accept an argument (which in the
1314current implementation is always a string). Such commands can be entered like
1315this:
1316<pre>
1317        insertString this is a test
1318</pre>
1319or like this:
1320<pre>
1321        insertString("this is a test")
1322</pre>
1323<b>Default key mapping:</b> Alt x
1324<br><br>
1325</dl><!--<hr>-->
1326
1327<a name="expand">expand</a><dl><dd>
1328<p>
1329Replaces the text to the left of the caret with a word in the current buffer for
1330which that text is a prefix.
1331<br><br>
1332The expand command takes the sequence of characters you've just typed (more
1333precisely, the sequence of characters that are legal in a Java identifier,
1334beginning immediately to the left of the caret), looks through the entire
1335buffer for words (i.e. legal Java identifiers) that have the sequence in
1336question as a prefix, and replaces the sequence of characters with the first
1337match it finds.
1338<p>
1339If you don't like that particular replacement, you can hit Alt Space (or Alt
1340/) again (and again and again) to cycle through all the possible replacements.
1341If you don't like any of the replacements, you can use
1342<a href="#undo">undo</a>, mapped by default to Ctrl Z, or
1343<a href="#escape">escape</a>, mapped by default to Escape, at any point, and
1344get back where you started.
1345<p>
1346In the header area of a mail composition buffer, expand looks for completions
1347in the global address book, rather than in the text of the buffer, so you can
1348use it to auto-complete mail addresses.
1349<p>
1350This functionality is also available in all of j's textfields (both in dialog
1351boxes and in the location bar), with the same default key mappings. In a
1352textfield, the expansion text is taken from the current buffer, and the
1353expansion can be cancelled by pressing Escape.
1354<p>
1355<b>Default key mapping:</b> Alt Space and Alt /
1356<br><br>
1357</dl><!--<hr>-->
1358
1359<a name="find">find</a><dl><dd>
1360<p>
1361Prompts for a pattern and finds the next occurrence of the specified pattern in
1362the current buffer.
1363<p>
1364The search is case-insensitive if the "Ignore case" checkbox is checked.
1365<p>
1366If the "Whole words only" checkbox is checked, a match is returned only if it
1367is both preceded and followed by a non-word character (i.e. a character not
1368legal in an identifier, based on the mode of the buffer).
1369<p>
1370If the "Regular expression" checkbox is checked, the pattern is interpreted as
1371a <a href="regexp.html">regular expression</a> rather than as a simple string.
1372<p>
1373If the "Multiline pattern" checkbox is checked, the regular expression can
1374contain newline characters ("\n"). Because of the way j handles things
1375internally, a single "\n" should be used to match a newline even if the file
1376being edited uses "\r\n" or "\r" as its line separator string. (The "Multiline
1377pattern" feature is experimental and is not enabled by default.)
1378<p>
1379If the "List occurrences" checkbox is checked, all lines in the current buffer
1380that match the specified pattern are listed.
1381<p>
1382If the "Search from start of document" checkbox is checked, the search begins
1383at the start of the document. Otherwise, the search begins at the current
1384location of the caret.
1385<p>
1386<b>Default key mapping:</b> Ctrl F or
1387Alt F3
1388<p>
1389<b>Note:</b> If you set
1390<a href="preferences.html#useIncrementalFind">useIncrementalFind</a> to true
1391in your <a href="preferences.html">preferences</a> file,
1392<a href="commands.html#incrementalFind">incrementalFind</a> will be mapped by
1393default to Ctrl F.
1394<br><br>
1395</dl><!--<hr>-->
1396
1397<a name="findFirstOccurrence">findFirstOccurrence</a><dl><dd>
1398<p>
1399Finds the first occurrence in the current buffer of the word at the current
1400location of the caret.
1401<p>
1402The search is case-sensitive and is carried out as if the "whole words only"
1403option was specified.
1404<p>
1405<b>Default key mapping:</b> Ctrl Alt Up
1406<p>
1407<b>See also:</b> <a href="#findNextWord">findNextWord</a>,
1408<a href="#findPrevWord">findPrevWord</a>
1409<br><br>
1410</dl><!--<hr>-->
1411
1412<a name="findInFiles">findInFiles</a><dl><dd>
1413<p>
1414Prompts for a pattern and a file specification and generates a list of all
1415occurrences of the specified pattern in files matching the file specification.
1416<p>
1417Several file specifications can be supplied at once, separated by semicolons.
1418If the full path is not given in a file specification, the current directory or
1419the directory last specified by a full path is used.
1420<p>
1421For example, if the file specification is <code>*.c;/usr/src/emacs-20.3/src/*.c;*.h</code>,
1422the search will examine <code>.c</code> files in the current directory and
1423<code>.c</code> and <code>.h</code> files in <code>/usr/src/emacs-20.3/src</code>.
1424<p>
1425The search is case-insensitive if the "Ignore case" checkbox is checked.
1426<p>
1427If the "Whole words only" checkbox is checked, a match will only be returned if
1428it is both preceded and followed by a non-word character (i.e. a character not
1429legal in a Java identifier).
1430<p>
1431If the "Regular expression" checkbox is checked, the pattern will be
1432interpreted as a <a href="regexp.html">regular expression</a> rather than a
1433simple string.
1434<p>
1435If the "Include subdirectories" checkbox is checked, the search will recurse
1436into any subdirectories of directories in the file specification. For example,
1437if the file specification is <code>/usr/src/linux/*.c</code>, the search will
1438examine <code>.c</code> files in <code>/usr/src/linux</code> and all of its
1439subdirectories.
1440<p>
1441If the "Search files in memory" checkbox is checked, if a file matching the
1442file specification is currently loaded in a buffer, the contents of the buffer
1443will be searched rather than the file as last saved on disk, so unsaved
1444changes to the buffer will be taken into account.
1445<p>
1446You can use the command <a href="#escape">escape</a>, mapped by default to
1447Escape, to cancel a search in progress.
1448<p>
1449<b>Default key mapping:</b> Ctrl Shift F, F6
1450<p>
1451<b>See also:</b> <a href="#listFiles">listFiles</a>
1452<br><br>
1453</dl><!--<hr>-->
1454
1455<a name="findMatchingChar">findMatchingChar</a><dl><dd>
1456<p>
1457Finds the match of the brace, parenthesis or bracket at the location of the
1458caret.
1459<br><br>
1460<b>Default key mapping:</b> Ctrl M
1461<br><br>
1462</dl><!--<hr>-->
1463
1464<a name="findNext">findNext</a><dl><dd>
1465<p>
1466Finds the next match in the current search (initiated by <a href="#find">find</a>,
1467<a href="#incrementalFind">incrementalFind</a>, <a href="#findNextWord">findNextWord</a>
1468or <a href="#findPrevWord">findPrevWord</a>).
1469<br><br>
1470<b>Default key mapping:</b> F3, Ctrl G
1471<br><br>
1472</dl><!--<hr>-->
1473
1474<a name="findNextWord">findNextWord</a><dl><dd>
1475<p>
1476Finds the next occurrence in the current buffer of the word at the current
1477location of the caret.
1478<p>
1479The search is case-sensitive and is carried out as if the "whole words only"
1480option was specified.
1481<p>
1482<b>Default key mapping:</b> Alt Down
1483<p>
1484<b>See also:</b> <a href="#findFirstOccurrence">findFirstOccurrence</a>,
1485<a href="#findPrevWord">findPrevWord</a>
1486<br><br>
1487</dl><!--<hr>-->
1488
1489<a name="findOccurrenceAtDot">findOccurrenceAtDot</a><dl><dd>
1490<p>
1491Jumps to the line in the source file corresponding to the current line in a
1492List Occurrences buffer.
1493<p>
1494<b>Default key mapping:</b> Enter or Ctrl Shift G in List Occurrences buffers
1495<p>
1496<b>See also:</b> <a href="#mouseFindOccurrence">mouseFindOccurrence</a>
1497<br><br>
1498</dl><!--<hr>-->
1499
1500<a name="findPrev">findPrev</a><dl><dd>
1501<p>
1502Finds the previous match in the current search (initiated by <a href="#find">find</a>,
1503<a href="#incrementalFind">incrementalFind</a>, <a href="#findNextWord">findNextWord</a>
1504or <a href="#findPrevWord">findPrevWord</a>).
1505<br><br>
1506<b>Default key mapping:</b> Shift F3, Ctrl H
1507<br><br>
1508</dl><!--<hr>-->
1509
1510<a name="findPrevWord">findPrevWord</a><dl><dd>
1511<p>
1512Finds the previous occurrence in the current buffer of the word at the current
1513location of the caret.
1514<p>
1515The search is case-sensitive and is carried out as if the "whole words only"
1516option was specified.
1517<p>
1518<b>Default key mapping:</b> Alt Up
1519<p>
1520<b>See also:</b> <a href="#findFirstOccurrence">findFirstOccurrence</a>,
1521<a href="#findNextWord">findNextWord</a>
1522<br><br>
1523</dl><!--<hr>-->
1524
1525<a name="findTag">findTag</a><dl><dd>
1526<p>
1527Prompts for a tag (generally speaking, a tag is a function name) and moves the
1528caret to the definition of the specified function. The current location of the
1529caret is first saved on the marker stack as a temporary bookmark, so you can
1530use <a href="#popPosition">popPosition</a>, mapped by default to Shift F5, to
1531get back where you came from.
1532<p>
1533<b>Default key mapping:</b> Ctrl T
1534<p>
1535<b>See also:</b> <a href="#findTagAtDot">findTagAtDot</a>,
1536<a href="#findTagAtDotOtherWindow">findTagAtDotOtherWindow</a>,
1537<a href="#mouseFindTag">mouseFindTag</a>
1538<br><br>
1539</dl><!--<hr>-->
1540
1541<a name="findTagAtDot">findTagAtDot</a><dl><dd>
1542<p>
1543Jumps to the definition of the function at the current location of the caret.
1544The current location of the caret is first saved on the marker stack as a
1545temporary bookmark, so you can use <a href="#popPosition">popPosition</a>,
1546mapped by default to Shift F5, to get back where you came from.
1547<p>
1548<b>Default key mapping:</b> Alt . (Alt dot) in Java, C, C++, Lisp, Scheme and
1549Perl modes
1550<p>
1551<b>See also:</b> <a href="#findTag">findTag</a>,
1552<a href="#findTagAtDotOtherWindow">findTagAtDotOtherWindow</a>,
1553<a href="#mouseFindTag">mouseFindTag</a>
1554<br><br>
1555</dl><!--<hr>-->
1556
1557<a name="findTagAtDotOtherWindow">findTagAtDotOtherWindow</a><dl><dd>
1558<p>
1559Jumps to the definition of the function at the current location of the caret,
1560using the other window (splitting the current window if necessary). Keyboard
1561focus stays in the original window.
1562<p>
1563<b>Default key mapping:</b> Ctrl Alt . (Ctrl Alt dot) in Java mode and its
1564derivatives
1565<p>
1566<b>See also:</b> <a href="#findTag">findTag</a>,
1567<a href="#findTagAtDot">findTagAtDot</a>,
1568<a href="#mouseFindTag">mouseFindTag</a>
1569<br><br>
1570</dl><!--<hr>-->
1571
1572<a name="finish">finish</a><dl><dd>
1573<p>
1574Completes the CVS checkin operation, using the contents of the current buffer
1575as the checkin comment. This command is only available in CVS checkin buffers.
1576<p>
1577<b>Default key mapping:</b> Ctrl Enter in CVS checkin buffers
1578<p>
1579<b>See also:</b> <a href="cvs.html">CVS Support</a>
1580<br><br>
1581</dl><!--<hr>-->
1582
1583<a name="fold">fold</a><dl><dd>
1584<p>
1585Creates a fold at (or near) the current location of the caret.
1586<br><br>
1587<b>Default key mapping:</b> Ctrl [ in Java, C, C++ and Perl modes
1588<br><br>
1589<b>See also:</b> <a href="#foldMethods">foldMethods</a>,
1590<a href="#unfold">unfold</a>, <a href="#unfoldAll">unfoldAll</a>
1591<br><br>
1592</dl><!--<hr>-->
1593
1594<a name="foldMethods">foldMethods</a><dl><dd>
1595<p>
1596Folds all the methods in the current buffer.
1597<br><br>
1598<b>Default key mapping:</b> None
1599<br><br>
1600<b>See also:</b> <a href="#fold">fold</a>,
1601<a href="#foldRegion">foldRegion</a>, <a href="#unfold">unfold</a>,
1602<a href="#unfoldAll">unfoldAll</a>
1603<br><br>
1604</dl><!--<hr>-->
1605
1606<a name="foldRegion">foldRegion</a><dl><dd>
1607<p>
1608Folds the marked region. The region in question must consist of full lines; in
1609other words, both dot and mark must be in column 1.
1610<br><br>
1611<b>Default key mapping:</b> None
1612<br><br>
1613<b>See also:</b> <a href="#fold">fold</a>,
1614<a href="#foldMethods">foldMethods</a>, <a href="#unfold">unfold</a>,
1615<a href="#unfoldAll">unfoldAll</a>
1616<br><br>
1617</dl><!--<hr>-->
1618
1619<a name="gotoBookmark">gotoBookmark</a><dl><dd>
1620<p>
1621Returns to a previously dropped numbered bookmark. By default,
1622<code>dropBookmark</code> is mapped to the ten keystrokes Alt 0 through Alt 9, and
1623<code>gotoBookmark</code> is mapped by default to the ten keystrokes Ctrl 0 through
1624Ctrl 9. When you drop a bookmark with Alt n, you can return to it with Ctrl n.
1625It's possible to unmap these keystrokes or map other commands to them, but the
1626current implementation of <code>dropBookmark</code> and <code>gotoBookmark</code> only
1627works with these key mappings.
1628<br><br>
1629You can still return to a bookmark even if the buffer it refers to has been
1630closed (in that case the buffer will be re-opened in the current frame), but
1631bookmarks are not retained from one session to the next.
1632<br><br>
1633<b>Default key mapping:</b> Ctrl 0 through Ctrl 9 (bookmarks 0-9)
1634<br><br>
1635<b>See also:</b> <a href="#dropBookmark">dropBookmark</a>
1636<br><br>
1637</dl><!--<hr>-->
1638
1639<a name="gotoFile">gotoFile</a><dl><dd>
1640<p>
1641Opens the file at the location of the caret or mouse click.
1642<p>
1643<b>Default key mapping:</b> Ctrl Shift G (global), Mouse-2 (shell buffers)
1644<br><br>
1645</dl><!--<hr>-->
1646
1647<a name="help">help</a><dl><dd>
1648<p>
1649Displays help.
1650<p>
1651For this command to work, you may need to set the <a href="preferences.html#docPath">docPath</a>
1652property in your <a href="preferences.html">preferences</a> file to point to the
1653directory containing the documentation:
1654<pre>
1655        docPath=/home/peter/j/doc
1656</pre>
1657For Windows, you'll need to use double backslashes, like this:
1658<pre>
1659        docPath=c:\\j\\doc
1660</pre>
1661If you use
1662<a href="#executeCommand">executeCommand</a> to invoke help, you can
1663specify the command you want help on at the same time:
1664<pre>
1665        help executeCommand
1666</pre>
1667or
1668<pre>
1669        help("executeCommand")
1670</pre>
1671<b>Default key mapping:</b> F1
1672<p>
1673<b>See also:</b> <a href="#executeCommand">executeCommand</a>
1674<br><br>
1675</dl><!--<hr>-->
1676
1677<a name="home">home</a><dl><dd>
1678<p>
1679Moves the caret to the beginning of the text on the current line, if the caret
1680is to the right of that location to begin with. If the caret is already at the
1681beginning of the text on the current line or in the whitespace to the left of
1682the text, <b>home</b> moves the caret to column 1 on the same line.
1683<p>
1684If the preference <a href="preferences.html#extendHome">extendHome</a> is
1685true, invoking <b>home</b> repeatedly in quick sequence triggers special
1686behavior after the caret reaches column 1 on the current line: the caret is
1687then moved to the top left corner of the edit window, and then to the
1688beginning of the buffer. There is a one-second timeout on this operation,
1689meaning that if one second elapses between invocations of <b>home</b>, the
1690second invocation is viewed as an independent event rather than a repetition
1691of the first, and the special behavior is not triggered.
1692<p>
1693<a href="preferences.html#extendHome">extendHome</a> is false by default.
1694<p>
1695<b>Default key mapping:</b> Home
1696<p>
1697<b>See also:</b> <a href="#end">end</a>
1698<br><br>
1699</dl><!--<hr>-->
1700
1701<a name="htmlBold">htmlBold</a><dl><dd>
1702<p>
1703Inserts an HTML bold tag ("&lt;B&gt;") before the selected text (or before the location of
1704the caret, if there's no selection) and an HTML end tag ("&lt;/B&gt;") after the selected
1705text (or after the location of the caret).
1706<br><br>
1707The case of the inserted tags is controlled by the property <a href="preferences.html#HtmlMode.upperCaseTagNames">HtmlMode.upperCaseTagNames</a>,
1708which is <code>true</code> by default.
1709<br><br>
1710<b>Default key mapping:</b> Ctrl B in HTML mode
1711<br><br>
1712<b>See also:</b> <a href="#htmlInsertTag">htmlInsertTag</a>
1713
1714<br><br>
1715</dl><!--<hr>-->
1716
1717<a name="htmlElectricEquals">htmlElectricEquals</a><dl><dd>
1718<p>
1719Inserts '=' at the current location of the caret.
1720<br><br>
1721In HTML mode, if the property
1722<a href="preferences.html#HtmlMode.attributesRequireQuotes">HtmlMode.attributesRequireQuotes</a>
1723is true, and if the '=' immediately follows an attribute name, and if the
1724character following the '=' is either whitespace or '>', this command inserts
1725a pair of double quotation marks after the '=' and positions the caret between
1726the quotation marks.
1727<p>
1728The effect of this is to make it possible to enclose attribute values in
1729quotation marks without having to type the quotation marks themselves.
1730<p>
1731<b>Default key mapping:</b> '=' in HTML mode
1732<p>
1733<b>See also:</b> <a href="#xmlElectricEquals">xmlElectricEquals</a>
1734<br><br>
1735</dl><!--<hr>-->
1736
1737<a name="htmlEndTag">htmlEndTag</a><dl><dd>
1738<p>
1739Inserts an empty HTML end tag, with the caret positioned after the opening "&lt;/".
1740<br><br>
1741<b>Default key mapping:</b> Ctrl Shift .
1742<br><br>
1743</dl><!--<hr>-->
1744
1745<a name="htmlFindMatch">htmlFindMatch</a><dl><dd>
1746<p>
1747Finds the match to the HTML tag at the location of the caret.  Nested tags are
1748handled correctly.
1749<br><br>
1750<b>Default key mapping:</b> Ctrl M in HTML mode
1751<br><br>
1752</dl><!--<hr>-->
1753
1754<a name="htmlInsertMatchingEndTag">htmlInsertMatchingEndTag</a><dl><dd>
1755<p>
1756Inserts the HTML end tag corresponding to the last HTML start tag before the
1757location of the caret. Nested tags are not currently supported.
1758<br><br>
1759<b>Default key mapping:</b> Ctrl E in HTML mode
1760<br><br>
1761</dl><!--<hr>-->
1762
1763<a name="htmlInsertTag">htmlInsertTag</a><dl><dd>
1764<p>
1765Inserts an HTML start tag and (if appropriate) the corresponding end tag,
1766enclosing the current selection. If no selection is marked, the start and end
1767tags will enclose the word at the current location of the caret, if any.
1768<br><br>
1769If the property <a href="preferences.html#HtmlMode.fixCase">HtmlMode.fixCase</a>
1770is true, the tag name will be converted to the preferred case (as specified by
1771<a href="preferences.html#HtmlMode.upperCaseTagNames">HtmlMode.upperCaseTagNames</a>
1772when it is inserted in the buffer.
1773<br><br>
1774J will normally insert an end tag unless it is forbidden.  You can customize this
1775behavior by supply a tag customization file; see <a href="preferences.html#HtmlMode.tags">HtmlMode.tags</a>.
1776<br><br>
1777<b>Default key mapping:</b> Ctrl Shift , (Ctrl Shift comma) in HTML mode
1778<br><br>
1779</dl><!--<hr>-->
1780
1781<a name="htmlStartTag">htmlStartTag</a><dl><dd>
1782<p>
1783Inserts an empty HTML start tag, with the caret positioned after the opening angle bracket.
1784<br><br>
1785<b>Default key mapping:</b> None
1786<br><br>
1787</dl><!--<hr>-->
1788
1789<a name="httpShowHeaders">httpShowHeaders</a><dl><dd>
1790<p>
1791Displays the request and response headers for the current HTTP buffer.
1792<p>
1793<b>Default key mapping:</b> None
1794<br><br>
1795</dl><!--<hr>-->
1796
1797<a name="iList">iList</a><dl><dd>
1798<p>
1799Lists all occurrences of the identifier at the location of the caret, both in
1800the current buffer and in any files referenced by a "#include" directive in
1801the current buffer, in the order in which they occur.
1802<p>
1803<b>Default key mapping:</b> Ctrl F6 in C and C++ modes
1804<p>
1805<b>See also:</b> <a href="preferences.html#includePath">includePath</a>,
1806<a href="#checkPath">checkPath</a>, <a href="#listIncludes">listIncludes</a>
1807<br><br>
1808</dl><!--<hr>-->
1809
1810<a name="imageCycleBackground">imageCycleBackground</a><dl><dd>
1811<p>
1812In Image mode, changes the background color of the image. Invoking this command
1813repeatedly cycles through a small number of plausible background colors
1814(currently gray, black and white).
1815<br><br>
1816<b>Default key mapping:</b> 'c' in Image mode
1817<br><br>
1818</dl><!--<hr>-->
1819
1820<a name="imageFit">imageFit</a><dl><dd>
1821<p>
1822Scales the image to fit the current display window. The aspect ratio of the
1823original image is preserved.
1824<br><br>
1825<b>Default key mapping:</b> 'f' in Image mode
1826<br><br>
1827<b>See also:</b> <a href="#imageRestore">imageRestore</a>,
1828<a href="#imageZoomIn">imageZoomIn</a>,
1829<a href="#imageZoomOut">imageZoomOut</a>
1830<br><br>
1831</dl><!--<hr>-->
1832
1833<a name="imageRestore">imageRestore</a><dl><dd>
1834<p>
1835Restores the image to its original size.
1836<br><br>
1837<b>Default key mapping:</b> 'r' in Image mode
1838<br><br>
1839<b>See also:</b> <a href="#imageFit">imageFit</a>,
1840<a href="#imageZoomIn">imageZoomIn</a>,
1841<a href="#imageZoomOut">imageZoomOut</a>
1842<br><br>
1843</dl><!--<hr>-->
1844
1845<a name="imageZoomIn">imageZoomIn</a><dl><dd>
1846<p>
1847Zoom in by a factor of 2.
1848<br><br>
1849<b>Default key mapping:</b> '=' in Image mode
1850<br><br>
1851<b>See also:</b> <a href="#imageFit">imageFit</a>,
1852<a href="#imageRestore">imageRestore</a>,
1853<a href="#imageZoomOut">imageZoomOut</a>
1854<br><br>
1855</dl><!--<hr>-->
1856
1857<a name="imageZoomOut">imageZoomOut</a><dl><dd>
1858<p>
1859Zoom out by a factor of 2.
1860<br><br>
1861<b>Default key mapping:</b> '-' in Image mode
1862<br><br>
1863<b>See also:</b> <a href="#imageFit">imageFit</a>,
1864<a href="#imageRestore">imageRestore</a>,
1865<a href="#imageZoomIn">imageZoomIn</a>
1866<br><br>
1867</dl><!--<hr>-->
1868
1869<a name="inbox">inbox</a><dl><dd>
1870<p>
1871Opens your default inbox.
1872<br><br>
1873To specify your default inbox, add a line like this to your
1874<a href="preferences.html">preferences</a> file:
1875<pre>
1876        inbox = pop://peter@annie</pre>
1877or for IMAP:
1878<pre>
1879        inbox = {peter@annie}inbox</pre>
1880<b>Default key mapping:</b> None
1881<br><br>
1882<b>See also:</b> <a href="#openMailbox">openMailbox</a>,
1883<a href="mail.html">Mail</a>
1884<br><br>
1885</dl><!--<hr>-->
1886
1887<a name="incrementalFind">incrementalFind</a><dl><dd>
1888<p>
1889Prompts for input and finds the string entered, as it is typed in.
1890<br><br>
1891The search is case-insensitive unless (or until) the pattern contains at least
1892one upper case character.
1893<br><br>
1894In the incremental find textfield, any key combination mapped to
1895<code>incrementalFind</code> or <code>findNext</code> can be used to search
1896for the next occurrence of the current pattern, and any key combination mapped
1897to <code>findPrev</code> can be used to search for the previous occurrence of
1898the pattern. (By default, <code>findNext</code> is mapped to F3 and Ctrl G, and
1899<code>findPrev</code> is mapped to Shift F3 and Ctrl H.)
1900<p>
1901Ctrl W can be used to copy text from the buffer into the search pattern. Ctrl
1902W copies the text from the buffer starting at the current location of the
1903caret up until the end of the current word (or the end of the next word, if
1904the caret is already at the end of the current word).
1905<p>
1906Ctrl P and Ctrl N can be used to navigate through the history list of
1907previously used search patterns.
1908<p>
1909If you invoke <a href="#incrementalFind">incrementalFind</a> and then realize
1910you'd rather use <a href="#find">find</a> instead, you can get there by simply
1911pressing Enter (as long as the incremental find textfield is empty).
1912<p>
1913<b>Default key mapping:</b> None
1914<p>
1915<b>Note:</b> If you set
1916<a href="preferences.html#useIncrementalFind">useIncrementalFind</a> to true
1917in your <a href="preferences.html">preferences</a> file,
1918<a href="#incrementalFind">incrementalFind</a> will be mapped by default to
1919Ctrl F.
1920<br><br>
1921</dl><!--<hr>-->
1922
1923<a name="indentLine">indentLine</a><dl><dd>
1924<p>
1925Applies j's idea of correct indentation to the current line.
1926<br><br>
1927<b>Default key mapping:</b> None
1928<p>
1929<b>See also:</b> <a href="#indentRegion">indentRegion</a>,
1930<a href="#indentLineOrRegion">indentLineOrRegion</a>,
1931<a href="preferences.html#indentLineFixWhitespace">indentLineFixWhitespace</a>
1932<br><br>
1933</dl><!--<hr>-->
1934
1935<a name="indentLineOrRegion">indentLineOrRegion</a><dl><dd>
1936<p>
1937Applies j's idea of correct indentation to the marked region, or, if no region is
1938marked, the current line.
1939<p>
1940<b>Default key mapping:</b> None
1941<p>
1942<b>See also:</b> <a href="#indentLine">indentLine</a>,
1943<a href="#indentRegion">indentRegion</a>,
1944<a href="preferences.html#indentLineFixWhitespace">indentLineFixWhitespace</a>
1945<br><br>
1946</dl><!--<hr>-->
1947
1948<a name="indentRegion">indentRegion</a><dl><dd>
1949<p>
1950Applies j's idea of correct indentation to the marked region.
1951<br><br>
1952<b>Default key mapping:</b> None
1953<p>
1954<b>See also:</b> <a href="commands.html#indentLine">indentLine</a>,
1955<a href="#indentLineOrRegion">indentLineOrRegion</a>,
1956<a href="preferences.html#indentLineFixWhitespace">indentLineFixWhitespace</a>
1957<br><br>
1958</dl><!--<hr>-->
1959
1960<a name="insertBraces">insertBraces</a><dl><dd>
1961<p>
1962Inserts an opening brace followed by a closing brace, indented appropriately,
1963leaving the caret positioned between them.
1964<br><br>
1965<b>Default key mapping:</b> Ctrl Shift [ in Java, JavaScript, C and C++ modes
1966<br><br>
1967</dl><!--<hr>-->
1968
1969<a name="insertByte">insertByte</a><dl><dd>
1970<p>
1971Inserts the character that corresponds to the specified byte in the default
1972encoding at the current location of the caret. The byte must be specified as a
1973decimal, hexadecimal or octal number. A leading zero denotes an octal number; a
1974leading "0x" or "0X" denotes a hexidecimal number; otherwise the number is
1975assumed to be decimal.
1976<br><br>
1977<b>Default key mapping:</b> None
1978<br><br>
1979</dl><!--<hr>-->
1980
1981<a name="insertChar">insertChar</a><dl><dd>
1982<p>
1983Inserts the specified Unicode character at the current location of the caret.
1984The character must be specified as a decimal, hexidecimal or octal number. A
1985leading zero denotes an octal number; a leading "0x" or "0X" denotes a
1986hexidecimal number; otherwise the number is assumed to be decimal.
1987<br><br>
1988<b>Default key mapping:</b> None
1989<br><br>
1990</dl><!--<hr>-->
1991
1992<a name="insertKeyText">insertKeyText</a><dl><dd>
1993<p>
1994Inserts the next key combination you type (which can be a single key like Enter
1995or Backspace, or a combination like Ctrl Alt S) as a string (like "Enter" or
1996"Backspace" or "Ctrl Alt S") at the location of the caret in the current
1997buffer. The action mapped to the key combination in question (if any) is not
1998performed. Useful for editing a custom key map. The inserted text is guaranteed
1999(well, not guaranteed, exactly, but extremely likely) to be in a format
2000recognizable by j's key map parser.
2001<br><br>
2002<b>Default key mapping:</b> None
2003<br><br>
2004</dl><!--<hr>-->
2005
2006<a name="insertParentheses">insertParentheses</a><dl><dd>
2007<p>
2008If a region is selected, inserts parentheses around the selected region.
2009Otherwise, inserts an opening parenthesis followed by a closing parenthesis,
2010leaving the caret positioned between them.
2011<br><br>
2012If <b>parensRequireSpaces</b> is <b>true</b>, single space characters are
2013added after the opening parenthesis and before the closing parenthesis.
2014<br><br>
2015<b>Default key mapping:</b> Ctrl Shift ( in Java, JavaScript, C, C++, and Perl modes
2016<br><br>
2017<b>See also:</b> <a href="#movePastCloseAndReindent">movePastCloseAndReindent</a>
2018<br><br>
2019</dl><!--<hr>-->
2020
2021<a name="insertRegister">insertRegister</a><dl><dd>
2022<p>
2023Prompts for a register name and inserts the contents of the selected register
2024at the location of the caret in the current buffer.
2025<p>
2026Register names must be lower case letters (a-z). The contents of registers
2027persist automatically from one j session to the next.
2028<p>
2029<b>Default key mapping:</b> None
2030<p>
2031<b>Abbreviation:</b> ir
2032<p>
2033<b>See also:</b>
2034<a href="#clearRegister">clearRegister</a>,
2035<a href="#editRegister">editRegister</a>,
2036<a href="#listRegisters">listRegisters</a>.
2037<a href="#saveToRegister">saveToRegister</a>
2038<br><br>
2039</dl><!--<hr>-->
2040
2041<a name="insertString">insertString</a><dl><dd>
2042<p>
2043Requires a string argument. The supplied string argument is inserted in the
2044current buffer at the location of the caret. Can be invoked using
2045<a href="#executeCommand">executeCommand</a> or mapped to a key combination in
2046a global or mode-specific key map.
2047<p>
2048For example:
2049<pre>
2050        insertString("e.printStackTrace( );")
2051</pre>
2052<b>Default key mapping:</b> None
2053<p>
2054<b>See also:</b> <a href="#executeCommand">executeCommand</a>
2055<br><br>
2056</dl><!--<hr>-->
2057
2058<a name="insertTab">insertTab</a><dl><dd>
2059<p>
2060If <code>useTabs</code> is <code>true</code> for the current buffer, inserts a
2061tab character at the location of the caret, otherwise inserts the appropriate
2062number of spaces, based on the buffer's <code>indentSize</code>.
2063Buffer-specific settings such as <code>useTabs</code> and
2064<code>indentSize</code> may be inspected and modified in the Properties dialog
2065(see <a href="#properties">properties</a>).
2066<br><br>
2067<b>Default key mapping:</b> Ctrl Tab in Java and HTML modes
2068<br><br>
2069</dl><!--<hr>-->
2070
2071<a name="jdkHelp">jdkHelp</a><dl><dd>
2072<p>
2073Displays the JDK HTML help file corresponding to the class name at the
2074location of the caret or mouse click.
2075<p>
2076The help file is displayed in another window, splitting the current window if
2077necessary. The help buffer can subsequently be dismissed using
2078<a href="#escape">escape</a>, mapped by default to Escape.
2079<p>
2080For this to work, you need to add a line to your
2081<a href="preferences.html">preferences</a> file specifying the location of the
2082JDK documentation:
2083<pre>
2084        jdkDocPath=/home/peter/sun/jdk1.3/docs</pre>
2085<p>
2086<b>Default key mapping:</b> Alt F1 in Java mode
2087<p>
2088<b>See also:</b> <a href="preferences.html#jdkDocPath">jdkDocPath</a>
2089<br><br>
2090</dl><!--<hr>-->
2091
2092<a name="jmips">jmips</a><dl><dd>
2093<p>
2094Measures the performance of the underlying Java runtime system (which is, of
2095course, dependent on the performance of the underlying hardware). The result
2096is displayed in the status bar.
2097<p>
2098The first measurement in a given session may be wildly inaccurate, since some
2099just-in-time compilers wait to compile a method until the second time it is called.
2100<p>
2101<b>Default key mapping:</b> None
2102<br><br>
2103</dl><!--<hr>-->
2104
2105<a name="jumpToColumn">jumpToColumn</a><dl><dd>
2106<p>
2107Prompts for a column number and moves the caret to the specified column.
2108<p>
2109The column number can be a simple number ("123"), an arithmetic expression
2110("100+23"), or a positive or negative offset from the current location ("+7",
2111"-12").
2112<p>
2113<b>Default key mapping:</b> None
2114<br><br>
2115</dl><!--<hr>-->
2116
2117<a name="jumpToLine">jumpToLine</a><dl><dd>
2118<p>
2119Prompts for a line number and moves the caret to the beginning of the specified line.
2120<p>
2121The line number can be a simple number ("123"), an arithmetic expression
2122("100+23"), or a positive or negative offset from the current location ("+7",
2123"-12").
2124<p>
2125<b>Default key mapping:</b> Ctrl J
2126<br><br>
2127</dl><!--<hr>-->
2128
2129<a name="jumpToOffset">jumpToOffset</a><dl><dd>
2130<p>
2131Prompts for an absolute offset (the number of characters from the start of the
2132buffer) and moves the caret to the specified location.
2133<p>
2134The offset can be a simple number ("123"), an arithmetic expression
2135("100+23"), or a positive or negative offset from the current location ("+7",
2136"-12").
2137<p>
2138<b>Default key mapping:</b> None
2139<p>
2140<b>See also:</b> <a href="#offset">offset</a>
2141<br><br>
2142</dl><!--<hr>-->
2143
2144<a name="killAppend">killAppend</a><dl><dd>
2145<p>
2146Deletes the selected region (or the current line if no region is selected),
2147appending the deleted text to the most recent entry in the
2148<a href="killring.html">kill ring</a>.
2149<br><br>
2150<b>Default key mapping:</b> Ctrl Shift X
2151<br><br>
2152</dl><!--<hr>-->
2153
2154<a name="killBuffer">killBuffer</a><dl><dd>
2155<p>
2156Closes the current buffer and removes it from the buffer list. If the buffer has
2157unsaved changes, you will be prompted for confirmation before they are discarded.
2158<br><br>
2159<b>Default key mapping:</b> Ctrl W
2160<br><br>
2161</dl><!--<hr>-->
2162
2163<a name="killFrame">killFrame</a><dl><dd>
2164<p>
2165Closes the current frame.
2166<br><br>
2167<b>Default key mapping:</b> Ctrl Shift W
2168<br><br>
2169</dl><!--<hr>-->
2170
2171<a name="killLine">killLine</a><dl><dd>
2172<p>
2173Copies the text from the location of the caret to the end of the current line to
2174the <a href="killring.html">kill ring</a> and then deletes that text. If the
2175text to be deleted is nothing but whitespace, or if the caret is already at the
2176end of the line, the following line separator is copied to the kill ring and
2177deleted too.
2178<br><br>
2179<b>Default key mapping:</b> Ctrl K
2180<br><br>
2181</dl><!--<hr>-->
2182
2183<a name="killRegion">killRegion</a><dl><dd>
2184<p>
2185Deletes the selected region (or the current line if no region is selected).
2186For normal regions, the deleted text is placed in the
2187<a href="killring.html">kill ring</a>. If the selected region is a column, the
2188deleted text is saved but not placed in the kill ring; it can be retrieved
2189with the command <a href="#pasteColumn">pasteColumn</a>.
2190<p>
2191<b>Default key mapping:</b> Ctrl X
2192<p>
2193<b>See also:</b> <a href="#copyRegion">copyRegion</a>,
2194<a href="columns.html">Columns</a>
2195<br><br>
2196</dl><!--<hr>-->
2197
2198<a name="killWordLeft">killWordLeft</a><dl><dd>
2199<p>
2200Deletes the word to the left of the caret, appending the deleted text to the
2201<a href="killring.html">kill ring</a>.
2202<p>
2203<b>Default key mapping:</b> None
2204<p>
2205<b>See also:</b> <a href="#deleteWordLeft">deleteWordLeft</a>
2206<br><br>
2207</dl><!--<hr>-->
2208
2209<a name="killWordRight">killWordRight</a><dl><dd>
2210<p>
2211Deletes the word to the right of the caret, appending the deleted text to the
2212<a href="killring.html">kill ring</a>.
2213<br><br>
2214<b>Default key mapping:</b> None
2215<br><br>
2216<b>See also:</b> <a href="#deleteWordRight">deleteWordRight</a>
2217<br><br>
2218</dl><!--<hr>-->
2219
2220<a name="left">left</a><dl><dd>
2221<p>
2222Moves the caret one character to the left.
2223<br><br>
2224<b>Default key mapping:</b>
2225<br><br>
2226</dl><!--<hr>-->
2227
2228<a name="listBindings">listBindings</a><dl><dd>
2229<p>
2230Displays a list of the key bindings that are in effect in the current buffer.
2231<br><br>
2232<b>Default key mapping:</b> None
2233<br><br>
2234</dl><!--<hr>-->
2235
2236<a name="listFiles">listFiles</a><dl><dd>
2237<p>
2238Displays the List Occurrences output buffer generated by the last invocation
2239of <a href="#findInFiles">findInFiles</a>.
2240<p>
2241<b>Default key mapping:</b> Ctrl L
2242<br><br>
2243</dl><!--<hr>-->
2244
2245<a name="listIncludes">listIncludes</a><dl><dd>
2246<p>
2247Recursively lists all files referenced by a "#include" directive in the
2248current buffer or in a file so referenced.
2249<p>
2250<b>Default key mapping:</b> None
2251<p>
2252<b>See also:</b> <a href="preferences.html#includePath">includePath</a>,
2253<a href="#checkPath">checkPath</a>, <a href="#iList">iList</a>
2254<br><br>
2255</dl><!--<hr>-->
2256
2257<a name="listOccurrences">listOccurrences</a><dl><dd>
2258<p>
2259Lists all lines in the current buffer that match the last search.
2260<p>
2261<b>Default key mapping:</b> Alt L
2262<br><br>
2263</dl><!--<hr>-->
2264
2265<a name="listOccurrencesOfPatternAtDot">listOccurrencesOfPatternAtDot</a><dl><dd>
2266<p>
2267Lists all occurrences in the current buffer of the selected text (if any) or of
2268the word at the current location of the caret.
2269<p>
2270If text is selected on the current line, the selected text is used as the
2271pattern for the search, and the search is carried out as if the "whole words
2272only" option was not specified.
2273<p>
2274If there is no selection on the current line, the word at the current location
2275of the caret is used as the pattern, and the search is carried out as if
2276the "whole words only" option was specified.
2277<p>
2278The search is case-sensitive (in both cases).
2279<p>
2280Multi-line selections are not supported.
2281<br><br>
2282<b>Default key mapping:</b> Ctrl Alt L
2283<br><br>
2284</dl><!--<hr>-->
2285
2286<a name="listRegisters">listRegisters</a><dl><dd>
2287<p>
2288Lists the contents of all registers in use.
2289<p>
2290Register names must be lower case letters (a-z). The contents of registers
2291persist automatically from one j session to the next.
2292<p>
2293<b>Default key mapping:</b> None
2294<p>
2295<b>Abbreviation:</b> lr
2296<p>
2297<b>See also:</b>
2298<a href="#clearRegister">clearRegister</a>,
2299<a href="#editRegister">editRegister</a>,
2300<a href="#insertRegister">insertRegister</a>,
2301<a href="#saveToRegister">saveToRegister</a>
2302<br><br>
2303</dl><!--<hr>-->
2304
2305<a name="listTags">listTags</a><dl><dd>
2306<p>
2307Lists the tags in the current buffer (generally speaking, a tag is a function
2308name). Pressing Enter in the tag list will move the caret to the definition of
2309the selected function. See <a href="tags.html">Tags and Tag Files</a>.
2310<br><br>
2311<b>Default key mapping:</b> None
2312<br><br>
2313<b>See also:</b> <a href="#sidebarListTags">sidebarListTags</a>
2314<br><br>
2315</dl><!--<hr>-->
2316
2317<a name="loadSession">loadSession</a><dl><dd>
2318<p>
2319Loads a previously saved named session. All currently open buffers are closed
2320before the new session is loaded.
2321<p>
2322<b>Default key mapping:</b> None
2323<p>
2324<b>See also:</b> <a href="sessions.html">Sessions</a>,
2325<a href="#saveSession">saveSession</a>
2326<br><br>
2327</dl><!--<hr>-->
2328
2329<a name="lowerCaseRegion">lowerCaseRegion</a><dl><dd>
2330<p>
2331Converts all upper case characters in the selected region to lower case.
2332<br><br>
2333<b>Default key mapping:</b> None
2334<br><br>
2335<b>See also:</b> <a href="#upperCaseRegion">upperCaseRegion</a>
2336<br><br>
2337</dl><!--<hr>-->
2338
2339<a name="mailboxCreateFolder">mailboxCreateFolder</a><dl><dd>
2340<p><b>Default key mapping:</b> None
2341<br><br>
2342<b>See also:</b> <a href="mail.html">Mail</a>
2343<br><br>
2344</dl><!--<hr>-->
2345
2346<a name="mailboxDelete">mailboxDelete</a><dl><dd>
2347<p>
2348Marks for deletion the tagged messages or the message at the current location
2349of the caret.
2350<br><br>
2351<b>Default key mapping:</b> 'd' in Mailbox mode
2352<br><br>
2353<b>See also:</b> <a href="#mailboxUndelete">mailboxUndelete</a>,
2354<a href="mail.html">Mail</a>
2355<br><br>
2356</dl><!--<hr>-->
2357
2358<a name="mailboxDeleteFolder">mailboxDeleteFolder</a><dl><dd>
2359<p>
2360<b>Default key mapping:</b> None
2361<br><br>
2362<b>See also:</b> <a href="mail.html">Mail</a>
2363<br><br>
2364</dl><!--<hr>-->
2365
2366<a name="mailboxExpunge">mailboxExpunge</a><dl><dd>
2367<p>
2368Commits deletions in the current mailbox.
2369<p>
2370<b>Default key mapping:</b> '$' in Mailbox mode
2371<p>
2372<b>See also:</b> <a href="mail.html">Mail</a>
2373<br><br>
2374</dl><!--<hr>-->
2375
2376<a name="mailboxFlag">mailboxFlag</a><dl><dd>
2377<p>
2378Toggles the "important" flag of the current message (or set of tagged messages).
2379<br><br>
2380<b>Default key mapping:</b> 'F' in Mailbox mode
2381<br><br>
2382<b>See also:</b> <a href="#messageFlag">messageFlag</a>,
2383<a href="mail.html">Mail</a>
2384<br><br>
2385</dl><!--<hr>-->
2386
2387<a name="mailboxGetNewMessages">mailboxGetNewMessages</a><dl><dd>
2388<p>
2389Connects to the server and retrieves any new messages (POP) or message headers
2390(IMAP).
2391<br><br>
2392<b>Default key mapping:</b> 'G' in Mailbox mode
2393<br><br>
2394<b>See also:</b> <a href="mail.html">Mail</a>
2395<br><br>
2396</dl><!--<hr>-->
2397
2398<a name="mailboxLastMessage">mailboxLastMessage</a><dl><dd>
2399<p>
2400Moves to the last message in the mailbox.
2401<br><br>
2402<b>Default key mapping:</b> Ctrl End in Mailbox mode
2403<br><br>
2404<b>See also:</b> <a href="mail.html">Mail</a>
2405<br><br>
2406</dl><!--<hr>-->
2407
2408<a name="mailboxLimit">mailboxLimit</a><dl><dd>
2409<p>
2410Prompts for a pattern and limits the messages displayed in the mailbox to
2411those matching the specified pattern.
2412<br><br>
2413If a simple pattern is specified, j looks for a match in the "Subject" and
2414"From" fields.
2415<br><br>
2416A few special patterns are also supported:
2417<pre>
2418    ~C expression       messages with expression in the "To" or "Cc" field
2419    ~D                  deleted messages
2420    ~d date1-date2      messages with date sent in the range date1-date2 (see below)
2421    ~F                  flagged messages
2422    ~N                  new messages
2423    ~R                  read messages
2424    ~T                  tagged messages
2425    ~t expression       messages with expression in the "To" field
2426    ~U                  unread messages
2427</pre>
2428If the expression to be matched contains any upper case letters, the matches
2429are exact; otherwise, case is ignored.
2430<br><br>
2431Dates must be in DD/MM/YY format. Month and year are optional; if omitted,
2432they default to the current month and year. If you omit the first date and
2433specify "-DD/MM/YY", all messages sent from the beginning of time through the
2434specified date will be selected. If you omit the second date and specify
2435"DD/MM/YY-", all messages sent from the specified date through the end of time
2436will be selected. If you specify a single date with no '-', only messages sent
2437on the specified date will be selected.
2438<br><br>
2439<b>Default key mapping:</b> 'l' (lower case 'L') in Mailbox mode
2440<br><br>
2441<b>See also:</b> <a href="#mailboxTagPattern">mailboxTagPattern</a>,
2442<a href="#mailboxUnlimit">mailboxUnlimit</a>, <a href="mail.html">Mail</a>
2443<br><br>
2444</dl><!--<hr>-->
2445
2446<a name="mailboxMarkRead">mailboxMarkRead</a><dl><dd>
2447<p>
2448Marks the current message (or set of tagged messages) read.
2449<br><br>
2450<b>Default key mapping:</b> 'M' in Mailbox mode
2451<br><br>
2452<b>See also:</b> <a href="mail.html">Mail</a>
2453<br><br>
2454</dl><!--<hr>-->
2455
2456<a name="mailboxMarkUnread">mailboxMarkUnread</a><dl><dd>
2457<p>
2458Marks the current message (or set of tagged messages) unread.
2459<br><br>
2460<b>Default key mapping:</b> Ctrl Shift M in Mailbox mode
2461<br><br>
2462<b>See also:</b> <a href="mail.html">Mail</a>
2463<br><br>
2464</dl><!--<hr>-->
2465
2466<a name="mailboxMoveToFolder">mailboxMoveToFolder</a><dl><dd>
2467<p>
2468Moves the current message (or set of tagged messages) to the specified folder.
2469Only supported in IMAP mailboxes.
2470<br><br>
2471<b>Default key mapping:</b> 'm' in Mailbox mode
2472<br><br>
2473<b>See also:</b> <a href="#mailboxSaveToFolder">mailboxSaveToFolder</a>,
2474<a href="mail.html">Mail</a>
2475<br><br>
2476</dl><!--<hr>-->
2477
2478<a name="mailboxReadMessage">mailboxReadMessage</a><dl><dd>
2479<p>
2480Opens a message buffer to read the message at the current location of the caret.
2481<p>
2482<b>Default key mapping:</b> Enter, Ctrl Shift G, Double Mouse-1, or Mouse-2 in Mailbox mode
2483<p>
2484<b>See also:</b> <a href="mail.html">Mail</a>
2485<br><br>
2486</dl><!--<hr>-->
2487
2488<a name="mailboxSaveToFolder">mailboxSaveToFolder</a><dl><dd>
2489<p>
2490Saves the current message (or set of tagged messages) in the specified folder.
2491Only supported in IMAP mailboxes.
2492<br><br>
2493<b>Default key mapping:</b> 's' in Mailbox mode
2494<br><br>
2495<b>See also:</b> <a href="#mailboxMoveToFolder">mailboxMoveToFolder</a>,
2496<a href="mail.html">Mail</a>
2497<br><br>
2498</dl><!--<hr>-->
2499
2500<a name="mailboxStop">mailboxStop</a><dl><dd>
2501<p>
2502Stops the current background process in a mailbox buffer. Mapped to the Stop
2503button on the toolbar in Mailbox mode.
2504<br><br>
2505<b>Default key mapping:</b> None
2506<br><br>
2507<b>See also:</b> <a href="mail.html">Mail</a>
2508<br><br>
2509</dl><!--<hr>-->
2510
2511<a name="mailboxTag">mailboxTag</a><dl><dd>
2512<p>
2513Tags or untags the message at the current location of the caret.
2514<br><br>
2515<b>Default key mapping:</b> 't' in Mailbox mode
2516<br><br>
2517<b>See also:</b> <a href="#mailboxUntagAll">mailboxUntagAll</a>,
2518<a href="mail.html">Mail</a>
2519<br><br>
2520</dl><!--<hr>-->
2521
2522<a name="mailboxTagPattern">mailboxTagPattern</a><dl><dd>
2523<p>
2524Prompts for a pattern and tags all messages that match the specified pattern.
2525<br><br>
2526If a simple pattern is specified, j looks for a match in the "Subject" and
2527"From" fields.
2528<br><br>
2529A few special patterns are also supported:
2530<pre>
2531    ~C expression       messages with expression in the "To" or "Cc" field
2532    ~D                  deleted messages
2533    ~d date1-date2      messages with date sent in the range date1-date2 (see below)
2534    ~F                  flagged messages
2535    ~N                  new messages
2536    ~R                  read messages
2537    ~t expression       messages with expression in the "To" field
2538    ~U                  unread messages
2539</pre>
2540If the expression to be matched contains any upper case letters, the matches
2541are exact; otherwise, case is ignored.
2542<br><br>
2543Dates must be in DD/MM/YY format. Month and year are optional; if omitted,
2544they default to the current month and year. If you omit the first date and
2545specify "-DD/MM/YY", all messages sent from the beginning of time through the
2546specified date will be selected. If you omit the second date and specify
2547"DD/MM/YY-", all messages sent from the specified date through the end of time
2548will be selected. If you specify a single date with no '-', only messages sent
2549on the specified date will be selected.
2550<br><br>
2551<b>Default key mapping:</b> Ctrl T in Mailbox mode
2552<br><br>
2553<b>See also:</b> <a href="#mailboxLimit">mailboxLimit</a>,
2554<a href="#mailboxUntagAll">mailboxUntagAll</a>, <a href="mail.html">Mail</a>
2555<br><br>
2556</dl><!--<hr>-->
2557
2558<a name="mailboxToggleRaw">mailboxToggleRaw</a><dl><dd>
2559<p>
2560Toggles raw mode for messages in this mailbox. Normally, messages are
2561displayed with only the most important headers shown, and MIME-encoded
2562messages are decoded. In raw mode, the text of the message is displayed
2563exactly as received.
2564<br><br>
2565<b>Default key mapping:</b> 'R' in Mailbox mode
2566<br><br>
2567<b>See also:</b> <a href="mail.html">Mail</a>
2568<br><br>
2569</dl><!--<hr>-->
2570
2571<a name="mailboxUndelete">mailboxUndelete</a><dl><dd>
2572<p>
2573Undeletes the tagged messages or the message at the current location of the
2574caret.
2575<br><br>
2576<b>Default key mapping:</b> 'u' in Mailbox mode
2577<br><br>
2578<b>See also:</b> <a href="#mailboxDelete">mailboxDelete</a>,
2579<a href="mail.html">Mail</a>
2580<br><br>
2581</dl><!--<hr>-->
2582
2583<a name="mailboxUnlimit">mailboxUnlimit</a><dl><dd>
2584<p>
2585Cancels the limit pattern for the current mailbox, so all messages are listed.
2586<br><br>
2587<b>Default key mapping:</b> 'L' in Mailbox mode
2588<br><br>
2589<b>See also:</b> <a href="mail.html">Mail</a>
2590<br><br>
2591</dl><!--<hr>-->
2592
2593<a name="mailboxUntagAll">mailboxUntagAll</a><dl><dd>
2594<p>
2595Untags all messages in the current mailbox.
2596<br><br>
2597<b>Default key mapping:</b> 'T' in Mailbox mode
2598<br><br>
2599<b>See also:</b> <a href="#mailboxTag">mailboxTag</a>,
2600<a href="#mailboxTagPattern">mailboxTagPattern</a>, <a href="mail.html">Mail</a>
2601<br><br>
2602</dl><!--<hr>-->
2603
2604<a name="makeTagFile">makeTagFile</a><dl><dd>
2605<p>
2606Makes a tag file for the current directory. It is normally not necessary to use
2607this command explicitly, since tag files are managed automatically.
2608See <a href="tags.html">Tags and Tag Files</a>.
2609<br><br>
2610<b>Default key mapping:</b> None
2611<br><br>
2612</dl><!--<hr>-->
2613
2614<a name="man">man</a><dl><dd>
2615<p>
2616Prompts for a topic and displays the corresponding man page.
2617<br><br>
2618<b>Default key mapping:</b> None
2619<br><br>
2620</dl><!--<hr>-->
2621
2622<a name="manFollowLink">manFollowLink</a><dl><dd>
2623<p>
2624Invokes <a href="#man">man</a> on the cross reference at the location of the
2625caret or mouse click.
2626<p>
2627<b>Default key mapping:</b> Enter, Ctrl Shift G, Double Mouse-1, or Mouse-2 in Man mode
2628<br><br>
2629</dl><!--<hr>-->
2630
2631<a name="messageDelete">messageDelete</a><dl><dd>
2632<p>
2633Marks the current message deleted and loads the next undeleted message in the
2634current message buffer.
2635<br><br>
2636<b>Default key mapping:</b> 'd' in Message mode
2637<br><br>
2638<b>See also:</b> <a href="mail.html">Mail</a>
2639<br><br>
2640</dl><!--<hr>-->
2641
2642<a name="messageFlag">messageFlag</a><dl><dd>
2643<p>
2644Toggles the "important" flag of the current message and loads the next
2645undeleted message in the current message buffer.
2646<br><br>
2647<b>Default key mapping:</b> 'F' in Message mode
2648<br><br>
2649<b>See also:</b> <a href="#mailboxFlag">mailboxFlag</a>,
2650<a href="mail.html">Mail</a>
2651<br><br>
2652</dl><!--<hr>-->
2653
2654<a name="messageForward">messageForward</a><dl><dd>
2655<p>
2656Opens a mail composition buffer to forward the current message.
2657<br><br>
2658<b>Default key mapping:</b> 'f' in Message mode
2659<br><br>
2660<b>See also:</b> <a href="mail.html">Mail</a>
2661<br><br>
2662</dl><!--<hr>-->
2663
2664<a name="messageIndex">messageIndex</a><dl><dd>
2665<p>
2666Closes the current message buffer and returns to the parent mailbox.
2667<br><br>
2668<b>Default key mapping:</b> 'i' in Message mode
2669<br><br>
2670<b>See also:</b> <a href="mail.html">Mail</a>
2671<br><br>
2672</dl><!--<hr>-->
2673
2674<a name="messageMoveToFolder">messageMoveToFolder</a><dl><dd>
2675<p>
2676Moves the current message to the specified folder. Currently this command is
2677only implemented for IMAP folders.
2678<br><br>
2679<b>Default key mapping:</b> 'm' in Message mode
2680<br><br>
2681<b>See also:</b> <a href="mail.html">Mail</a>
2682<br><br>
2683</dl><!--<hr>-->
2684
2685<a name="messageNext">messageNext</a><dl><dd>
2686<p>
2687Loads the next undeleted message in the current message buffer.
2688<br><br>
2689<b>Default key mapping:</b> 'n' in Message mode
2690<br><br>
2691<b>See also:</b> <a href="mail.html">Mail</a>
2692<br><br>
2693</dl><!--<hr>-->
2694
2695<a name="messageNextInThread">messageNextInThread</a><dl><dd>
2696<p>
2697Loads the next message in the current thread into the current message buffer.
2698Messages that are marked deleted but not yet expunged are included.
2699<br><br>
2700<b>Default key mapping:</b> 'N' in Message mode
2701<br><br>
2702<b>See also:</b> <a href="mail.html">Mail</a>
2703<br><br>
2704</dl><!--<hr>-->
2705
2706<a name="messagePrevious">messagePrevious</a><dl><dd>
2707<p>
2708Loads the previous undeleted message in the current message buffer.
2709<br><br>
2710<b>Default key mapping:</b> 'p' in Message mode
2711<br><br>
2712<b>See also:</b> <a href="mail.html">Mail</a>
2713<br><br>
2714</dl><!--<hr>-->
2715
2716<a name="messagePreviousInThread">messagePreviousInThread</a><dl><dd>
2717<p>
2718Loads the previous message in the current thread into the current message
2719buffer. Messages that are marked deleted but not yet expunged are included.
2720<br><br>
2721<b>Default key mapping:</b> 'P' in Message mode
2722<br><br>
2723<b>See also:</b> <a href="mail.html">Mail</a>
2724<br><br>
2725</dl><!--<hr>-->
2726
2727<a name="messageReplyToGroup">messageReplyToGroup</a><dl><dd>
2728<p>
2729Opens a mail composition buffer to reply to the current message. The reply is
2730addressed to the sender and addressees of the original message.
2731<br><br>
2732<b>Default key mapping:</b> 'g' in Message mode
2733<br><br>
2734<b>See also:</b> <a href="mail.html">Mail</a>
2735<br><br>
2736</dl><!--<hr>-->
2737
2738<a name="messageReplyToSender">messageReplyToSender</a><dl><dd>
2739<p>
2740Opens a mail composition buffer to reply to the current message. The reply is
2741addressed to the sender of the original message.
2742<br><br>
2743<b>Default key mapping:</b> 'r' in Message mode
2744<br><br>
2745<b>See also:</b> <a href="mail.html">Mail</a>
2746<br><br>
2747</dl><!--<hr>-->
2748
2749<a name="messageSaveAttachment">messageSaveAttachment</a><dl><dd>
2750<p>
2751Prompts for a filename and saves the attachment listed on the line containing
2752the caret to the specified file.
2753<br><br>
2754<b>Default key mapping:</b> 's' in Message mode
2755<br><br>
2756<b>See also:</b> <a href="#messageViewAttachment">messageViewAttachment</a>,
2757<a href="mail.html">Mail</a>
2758<br><br>
2759</dl><!--<hr>-->
2760
2761<a name="messageToggleHeaders">messageToggleHeaders</a><dl><dd>
2762<p>
2763Toggles display of full headers in message buffers.
2764<br><br>
2765<b>Default key mapping:</b> 'h' in Message mode
2766<br><br>
2767<b>See also:</b> <a href="#messageToggleRaw">messageToggleRaw</a>,
2768<a href="mail.html">Mail</a>
2769<br><br>
2770</dl><!--<hr>-->
2771
2772<a name="messageToggleRaw">messageToggleRaw</a><dl><dd>
2773<p>
2774Toggles raw mode for the current message (and all messages in the parent
2775mailbox). Normally, messages are displayed with only the most important
2776headers shown, and MIME-encoded messages are decoded. In raw mode, the text of
2777the message is displayed exactly as received.
2778<br><br>
2779<b>Default key mapping:</b> 'R' in Message mode
2780<br><br>
2781<b>See also:</b> <a href="#mailboxToggleRaw">mailboxToggleRaw</a>,
2782<a href="#messageToggleHeaders">messageToggleHeaders</a>,
2783<a href="mail.html">Mail</a>
2784<br><br>
2785</dl><!--<hr>-->
2786
2787<a name="messageViewAttachment">messageViewAttachment</a><dl><dd>
2788<p>
2789Opens the attachment listed on the line containing the caret.
2790<p>
2791<b>Default key mapping:</b> Enter or 'v' in Message mode
2792<p>
2793<b>See also:</b> <a href="#messageSaveAttachment">messageSaveAttachment</a>,
2794<a href="mail.html">Mail</a>
2795<br><br>
2796</dl><!--<hr>-->
2797
2798<a name="mouseFindOccurrence">mousefindOccurrence</a><dl><dd>
2799<p>
2800Jumps to the line in the source file corresponding to the location of the
2801mouse click in a List Occurrences buffer.
2802<p>
2803<b>Default key mapping:</b> Mouse-2 or Double Mouse-1 in List Occurrences buffers
2804<p>
2805<b>See also:</b> <a href="#findOccurrenceAtDot">findOccurrenceAtDot</a>
2806<br><br>
2807</dl><!--<hr>-->
2808
2809<a name="mouseFindTag">mouseFindTag</a><dl><dd>
2810<p>
2811Jumps to the definition of the function at the location of the mouse click.
2812The location of the mouse click is first saved on the marker stack as a
2813temporary bookmark, so you can use <a href="#popPosition">popPosition</a>,
2814mapped by default to Shift F5, to get back where you came from.
2815<p>
2816<b>Default key mapping:</b> Mouse-2 in Java, C, C++, Lisp, Scheme and Perl modes
2817<p>
2818<b>See also:</b> <a href="#findTag">findTag</a>,
2819<a href="#findTagAtDot">findTagAtDot</a>,
2820<a href="#findTagAtDotOtherWindow">findTagAtDotOtherWindow</a>
2821<br><br>
2822</dl><!--<hr>-->
2823
2824<a name="mouseMoveDotToPoint">mouseMoveDotToPoint</a><dl><dd>
2825<p>
2826Moves the caret to the location of the mouse click.
2827<p>
2828<b>Default key mapping:</b> Mouse-1
2829<p>
2830<b>See also:</b> <a href="#mouseSelect">mouseSelect</a>
2831<br><br>
2832</dl><!--<hr>-->
2833
2834<a name="mousePaste">mousePaste</a><dl><dd>
2835<p>
2836If a selection is marked, the contents of the selected region are copied to
2837the <a href="killring.html">kill ring</a>, and the region is deselected. Then
2838the copied text is inserted at the location of the mouse click.
2839<p>
2840If no selection is marked, mousePaste is equivalent to
2841<a href="#paste">paste</a> at the location of the mouse click.
2842<p>
2843If the text to be inserted ends with a line separator, it is inserted above
2844the line where the mouse click occurred, as if the mouse click were in the
2845first column of the line, even if that is not the case. The intention behind
2846this is to make it easy to paste whole lines of text (or blocks of lines),
2847without having to click exactly at the beginning of the line. If possible, the
2848indentation of the inserted lines is corrected to match their new context.
2849<p>
2850<b>Default key mapping:</b> None
2851<p>
2852<b>See also:</b> <a href="#paste">paste</a>,
2853<a href="#cyclePaste">cyclePaste</a>,
2854<a href="#pasteColumn">pasteColumn</a>
2855<br><br>
2856</dl><!--<hr>-->
2857
2858<a name="mouseSelect">mouseSelect</a><dl><dd>
2859<p>
2860Selects the region from the caret to the location of the mouse click, or
2861adjusts the current selection accordingly.
2862<p>
2863<b>Default key mapping:</b> Mouse-1
2864<p>
2865<b>See also:</b> <a href="#mouseMoveDotToPoint">mouseMoveDotToPoint</a>
2866<br><br>
2867</dl><!--<hr>-->
2868
2869<a name="mouseShowContextMenu">mouseShowContextMenu</a><dl><dd>
2870<p>
2871Displays the context menu (if any) for the current buffer.
2872<p>
2873<b>Default key mapping:</b> Mouse-3
2874<br><br>
2875</dl><!--<hr>-->
2876
2877<a name="movePastCloseAndReindent">movePastCloseAndReindent</a><dl><dd>
2878<p>
2879Moves the caret past the next unmatched closing parenthesis to the right of its
2880current location, inserts a line separator, and indents according to context.
2881<br><br>
2882<b>Default key mapping:</b> Ctrl Shift ) in Java, JavaScript, C and C++ modes
2883<br><br>
2884<b>See also:</b> <a href="#insertParentheses">insertParentheses</a>
2885<br><br>
2886</dl><!--<hr>-->
2887
2888<a name="newBuffer">newBuffer</a><dl><dd>
2889<p>
2890Creates and activates an empty buffer with no associated file.
2891<br><br>
2892<b>Default key mapping:</b> Ctrl N
2893<br><br>
2894</dl><!--<hr>-->
2895
2896<a name="newFrame">newFrame</a><dl><dd>
2897<p>
2898Creates a new frame (top-level editor window) displaying the current buffer.
2899<br><br>
2900<b>Default key mapping:</b> Ctrl Shift N
2901<br><br>
2902</dl><!--<hr>-->
2903
2904<a name="newline">newline</a><dl><dd>
2905<p>
2906Inserts a line separator at the location of the caret.
2907<br><br>
2908<b>Default key mapping:</b> Enter (global default); Ctrl Enter in JavaScript and HTML modes
2909<br><br>
2910</dl><!--<hr>-->
2911
2912<a name="newlineAndIndent">newlineAndIndent</a><dl><dd>
2913<p>
2914Inserts a line separator at the location of the caret and indents according to
2915context..
2916<br><br>
2917<b>Default key mapping:</b> Enter in JavaScript and HTML modes
2918<br><br>
2919</dl><!--<hr>-->
2920
2921<a name="nextBuffer">nextBuffer</a><dl><dd>
2922<p>
2923Switches to the next buffer.
2924<br><br>
2925<b>Default key mapping:</b> Alt Right
2926<br><br>
2927<b>See also:</b> <a href="#prevBuffer">prevBuffer</a>
2928<br><br>
2929</dl><!--<hr>-->
2930
2931<a name="nextChange">nextChange</a><dl><dd>
2932<p>
2933Moves to the next group of changed lines (below the position of the caret in
2934the current buffer).
2935<p>
2936<b>Default key mapping:</b> Ctrl Alt N
2937<p>
2938<b>See also:</b> <a href="#previousChange">previousChange</a>,
2939<a href="preferences.html#showChangeMarks">showChangeMarks</a>
2940<br><br>
2941</dl><!--<hr>-->
2942
2943<a name="nextComment">nextComment</a><dl><dd>
2944<p>
2945Cycles forwards through the history of CVS checkin comments.
2946<p>
2947<b>Default key mapping:</b> Ctrl N in CVS checkin buffers
2948<p>
2949<b>See also:</b> <a href="#previousComment">previousComment</a>,
2950<a href="#cvsCommit">cvsCommit</a>, <a href="#finish">finish</a>,
2951<a href="cvs.html">CVS Support</a>
2952<br><br>
2953</dl><!--<hr>-->
2954
2955<a name="nextError">nextError</a><dl><dd>
2956<p>
2957Jumps to the location in the source file that corresponds to the next
2958compilation error.
2959<p>
2960<b>Default key mapping:</b> F4
2961<p>
2962<b>See also:</b> <a href="#thisError">thisError</a>,
2963<a href="compilation.html">Compilation Buffers</a>
2964<br><br>
2965</dl><!--<hr>-->
2966
2967<a name="nextFrame">nextFrame</a><dl><dd>
2968<p>
2969Activates the next frame (top-level editor window).
2970<br><br>
2971<b>Default key mapping:</b> Alt N
2972<br><br>
2973</dl><!--<hr>-->
2974
2975<a name="offset">offset</a><dl><dd>
2976<p>
2977Reports the current location of the caret as an absolute offset (the number of
2978characters from the start of the buffer).
2979<br><br>
2980<b>Default key mapping:</b> None
2981<p>
2982<b>See also:</b> <a href="#jumpToOffset">jumpToOffset</a>
2983<br><br>
2984</dl><!--<hr>-->
2985
2986<a name="openFile">openFile</a><dl><dd>
2987<p>
2988Sets focus to the edit control in the location bar of the current window,
2989where you can enter a filename and press Enter to activate the corresponding
2990buffer, if it exists, or else create and activate a new buffer for the
2991specified file.
2992<br><br>
2993If the specified file is not found in the current directory, j will look for it
2994first in the <a href="preferences.html#includePath">include path</a> (if it's a
2995.h file) and then in the <a href="preferences.html#sourcePath">source path</a>.
2996You can define include and source paths in your <a href="preferences.html">preferences</a> file.
2997If j can't find the file you specify, you will be asked if you want to create
2998it.
2999<br><br>
3000The edit control supports both history (using the up and down arrow keys) and
3001completion (using Tab and Shift Tab).
3002<br><br>
3003In addition to normal text files, you can open a directory, a .zip or .gz file,
3004or a URL (like http://armedbear.org).
3005<br><br>
3006If you press Enter with no text in the edit control, you will get a directory
3007buffer on the current directory.
3008<br><br>
3009<b>Default key mapping:</b> Ctrl O
3010<br><br>
3011<b>See also:</b> <a href="directories.html">Directory Buffers</a>.
3012<br><br>
3013</dl><!--<hr>-->
3014
3015<a name="openFileInOtherFrame">openFileInOtherFrame</a><dl><dd>
3016<p>
3017Same as <a href="#openFile">openFile</a>, but the specified file is opened in
3018a different (possibly new) frame (top-level editor window). You will be
3019prompted to enter the filename in a dialog box, rather than in the location
3020bar of the current window.
3021<br><br>
3022<b>Default key mapping:</b> Ctrl Shift O
3023<br><br>
3024</dl><!--<hr>-->
3025
3026<a name="openFileInOtherWindow">openFileInOtherWindow</a><dl><dd>
3027<p>
3028Same as <a href="#openFile">openFile</a>, but the specified file
3029is opened in the other window of the current frame. The current window is
3030split if necessary.
3031<br><br>
3032<b>Default key mapping:</b> Ctrl Alt O
3033<br><br>
3034</dl><!--<hr>-->
3035
3036<a name="openMailbox">openMailbox</a><dl><dd>
3037<p>
3038Prompts for a URL and opens the corresponding mailbox. IMAP and POP are
3039supported.
3040<br><br>
3041IMAP URLs look like this:
3042<pre>
3043    {user@host}folder</pre>
3044For example:
3045<pre>
3046    {peter@annie}inbox
3047    {peter@annie}mail/linux-kernel</pre>
3048POP URLs look like this:
3049<pre>
3050    pop://user@host</pre>
3051For example:
3052<pre>
3053    pop://peter@annie
3054    pop://pgraves@ix.netcom.com</pre>
3055<b>Default key mapping:</b> None
3056<br><br>
3057<b>See also:</b> <a href="#inbox">inbox</a>, <a href="mail.html">Mail</a>
3058<br><br>
3059</dl><!--<hr>-->
3060
3061<a name="otherWindow">otherWindow</a><dl><dd>
3062<p>
3063Selects the other window in the current frame.
3064<br><br>
3065<b>Default key mapping:</b> Alt O
3066<br><br>
3067</dl><!--<hr>-->
3068
3069<a name="p4">p4</a><dl><dd>
3070<p>
3071Executes an arbitrary Perforce command. The Perforce command, together with
3072any required flags and arguments, must be supplied as an argument to this
3073command. You can use "%" to represent the full pathname of the file associated
3074with the current buffer. For example:
3075<pre>
3076        p4 filelog -l %
3077</pre>
3078<p>
3079or:
3080<pre>
3081        p4 help commands
3082</pre>
3083<p>
3084<b>Default key mapping:</b> None
3085<br><br>
3086</dl><!--<hr>-->
3087
3088<a name="pageDown">pageDown</a><dl><dd>
3089<p>
3090Moves the caret down one full screen.
3091<br><br>
3092<b>Default key mapping:</b> Page Down
3093<br><br>
3094</dl><!--<hr>-->
3095
3096<a name="pageUp">pageUp</a><dl><dd>
3097<p>
3098Moves the caret up one full screen.
3099<br><br>
3100<b>Default key mapping:</b> Page Up
3101<br><br>
3102</dl><!--<hr>-->
3103
3104<a name="paste">paste</a><dl><dd>
3105<p>
3106The contents of the system clipboard (if any) are appended to the
3107<a href="killring.html">kill ring</a>, and then the last item from the
3108kill ring (which will be the contents of the system clipboard, if anything was
3109there) is inserted at the current location of the caret.
3110<p>
3111If a block is marked, the inserted text replaces the marked block.
3112<p>
3113If the text to be inserted ends with a line separator, it is inserted above
3114the line containing the caret, as if the caret were in the first column of the
3115line, even if that is not the case. The intention behind this is to make it
3116easy to cut and paste whole lines of text (or blocks of lines), without having
3117to move the caret to the beginning of the line. If possible, the indentation
3118of the inserted lines is corrected to match their new context.
3119<p>
3120<b>Default key mapping:</b> Ctrl V
3121<p>
3122<b>See also:</b> <a href="#cyclePaste">cyclePaste</a>,
3123<a href="#pasteColumn">pasteColumn</a>,
3124<a href="#mousePaste">mousePaste</a>
3125<br><br>
3126</dl><!--<hr>-->
3127
3128<a name="pasteColumn">pasteColumn</a><dl><dd>
3129<p>
3130Inserts the last killed or copied column at the current location of the caret.
3131<p>
3132<b>Default key mapping:</b> None
3133<p>
3134<b>See also:</b> <a href="#copyRegion">copyRegion</a>,
3135<a href="#killRegion">killRegion</a>, <a href="#paste">paste</a>,
3136<a href="columns.html">Columns</a>
3137<br><br>
3138</dl><!--<hr>-->
3139
3140<a name="pastePrimarySelection">pastePrimarySelection</a><dl><dd>
3141<p>
3142Inserts the primary X selection at the current location of the caret or mouse
3143click. This command requires Java 1.4 or later and only works on platforms
3144that support a primary X selection (e.g. Linux).
3145<p>
3146<b>Default key mapping:</b> Mouse-2 (on supported platforms)
3147<br><br>
3148</dl><!--<hr>-->
3149
3150<a name="playbackMacro">playbackMacro</a><dl><dd>
3151<p>
3152Plays back previously recorded keystrokes.
3153<br><br>
3154<b>Default key mapping:</b> F8
3155<br><br>
3156<b>See also:</b> <a href="#recordMacro">recordMacro</a>
3157<br><br>
3158</dl><!--<hr>-->
3159
3160<a name="popPosition">popPosition</a><dl><dd>
3161<p>
3162Pops the last position off the marker stack and jumps to that location.
3163<br><br>
3164<b>Default key mapping:</b> Shift F5
3165<br><br>
3166<b>See also:</b> <a href="#pushPosition">pushPosition</a>
3167<br><br>
3168</dl><!--<hr>-->
3169
3170<a name="prevBuffer">prevBuffer</a><dl><dd>
3171<p>
3172Switches to the previous buffer.
3173<p>
3174<b>Default key mapping:</b> Alt Left
3175<p>
3176<b>See also:</b> <a href="#nextBuffer">nextBuffer</a>
3177<br><br>
3178</dl><!--<hr>-->
3179
3180<a name="previousChange">previousChange</a><dl><dd>
3181<p>
3182Moves to the previous group of changed lines (above the position of the caret
3183in the current buffer).
3184<p>
3185<b>Default key mapping:</b> Ctrl Alt P
3186<p>
3187<b>See also:</b> <a href="#nextChange">nextChange</a>,
3188<a href="preferences.html#showChangeMarks">showChangeMarks</a>
3189<br><br>
3190</dl><!--<hr>-->
3191
3192<a name="previousComment">previousComment</a><dl><dd>
3193<p>
3194Cycles backwards through the history of CVS checkin comments.
3195<p>
3196<b>Default key mapping:</b> Ctrl P in CVS checkin buffers
3197<p>
3198<b>See also:</b> <a href="#nextComment">nextComment</a>,
3199<a href="#cvsCommit">cvsCommit</a>, <a href="#finish">finish</a>,
3200<a href="cvs.html">CVS Support</a>
3201<br><br>
3202</dl><!--<hr>-->
3203
3204<a name="print">print</a><dl><dd>
3205<p>
3206Prints the selected region, or the current buffer if no region is selected.
3207<p>
3208<b>Default key mapping:</b> Ctrl P
3209<br><br>
3210</dl><!--<hr>-->
3211
3212<a name="properties">properties</a><dl><dd>
3213<p>
3214Invokes the Properties dialog, which lets you inspect and modify
3215buffer-specific settings such as tab width, indent size, and mode.
3216<p>
3217<b>Default key mapping:</b> Alt P
3218<br><br>
3219</dl><!--<hr>-->
3220
3221<a name="pushPosition">pushPosition</a><dl><dd>
3222<p>
3223Saves the current location of the caret on the marker stack as a temporary bookmark.
3224<br><br>
3225<b>Default key mapping:</b> F5
3226<br><br>
3227<b>See also:</b> <a href="#popPosition">popPosition</a>
3228<br><br>
3229</dl><!--<hr>-->
3230
3231<a name="quit">quit</a><dl><dd>
3232<p>
3233Shuts down the editor. You will be prompted for confirmation if there are any
3234buffers with unsaved changes.
3235<br><br>
3236<b>Default key mapping:</b> Ctrl Q
3237<br><br>
3238<b>See also:</b> <a href="#saveAllExit">saveAllExit</a>
3239<br><br>
3240</dl><!--<hr>-->
3241
3242<a name="recompile">recompile</a><dl><dd>
3243<p>
3244Compiles the source file in the current buffer, using the last specified
3245compile command. (On Windows, this command is only supported for Windows 2000
3246and Windows XP.)
3247<p>
3248<b>Default key mapping:</b> Ctrl F9
3249<p>
3250<b>See also:</b> <a href="#compile">compile</a>,
3251<a href="compilation.html">Compilation Buffers</a>
3252<br><br>
3253</dl><!--<hr>-->
3254
3255<a name="recordMacro">recordMacro</a><dl><dd>
3256<p>
3257Records keystrokes for later playback. Recording ends when this command is
3258invoked again. While recording is in progress, "REC" is displayed in the
3259status bar (at the right end, after the column number).
3260<br><br>
3261<b>Default key mapping:</b> F7
3262<br><br>
3263<b>See also:</b> <a href="#playbackMacro">playbackMacro</a>
3264<br><br>
3265</dl><!--<hr>-->
3266
3267<a name="redo">redo</a><dl><dd>
3268<p>
3269Undoes the last undo.
3270<br><br>
3271<b>Default key mapping:</b> Ctrl Y
3272<br><br>
3273<b>See also:</b> <a href="#undo">undo</a>
3274<br><br>
3275</dl><!--<hr>-->
3276
3277<a name="replace">replace</a><dl><dd>
3278<p>
3279Replaces one or more occurrences of one pattern with another.
3280<p>
3281If the "Ignore case" checkbox is checked, j tries, paradoxically, to preserve
3282case, if possible, when it makes a replacement. More precisely, if the pattern
3283is all upper case, j will make the replacement all upper case, and if the
3284pattern begins with an upper case letter, j will make the replacement begin
3285with an upper case letter. For example, if the pattern is "javaFormatter" and
3286the replacement is "cppFormatter", "JAVAFORMATTER" will become "CPPFORMATTER",
3287and "JavaFormatter" will  become "CppFormatter". These are the only two
3288situations in which the replacement string is altered to preserve case.
3289Upper-case letters in the replacement string are NEVER converted to lower case.
3290This may seem strange, but in practice, chances are good that this is the
3291behavior you want.
3292<p>
3293If the "Whole words only" checkbox is checked, occurrences of the pattern will
3294be replaced only if they are delimited by characters that cannot appear in a
3295Java identifier. Generally speaking, Java identifiers can contain letters,
3296digits, and the characters '$' and '_'.
3297<p>
3298If the "Regular expressions" checkbox is checked, the pattern will be
3299interpreted as a regular expression rather than as a literal string. In
3300addition, the replacement string can refer to all or part of what is matched by
3301the pattern. "\&amp;" in the replacement string will be replaced with the
3302entire string that matched the pattern. "\<i>n</i>", where <i>n</i> is a digit
3303from 1 to 9, will be replaced by whatever matched the <i>n</i>th
3304parenthesized grouping in the pattern.
3305See <a href="regexp.html">Regular Expressions</a>.
3306<p>
3307For example, if you specify this pattern:
3308<pre>
3309    foo\((.*), (.*)\)
3310</pre>
3311and this replacement:
3312<pre>
3313    foo(\2, \1)
3314</pre>
3315the effect would be to reverse the order of the arguments in every call to the
3316function foo. Note that you need to escape the literal parentheses in the
3317pattern, but not in the replacement.
3318<p>
3319If the "Multiline pattern" checkbox is checked, both the regular expression
3320and the replacement can contain newline characters ("\n"). Because of the way
3321j handles things internally, a single "\n" should be used to match a newline
3322even if the file being edited uses "\r\n" or "\r" as its line separator
3323string. (The "Multiline pattern" feature is experimental and is not enabled by
3324default.)
3325<p>
3326If the "Restrict changes to selected text" checkbox is checked, only those
3327occurrences of the pattern that fall within the current selection are replaced.
3328Otherwise, if a block is marked, replacements are carried out starting at the
3329beginning of the marked block.
3330<p>
3331If the "Confirm changes" checkbox is checked, you will be prompted to confirm
3332each replacement.
3333<br><br>
3334<b>Default key mapping:</b> Ctrl R
3335<br><br>
3336</dl><!--<hr>-->
3337
3338<a name="replaceInFiles">replaceInFiles</a><dl><dd>
3339<p>
3340Replaces one or more occurrences of one pattern with another in multiple files.
3341If a file matching the file specification is already loaded in a buffer, the
3342operation is performed on the contents of the buffer rather than the file as
3343last saved on disk, so unsaved changes to the buffer are never lost. Files that
3344were not previously loaded are saved automatically if any replacements are
3345made. Buffers created specifically for the replace in files operation are
3346deleted when they are no longer needed.
3347<p>
3348Several file specifications can be supplied at once, separated by semicolons.
3349If the full path is not given in a file specification, the current directory or
3350the directory last specified by a full path is used.
3351<p>
3352For example, if the file specification is <code>*.c;/usr/src/emacs-20.3/src/*.c;*.h</code>,
3353the search will examine <code>.c</code> files in the current directory and
3354<code>.c</code> and <code>.h</code> files in <code>/usr/src/emacs-20.3/src</code>.
3355<p>
3356If the "Ignore case" checkbox is checked, j tries, paradoxically, to preserve
3357case, if possible, when it makes a replacement. More precisely, if the pattern
3358is all upper case, j will make the replacement all upper case, and if the
3359pattern begins with an upper case letter, j will make the replacement begin
3360with an upper case letter. For example, if the pattern is "javaFormatter" and
3361the replacement is "cppFormatter", "JAVAFORMATTER" will become "CPPFORMATTER",
3362and "JavaFormatter" will  become "CppFormatter". These are the only two
3363situations in which the replacement string is altered to preserve case.
3364Upper-case letters in the replacement string are NEVER converted to lower case.
3365This may seem strange, but in practice, chances are good that this is the
3366behavior you want.
3367<p>
3368If the "Whole words only" checkbox is checked, occurrences of the pattern will
3369be replaced only if they are delimited by characters that cannot appear in a
3370Java identifier. Generally speaking, Java identifiers can contain letters,
3371digits, and the characters '$' and '_'.
3372<p>
3373If the "Regular expressions" checkbox is checked, the pattern is interpreted
3374as a regular expression rather than as a literal string. In addition, the
3375replacement string can refer to all or part of what is matched by the pattern.
3376"\&amp;" in the replacement string will be replaced with the entire string
3377that matched the pattern. "\<i>n</i>", where <i>n</i> is a digit from 1 to 9,
3378will be replaced by whatever matched the <i>n</i>th parenthesized grouping in
3379the pattern. See <a href="regexp.html">Regular Expressions</a>.
3380<p>
3381For example, if you specify this pattern:
3382<pre>
3383        foo\((.*), (.*)\)
3384</pre>
3385and this replacement:
3386<pre>
3387        foo(\2, \1)
3388</pre>
3389the effect is to reverse the order of the arguments in every call to the
3390function foo. Note that you need to escape the literal parentheses in the
3391pattern, but not in the replacement string.
3392<p>
3393If the "Confirm changes" checkbox is checked, you will be prompted to confirm
3394each replacement.
3395<p>
3396<b>Default key mapping:</b> Ctrl Shift R
3397<p>
3398<b>See also:</b> <a href="#findInFiles">findInFiles</a>, <a href="#replace">replace</a>
3399<br><br>
3400</dl><!--<hr>-->
3401
3402<a name="resetDisplay">resetDisplay</a><dl><dd>
3403<p>
3404Resets and repaints all edit windows.
3405<p>
3406<b>Default key mapping:</b> None
3407<br><br>
3408</dl><!--<hr>-->
3409
3410<a name="revertBuffer">revertBuffer</a><dl><dd>
3411<p>
3412Reloads the current buffer. If the buffer has unsaved changes, you will be
3413prompted for confirmation before they are discarded.
3414<p>
3415<b>Default key mapping:</b> None
3416<br><br>
3417</dl><!--<hr>-->
3418
3419<a name="right">right</a><dl><dd>
3420<p>
3421Moves the caret one character to the right.
3422<p>
3423<b>Default key mapping:</b> Right
3424<br><br>
3425</dl><!--<hr>-->
3426
3427<a name="save">save</a><dl><dd>
3428<p>
3429Saves the current buffer, if it has been modified. If it's a new buffer,
3430<b>saveAs</b> is invoked so you can provide a filename.
3431<p>
3432<b>Default key mapping:</b> Ctrl S
3433<br><br>
3434</dl><!--<hr>-->
3435
3436<a name="saveAll">saveAll</a><dl><dd>
3437<p>
3438Saves all modified buffers. <code>saveAs</code> is invoked for new buffers so
3439you can provide filenames if necessary.
3440<p>
3441<b>Default key mapping:</b> F2
3442<br><br>
3443</dl><!--<hr>-->
3444
3445<a name="saveAllExit">saveAllExit</a><dl><dd>
3446<p>
3447Saves all modified buffers and shuts down the editor. <code>saveAs</code> is
3448invoked for new buffers so you can provide filenames if necessary.
3449<p>
3450<b>Default key mapping:</b> Ctrl Shift Q
3451<p>
3452<b>See also:</b> <a href="#quit">quit</a>
3453<br><br>
3454</dl><!--<hr>-->
3455
3456<a name="saveAs">saveAs</a><dl><dd>
3457<p>
3458Saves the current buffer under a new name. The file (if any) that was
3459previously associated with the buffer is not deleted, but the buffer is
3460henceforth associated with the new file. The buffer's mode is changed, if
3461necessary, to match the new filename.
3462<br><br>
3463<b>Default key mapping:</b> Ctrl Shift S
3464<br><br>
3465</dl><!--<hr>-->
3466
3467<a name="saveCopy">saveCopy</a><dl><dd>
3468<p>
3469Saves a copy of the current buffer under a new name. The buffer continues to be
3470associated with its original file.
3471<br><br>
3472<b>Default key mapping:</b> Ctrl Alt S
3473<br><br>
3474</dl><!--<hr>-->
3475
3476<a name="saveSession">saveSession</a><dl><dd>
3477<p>
3478Saves information about the current editing session in the active named
3479session file.
3480<p>
3481If no named session is active, you will be prompted for a name for the current
3482session.
3483<p>
3484<b>Default key mapping:</b> None
3485<p>
3486<b>See also:</b> <a href="sessions.html">Sessions</a>,
3487<a href="#loadSession">loadSession</a>,
3488<a href="preferences.html#autosaveNamedSessions">autosaveNamedSessions</a>
3489<br><br>
3490</dl><!--<hr>-->
3491
3492<a name="saveToRegister">saveToRegister</a><dl><dd>
3493<p>
3494Prompts for a register name and saves the selected region in the specified
3495register.
3496<p>
3497Register names must be lower case letters (a-z). The contents of registers
3498persist automatically from one j session to the next.
3499<p>
3500<b>Default key mapping:</b> None
3501<p>
3502<b>Abbreviation:</b> sr
3503<p>
3504<b>See also:</b> <a href="#clearRegister">clearRegister</a>,
3505<a href="#editRegister">editRegister</a>,
3506<a href="#insertRegister">insertRegister</a>
3507<a href="#listRegisters">listRegisters</a>
3508<br><br>
3509</dl><!--<hr>-->
3510
3511<a name="selectAll">selectAll</a><dl><dd>
3512<p>
3513Selects the entire buffer. The current location of the caret is first saved on
3514the marker stack as a temporary bookmark, so you can use
3515<a href="#popPosition">popPosition</a>, mapped by default to Shift F5, to get
3516back where you came from.
3517<p>
3518<b>Default key mapping:</b> Ctrl A
3519<br><br>
3520</dl><!--<hr>-->
3521
3522<a name="selectBob">selectBob</a><dl><dd>
3523<p>
3524Extends the selection to the beginning of the buffer.
3525<br><br>
3526<b>Default key mapping:</b> Ctrl Shift Home
3527<br><br>
3528</dl><!--<hr>-->
3529
3530<a name="selectDown">selectDown</a><dl><dd>
3531<p>
3532Extends the selection down one line.
3533<br><br>
3534<b>Default key mapping:</b> Shift down arrow
3535<br><br>
3536</dl><!--<hr>-->
3537
3538<a name="selectEnd">selectEnd</a><dl><dd>
3539<p>
3540Extends the selection to the end of the current line.
3541<br><br>
3542<b>Default key mapping:</b> Shift End
3543<br><br>
3544</dl><!--<hr>-->
3545
3546<a name="selectEob">selectEob</a><dl><dd>
3547<p>
3548Extends the selection to the end of the buffer.
3549<br><br>
3550<b>Default key mapping:</b> Ctrl Shift End
3551<br><br>
3552</dl><!--<hr>-->
3553
3554<a name="selectHome">selectHome</a><dl><dd>
3555<p>
3556Extends the selection to the beginning of the current line.
3557<br><br>
3558<b>Default key mapping:</b> Shift Home
3559<br><br>
3560</dl><!--<hr>-->
3561
3562<a name="selectLeft">selectLeft</a><dl><dd>
3563<p>
3564Extends the selection one character to the left.
3565<br><br>
3566<b>Default key mapping:</b> Shift Left
3567<br><br>
3568</dl><!--<hr>-->
3569
3570<a name="selectPageDown">selectPageDown</a><dl><dd>
3571<p>
3572Extends the selection down one full screen.
3573<br><br>
3574<b>Default key mapping:</b> Shift Page Down
3575<br><br>
3576</dl><!--<hr>-->
3577
3578<a name="selectPageUp">selectPageUp</a><dl><dd>
3579<p>
3580Extends the selection up one full screen.
3581<br><br>
3582<b>Default key mapping:</b> Shift Page Up
3583<br><br>
3584</dl><!--<hr>-->
3585
3586<a name="selectRight">selectRight</a><dl><dd>
3587<p>
3588Extends the selection one character to the right.
3589<br><br>
3590<b>Default key mapping:</b> Shift Right
3591<br><br>
3592</dl><!--<hr>-->
3593
3594<a name="selectUp">selectUp</a><dl><dd>
3595<p>
3596Extends the selection up one line.
3597<br><br>
3598<b>Default key mapping:</b> Shift up arrow
3599<br><br>
3600</dl><!--<hr>-->
3601
3602<a name="selectWord">selectWord</a><dl><dd>
3603<p>
3604Selects the word at the location of the caret or mouse click.
3605<p>
3606<b>Default key mapping:</b> Alt W or Double Mouse-1
3607<br><br>
3608</dl><!--<hr>-->
3609
3610<a name="selectWordLeft">selectWordLeft</a><dl><dd>
3611<p>
3612Extends the selection to the left by one word.
3613<br><br>
3614<b>Default key mapping:</b> Ctrl Shift Left
3615<br><br>
3616</dl><!--<hr>-->
3617
3618<a name="selectWordRight">selectWordRight</a><dl><dd>
3619<p>
3620Extends the selection to the right by one word.
3621<br><br>
3622<b>Default key mapping:</b> Ctrl Shift Right
3623<br><br>
3624</dl><!--<hr>-->
3625
3626<a name="send">send</a><dl><dd>
3627<p>
3628In a mail composition buffer, sends the current message.
3629<br><br>
3630<b>Default key mapping:</b> None.
3631<br><br>
3632<b>See also:</b> <a href="mail.html">Mail</a>
3633<br><br>
3634</dl><!--<hr>-->
3635
3636<a name="sendMailBackTab">sendMailBackTab</a><dl><dd>
3637<p>
3638Goes back to the previous field in the header area of a mail composition buffer.
3639<p>
3640<b>Default key mapping:</b> Shift Tab in mail composition buffers
3641<p>
3642<b>See also:</b> <a href="#sendMailTab">sendMailTab</a>, <a href="mail.html">Mail</a>
3643<br><br>
3644</dl><!--<hr>-->
3645
3646<a name="sendMailTab">sendMailTab</a><dl><dd>
3647<p>
3648Advances to the next field in the header area of a mail composition buffer.
3649<p>
3650<b>Default key mapping:</b> Tab in mail composition buffers
3651<p>
3652<b>See also:</b> <a href="#sendMailBackTab">sendMailBackTab</a>, <a href="mail.html">Mail</a>
3653<br><br>
3654</dl><!--<hr>-->
3655
3656<a name="setEncoding">setEncoding</a><dl><dd>
3657<p>
3658Sets the character encoding to be used when the current buffer is saved. The
3659encoding name that you specify (e.g. "ISO-8859-1", "UTF-8", "UTF-16",
3660"UnicodeBig", etc.) must be supported by the version of Java that you're
3661using; the string is not case-sensitive.
3662<p>
3663Java recognizes both canonical names and aliases for a variety of encodings,
3664and to make things more interesting, there are significant variations in this
3665area among the different versions of Java. More information from the
3666perspective of Java 1.4 is available here:
3667<pre>
3668        http://java.sun.com/j2se/1.4/docs/guide/intl/encoding.doc.html</pre>
3669<p>
3670<b>Default key mapping:</b> None
3671<br><br>
3672</dl><!--<hr>-->
3673
3674<a name="shellEscape">shellEscape</a><dl><dd>
3675<p>
3676In a shell buffer, if a selection is marked, clears it.  Otherwise, if the
3677caret is on the command line, clears any text past the end of the command
3678prompt and moves the caret to the end of the prompt.
3679<br><br>
3680<b>Default key mapping:</b> Escape in Shell mode
3681<br><br>
3682</dl><!--<hr>-->
3683
3684<a name="shellHome">shellHome</a><dl><dd>
3685<p>
3686In a shell buffer, if the current line begins with a prompt, and if the caret
3687is to the right of the prompt, moves the caret to the end of prompt.  Otherwise,
3688moves the caret to the beginning of the current line.
3689<br><br>
3690<b>Default key mapping:</b> Home in Shell mode
3691<br><br>
3692</dl><!--<hr>-->
3693
3694<a name="shellTab">shellTab</a><dl><dd>
3695<p>
3696Completes pending input.
3697<br><br>
3698<b>Default key mapping:</b> Tab in Shell mode
3699<br><br>
3700</dl><!--<hr>-->
3701
3702<a name="showMessage">showMessage</a><dl><dd>
3703<p>
3704Displays the current compiler or XML parser error message.
3705<br><br>
3706<b>Default key mapping:</b> Alt M
3707<br><br>
3708<b>See also:</b> <a href="#xmlParseBuffer">xmlParseBuffer</a>
3709<br><br>
3710</dl><!--<hr>-->
3711
3712<a name="sidebarListBuffers">sidebarListBuffers</a><dl><dd>
3713<p>
3714Displays (and sets keyboard focus to) the sidebar buffer list.
3715<br><br>
3716<b>Default key mapping:</b> Alt B
3717<br><br>
3718</dl><!--<hr>-->
3719
3720<a name="sidebarListTags">sidebarListTags</a><dl><dd>
3721<p>
3722Displays (and sets keyboard focus to) the sidebar tag list, if the current
3723buffer supports tags.
3724<br><br>
3725<b>Default key mapping:</b> Ctrl Shift L
3726<br><br>
3727</dl><!--<hr>-->
3728
3729<a name="slideIn">slideIn</a><dl><dd>
3730<p>
3731Moves all text in the marked region <code>indentSize</code> columns to the right.
3732<code>indentSize</code> is a buffer-specific setting and may be inspected and
3733modified in the Properties dialog (see <a href="#properties">properties</a>).
3734<br><br>
3735<b>Default key mapping:</b> Alt ]
3736<br><br>
3737</dl><!--<hr>-->
3738
3739<a name="slideOut">slideOut</a><dl><dd>
3740<p>
3741Moves all text in the marked region <code>indentSize</code> columns to the left.
3742<code>indentSize</code> is a buffer-specific setting and may be inspected and
3743modified in the Properties dialog (see <a href="#properties">properties</a>).
3744<br><br>
3745<b>Default key mapping:</b> Alt [
3746<br><br>
3747</dl><!--<hr>-->
3748
3749<a name="sortByDateSent">sortByDateSent</a><dl><dd>
3750<p>
3751Sorts the entries in the current mailbox in order of date sent, with the most
3752recent entries last.
3753<p>
3754<b>Default key mapping:</b> None
3755<br><br>
3756</dl><!--<hr>-->
3757
3758<a name="sortByThread">sortByThread</a><dl><dd>
3759<p>
3760Sorts the entries in the current mailbox by thread.
3761<p>
3762<b>Default key mapping:</b> None
3763<br><br>
3764</dl><!--<hr>-->
3765
3766<a name="sortLines">sortLines</a><dl><dd>
3767<p>
3768Sorts the lines in the selected region in ascending lexicographic order, based
3769on the Unicode value of the characters in each line.
3770<br><br>
3771<b>Default key mapping:</b> None
3772<br><br>
3773</dl><!--<hr>-->
3774
3775<a name="source">source</a><dl><dd>
3776<p>
3777Finds the source of the Java class at the current location of the caret.
3778<p>
3779You can also use <a href="commands.html#executeCommand">executeCommand</a> and
3780specify the name of the class along with the command:
3781<pre>
3782        source javax.swing.JFrame</pre>
3783If the class is properly imported in the current buffer, the simple name is
3784enough:
3785<pre>
3786        source JFrame</pre>
3787<p>
3788For this command to work properly, you need to specify the location of the JDK
3789source on your system by adding a line like this to your
3790<a href="preferences.html">preferences</a> file:
3791<pre>
3792        jdkSourcePath = /home/peter/sun/j2sdk1.4.0/src</pre>
3793<b>Default key mapping:</b> Ctrl F1 in Java mode
3794<p>
3795<b>See also:</b> <a href="preferences.html#jdkSourcePath">jdkSourcePath</a>
3796<br><br>
3797</dl><!--<hr>-->
3798
3799<a name="splitWindow">splitWindow</a><dl><dd>
3800<p>
3801Splits the current window horizontally. Only one split per frame is currently
3802supported.
3803<p>
3804<b>Default key mapping:</b> F10
3805<br><br>
3806</dl><!--<hr>-->
3807
3808<a name="stamp">stamp</a><dl><dd>
3809<p>
3810Inserts the current date and time at the location of the caret.
3811<p>
3812The format of the inserted string is controlled by the
3813<a href="preferences.html#stampFormat">stampFormat</a> property.
3814<p>
3815<b>Default key mapping:</b> Shift F2
3816<br><br>
3817</dl><!--<hr>-->
3818
3819<a name="tab">tab</a><dl><dd>
3820<p>
3821If a multi-line region is selected, or if the property <a href="preferences.html#tabAlwaysIndent">tabAlwaysIndent</a>
3822is true, this command simply calls <a href="commands.html#indentLineOrRegion">indentLineOrRegion</a>.
3823<p>
3824Otherwise (i.e. no multi-line selection, <a href="preferences.html#tabAlwaysIndent">tabAlwaysIndent</a> is
3825false), the behavior depends on the location of the caret.
3826<p>
3827If the caret is at the very beginning of the text on the line, or in the
3828whitespace to the left of the text, <a href="commands.html#tab">tab</a> calls <a href="commands.html#indentLine">indentLine</a>.
3829If the caret is in the midst of the actual text on the line, <a href="commands.html#tab">tab</a>
3830inserts either a single tab character or the equivalent number of spaces,
3831depending on the setting of the <a href="preferences.html#useTabs">useTabs</a> property.
3832<p>
3833<b>Default key mapping:</b> Tab (in programming modes)
3834<p>
3835<b>See also:</b> <a href="#insertTab">insertTab</a>
3836<br><br>
3837</dl><!--<hr>-->
3838
3839<a name="thisError">thisError</a><dl><dd>
3840<p>
3841Jumps to the location in the source file that corresponds to the error message
3842at the current location in the compilation buffer.
3843<p>
3844<b>Default key mapping:</b> Enter, Ctrl Shift G, Double Mouse-1 or Mouse-2 in
3845compilation buffers
3846<p>
3847<b>See also:</b> <a href="#nextError">nextError</a>,
3848<a href="compilation.html">Compilation Buffers</a>
3849<br><br>
3850</dl><!--<hr>-->
3851
3852<a name="toCenter">toCenter</a><dl><dd>
3853<p>
3854Moves the line containing the caret to the center of the window.
3855<br><br>
3856<b>Default key mapping:</b> Ctrl -
3857<br><br>
3858</dl><!--<hr>-->
3859
3860<a name="toggleSidebar">toggleSidebar</a><dl><dd>
3861<p>
3862Toggles the sidebar.
3863<br><br>
3864<b>Default key mapping:</b> Alt =
3865<br><br>
3866</dl><!--<hr>-->
3867
3868<a name="toggleWrap">toggleWrap</a><dl><dd>
3869<p>
3870Toggles automatic word wrap in the current buffer. When automatic wrap is on,
3871j automatically wraps long lines as you type them, when your caret advances
3872past the wrap column.
3873<br><br>
3874<b>Default key mapping:</b> Ctrl F12
3875<br><br>
3876<b>See also:</b> <a href="preferences.html#wrapCol">wrapCol</a>,
3877<a href="#wrapParagraph">wrapParagraph</a>, <a href="#wrapRegion">wrapRegion</a>
3878<br><br>
3879</dl><!--<hr>-->
3880
3881<a name="top">top</a><dl><dd>
3882<p>
3883Moves the caret to the top line of the display, keeping it in the same column.
3884<br><br>
3885<b>Default key mapping:</b> Ctrl Page Up
3886<br><br>
3887</dl><!--<hr>-->
3888
3889<a name="toTop">toTop</a><dl><dd>
3890<p>
3891Moves the line containing the caret to the top of the window.
3892<br><br>
3893<b>Default key mapping:</b> Ctrl Shift -
3894<br><br>
3895</dl><!--<hr>-->
3896
3897<a name="uncommentRegion">uncommentRegion</a><dl><dd>
3898<p>
3899Uncomments each line in the selected region, or the current line if no region is selected.
3900<br><br>
3901<b>Default key mapping:</b> Shift F11
3902<br><br>
3903<b>See also:</b> <a href="#commentRegion">commentRegion</a>
3904<br><br>
3905</dl><!--<hr>-->
3906
3907<a name="undo">undo</a><dl><dd>
3908<p>
3909Undoes the last editing action or actions. Generally speaking, movement within
3910the buffer and simple edits on the same line are grouped for the purposes of
3911undo. All editing actions that modify text in the buffer are undoable except
3912for <a href="#entabRegion">entabRegion</a> and <a href="#detabRegion">detabRegion</a>.
3913<br><br>
3914If you undo through a save, the file saved on disk will not be affected by the
3915undo.
3916<br><br>
3917<b>Default key mapping:</b> Ctrl Z, Alt Backspace, NumPad *
3918<br><br>
3919<b>See also:</b> <a href="#redo">redo</a>
3920<br><br>
3921</dl><!--<hr>-->
3922
3923<a name="unfold">unfold</a><dl><dd>
3924<p>
3925Unfolds the current fold.
3926<br><br>
3927<b>Default key mapping:</b> Ctrl ] in Java, C, C++ and Perl modes
3928<br><br>
3929<b>See also:</b> <a href="#fold">fold</a>
3930<br><br>
3931</dl><!--<hr>-->
3932
3933<a name="unfoldAll">unfoldAll</a><dl><dd>
3934<p>
3935Unfolds all the folds in the current buffer.
3936<br><br>
3937<b>Default key mapping:</b> None
3938<br><br>
3939<b>See also:</b> <a href="#fold">fold</a>
3940<br><br>
3941</dl><!--<hr>-->
3942
3943<a name="unsplitWindow">unsplitWindow</a><dl><dd>
3944<p>
3945Makes the current window fill its frame, closing the other window in the
3946current frame.
3947<br><br>
3948<b>Default key mapping:</b> Shift F10
3949<br><br>
3950</dl><!--<hr>-->
3951
3952<a name="unwrapParagraph">unwrapParagraph</a><dl><dd>
3953<p>
3954Removes line breaks from the current paragraph, making it into one lone line.
3955<br><br>
3956<b>Default key mapping:</b> Shift F12
3957<br><br>
3958<b>See also:</b> <a href="#wrapParagraph">wrapParagraph</a>
3959<br><br>
3960</dl><!--<hr>-->
3961
3962<a name="up">up</a><dl><dd>
3963<p>
3964Moves the caret up one line.
3965<br><br>
3966<b>Default key mapping:</b> Up arrow
3967<br><br>
3968</dl><!--<hr>-->
3969
3970<a name="upperCaseRegion">upperCaseRegion</a><dl><dd>
3971<p>
3972Converts all upper case characters in the selected region to lower case.
3973<br><br>
3974<b>Default key mapping:</b> None
3975<br><br>
3976<b>See also:</b> <a href="#lowerCaseRegion">lowerCaseRegion</a>
3977<br><br>
3978</dl><!--<hr>-->
3979
3980<a name="visibleTabs">visibleTabs</a><dl><dd>
3981<p>
3982Toggles the visibility of tab characters in the buffer. By default, tabs are
3983not visible, and are displayed using the appropriate number of space
3984characters, as you would expect. When you turn on visible tabs, tab characters
3985are indicated by the character '^'.
3986<br><br>
3987<b>Default key mapping:</b> Ctrl Alt T
3988<br><br>
3989</dl><!--<hr>-->
3990
3991<a name="whatChar">whatChar</a><dl><dd>
3992<p>
3993Displays decimal, hex and character equivalents for the character at
3994the current location of the caret.
3995<br><br>
3996<b>Default key mapping:</b> None
3997<br><br>
3998</dl><!--<hr>-->
3999
4000<a name="whereIs">whereIs</a><dl><dd>
4001<p>
4002Displays information about the keys mapped to a particular command.
4003<br><br>
4004<b>Default key mapping:</b> None
4005<br><br>
4006</dl><!--<hr>-->
4007
4008<a name="windowDown">windowDown</a><dl><dd>
4009<p>
4010Moves the window down one line (so that the text seems to move up one line),
4011without changing the location of the caret.
4012<br><br>
4013<b>Default key mapping:</b> Ctrl Down
4014<br><br>
4015</dl><!--<hr>-->
4016
4017<a name="windowUp">windowUp</a><dl><dd>
4018<p>
4019Moves the window up one line (so that the text seems to move down one line),
4020without changing the location of the caret.
4021<br><br>
4022<b>Default key mapping:</b> Ctrl Up
4023<br><br>
4024</dl><!--<hr>-->
4025
4026<a name="wordLeft">wordLeft</a><dl><dd>
4027<p>
4028Moves the caret to the beginning of the current word, or, if the caret is
4029already at the beginning of the current word, to the beginning of the previous word.
4030<br><br>
4031<b>Default key mapping:</b> Ctrl Left
4032<br><br>
4033</dl><!--<hr>-->
4034
4035<a name="wordRight">wordRight</a><dl><dd>
4036<p>
4037Moves the caret to the beginning of the next word.
4038<br><br>
4039<b>Default key mapping:</b> Ctrl Right
4040<br><br>
4041</dl><!--<hr>-->
4042
4043<a name="wrapComment">wrapComment</a><dl><dd>
4044<p>
4045Wraps all the lines in the current multi-line comment at the wrap column,
4046which by default is column 80. The wrap column is controlled by the property
4047<a href="preferences.html#wrapCol">wrapCol</a>, which is a buffer-specific
4048setting that may be inspected and modified in the Properties dialog (see
4049<a href="#properties">properties</a>). You can set global and mode-specific
4050defaults for <a href="preferences.html#wrapCol">wrapCol</a> in your
4051<a href="preferences.html">preferences</a> file.
4052<br><br>
4053<b>Default key mapping:</b> F12 in Java, C, C++ and Perl modes
4054<br><br>
4055<b>See also:</b> <a href="#wrapParagraph">wrapParagraph</a>,
4056<a href="#wrapRegion">wrapRegion</a>
4057<br><br>
4058</dl><!--<hr>-->
4059
4060<a name="wrapParagraph">wrapParagraph</a><dl><dd>
4061<p>
4062Wraps all the lines in the current paragraph at the wrap column, which by
4063default is column 80. The wrap column is controlled by the property
4064<a href="preferences.html#wrapCol">wrapCol</a>, which is a buffer-specific
4065setting that may be inspected and modified in the Properties dialog (see
4066<a href="#properties">properties</a>). You can set global and mode-specific
4067defaults for <a href="preferences.html#wrapCol">wrapCol</a> in your
4068<a href="preferences.html">preferences</a> file.
4069<br><br>
4070A paragraph is basically defined as a block of contiguous lines with blank
4071lines before and after it. To make the definition a bit more flexible,
4072a line starting with &lt;p&gt;, &lt;br&gt; or &lt;pre&gt; is recognized as the
4073first line of a paragraph, even if the line before it is not blank. Similarly,
4074a line ending with &lt;p&gt;, &lt;/p&gt;, &lt;br&gt; or
4075&lt;/pre&gt; is recognized as the last line of a paragraph, even if the line after it is not
4076blank.
4077<br><br>
4078This function does not move the caret, so you can reformat the
4079paragraph and immediately continue typing right where you left off.
4080<br><br>
4081<b>Default key mapping:</b> F12
4082<br><br>
4083<b>See also:</b> <a href="#unwrapParagraph">unwrapParagraph</a>,
4084<a href="#wrapComment">wrapComment</a>, <a href="#wrapRegion">wrapRegion</a>
4085<br><br>
4086</dl><!--<hr>-->
4087
4088<a name="wrapRegion">wrapRegion</a><dl><dd>
4089<p>
4090Wraps all the lines in the selected region at the wrap column, which by
4091default is column 80. The wrap column is controlled by the property
4092<a href="preferences.html#wrapCol">wrapCol</a>, which is a buffer-specific
4093setting that may be inspected and modified in the Properties dialog (see
4094<a href="#properties">properties</a>). You can set global and mode-specific
4095defaults for <a href="preferences.html#wrapCol">wrapCol</a> in your
4096<a href="preferences.html">preferences</a> file.
4097<br><br>
4098<b>Default key mapping:</b> None
4099<br><br>
4100<b>See also:</b> <a href="#wrapComment">wrapComment</a>,
4101<a href="#wrapParagraph">wrapParagraph</a>
4102<br><br>
4103</dl><!--<hr>-->
4104
4105<a name="writeGlobalKeyMap">writeGlobalKeyMap</a><dl><dd>
4106<p>
4107Prompts for a filename and writes out the current global key map to the
4108specifed file, in human-readable form.
4109<br><br>
4110<b>Default key mapping:</b> None
4111<br><br>
4112</dl><!--<hr>-->
4113
4114<a name="writeLocalKeyMap">writeLocalKeyMap</a><dl><dd>
4115<p>
4116Prompts for a filename and writes out the local key map for the current buffer
4117to the specifed file, in human-readable form. The local key map supplements
4118(and possible overrides) global key assignments, based on the mode (Java, HTML,
4119etc.) of the buffer.
4120<br><br>
4121<b>Default key mapping:</b> None
4122<br><br>
4123</dl><!--<hr>-->
4124
4125<a name="xmlElectricEquals">xmlElectricEquals</a><dl><dd>
4126<p>
4127Inserts '=' at the current location of the caret.
4128<br><br>
4129In XML mode, if the '=' immediately follows an attribute name, and if the
4130character following the '=' is either whitespace or '>', this command inserts
4131a pair of double quotation marks after the '=' and positions the caret between
4132the quotation marks.
4133<p>
4134The effect of this is to make it possible to enclose attribute values in
4135quotation marks without having to type the quotation marks themselves.
4136<p>
4137<b>Default key mapping:</b> '=' in XML mode
4138<p>
4139<b>See also:</b> <a href="#htmlElectricEquals">htmlElectricEquals</a>
4140<br><br>
4141</dl><!--<hr>-->
4142
4143<a name="xmlElectricSlash">xmlElectricSlash</a><dl><dd>
4144<p>
4145Inserts '/' at the current location of the caret.
4146<p>
4147In XML mode, if the '/' immediately follows '&lt;', and if there is an
4148unmatched start tag before the current location of the caret, the
4149corresponding end tag is automatically inserted. The line is then
4150automatically re-indented if
4151<a href="preferences.html#autoIndent">autoIndent</a> is true for the current
4152buffer.
4153<p>
4154<b>Default key mapping:</b> '/' in XML mode
4155<br><br>
4156</dl><!--<hr>-->
4157
4158<a name="xmlFindCurrentNode">xmlFindCurrentNode</a><dl><dd>
4159<p>
4160In XML mode, if XML parser support is available and the document tree is
4161displayed in the sidebar, forces the tree to expand all the way down to the
4162node corresponding to the location of the caret in the edit buffer.
4163<br><br>
4164<b>Default key mapping:</b> Ctrl = in XML mode
4165<br><br>
4166<b>See also:</b> <a href="xmlmode.html">XML Mode</a>
4167<br><br>
4168</dl><!--<hr>-->
4169
4170<a name="xmlFindMatch">xmlFindMatch</a><dl><dd>
4171<p>
4172Finds the match to the XML tag at the location of the caret.  Nested tags are
4173handled correctly.
4174<br><br>
4175<b>Default key mapping:</b> Ctrl M in XML mode
4176<br><br>
4177</dl><!--<hr>-->
4178
4179<a name="xmlInsertEmptyElementTag">xmlInsertEmptyElementTag</a><dl><dd>
4180<p>
4181Inserts an XML empty element tag.
4182<br><br>
4183If the property <a href="preferences.html#XmlMode.fixCase">XmlMode.fixCase</a>
4184is true, the tag name is converted to the preferred case (as specified by
4185<a href="preferences.html#XmlMode.upperCaseTagNames">XmlMode.upperCaseTagNames</a>)
4186when it is inserted in the buffer.
4187<br><br>
4188<b>Default key mapping:</b> Ctrl Shift . (Ctrl Shift period) in XML mode
4189<br><br>
4190</dl><!--<hr>-->
4191
4192<a name="xmlInsertMatchingEndTag">xmlInsertMatchingEndTag</a><dl><dd>
4193<p>
4194If there is an unmatched start tag before the current location of the caret,
4195automatically inserts the corresponding end tag.
4196<p>
4197<b>Default key mapping:</b> Ctrl E in XML mode
4198<br><br>
4199</dl><!--<hr>-->
4200
4201<a name="xmlInsertTag">xmlInsertTag</a><dl><dd>
4202<p>
4203Inserts an XML start tag and the corresponding end tag, enclosing the current
4204selection. If no selection is marked, the start and end tags enclose the word
4205at the current location of the caret, if any.
4206<br><br>
4207If the property <a href="preferences.html#XmlMode.fixCase">XmlMode.fixCase</a>
4208is true, the tag name is converted to the preferred case (as specified by
4209<a href="preferences.html#XmlMode.upperCaseTagNames">XmlMode.upperCaseTagNames</a>)
4210when it is inserted in the buffer.
4211<br><br>
4212<b>Default key mapping:</b> Ctrl Shift , (Ctrl Shift comma) in XML mode
4213<br><br>
4214</dl><!--<hr>-->
4215
4216<a name="xmlParseBuffer">xmlParseBuffer</a><dl><dd>
4217<p>
4218In XML mode, parses the current buffer. If the operation succeeds, the document
4219tree in the sidebar is updated. If an error occurs, the parser's error message
4220is displayed in a message box and the caret is moved to the location of the
4221error in the edit buffer.
4222<br><br>
4223<b>Default key mapping:</b> Ctrl P in XML mode
4224<br><br>
4225<b>See also:</b> <a href="xmlmode.html">XML Mode</a>,
4226<a href="preferences.html#enableTree">enableTree</a>,
4227<a href="preferences.html#org.xml.sax.parser">org.xml.sax.parser </a>
4228<br><br>
4229</dl><!--<hr>-->
4230
4231</body>
4232
4233</html>
Note: See TracBrowser for help on using the repository browser.