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

Last change on this file since 209 was 209, checked in by piso, 21 years ago

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