common/locale/en-US/browsing.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="browsing"
   8     title="&dactyl.appName; Browsing"
   9     xmlns="&xmlns.dactyl;"
  10     xmlns:html="&xmlns.html;">
  11
  12 <h1 tag="surfing browsing">Browsing</h1>
  13 <toc start="2"/>
  14
  15 <h2 tag="bypassing-&dactyl.name;">Bypassing &dactyl.appName;</h2>
  16
  17 &dactyl.appName; overrides nearly all &dactyl.host; keys in order to
  18 make browsing more pleasant for Vim users. On the occasions when you
  19 want to bypass &dactyl.appName;'s key handling and pass keys directly to
  20 &dactyl.host; or to a web page, you have two options:
  21
  22 <item>
  23     <tags><![CDATA[<A-b>]]></tags>
  24     <spec><![CDATA[<A-b>]]></spec>
  25     <description>
  26         <p>
  27             Process the next key as a builtin mapping, ignoring any user defined
  28             mappings and <o>passkeys</o> settings.
  29         </p>
  30     </description>
  31 </item>
  32
  33 <item>
  34     <tags><![CDATA[send-key <pass-next-key> <C-v> CTRL-V]]></tags>
  35     <spec><![CDATA[<C-v>]]></spec>
  36     <description>
  37         <p>
  38             Pass the next key press directly to &dactyl.host;.
  39         </p>
  40     </description>
  41 </item>
  42
  43 <item>
  44     <tags><![CDATA[pass-through <pass-all-keys> <C-z> CTRL-Z]]></tags>
  45     <spec><![CDATA[<C-z>]]></spec>
  46     <description>
  47         <p>
  48             Pass all keys except for <k name="Esc"/> directly to
  49             &dactyl.host;. When <k name="Esc"/> is pressed,
  50             resume normal key handling. This is especially useful
  51             for web sites which make heavy use of key bindings.
  52         </p>
  53     </description>
  54 </item>
  55
  56 <h2 tag="opening">Opening web pages</h2>
  57
  58 <item>
  59     <tags>o :o :open</tags>
  60     <spec>:o<oa>pen</oa> <oa>args</oa></spec>
  61     <spec>o</spec>
  62     <description>
  63         <p>
  64             Open a single URL in the current tab, or multiple URLs
  65             in the current tab and background tabs. URLs may be
  66             separated with <o>urlseparator</o>, in which case the
  67             first URL is opened in the current tab and the rest are
  68             opened in new background tabs.
  69         </p>
  70
  71         <p>
  72             Each URL may be one of the following:
  73         </p>
  74
  75         <ol>
  76             <li>
  77                 A local filename, if it begins with <em>/</em>,
  78                 <em>./</em>, or <em>~/</em> and the specified file
  79                 exists.
  80             </li>
  81             <li>
  82                 <p>
  83                     A search or bookmark keyword, or a search engine
  84                     name, followed by search arguments.
  85                 </p>
  86                 <example><ex>:open wikipedia Linus Torvalds</ex></example>
  87                 <p>
  88                     Search engines can be edited via
  89                     <ex>:dialog searchengines</ex> and search
  90                     keywords may be added by right clicking any
  91                     search box and selecting <str>Add a Keyword for
  92                     this Search</str>.
  93                 </p>
  94             </li>
  95             <li>
  96                 <p>
  97                     Any search string which does not look like a URL or
  98                     hostname, which will be passed to the default
  99                     search engine (see <o>defsearch</o>).
 100                 </p>
 101                 <example><ex>:open Linus Torvalds</ex></example>
 102            </li>
 103            <li>
 104                Any other value is passed directly &dactyl.host; and
 105                must be a valid URL or hostname.
 106            </li>
 107         </ol>
 108
 109         <p>
 110             <ex>:open</ex> provides powerful URL completion from
 111             several possible sources, which can be adjusted via the
 112             <o>complete</o> option.
 113         </p>
 114     </description>
 115 </item>
 116
 117 <item>
 118     <tags>t :t :tabopen :tabnew</tags>
 119     <spec>:tabopen<oa>!</oa> <oa>args</oa></spec>
 120     <spec>t</spec>
 121     <description>
 122         <p>
 123             Like <ex>:open</ex>, but all arguments are opened in new
 124             tabs. The first new tab is activated if <o>activate</o>
 125             contains <str>tabopen</str> or <oa>!</oa> is provided.
 126         </p>
 127     </description>
 128 </item>
 129
 130 <item>
 131     <tags>T</tags>
 132     <spec>T</spec>
 133     <description short="true">
 134         <p>
 135             Open a <ex>:tabopen</ex> prompt followed by the current URL.
 136         </p>
 137     </description>
 138 </item>
 139
 140 <item>
 141     <tags>:tabdu :tabduplicate</tags>
 142     <spec>:<oa>count</oa>tabdu<oa>plicate</oa><oa>!</oa></spec>
 143     <description>
 144         <p>
 145             Duplicates current tab <oa>count</oa> times. The first
 146             new tab is activated if <o>activate</o> contains
 147             <str>tabopen</str> or <oa>!</oa> is provided.
 148         </p>
 149     </description>
 150 </item>
 151
 152 <item>
 153     <tags>O</tags>
 154     <spec>O</spec>
 155     <description short="true">
 156         <p>
 157             Open an <ex>:open</ex> prompt followed by the current URL.
 158         </p>
 159     </description>
 160 </item>
 161
 162 <item>
 163     <tags>w :winopen :wopen</tags>
 164     <spec>:wino<oa>pen</oa><oa>!</oa> <oa>args</oa></spec>
 165     <spec>w</spec>
 166     <description>
 167         <p>
 168             Like <ex>:tabopen</ex>, but all arguments are opened in
 169             a single new window.
 170         </p>
 171     </description>
 172 </item>
 173
 174 <item>
 175     <tags>W</tags>
 176     <spec>W</spec>
 177     <description short="true">
 178         <p>
 179             Open a <ex>:winopen</ex> prompt followed by the current URL.
 180         </p>
 181     </description>
 182 </item>
 183
 184 <item>
 185     <tags><![CDATA[<open-clipboard-url> <MiddleMouse> p]]></tags>
 186     <strut/>
 187     <spec>p</spec>
 188     <description>
 189         <p>
 190             Open (put) a URL based on the current clipboard
 191             contents, or, on X11 systems, the currently selected
 192             text. All white space is stripped from the selection and
 193             it is opened in the same manner as <ex>:open</ex>.
 194         </p>
 195     </description>
 196 </item>
 197
 198 <item>
 199     <tags>&lt;tab-open-clipboard-url> P</tags>
 200     <strut/>
 201     <spec>P</spec>
 202     <description>
 203         <p>
 204             Open (put) a URL based on the current clipboard contents
 205             in a new buffer. Works like <k>p</k> but opens a new
 206             tab. The new tab is activated if <o>activate</o>
 207             contains <str>paste</str>.
 208         </p>
 209     </description>
 210 </item>
 211
 212 <item>
 213     <tags>gP</tags>
 214     <strut/>
 215     <spec>gP</spec>
 216     <description>
 217         <p>
 218             Open (put) a URL based on the current clipboard contents
 219             in a new buffer. The new tab is activated if <o>activate</o>
 220             does <em>not</em> contain <str>paste</str>.
 221         </p>
 222     </description>
 223 </item>
 224
 225 <item>
 226     <tags><![CDATA[<C-x>]]></tags>
 227     <strut/>
 228     <spec><oa>count</oa>&lt;C-x></spec>
 229     <description>
 230         <p>
 231             Decrements the last number in URL by 1, or by
 232             <oa>count</oa> if given. Negative numbers are not
 233             supported as trailing numbers in URLs are often preceded
 234             by hyphens.
 235         </p>
 236     </description>
 237 </item>
 238
 239 <item>
 240     <tags><![CDATA[<C-a>]]></tags>
 241     <strut/>
 242     <spec><oa>count</oa>&lt;C-a></spec>
 243     <description>
 244         <p>
 245             Increments the last number in URL by 1, or by
 246             <oa>count</oa> if given.
 247         </p>
 248     </description>
 249 </item>
 250
 251 <item>
 252     <tags>~</tags>
 253     <spec>~</spec>
 254     <description short="true">
 255         <p>Open home directory. Equivalent to <ex>:open ~/</ex></p>
 256     </description>
 257 </item>
 258
 259 <h2 tag="navigating">Navigating</h2>
 260
 261 <item>
 262     <tags><![CDATA[H <C-o> CTRL-O :ba :back]]></tags>
 263     <spec>:<oa>count</oa>ba<oa>ck</oa> <oa>url</oa></spec>
 264     <spec>:ba<oa>ck</oa>!</spec>
 265     <spec><oa>count</oa>&lt;C-o></spec>
 266     <description>
 267         <p>
 268             Go <oa>count</oa> pages back in the browser history. If
 269             <oa>url</oa> is specified go back to the first matching
 270             URL. The special version <ex>:back!</ex> goes to the
 271             beginning of the browser history.
 272         </p>
 273     </description>
 274 </item>
 275
 276 <item>
 277     <tags><![CDATA[L <C-i> CTRL-I :fo :fw :forward]]></tags>
 278     <spec>:<oa>count</oa>fo<oa>rward</oa> <oa>url</oa></spec>
 279     <spec>:fo<oa>rward</oa>!</spec>
 280     <spec><oa>count</oa>&lt;C-i></spec>
 281     <description>
 282         <p>
 283             Go <oa>count</oa> pages forward in the browser history.
 284             If <oa>url</oa> is specified go forward to the first
 285             matching URL. The special version <ex>:forward!</ex>
 286             goes to the end of the browser history.
 287         </p>
 288     </description>
 289 </item>
 290
 291 <item>
 292     <tags>:ju :jumps</tags>
 293     <spec>:ju<oa>mps</oa></spec>
 294     <description>
 295         <p>List all jumps, i.e., the current tab's session history.</p>
 296
 297         <p>
 298             Current history position is marked with <em>></em>.
 299             Jump numbers may be used as counts for with
 300             <ex>:back</ex> or <ex>:forward</ex>.
 301         </p>
 302     </description>
 303 </item>
 304
 305 <item>
 306     <tags>gh</tags>
 307     <spec>gh</spec>
 308     <description short="true">
 309         <p>Go home. Opens the homepage in the current tab.</p>
 310     </description>
 311 </item>
 312
 313 <item>
 314     <tags>gH</tags>
 315     <strut/>
 316     <spec>gH</spec>
 317     <description>
 318         <p>
 319             Go home in a new tab. Opens the homepage in a new tab.
 320             The new tab is activated if <o>activate</o> contains
 321             <str>homepage</str>.
 322         </p>
 323     </description>
 324 </item>
 325
 326 <item>
 327     <tags>gu</tags>
 328     <spec><oa>count</oa>gu</spec>
 329     <description short="true">
 330         <p>Go to <oa>count</oa>th parent directory.</p>
 331
 332         <p>
 333             For example, at the URL
 334             <tt>http://www.example.com/dir1/dir2/file.htm</tt>,
 335             2<k>gu</k> opens <tt>http://www.example.com/dir1/</tt>.
 336         </p>
 337     </description>
 338 </item>
 339
 340 <item>
 341     <tags>gU</tags>
 342     <spec>gU</spec>
 343     <description short="true">
 344         <p>Go to the root of the web site.</p>
 345
 346         <p>
 347             For example, at the URL
 348             <tt>http://www.example.com/dir1/dir2/file.htm</tt>,
 349             <k>gU</k> opens <tt>http://www.example.com/</tt>.
 350         </p>
 351     </description>
 352 </item>
 353
 354 <h2 tag="reloading">Reloading</h2>
 355
 356 <item>
 357     <tags>&lt;reload> r</tags>
 358     <spec>r</spec>
 359     <description short="true">
 360         <p>Reload the current web page.</p>
 361     </description>
 362 </item>
 363
 364 <item>
 365     <tags>&lt;full-reload> R</tags>
 366     <spec>R</spec>
 367     <description short="true">
 368         <p>Reload the current web page without using the cache.</p>
 369     </description>
 370 </item>
 371
 372 <item>
 373     <tags>:reh :rehash</tags>
 374     <spec>:reh<oa>ash</oa> <oa>arg</oa> …</spec>
 375     <description>
 376         <p>
 377             Reload the &dactyl.appName; add-on, including all code, plugins,
 378             and configuration. For users running directly from the development
 379             repository, this is a good way to update to the latest version or
 380             to test your changes.
 381         </p>
 382         <p>
 383             Any arguments supplied are parsed as command-line arguments as
 384             specified in <t>startup-options</t>.
 385         </p>
 386         <warning>
 387             Not all plugins are designed to cleanly un-apply during a rehash.
 388             While official plugins are safe, beware of possible instability
 389             if you rehash while running third-party plugins.
 390         </warning>
 391     </description>
 392 </item>
 393
 394 <item>
 395     <tags>:re :reload</tags>
 396     <spec>:re<oa>load</oa><oa>!</oa></spec>
 397     <description>
 398         <p>
 399             Reload current web page. If <oa>!</oa> is given, reload
 400             without using the cache.
 401         </p>
 402     </description>
 403 </item>
 404
 405 <item>
 406     <tags>:reloada :reloadall</tags>
 407     <spec>:reloada<oa>ll</oa><oa>!</oa></spec>
 408     <description>
 409         <p>
 410             Reload all tabs. If <oa>!</oa> is given, reload without
 411             using the cache.
 412         </p>
 413     </description>
 414 </item>
 415
 416 <h2 tag="stopping">Stopping</h2>
 417
 418 <item>
 419     <tags><![CDATA[<C-c> :st :stop]]></tags>
 420     <spec>&lt;C-c></spec>
 421     <strut/>
 422     <spec>:st<oa>op</oa></spec>
 423     <description short="true">
 424         <p>Stop loading the current web page.</p>
 425     </description>
 426 </item>
 427
 428 <item>
 429     <tags>:stopa :stopall</tags>
 430     <spec>:stopa<oa>ll</oa></spec>
 431     <description short="true">
 432         <p>Stop loading all web pages.</p>
 433     </description>
 434 </item>
 435
 436 <h2 tag="writing save-file">Writing</h2>
 437
 438 <item>
 439     <tags>:w :write :sav :saveas</tags>
 440     <spec>:sav<oa>eas</oa><oa>!</oa> <oa>file</oa></spec>
 441     <description>
 442         <p>
 443             Save current web page to disk. If <oa>file</oa> is omitted, save to
 444             the page's default filename. If <oa>file</oa> is a directory or ends
 445             with your platform's path separator, save to the page's default
 446             filename in that directory. Existing documents will only be
 447             overwritten if <oa>!</oa> is given.
 448         </p>
 449     </description>
 450 </item>
 451
 452 <item>
 453     <spec>:write >> <a>file</a></spec>
 454     <description>
 455         <p>
 456             Appends the current web page to the file <a>file</a>. The given
 457             file must already exist.
 458         </p>
 459     </description>
 460 </item>
 461
 462 <item>
 463     <spec>:write !<a>cmd</a></spec>
 464     <description>
 465         <p>
 466             Writes the current web page to <a>cmd</a> and prints the command's
 467             output.
 468         </p>
 469     </description>
 470 </item>
 471
 472 <h2 tag="quitting save-session">Quitting</h2>
 473
 474 <item>
 475     <tags>:q :quit</tags>
 476     <strut/>
 477     <spec>:q<oa>uit</oa></spec>
 478     <description>
 479         <p>
 480             Quit current tab. If this is the last tab in the window,
 481             close the window.
 482         </p>
 483     </description>
 484 </item>
 485
 486 <item>
 487     <tags>:qa :qall :quita :quitall</tags>
 488     <strut/>
 489     <spec>:quita<oa>ll</oa></spec>
 490     <description>
 491         <p>
 492             Quit &dactyl.appName;, no matter how many tabs/windows
 493             are open. The session is not stored.
 494         </p>
 495     </description>
 496 </item>
 497
 498 <item>
 499     <tags>:wc :wclose :winc :winclose</tags>
 500     <spec>:winc<oa>lose</oa></spec>
 501     <description short="true">
 502         <p>Close the current window.</p>
 503     </description>
 504 </item>
 505
 506 <item>
 507     <tags>:winon :winonly</tags>
 508     <spec>:winon<oa>ly</oa></spec>
 509     <description short="true">
 510         <p>Close all windows but the current.</p>
 511     </description>
 512 </item>
 513
 514 <item>
 515     <tags>:xa :xall :wq :wqa :wqall</tags>
 516     <spec>:wqa<oa>ll</oa></spec>
 517     <strut/>
 518     <spec>:xa<oa>ll</oa></spec>
 519     <description short="true">
 520         <p>Save the current session and quit.</p>
 521         <note>
 522             Unlike Vim, <ex>:wq</ex> closes the entire window rather
 523             than just the current tab.
 524         </note>
 525     </description>
 526 </item>
 527
 528 <item>
 529     <tags>ZQ</tags>
 530     <spec>ZQ</spec>
 531     <description short="true">
 532         <p>Quit and don't save the session. Works like <ex>:qall</ex>.</p>
 533     </description>
 534 </item>
 535
 536 <item>
 537     <tags>ZZ</tags>
 538     <spec>ZZ</spec>
 539     <description short="true">
 540         <p>
 541             Quit &dactyl.appName; and save the session. Works like
 542             <ex>:xall</ex>.
 543         </p>
 544     </description>
 545 </item>
 546
 547 <h2 tag="current-directory">The current directory</h2>
 548
 549 <item>
 550     <tags>:chd :chdir :cd</tags>
 551     <strut/>
 552     <spec>:cd <oa>path</oa></spec>
 553     <description>
 554         <p>
 555             Change the current directory. If <oa>path</oa> is
 556             <em>-</em>, change to the previous directory. If it is
 557             omitted, change to the home directory.
 558         </p>
 559     </description>
 560 </item>
 561
 562 <item>
 563     <tags>:pw :pwd</tags>
 564     <spec>:pw<oa>d</oa></spec>
 565     <description short="true">
 566         <p>Print the current directory name.</p>
 567     </description>
 568 </item>
 569
 570 </document>
 571
 572 <!-- vim:se sts=4 sw=4 et: -->