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