]> git.donarmstrong.com Git - dactyl.git/blob - common/locale/en-US/tabs.xml
f4379266061982ab031b558c5a2bd2f83443031f
[dactyl.git] / common / locale / en-US / tabs.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <?xml-stylesheet type="text/xsl" href="dactyl://content/help.xsl"?>
3
4 <!DOCTYPE document SYSTEM "dactyl://content/dtd">
5
6 <document
7     name="tabs"
8     title="&dactyl.appName; Tabs"
9     xmlns="&xmlns.dactyl;"
10     xmlns:html="&xmlns.html;">
11
12 <h1 tag="tabs buffers">Tabs and buffers</h1>
13 <toc start="2"/>
14
15 <p>
16     Tabs allow you to keep many web pages open at the same time and to quickly
17     switch between them. Each tab contains exactly one buffer. If your version
18     of &dactyl.host; supports tab groups, only buffers in the active group
19     will be attached to visible tabs. Although not all buffers are always
20     attached to visible tabs, they are all always accessible via the
21     buffer-centric commands and key bindings. Tab-centric commands and key
22     bindings, however, only operate on the set of visible tabs.
23 </p>
24
25 <p>
26
27 </p>
28
29 <h2 tag="listing-tabs">Listing tabs</h2>
30
31 <item>
32     <tags>B :tabs :ls :files :buffers</tags>
33     <spec>:buffers <oa>filter</oa></spec>
34     <spec>B</spec>
35     <description>
36         <p>
37             Show a list of buffers matching <oa>filter</oa>. Buffers are
38             listed according to their tab groups, whether they are visible or
39             not.
40         </p>
41
42         <p>A buffer may be marked with one of the following indicators:</p>
43
44         <dl dt="width: 6em;">
45             <dt><hl key="Indicator">%</hl></dt><dd>The current buffer</dd>
46             <dt><hl key="Indicator">#</hl></dt><dd>The alternate buffer for <ex>:buffer #</ex> and <k name="C-^"/></dd>
47         </dl>
48     </description>
49 </item>
50
51 <item>
52     <tags>:keepa :keepalt</tags>
53     <spec>:keepa<oa>lt</oa> <a>cmd</a></spec>
54     <description>
55         <p>Execute a command without changing the current alternate buffer.</p>
56     </description>
57 </item>
58
59 <h2 tag="opening-tabs">Opening tabs</h2>
60
61 <item>
62     <tags><![CDATA[<new-tab-next> <C-t>]]></tags>
63     <spec><oa>count</oa><![CDATA[<C-t>]]></spec>
64     <description>
65         <p>Execute the next <oa>count</oa> mappings in a new tab.</p>
66     </description>
67 </item>
68
69 <item>
70     <tags>:bg :background</tags>
71     <spec>:background</spec>
72     <description>
73         <p>Execute a command opening any new tabs in the background.</p>
74     </description>
75 </item>
76
77
78 <item>
79     <tags>:tab</tags>
80     <strut/>
81     <spec>:tab <a>cmd</a></spec>
82     <description>
83         <p>
84             Execute <a>cmd</a>, but open any new pages in a new tab rather
85             than the currently focused tab.
86         </p>
87     </description>
88 </item>
89
90 <item>
91     <!-- TODO: move this somewhere more appropriate -->
92     <tags>:window :wind</tags>
93     <spec>:wind<oa>ow</oa> <a>cmd</a></spec>
94     <description>
95         <p>
96             Execute <a>cmd</a>, but open any new pages in a new window rather
97             than the currently focused tab.
98         </p>
99     </description>
100 </item>
101
102 <!-- TODO: should the tab commands be moved back here? -->
103 <p>
104     See <t>opening</t> for other ways to open new tabs.
105 </p>
106
107 <h2 tag="changing-tabs">Changing tabs</h2>
108
109 <item>
110     <tags>gb</tags>
111     <strut/>
112     <spec><oa>count</oa>gb</spec>
113     <description>
114         <p>
115             Repeat last <ex>:buffer</ex> command. This is useful to quickly
116             jump between buffers which have a similar URL or title.
117         </p>
118     </description>
119 </item>
120
121 <item>
122     <tags>gB</tags>
123     <strut/>
124     <spec><oa>count</oa>gB</spec>
125     <description>
126         <p>
127             Repeat last <ex>:buffer</ex> command in the reverse direction.
128         </p>
129     </description>
130 </item>
131
132 <item>
133     <tags>gt</tags>
134     <strut/>
135     <spec><oa>count</oa>gt</spec>
136     <description>
137         <p>
138             Go to the next tab. Cycles to the first tab when the last one is selected.
139             If <oa>count</oa> is specified, go to the <oa>count</oa>th tab.
140         </p>
141     </description>
142 </item>
143
144 <item>
145     <tags><![CDATA[<C-PageDown> <C-Tab> <C-n>]]></tags>
146     <strut/>
147     <spec><oa>count</oa>&lt;C-n></spec>
148     <description>
149         <p>
150             Go to the next tab. Cycles to the first tab when the last one is selected.
151             If <oa>count</oa> is specified, go to the <oa>count</oa>th next tab.
152         </p>
153     </description>
154 </item>
155
156 <item>
157     <tags><![CDATA[<C-PageUp> <C-S-Tab> <C-p> gT]]></tags>
158     <strut/>
159     <spec><oa>count</oa>gT</spec>
160     <description>
161         <p>
162             Go to the previous tab. Cycles to the last tab when the first one is selected.
163             If <oa>count</oa> is specified, go to the <oa>count</oa>th previous tab.
164         </p>
165     </description>
166 </item>
167
168 <item>
169     <tags>:tabn :tabnext</tags>
170     <spec>:<oa>count</oa>tabn<oa>ext</oa> <oa>count</oa></spec>
171     <tags>:tn :tnext</tags>
172     <spec>:<oa>count</oa>tn<oa>ext</oa> <oa>count</oa></spec>
173     <tags>:bn :bnext</tags>
174     <spec>:<oa>count</oa>bn<oa>ext</oa> <oa>count</oa></spec>
175     <description>
176         <p>
177             Switch to the next or <oa>count</oa>th tab. Cycles to the first tab when
178             the last one is selected and <oa>count</oa> is not specified.
179         </p>
180     </description>
181 </item>
182
183 <item>
184     <tags>:bN :bNext :bp :bprevious</tags>
185     <spec>:<oa>count</oa>bp<oa>revious</oa> <oa>count</oa></spec>
186     <spec>:<oa>count</oa>bN<oa>ext</oa> <oa>count</oa></spec>
187     <tags>:tN :tNext :tabN :tabNext</tags>
188     <spec>:<oa>count</oa>tabN<oa>ext</oa> <oa>count</oa></spec>
189     <tags>:tp :tprevious :tabp :tabprevious</tags>
190     <spec>:<oa>count</oa>tabp<oa>revious</oa> <oa>count</oa></spec>
191     <spec>:<oa>count</oa>tp<oa>revious</oa> <oa>count</oa></spec>
192     <description>
193         <p>
194             Switch to the previous tab or go <oa>count</oa> tabs back. Wraps around from the
195             first tab to the last tab.
196         </p>
197     </description>
198 </item>
199
200 <item>
201     <tags><![CDATA[<C-6> <C-^>]]></tags>
202     <spec><oa>count</oa>&lt;C-^></spec>
203     <description>
204         <p>
205             Select the previously selected tab. This provides a quick method of toggling
206             between two tabs. If <oa>count</oa> is specified, go to the <oa>count</oa>th tab.
207         </p>
208     </description>
209 </item>
210
211 <item>
212     <tags>b :b :buffer</tags>
213     <spec>:<oa>count</oa>b<oa>uffer</oa><oa>!</oa> <oa>url|index</oa></spec>
214     <spec>:<oa>count</oa>b<oa>uffer</oa><oa>!</oa> <a>match</a></spec>
215     <spec><oa>count</oa>b</spec>
216     <description>
217         <p>
218             Go to the specified buffer from the buffer list. Argument can be
219             either the buffer index or the full URL opened in an existing
220             buffer. If <oa>count</oa> is given, go to the <oa>count</oa>th
221             buffer.
222         </p>
223
224         <p>
225             If argument is neither a full URL nor an index but uniquely identifies a
226             buffer, by a partial match with the URL or title, it is selected.
227             With <oa>!</oa> the next buffer matching the argument is selected,
228             even if it cannot be identified uniquely. Use <k>b</k> as a
229             shortcut to open this prompt.
230         </p>
231
232         <p>If argument is <em>#</em>, the alternate buffer will be selected (see <k name="C-^"/>).</p>
233
234         <p>If no argument is given, the current buffer remains current.</p>
235     </description>
236 </item>
237
238 <item>
239     <tags>g^ g0</tags>
240     <spec>g0</spec>
241     <spec>g^</spec>
242
243     <tags>:bf :bfirst :br :brewind</tags>
244     <spec>:br<oa>ewind</oa></spec>
245     <spec>:bf<oa>irst</oa></spec>
246
247     <tags>:tabfir :tabfirst :tabr :tabrewind</tags>
248     <spec>:tabr<oa>ewind</oa></spec>
249     <spec>:tabfir<oa>st</oa></spec>
250     <description>
251         <p>Switch to the first tab.</p>
252     </description>
253 </item>
254
255 <item>
256     <tags>g$ :bl :blast :tabl :tablast</tags>
257     <spec>:tabl<oa>ast</oa></spec>
258     <spec>:bl<oa>ast</oa></spec>
259     <spec>g$</spec>
260     <description>
261         <p>Switch to the last tab.</p>
262     </description>
263 </item>
264
265 <item>
266     <tags>:tabde :tabdetach</tags>
267     <strut/>
268     <spec>:tabde<oa>tach</oa></spec>
269     <description>
270         <p>
271             Detach the current tab, and open it in its own window. As each
272             window must contain at least one buffer, it is not possible to detach
273             the last buffer in a window.
274         </p>
275     </description>
276 </item>
277
278 <item>
279     <tags>:taba :tabattach</tags>
280     <spec>:taba<oa>ttach</oa> <a>window-index</a> <oa>buffer-index</oa></spec>
281     <description>
282         <p>
283             Attach the current tab to another window. <a>window-index</a> is
284             an index into the list of open windows and <oa>buffer-index</oa>
285             is the index at which to insert the tab in the other window's
286             buffer list. If this is the last buffer in a window, the window
287             will be closed.
288         </p>
289
290         <p>The following options are available:</p>
291
292         <dl dt="width: 8em;">
293             <dt>-group</dt>
294             <dd>
295                 Attach to a tab group in the current window rather than to a
296                 separate window.
297                 (short name <em>-g</em>).
298             </dd>
299         </dl>
300     </description>
301 </item>
302
303 <h2 tag="reordering-tabs">Reordering tabs</h2>
304
305 <item>
306     <tags>:tabm :tabmove</tags>
307     <spec>:tabm<oa>ove</oa> <a>N</a></spec>
308     <spec>:tabm<oa>ove</oa> <a>match</a></spec>
309     <spec>:tabm<oa>ove</oa><oa>!</oa> <a>+N|-N</a></spec>
310     <description>
311         <p>
312             Move the current tab to the position of tab <a>N</a>. When <a>N</a>
313             is <em>$</em>, the current tab is made the last one. <a>N</a> can
314             also be prefixed with <em>+</em> or <em>-</em> to indicate a
315             relative movement. If <oa>!</oa> is specified the movement wraps
316             around the start or end of the tab list.
317         </p>
318         <p>
319             The tab index may also be selected by a general <a>match</a> string
320             like <ex>:buffer</ex>.
321         </p>
322     </description>
323 </item>
324
325 <h2 tag="closing-tabs">Closing tabs</h2>
326
327 <item>
328     <tags>d</tags>
329     <tags>:tabc :tabclose</tags>
330     <spec>:<oa>count</oa>tabc<oa>lose</oa><oa>!</oa> <oa>arg</oa></spec>
331     <spec><oa>count</oa>d</spec>
332     <description>
333         <p>
334             Delete current buffer. If <oa>count</oa> is specified then <oa>count</oa> tabs are
335             removed. Afterwards, the tab to the right of the deleted tabs is selected.
336         </p>
337
338         <p>
339             When used with <oa>arg</oa>, remove all visible tabs which match the
340             <t>site-filter</t> <oa>arg</oa>. With <oa>!</oa>, remove all tabs
341             for which the currently opened page's URL or title matches the
342             regular expression <oa>arg</oa>.
343         </p>
344     </description>
345 </item>
346
347 <item>
348     <tags>:bd :bdelete</tags>
349     <spec>:<oa>count</oa>bd<oa>elete</oa><oa>!</oa> <oa>arg</oa></spec>
350     <description>
351         <p>
352             Like <ex>:tabclose</ex> but include hidden tabs.
353         </p>
354     </description>
355 </item>
356
357 <item>
358     <tags>D</tags>
359     <strut/>
360     <spec><oa>count</oa>D</spec>
361     <description>
362         <p>Like <k>d</k> but selects the tab to the left of the deleted tabs after deletion.</p>
363     </description>
364 </item>
365
366 <item>
367     <tags>:tabo :tabonly</tags>
368     <strut/>
369     <spec>:tabo<oa>nly</oa></spec>
370     <description>
371         <p>Close all buffers other than the currently visible tab.</p>
372     </description>
373 </item>
374
375 <item>
376     <tags>u :u :undo</tags>
377     <spec>:<oa>count</oa>u<oa>ndo</oa> <oa>url</oa></spec>
378     <spec><oa>count</oa>u</spec>
379     <description>
380         <p>
381             Restore a closed tab. If a <oa>count</oa> is given, restore the
382             <oa>count</oa>th closed tab. With <oa>url</oa>, restores most
383             recently closed tab with a matching URL.
384         </p>
385     </description>
386 </item>
387
388 <item>
389     <tags>:undoa :undoall</tags>
390     <spec>:undoa<oa>ll</oa></spec>
391     <description short="true">
392         <p>Restore all closed tabs in the closed tabs list.</p>
393     </description>
394 </item>
395
396 <h2 tag="looping-over-tabs">Looping over tabs</h2>
397
398 <item>
399     <tags>:tabd :tabdo :bufd :bufdo</tags>
400     <spec>:tabd<oa>o</oa> <a>cmd</a></spec>
401     <description>
402         <p>
403             Execute <a>cmd</a> once in each buffer. Each buffer is focused, in
404             turn, and <a>cmd</a> is executed therein. The last buffer remains
405             focused after execution.
406         </p>
407
408         <p>
409             <a>cmd</a> should not alter the tab list state by adding, removing or reordering
410             tabs.
411         </p>
412     </description>
413 </item>
414
415 <h2 tag="app-tabs application-tabs pinned-tabs">Application Tabs</h2>
416
417 <item>
418     <tags>:pin :pintab</tags>
419     <spec>:<oa>count</oa>pin<oa>tab</oa><oa>!</oa> <oa>arg</oa></spec>
420     <description>
421         <p>
422             Pin tab as an application tab. If <oa>!</oa> is given,
423             the tab's pinned state is toggled. Arguments and count
424             are the same as for <ex>:bdelete</ex> and <ex>:buffer</ex>.
425         </p>
426     </description>
427 </item>
428
429 <item>
430     <tags>:unpin :unpintab</tags>
431     <spec>:<oa>count</oa>unpin<oa>tab</oa> <oa>arg</oa></spec>
432     <description>
433         <p>
434             Unpin tab as an application tab. Arguments and count
435             are the same as for <ex>:pintab</ex>.
436         </p>
437     </description>
438 </item>
439
440
441 </document>
442
443 <!-- vim:se sts=4 sw=4 et: -->