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