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         <p>
 147             When called via <ex>:private</ex>, the new window is a
 148             private browsing window.
 149         </p>
 150     </description>
 151 </item>
 152
 153 <item>
 154     <tags>W</tags>
 155     <spec>W</spec>
 156     <description short="true">
 157         <p>
 158             Open a <ex>:winopen</ex> prompt followed by the current URL.
 159         </p>
 160     </description>
 161 </item>
 162
 163 <item>
 164     <tags><![CDATA[<open-clipboard-url> <MiddleMouse> p]]></tags>
 165     <strut/>
 166     <spec>p</spec>
 167     <description>
 168         <p>
 169             Open (put) a URL based on the current clipboard
 170             contents, or, on X11 systems, the currently selected
 171             text. All white space is stripped from the selection and
 172             it is opened in the same manner as <ex>:open</ex>.
 173         </p>
 174     </description>
 175 </item>
 176
 177 <item>
 178     <tags>&lt;tab-open-clipboard-url> P</tags>
 179     <strut/>
 180     <spec>P</spec>
 181     <description>
 182         <p>
 183             Open (put) a URL based on the current clipboard contents
 184             in a new buffer. Works like <k>p</k> but opens a new
 185             tab. The new tab is activated if <o>activate</o>
 186             contains <str>paste</str>.
 187         </p>
 188     </description>
 189 </item>
 190
 191 <item>
 192     <tags>gP</tags>
 193     <strut/>
 194     <spec>gP</spec>
 195     <description>
 196         <p>
 197             Open (put) a URL based on the current clipboard contents
 198             in a new buffer. The new tab is activated if <o>activate</o>
 199             does <em>not</em> contain <str>paste</str>.
 200         </p>
 201     </description>
 202 </item>
 203
 204 <item>
 205     <tags><![CDATA[<decrement-url-path> <C-x>]]></tags>
 206     <strut/>
 207     <spec><oa>count</oa>&lt;C-x></spec>
 208     <description>
 209         <p>
 210             Decrements the last number in URL by 1, or by
 211             <oa>count</oa> if given. Negative numbers are not
 212             supported as trailing numbers in URLs are often preceded
 213             by hyphens.
 214         </p>
 215     </description>
 216 </item>
 217
 218 <item>
 219     <tags><![CDATA[<increment-url-path> <C-a>]]></tags>
 220     <strut/>
 221     <spec><oa>count</oa>&lt;C-a></spec>
 222     <description>
 223         <p>
 224             Increments the last number in URL by 1, or by
 225             <oa>count</oa> if given.
 226         </p>
 227     </description>
 228 </item>
 229
 230 <h2 tag="history">History</h2>
 231
 232 <item>
 233     <tags><![CDATA[<C-o>]]></tags>
 234     <strut/>
 235     <spec><oa>count</oa><![CDATA[<C-o>]]></spec>
 236     <description>
 237         <p>
 238             Go to an older position in the jump list.
 239             If <oa>count</oa> is specified, jump <oa>count</oa> positions backward.
 240         </p>
 241     </description>
 242 </item>
 243
 244 <item>
 245     <tags><![CDATA[<C-i>]]></tags>
 246     <strut/>
 247     <spec><oa>count</oa><![CDATA[<C-i>]]></spec>
 248     <description>
 249         <p>
 250             Go to a newer position in the jump list.
 251             If <oa>count</oa> is specified, jump <oa>count</oa> positions forward.
 252         </p>
 253     </description>
 254 </item>
 255
 256 <item>
 257     <tags>:ju :jumps</tags>
 258     <strut/>
 259     <spec>:ju<oa>mps</oa></spec>
 260     <description>
 261         <p>
 262             Display the jump list.
 263             The jump numbers shown are suitable as arguments to <k name="C-o"/>
 264             or <k name="C-i"/>.
 265         </p>
 266     </description>
 267 </item>
 268
 269 <item>
 270     <tags><![CDATA[<M-Left> <A-Left> H]]></tags>
 271     <strut/>
 272     <spec>[count]H</spec>
 273     <description>
 274         <p>
 275             Go back in the browser history. If <oa>count</oa> is specified, go
 276             back <oa>count</oa> pages.
 277         </p>
 278     </description>
 279 </item>
 280
 281 <item>
 282     <tags><![CDATA[<M-Right> <A-Right> L]]></tags>
 283     <strut/>
 284     <spec><oa>count</oa>L</spec>
 285     <description>
 286         <p>
 287             Go forward in the browser history. If <oa>count</oa> is specified,
 288             go forward <oa>count</oa> pages.
 289         </p>
 290     </description>
 291 </item>
 292
 293 <item>
 294     <tags>:ba :back</tags>
 295     <spec>:<oa>count</oa>ba<oa>ck</oa> <oa>url</oa></spec>
 296     <spec>:<oa>count</oa>ba<oa>ck</oa>!</spec>
 297     <description>
 298         <p>
 299             Go back in the browser history. If <oa>count</oa> is specified, go
 300             back <oa>count</oa> pages.
 301         </p>
 302         <p>
 303             The special version <ex>:back!</ex> goes to the beginning of the browser history.
 304         </p>
 305     </description>
 306 </item>
 307
 308 <item>
 309     <tags>:fw :fo :forward</tags>
 310     <spec>:<oa>count</oa>fo<oa>rward</oa> <oa>url</oa></spec>
 311     <spec>:<oa>count</oa>fo<oa>rward</oa>!</spec>
 312     <description>
 313         <p>
 314             Go forward in the browser history. If <oa>count</oa> is specified,
 315             go forward <oa>count</oa> pages.
 316         </p>
 317         <p>
 318             The special version <ex>:forward!</ex> goes to the end of the browser history.
 319         </p>
 320     </description>
 321 </item>
 322
 323 <item>
 324     <tags><![CDATA[[d]]></tags>
 325     <spec><oa>count</oa>[d</spec>
 326     <description>
 327         <p>
 328             Go to the <oa>count</oa>th previous domain in the history stack.
 329         </p>
 330     </description>
 331 </item>
 332
 333 <item>
 334     <tags><![CDATA[]d]]></tags>
 335     <spec><oa>count</oa>]d</spec>
 336     <description>
 337         <p>
 338             Go to the <oa>count</oa>th next domain in the history stack.
 339         </p>
 340     </description>
 341 </item>
 342
 343 <item>
 344     <tags>:hs :hist :history</tags>
 345     <spec>:hist<oa>ory</oa><oa>!</oa> <oa>filter</oa></spec>
 346     <description>
 347         <p>
 348             Show recently visited URLs. Opens the message window at the bottom of the screen
 349             with all history items whose page titles or URLs match
 350             <oa>filter</oa>.
 351         </p>
 352
 353         <p>
 354             The special version <ex>:history!</ex> works the same as
 355             <ex>:history</ex> except that it opens all matching
 356             pages in new tabs rather than listing them.
 357         </p>
 358
 359         <p>The pages may also be filtered via the following options,</p>
 360
 361         <dl dt="width: 8em;">
 362             <dt>-max</dt>
 363             <dd>
 364                 The maximum number of items to list or open
 365                 (short name <em>-m</em>).
 366             </dd>
 367             <dt>-sort</dt>
 368             <dd>
 369                 The sort order of the results
 370                 (short name <em>-s</em>).
 371             </dd>
 372         </dl>
 373     </description>
 374 </item>
 375
 376 <h2 tag="navigating">Navigating</h2>
 377
 378 <item>
 379     <tags><![CDATA[<open-home-directory> ~]]></tags>
 380     <spec>~</spec>
 381     <description short="true">
 382         <p>Open home directory. Equivalent to <ex>:open ~/</ex></p>
 383     </description>
 384 </item>
 385
 386 <item>
 387     <tags><![CDATA[<open-homepage> gh]]></tags>
 388     <spec>gh</spec>
 389     <description short="true">
 390         <p>Go home. Opens the homepage in the current tab.</p>
 391     </description>
 392 </item>
 393
 394 <item>
 395     <tags><![CDATA[<tab-open-homepage> gH]]></tags>
 396     <strut/>
 397     <spec>gH</spec>
 398     <description>
 399         <p>
 400             Go home in a new tab. Opens the homepage in a new tab.
 401             The new tab is activated if <o>activate</o> contains
 402             <str>homepage</str>.
 403         </p>
 404     </description>
 405 </item>
 406
 407 <item>
 408     <tags><![CDATA[<open-parent-path> gu]]></tags>
 409     <spec><oa>count</oa>gu</spec>
 410     <description short="true">
 411         <p>Go to <oa>count</oa>th parent directory.</p>
 412
 413         <p>
 414             For example, at the URL
 415             <tt>http://www.example.com/dir1/dir2/file.htm</tt>,
 416             2<k>gu</k> opens <tt>http://www.example.com/dir1/</tt>.
 417         </p>
 418     </description>
 419 </item>
 420
 421 <item>
 422     <tags><![CDATA[<open-root-path> gU]]></tags>
 423     <spec>gU</spec>
 424     <description short="true">
 425         <p>Go to the root of the web site.</p>
 426
 427         <p>
 428             For example, at the URL
 429             <tt>http://www.example.com/dir1/dir2/file.htm</tt>,
 430             <k>gU</k> opens <tt>http://www.example.com/</tt>.
 431         </p>
 432     </description>
 433 </item>
 434
 435 <h2 tag="reloading">Reloading</h2>
 436
 437 <item>
 438     <tags>&lt;reload> r</tags>
 439     <spec>r</spec>
 440     <description short="true">
 441         <p>Reload the current web page.</p>
 442     </description>
 443 </item>
 444
 445 <item>
 446     <tags>&lt;full-reload> R</tags>
 447     <spec>R</spec>
 448     <description short="true">
 449         <p>Reload the current web page without using the cache.</p>
 450     </description>
 451 </item>
 452
 453 <item>
 454     <tags>:re :reload</tags>
 455     <spec>:re<oa>load</oa><oa>!</oa></spec>
 456     <description>
 457         <p>
 458             Reload current web page. If <oa>!</oa> is given, reload
 459             without using the cache.
 460         </p>
 461     </description>
 462 </item>
 463
 464 <item>
 465     <tags>:reloada :reloadall</tags>
 466     <spec>:reloada<oa>ll</oa><oa>!</oa></spec>
 467     <description>
 468         <p>
 469             Reload all tabs. If <oa>!</oa> is given, reload without
 470             using the cache.
 471         </p>
 472     </description>
 473 </item>
 474
 475 <h2 tag="stopping">Stopping</h2>
 476
 477 <item>
 478     <tags><![CDATA[<stop-load> <C-c> :st :stop]]></tags>
 479     <spec>&lt;C-c></spec>
 480     <strut/>
 481     <spec>:st<oa>op</oa></spec>
 482     <description short="true">
 483         <p>Stop loading the current web page.</p>
 484     </description>
 485 </item>
 486
 487 <item>
 488     <tags>:stopa :stopall</tags>
 489     <spec>:stopa<oa>ll</oa></spec>
 490     <description short="true">
 491         <p>Stop loading all web pages.</p>
 492     </description>
 493 </item>
 494
 495 <h2 tag="writing save-file">Writing</h2>
 496
 497 <item>
 498     <tags>:w :write :sav :saveas</tags>
 499     <spec>:sav<oa>eas</oa><oa>!</oa> <oa>file</oa></spec>
 500     <description>
 501         <p>
 502             Save current web page to disk. If <oa>file</oa> is omitted, save to
 503             the page's default filename. If <oa>file</oa> is a directory or ends
 504             with your platform's path separator, save to the page's default
 505             filename in that directory. Existing documents will only be
 506             overwritten if <oa>!</oa> is given.
 507         </p>
 508     </description>
 509 </item>
 510
 511 <item>
 512     <spec>:write >> <a>file</a></spec>
 513     <description>
 514         <p>
 515             Appends the current web page to the file <a>file</a>. The given
 516             file must already exist.
 517         </p>
 518     </description>
 519 </item>
 520
 521 <item>
 522     <spec>:write !<a>cmd</a></spec>
 523     <description>
 524         <p>
 525             Writes the current web page to <a>cmd</a> and prints the command's
 526             output.
 527         </p>
 528     </description>
 529 </item>
 530
 531 <h2 tag="quitting save-session">Quitting</h2>
 532
 533 <item>
 534     <tags>ZQ :x :exit</tags>
 535     <strut/>
 536     <spec>:exit<oa>!</oa></spec>
 537     <description>
 538         <p>
 539             Quit &dactyl.appName;, no matter how many tabs/windows are open.
 540             The session is not stored. Use <oa>!</oa> to forcibly quit.
 541         </p>
 542     </description>
 543 </item>
 544
 545 <item>
 546     <tags>:q :quit</tags>
 547     <strut/>
 548     <spec>:q<oa>uit</oa></spec>
 549     <description>
 550         <p>
 551             Quit current tab. If this is the last tab in the window,
 552             close the window.
 553         </p>
 554     </description>
 555 </item>
 556
 557 <item>
 558     <tags>:qa :qall :quita :quitall</tags>
 559     <strut/>
 560     <spec>:quita<oa>ll</oa></spec>
 561     <description>
 562         <p>
 563             Close the current &dactyl.appName; window, no matter how
 564             many tabs are open.
 565         </p>
 566     </description>
 567 </item>
 568
 569 <item>
 570     <tags>:wc :wclose :winc :winclose</tags>
 571     <spec>:winc<oa>lose</oa></spec>
 572     <description short="true">
 573         <p>Close the current window.</p>
 574     </description>
 575 </item>
 576
 577 <item>
 578     <tags>:winon :winonly</tags>
 579     <spec>:winon<oa>ly</oa></spec>
 580     <description short="true">
 581         <p>Close all windows but the current.</p>
 582     </description>
 583 </item>
 584
 585 <item>
 586     <tags>ZZ :xa :xall :wq :wqa :wqall</tags>
 587     <spec>:wqa<oa>ll</oa></spec>
 588     <strut/>
 589     <spec>:xa<oa>ll</oa></spec>
 590     <description short="true">
 591         <p>Save the current session and quit.</p>
 592         <note>
 593             Unlike Vim, <ex>:wq</ex> closes the entire window rather
 594             than just the current tab.
 595         </note>
 596     </description>
 597 </item>
 598
 599 <h2 tag="current-directory">The current directory</h2>
 600
 601 <item>
 602     <tags>:chd :chdir :cd</tags>
 603     <strut/>
 604     <spec>:cd <oa>path</oa></spec>
 605     <description>
 606         <p>
 607             Change the current directory. If <oa>path</oa> is
 608             <em>-</em>, change to the previous directory. If it is
 609             omitted, change to the home directory.
 610         </p>
 611     </description>
 612 </item>
 613
 614 <item>
 615     <tags>:pw :pwd</tags>
 616     <spec>:pw<oa>d</oa></spec>
 617     <description short="true">
 618         <p>Print the current directory name.</p>
 619     </description>
 620 </item>
 621
 622 </document>
 623
 624 <!-- vim:se sts=4 sw=4 et: -->