common/locale/en-US/options.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://cache/options.dtd">
   5
   6 <document
   7     name="options"
   8     title="&dactyl.appName; Options"
   9     xmlns="&xmlns.dactyl;"
  10     xmlns:html="&xmlns.html;">
  11
  12 <h1 tag="options">Options</h1>
  13 <toc start="2"/>
  14
  15 <p>
  16     &dactyl.appName; has a number of internal variables and switches which can be set to
  17     achieve special effects. These options come in the following forms:
  18 </p>
  19
  20 <dl dt="width: 10em;">
  21     <dt/><dd tag="boolean"/>
  22     <dt>boolean</dt>
  23     <dd>
  24         Can only be <hl key="Boolean">on</hl> (<ex>:set <a>option</a></ex>) or
  25         <hl key="Boolean">off</hl> (<ex>:set no<a>option</a></ex>)
  26     </dd>
  27
  28     <dt>number</dt>        <dd>A numeric value</dd>
  29     <dt>string</dt>        <dd>A string value</dd>
  30
  31     <dt/><dd tag="charlist"/>
  32     <dt>charlist</dt>
  33     <dd>A string containing a discrete set of distinct characters</dd>
  34
  35     <dt/><dd tag="stringlist"/>
  36     <dt>stringlist</dt>
  37     <dd>
  38         A comma-separated list of strings. Any comma appearing within single
  39         or double quotes, or prefixed with a <tt>\</tt>, will not be treated
  40         as an item separator.
  41     </dd>
  42
  43     <dt/><dd tag="stringmap"/>
  44     <dt>stringmap</dt>
  45     <dd>A comma-separated list of key-value pairs, e.g., <str delim="">key:val,foo:bar</str></dd>
  46
  47     <dt/><dd tag="regexplist"/>
  48     <dt>regexplist</dt>
  49     <dd>
  50         A comma-separated list of regular expressions. Expressions may be
  51         prefixed with a <tt>!</tt>, in which case the match will be negated. A
  52         literal <tt>!</tt> at the beginning of the expression may be matched
  53         with <tt>[!]</tt> or by placing the regular expression in quotes.
  54         Generally, the first matching regular expression is used. Any comma
  55         appearing within single or double quotes, or prefixed with a
  56         <tt>\</tt>, will not be treated as an item separator.
  57     </dd>
  58
  59     <dt/><dd tag="regexpmap"/>
  60     <dt>regexpmap</dt>
  61     <dd>
  62         A combination of a <t>stringmap</t> and a <t>regexplist</t>. Each key
  63         in the <a>key</a>:<a>value</a> pair is a regexp. If the regexp begins with a
  64         <tt>!</tt>, the sense of the match is negated, such that a non-matching
  65         expression will be considered a match and <html:i>vice versa</html:i>.
  66         The first <a>key</a> to match yields value.
  67     </dd>
  68
  69     <dt>sitelist</dt> <dd tag="sitelist sitemap"/>
  70     <dt>sitemap</dt>
  71     <dd>
  72         Like <t>regexplist</t> and <t>regexpmap</t>, but the keys are
  73         <t>site-filters</t> rather than regular expressions.
  74     </dd>
  75 </dl>
  76
  77 <p tag="macro-string">
  78     Some options may be given format strings containing macro replacements in
  79     the form of <tt>&lt;<a>name</a>></tt>. These tokens are replaced by
  80     the parameter <a>name</a> as specified in the relevant documentation.
  81     If the token is in the form <tt>&lt;q-<a>name</a>></tt>, the value of the
  82     parameter is automatically <link topic="quoting">quoted</link>. If it is in
  83     the form of <tt>&lt;e-<a>name</a>></tt>, its value is never shown but may be
  84     used to test whether the given parameter is empty.
  85 </p>
  86 <p>
  87     Array elements, such as in the <tt>&lt;args></tt> parameter
  88     of <ex>:command</ex> macros, may be accessed by appending
  89     <tt>[<a>n</a>]</tt>, where <a>n</a> is the one-based array
  90     index, to the macro name. The first argument of a command is
  91     therefore accessed with <tt>&lt;args[1]&gt;</tt>.
  92 </p>
  93 <p>
  94     Any substring enclosed by <em><tt>&lt;{</tt></em> and <em><tt>}></tt></em>
  95     is automatically elided if any of the contained macros aren't currently
  96     valid. A literal <em><tt>&lt;</tt></em> or <em><tt>></tt></em> character may
  97     be included with the special escape sequences <tt>&lt;lt></tt> or
  98     <tt>&lt;gt></tt> respectively.
  99 </p>
 100
 101 <p style="text-align: left">
 102     For example, given the format string
 103     <str>&lt;{(cmd: &lt;column>) }>&lt;{line: &lt;line> }>&lt;file></str>,
 104     where <em>line</em>=<hl key="Number">32</hl> and
 105     <em>file</em>=<str delim="'">Lieder eines fahrenden Gesellen.txt</str>,
 106     the result is formatted as
 107     <str>line: 32 'Lieder eines fahrenden Gesellen.txt'</str>
 108 </p>
 109
 110 <h2 tag="set-option E764">Setting options</h2>
 111
 112 <item>
 113     <tags>:set :se</tags>
 114     <spec>:se<oa>t</oa></spec>
 115     <description short="true">
 116         <p>Show all options which differ from their default values.</p>
 117     </description>
 118 </item>
 119
 120 <item>
 121     <spec>:se<oa>t</oa> all</spec>
 122     <description short="true">
 123         <p>Show all options.</p>
 124     </description>
 125 </item>
 126
 127 <item>
 128     <tags>E518 E519</tags>
 129     <spec>:se<oa>t</oa> <a>option</a>?</spec>
 130     <description>
 131         <p>Show value of <a>option</a>.</p>
 132     </description>
 133 </item>
 134
 135 <item>
 136     <spec>:se<oa>t</oa> <a>option</a> <oa>...</oa></spec>
 137     <description>
 138         <p>
 139             For boolean options, turn them on. For all other types,
 140             show their values.
 141         </p>
 142     </description>
 143 </item>
 144
 145 <item>
 146     <spec>:se<oa>t</oa> no<a>option</a> <oa>...</oa></spec>
 147     <description>
 148         <p>
 149             For boolean options, turn them off. For all other types,
 150             display an error.
 151         </p>
 152     </description>
 153 </item>
 154
 155 <item>
 156     <spec>:se<oa>t</oa> <a>option</a>! <oa>...</oa></spec>
 157     <spec>:se<oa>t</oa> inv<a>option</a> <oa>...</oa></spec>
 158     <description>
 159         <p>
 160             For boolean options, invert their value. For all other types,
 161             display an error.
 162         </p>
 163     </description>
 164 </item>
 165
 166 <item>
 167     <tags>:set!=</tags>
 168     <spec>:se<oa>t</oa> inv<a>option</a>=<a>value</a> <oa>...</oa></spec>
 169     <spec>:se<oa>t</oa> <a>option</a>!=<a>value</a> <oa>...</oa></spec>
 170     <description>
 171         <p>For list options, toggle the specified values.</p>
 172
 173         <p style="text-align: left;">
 174             If the option is a list, the given values are toggled. Given,
 175             <se opt="opt" link="false"><str delim="">foo</str>,<str delim="">bar</str></se>
 176             then,
 177             <se opt="opt" op="!=" link="false"><str delim="">foo</str>,<str delim="">baz</str></se>
 178             has the same result as
 179             <se opt="opt" link="false"><str delim="">bar</str>,<str delim="">baz</str></se>
 180         </p>
 181
 182         <p>
 183             This extends to string options in a natural way, e.g.,
 184             <se opt="stal" op="!="><str delim="">always</str>,<str delim="">never</str></se>
 185             toggles between the two values.
 186         </p>
 187     </description>
 188 </item>
 189
 190 <item>
 191     <tags>:set-default</tags>
 192     <spec>:se<oa>t</oa> <a>option</a>&amp; <oa>...</oa></spec>
 193     <description>
 194         <p>Reset option to its default value.</p>
 195     </description>
 196 </item>
 197
 198 <item>
 199     <tags>:set-default-all</tags>
 200     <spec>:se<oa>t</oa> all&amp;</spec>
 201     <description>
 202         <p>Set all options to their default value.</p>
 203     </description>
 204 </item>
 205
 206 <item>
 207     <tags>:set-args E487 E521</tags>
 208     <spec>:se<oa>t</oa> <a>option</a>=<a>value</a> <oa>...</oa></spec>
 209     <description>
 210         <p>
 211             Set string or number option to <a>value</a>.
 212             For numeric options the value must be given in decimal.
 213             The old value can be inserted by typing <k name="Tab" mode="c"/>.
 214         </p>
 215     </description>
 216 </item>
 217
 218 <item>
 219     <tags>:set+=</tags>
 220     <spec>:se<oa>t</oa> <a>option</a>+=<a>value</a> <oa>...</oa></spec>
 221     <description>
 222         <p>
 223             Add the <a>value</a> to a number option, or append the <a>value</a>
 224             to a string option.  When the option is a comma separated list, a
 225             comma is added, unless the value was empty. If the option is a list
 226             of flags, superfluous flags are removed.  When adding a flag that
 227             was already present the option value doesn't change.
 228         </p>
 229     </description>
 230 </item>
 231
 232 <item>
 233     <tags>:set^=</tags>
 234     <spec>:se<oa>t</oa> <a>option</a>^=<a>value</a> <oa>...</oa></spec>
 235     <description>
 236         <p>
 237             Multiply the <a>value</a> to a number option, or prepend the
 238             <a>value</a> to a string option. When the option is a comma
 239             separated list, a comma is added, unless the value was empty.
 240         </p>
 241     </description>
 242 </item>
 243
 244 <item>
 245     <tags>:set-=</tags>
 246     <spec>:se<oa>t</oa> <a>option</a>-=<a>value</a> <oa>...</oa></spec>
 247     <description>
 248         <p>
 249             Subtract the <a>value</a> from a number option, or remove the
 250             <a>value</a> from a string option if it is there. If the
 251             <a>value</a> is not found in a string option, there is no error or
 252             warning. When the option is a comma separated list, a comma is
 253             deleted, unless the option becomes empty. When the option is a list
 254             of flags, <a>value</a> must be exactly as they appear in the option.
 255             Remove flags one by one to avoid problems.
 256         </p>
 257     </description>
 258 </item>
 259
 260 <item>
 261     <tags>:setlocal :setl</tags>
 262     <spec>:setl<oa>ocal</oa> …</spec>
 263     <description>
 264         <p>
 265             The same as <ex>:set</ex> command, but operates on current tab options
 266             only. See <ex>:set</ex> for details.
 267         </p>
 268     </description>
 269 </item>
 270
 271 <item>
 272     <tags>:setglobal :setg</tags>
 273     <spec>:setg<oa>lobal</oa> …</spec>
 274     <description>
 275         <p>
 276             The same as <ex>:set</ex> command, but operates on global options only.
 277             See <ex>:set</ex> for details.
 278         </p>
 279     </description>
 280 </item>
 281
 282 <p tag="expand-environment-var expand-env :set_env">
 283     Environment variables are expanded for path options like <o>cdpath</o> and
 284     <o>runtimepath</o>. The variable notation is <em>$VAR</em> (terminated by a non-word
 285     character) or <em>${VAR}</em>. <em>%VAR%</em> is also supported on Windows.
 286 </p>
 287
 288 <h2 tag="&dactyl.host;-options preferences">Setting &dactyl.host; options</h2>
 289
 290 <p>&dactyl.host; options can be viewed and set with the following commands:</p>
 291
 292 <item>
 293     <tags>:pref :prefs :preferences</tags>
 294     <spec>:pref<oa>erences</oa></spec>
 295     <description>
 296         <p>
 297             Show the &dactyl.host; preferences dialog. You can change the browser
 298             preferences from this dialog. Be aware that not all &dactyl.host;
 299             preferences work, because &dactyl.appName; overrides some key bindings and
 300             changes &dactyl.host;'s GUI.
 301         </p>
 302     </description>
 303 </item>
 304
 305 <item>
 306     <tags>:pref! :prefs! :preferences!</tags>
 307     <spec>:pref<oa>erences</oa>!</spec>
 308     <description>
 309         <p>
 310             Opens about:config in the current tab, where you can change advanced &dactyl.host;
 311             preferences.
 312         </p>
 313     </description>
 314 </item>
 315
 316 <item>
 317     <tags>:set! :set-!</tags>
 318     <spec>:se<oa>t</oa>! …</spec>
 319     <description>
 320         <p>
 321             The same as <ex>:set</ex> but operates on &dactyl.host; preferences
 322             (those on the about:config page). See <ex>:set</ex> for operator
 323             details.
 324         </p>
 325         <note>
 326             The <em>no</em> and <em>inv</em> prefix operators are not available
 327             for setting preferences.
 328         </note>
 329     </description>
 330 </item>
 331
 332 <p tag="overridden-preferences">
 333     &dactyl.appName; needs to set several &dactyl.host; preferences at
 334     startup in order to function properly. If this is unacceptable,
 335     they can be changed in your RC file with the <ex>:set!</ex>
 336     command, but beware of unexpected behavior. The affected
 337     preferences are:
 338 </p>
 339
 340 <ul>
 341     <li><pref>accessibility.typeaheadfind</pref></li>
 342 </ul>
 343
 344 <h2 tag="list-options">List of options</h2>
 345
 346 <item>
 347     <tags>'act' 'activate'</tags>
 348     <strut/>
 349     <spec>'activate' 'act'</spec>
 350     <type>&option.activate.type;</type>
 351     <default>addons,bookmarks,diverted,downloads,extoptions,
 352           help,homepage,quickmark,tabopen,paste</default>
 353     <description>
 354         <p>
 355             A list of items which, when opened in a new tab, are
 356             automatically focused. Available items:
 357         </p>
 358
 359         <dl>
 360             <dt>all</dt>           <dd>Activate all items.</dd>
 361             <dt>addons</dt>        <dd><ex>:addo<oa>ns</oa></ex> command</dd>
 362             <dt>bookmarks</dt>     <dd>Tabs loaded from bookmarks</dd>
 363             <dt>diverted</dt>      <dd>Links with targets set to new tabs</dd>
 364             <dt>downloads</dt>     <dd><ex>:downl<oa>oads</oa></ex> command</dd>
 365             <dt>extoptions</dt>    <dd><ex>:exto<oa>ptions</oa></ex> command</dd>
 366             <dt>help</dt>          <dd><ex>:h<oa>elp</oa></ex> command</dd>
 367             <dt>homepage</dt>      <dd><k>gH</k> mapping</dd>
 368             <dt>links</dt>         <dd>Middle- or Control-clicked links</dd>
 369             <dt>quickmark</dt>     <dd><k>go</k> and <k>gn</k> mappings</dd>
 370             <dt>tabopen</dt>       <dd><ex>:tabopen<oa>!</oa></ex> command</dd>
 371             <dt>paste</dt>         <dd><k>P</k> and <k>gP</k> mappings</dd>
 372         </dl>
 373     </description>
 374 </item>
 375
 376 <item>
 377     <tags>'awim' 'altwildmode'</tags>
 378     <spec>'altwildmode' 'awim'</spec>
 379     <type>&option.altwildmode.type;</type>
 380     <default>&option.altwildmode.default;</default>
 381     <description>
 382         <p>
 383             Like <o>wildmode</o>, but when the <k name="A-Tab" mode="c"/> key
 384             is pressed.
 385         </p>
 386     </description>
 387 </item>
 388
 389 <item>
 390     <tags>'au' 'autocomplete'</tags>
 391     <spec>'autocomplete' 'au'</spec>
 392     <type>&option.autocomplete.type;</type>
 393     <default>&option.autocomplete.default;</default>
 394     <description>
 395         <p>
 396             Enables automatic completion for completion contexts (see
 397             <ex>:contexts</ex>) matching the given regular expressions. When
 398             automatic completion is enabled, the completion list is
 399             automatically opened when the &tag.command-line; is focused.
 400             Thereafter, any key press triggers a completion update for the
 401             matching contexts. Non-matching contexts will only be updated when
 402             the <k name="Tab" mode="c"/> key is pressed. This option is useful
 403             for disabling auto-completion for computationally intensive
 404             contexts that don't perform well when your system is under load.
 405         </p>
 406
 407         <note>
 408             Completion contexts have names very much like Unix path names.
 409             These denote the tree in which they're called. A completer will
 410             never be called unless every completer preceding it in the tree
 411             was also called. For example, if your completer excludes
 412             <str>/ex/</str>, it will also exclude <str>/ex/bmarks</str>, and
 413             so on.
 414         </note>
 415
 416         <example>
 417             To enable auto-completion for everything but <ex>:history</ex> or
 418             <ex>:bmarks</ex>, you would choose a value such as
 419             <str delim="">!/ex/(bmarks|history),.?</str>
 420         </example>
 421
 422         <p>
 423             To go in the other direction, i.e. <em>only</em> enable
 424             auto-completion for those commands, you have to jump through
 425             some hoops, due to the way contexts work (see the note above):
 426             <str delim="">/ex/(bmarks|history),^(/|/ex/?)$</str>
 427         </p>
 428     </description>
 429 </item>
 430
 431 <item>
 432     <tags>'bh' 'banghist'</tags>
 433     <spec>'banghist' 'bh'</spec>
 434     <type>&option.banghist.type;</type>
 435     <default>&option.banghist.default;</default>
 436     <description>
 437         <p>
 438             Replace occurrences of ! with the previous command when
 439             executing external commands.
 440         </p>
 441     </description>
 442 </item>
 443
 444 <item>
 445     <tags>$CDPATH</tags>
 446     <tags>'cd' 'cdpath'</tags>
 447     <spec>'cdpath' 'cd'</spec>
 448     <type>&option.cdpath.type;</type>
 449     <default type="plain">equivalent to <str>.</str> or <str>.,$CDPATH</str></default>
 450     <description>
 451         <p>
 452             List of directories searched when executing the <ex>:cd</ex>
 453             command. This is only used for relative paths; if an absolute path is
 454             specified, this option is ignored.
 455         </p>
 456         <p>
 457             If the <em>CDPATH</em> environment variable is set this path list
 458             is appended to the default value of <str>.</str>.
 459         </p>
 460     </description>
 461 </item>
 462
 463 <item>
 464     <tags>'ca' 'cookieaccept'</tags>
 465     <spec>'cookieaccept' 'ca'</spec>
 466     <type>&option.cookieaccept.type;</type>
 467     <default>&option.cookieaccept.default;</default>
 468     <description>
 469         <p>When to accept cookies.</p>
 470
 471         <dl>
 472             <dt>all</dt>      <dd>Accept all cookies</dd>
 473             <dt>none</dt>     <dd>Accept no cookies</dd>
 474             <dt>samesite</dt> <dd>Accept all non-third-party cookies</dd>
 475         </dl>
 476     </description>
 477 </item>
 478
 479 <item>
 480     <tags>'cl' 'cookielifetime'</tags>
 481     <spec>'cookielifetime' 'cl'</spec>
 482     <type>&option.cookielifetime.type;</type>
 483     <default>&option.cookielifetime.default;</default>
 484     <description>
 485         <p>
 486             The lifetime for which to accept cookies. The available
 487             options are:
 488         </p>
 489         <dl>
 490             <dt>default</dt>     <dd>The lifetime requested by the setter</dd>
 491             <dt>prompt</dt>      <dd>Always prompt for a lifetime</dd>
 492             <dt>session</dt>     <dd>The current session</dd>
 493             <dt><a>days</a></dt> <dd>When a number is given, it is
 494                 interpreted as the number of days for which to keep
 495                 cookies</dd>
 496         </dl>
 497     </description>
 498 </item>
 499
 500 <item>
 501     <tags>'ck' 'cookies'</tags>
 502     <spec>'cookies' 'ck'</spec>
 503     <type>&option.cookies.type;</type>
 504     <default>&option.cookies.default;</default>
 505     <description>
 506         <p>The default action for the <ex>:cookies</ex> command.</p>
 507     </description>
 508 </item>
 509
 510 <item>
 511     <tags>'cpt' 'complete'</tags>
 512     <spec>'complete' 'cpt'</spec>
 513     <type>&option.complete.type;</type>
 514     <default>&option.complete.default;</default>
 515     <description>
 516         <p>Items which are completed at the <ex>:open</ex> prompts. Available items:</p>
 517
 518         <dl dt="width: 6.5em;">
 519             <dt>search</dt> <dd>Search engines and keyword URLs</dd>
 520             <dt>file</dt> <dd>Local files</dd>
 521             <dt>location</dt> <dd>&dactyl.host; location bar entries (bookmarks and history sorted in an intelligent way)</dd>
 522             <dt>bookmark</dt> <dd>Bookmarks</dd>
 523             <dt>history</dt> <dd>History</dd>
 524             <dt>suggestion</dt> <dd>Search engine suggestions</dd>
 525         </dl>
 526
 527         <p>
 528             Additionally, native search providers can be added by prefixing
 529             their names with the string <str delim="'">native:</str>. These
 530             providers are often added by other add-ons and are occasionally
 531             useful.
 532         </p>
 533
 534         <p>
 535             The order is important, such that <se opt="complete"><str delim="">bsf</str></se> will
 536             list bookmarks followed by matching quick searches and then
 537             matching files.
 538         </p>
 539
 540         <note>
 541             For backward compatibility, this option currently accepts a single
 542             entry containing single-letter names for completers. This usage
 543             is deprecated and will be removed in the future.
 544         </note>
 545
 546         <warning>
 547             Using <em>bookmark</em> and <em>history</em> can make completion very slow if
 548             there are many items.
 549         </warning>
 550     </description>
 551 </item>
 552
 553 <item>
 554     <tags>'ds' 'defsearch'</tags>
 555     <spec>'defsearch' 'ds'</spec>
 556     <type>&option.defsearch.type;</type>
 557     <default>&option.defsearch.default;</default>
 558     <description>
 559         <p>
 560             Sets the default search engine. The default search engine is
 561             used by <ex>:open</ex> and related commands for arguments which
 562             include no search or bookmark keywords and can't otherwise be
 563             converted into URLs or existing file names.
 564         </p>
 565
 566         <p>
 567             This means that with <o>defsearch</o> set to <str>youtube</str>,
 568             <ex>:open Tim Minchin</ex> behaves exactly as
 569             <ex>:open youtube Tim Minchin</ex>, so long as you don't have a
 570             search or bookmark keyword called ‘Tim’.
 571         </p>
 572     </description>
 573 </item>
 574
 575 <item>
 576     <tags>'dls' 'dlsort' 'downloadsort'</tags>
 577     <spec>'downloadsort' 'dlsort' 'dls'</spec>
 578     <strut/>
 579     <type>&option.downloadsort.type;</type>
 580     <default>&option.downloadsort.default;</default>
 581     <description>
 582         <p>
 583             <ex>:downloads</ex> sort order, in order of precedence.
 584             Each element must be preceded by a <tt>+</tt> or
 585             <tt>-</tt>, indicating ascending or descending sorting,
 586             respectively. Valid sort orders are:
 587         </p>
 588
 589         <dl>
 590             <dt>active</dt>   <dd>Whether download is active</dd>
 591             <dt>complete</dt> <dd>Percent complete</dd>
 592             <dt>date</dt>     <dd>Date and time the download began</dd>
 593             <dt>filename</dt> <dd>Target filename</dd>
 594             <dt>size</dt>     <dd>File size</dd>
 595             <dt>speed</dt>    <dd>Download speed</dd>
 596             <dt>time</dt>     <dd>Time remaining</dd>
 597             <dt>url</dt>      <dd>Source URL</dd>
 598         </dl>
 599     </description>
 600 </item>
 601
 602 <item>
 603     <tags>'editor'</tags>
 604     <spec>'editor'</spec>
 605     <type>&option.editor.type;</type>
 606     <default>&option.editor.default;</default>
 607     <description>
 608         <p>
 609             Set the external text editor.
 610             This is the editor used by <k name="C-i" mode="I"/>, <k>gF</k>, and
 611             other commands which launch an external text editor.
 612         </p>
 613
 614         <p>
 615             Accepts a <t>macro-string</t> with the following escapes available.
 616             Arguments containing escapes which are not relevant to a given call
 617             are automatically elided. All field splitting is done before format
 618             characters are processed.
 619         </p>
 620
 621         <dl>
 622             <dt>&lt;file></dt>   <dd>The file to edit. Appended as the final argument if missing.</dd>
 623             <dt>&lt;line></dt>   <dd>The line number at which to position the cursor.</dd>
 624             <dt>&lt;column></dt> <dd>The column at which to position the cursor.</dd>
 625         </dl>
 626
 627         <warning>
 628             &dactyl.appName; will not behave correctly if the editor forks its
 629             own process rather than blocking until editing is complete. Gvim
 630             invoked without the <em>-f</em> option is one such example.
 631         </warning>
 632     </description>
 633 </item>
 634
 635 <item>
 636     <tags>'enc' 'encoding'</tags>
 637     <spec>'encoding' 'enc'</spec>
 638     <type>&option.encoding.type;</type>
 639     <default>&option.encoding.default;</default>
 640     <description>
 641         <p>
 642             Changes the character encoding of the current buffer. Valid only
 643             until a new page is loaded.
 644         </p>
 645     </description>
 646 </item>
 647
 648 <item>
 649     <tags>'noeb' 'noerrorbells'</tags>
 650     <tags>'eb' 'errorbells'</tags>
 651     <spec>'errorbells' 'eb'</spec>
 652     <type>&option.errorbells.type;</type>
 653     <default>&option.errorbells.default;</default>
 654     <description>
 655         <p>
 656             Ring the bell when an error message is displayed. See also
 657             <o>visualbell</o>.
 658         </p>
 659     </description>
 660 </item>
 661
 662 <item>
 663     <tags>'ei' 'eventignore'</tags>
 664     <spec>'eventignore' 'ei'</spec>
 665     <type>&option.eventignore.type;</type>
 666     <default>&option.eventignore.default;</default>
 667     <description>
 668         <p>
 669             A list of autocommand event names which should be ignored. If the
 670             list contains the value <str>all</str> then all events are
 671             ignored.
 672         </p>
 673     </description>
 674 </item>
 675
 676 <item>
 677     <tags>'noex' 'noexrc'</tags>
 678     <tags>'ex' 'exrc'</tags>
 679     <spec>'exrc' 'ex'</spec>
 680     <type>&option.exrc.type;</type>
 681     <default>&option.exrc.default;</default>
 682     <description>
 683         <p>
 684             Allow reading of an RC file in the current directory. This file is
 685             sourced after the default <tt><t>&dactyl.name;rc</t></tt> file in your
 686             home directory.
 687         </p>
 688     </description>
 689 </item>
 690
 691 <item>
 692     <tags>'eht' 'extendedhinttags'</tags>
 693     <spec>'extendedhinttags' 'eht'</spec>
 694     <strut/>
 695     <type>&option.extendedhinttags.type;</type>
 696     <default>[asOTvVWy]:':-moz-any-link',area[href],img[src],iframe[src],
 697           [A]:[id],a[name],
 698           [f]:body,
 699           [F]:body,code,div,html,p,pre,span,
 700           [iI]:img,
 701           [S]:button,'input:not([type=hidden])',select,textarea</default>
 702     <description>
 703         <p>
 704             Defines specialized CSS selectors or XPath expressions for arbitrary
 705             <t>extended-hints</t> modes. The syntax is the same as for
 706             <o>hinttags</o>. If no matches are found, the value of
 707             <o>hinttags</o> is used.
 708         </p>
 709     </description>
 710 </item>
 711
 712 <item>
 713     <tags>'fenc' 'fileencoding'</tags>
 714     <spec>'fileencoding' 'fenc'</spec>
 715     <type>&option.fileencoding.type;</type>
 716     <default>&option.fileencoding.default;</default>
 717     <description>
 718         <p>
 719             Changes the character encoding that &dactyl.appName; uses to read
 720             and write files.
 721         </p>
 722     </description>
 723 </item>
 724
 725 <item>
 726     <tags>'fc' 'findcase'</tags>
 727     <spec>'findcase' 'fc'</spec>
 728     <type>&option.findcase.type;</type>
 729     <default>&option.findcase.default;</default>
 730     <description>
 731         <p>Find case matching mode.</p>
 732
 733         <dl>
 734             <dt>ignore</dt> <dd>Case is never significant</dd>
 735             <dt>match</dt> <dd>Case is always significant</dd>
 736             <dt>smart</dt> <dd>Case is significant when capital letters are typed</dd>
 737         </dl>
 738     </description>
 739 </item>
 740
 741 <item>
 742     <tags>'ff' 'findflags'</tags>
 743     <spec>'findflags' 'ff'</spec>
 744     <type>&option.findflags.type;</type>
 745     <default>&option.findflags.default;</default>
 746     <description>
 747         <p>Default flags for find invocations.</p>
 748
 749         <dl>
 750             <dt>C</dt> <dd>Match case</dd>
 751             <dt>L</dt> <dd>Search all text</dd>
 752             <dt>R</dt> <dd>Perform a plain string search</dd>
 753             <dt>c</dt> <dd>Ignore case</dd>
 754             <dt>l</dt> <dd>Search only in links</dd>
 755             <dt>r</dt> <dd>Perform a regular expression search</dd>
 756         </dl>
 757     </description>
 758 </item>
 759
 760 <item>
 761     <tags>'fh' 'followhints'</tags>
 762     <spec>'followhints' 'fh'</spec>
 763     <type>&option.followhints.type;</type>
 764     <default>&option.followhints.default;</default>
 765     <description>
 766         <p>
 767             Define the conditions under which hints selected by typing the link
 768             substring are followed. Hints selected by typing their label (as
 769             specified by <o>hintkeys</o>) are always followed immediately.
 770         </p>
 771
 772         <p>Possible values:</p>
 773
 774         <dl dt="width: 6em;">
 775             <dt>0</dt>      <dd>Follow the first hint as soon as typed text uniquely identifies it.</dd>
 776             <dt>1</dt>      <dd>Follow the selected hint on <k name="CR" link="false"/>.</dd>
 777         </dl>
 778     </description>
 779 </item>
 780
 781 <item>
 782     <tags>'nofs' 'nofullscreen'</tags>
 783     <tags>'fs' 'fullscreen'</tags>
 784     <spec>'fullscreen' 'fs'</spec>
 785     <type>&option.fullscreen.type;</type>
 786     <default>&option.fullscreen.default;</default>
 787     <description>
 788         <p>
 789             Show the current window full-screen. Also hide certain GUI elements, such as
 790             <t>status-line</t> and tab bar.
 791         </p>
 792     </description>
 793 </item>
 794
 795 <item>
 796     <tags>'go' 'guioptions'</tags>
 797     <spec>'guioptions' 'go'</spec>
 798     <type>&option.guioptions.type;</type>
 799     <default>&option.guioptions.default;</default>
 800     <description>
 801         <p>Show or hide certain GUI elements.</p>
 802
 803         <p>Supported characters:</p>
 804
 805         <dl dt="width: 6em;">
 806             <dt>B</dt>      <dd>Bookmark bar</dd>
 807             <dt>C</dt>      <dd>Always show the command line outside of the status line</dd>
 808             <dt>M</dt>      <dd>Always show messages outside of the status line</dd>
 809             <dt>N</dt>      <dd>Tab number over image</dd>
 810             <dt>T</dt>      <dd>Toolbar</dd>
 811             <dt>b</dt>      <dd>Bottom scrollbar</dd>
 812             <dt>c</dt>      <dd>Always show the command line, even when empty</dd>
 813             <dt>l</dt>      <dd>Left scrollbar (<em>l</em> and <em>r</em> are mutually exclusive)</dd>
 814             <dt>m</dt>      <dd>Menu bar</dd>
 815             <dt>n</dt>      <dd>Tab number</dd>
 816             <dt>r</dt>      <dd>Right scrollbar</dd>
 817             <dt>s</dt>      <dd>Status bar</dd>
 818         </dl>
 819
 820         <p>See also <o>showtabline</o>.</p>
 821
 822         <note>Scrollbar changes require a page reload to take effect.</note>
 823         <note>Only one of <em>l</em> or <em>r</em> may be included.</note>
 824     </description>
 825 </item>
 826
 827 <item>
 828     <tags>'hf' 'helpfile'</tags>
 829     <spec>'helpfile' 'hf'</spec>
 830     <type>&option.helpfile.type;</type>
 831     <default>&option.helpfile.default;</default>
 832     <description>
 833         <p>
 834             Name of the main help file. This is that page shown if the
 835             <ex>:help</ex> command is called without any arguments.
 836         </p>
 837     </description>
 838 </item>
 839
 840 <item>
 841     <tags>'hin' 'hintinputs'</tags>
 842     <spec>'hintinputs' 'hin'</spec>
 843     <type>&option.hintinputs.type;</type>
 844     <default>&option.hintinputs.default;</default>
 845     <description>
 846         <p>
 847             When generating hints for input elements that do not have an
 848             explicit caption, this specifies the methods used to generate a
 849             textual hint. The options are attempted in the order they are
 850             given, and the first successful value is used.
 851         </p>
 852
 853         <dl dt="width: 8em;">
 854             <dt>value</dt>      <dd>The hint is the value displayed in a text input, or the selected option for a drop-down.</dd>
 855             <dt>label</dt>      <dd>The value of an explicit label for the input; this will not match most manually added labels that are found on sites.</dd>
 856             <dt>name </dt>      <dd>The name of the input will be used; although the name is not designed for user consumption, it is frequently very similar to the label.</dd>
 857         </dl>
 858     </description>
 859 </item>
 860
 861 <item>
 862     <tags>'hk' 'hintkeys'</tags>
 863     <spec>'hintkeys' 'hk'</spec>
 864     <type>&option.hintkeys.type;</type>
 865     <default>&option.hintkeys.default;</default>
 866     <description>
 867         <p>
 868             The keys used to label and select hints. With its default value,
 869             each hint has a unique number which can be typed to select it,
 870             while all other characters are used to filter hints based on their
 871             text. With a value such as <str>asdfg;lkjh</str>, each hint is
 872             ‘numbered’ based on the characters of the home row.
 873         </p>
 874     </description>
 875 </item>
 876
 877 <item>
 878     <tags>'hm' 'hintmatching'</tags>
 879     <spec>'hintmatching' 'hm'</spec>
 880     <type>&option.hintmatching.type;</type>
 881     <default>&option.hintmatching.default;</default>
 882     <description>
 883         <p>Change the hint matching algorithm used in Hints mode.</p>
 884
 885         <p>Possible values:</p>
 886
 887         <dl>
 888             <dt>contains</dt>
 889             <dd>
 890                 The typed characters are split on whitespace, and
 891                 these character groups have to match anywhere inside
 892                 the text of the link.
 893             </dd>
 894             <dt>wordstartswith</dt>
 895             <dd>
 896                 The typed characters are matched with the beginning
 897                 of the first word (see <o>wordseparators</o>) in the
 898                 link as long as possible. If no matches occur in the
 899                 current word, then the matching is continued at the
 900                 beginning of the next word. The words are worked
 901                 through in the order they appear in the link. If the
 902                 typed characters contain spaces, then the characters
 903                 are split on whitespace. These character groups are
 904                 then matched with the beginning of the words,
 905                 beginning at the first one and continuing with the
 906                 following words in the order they appear in the
 907                 link.
 908             </dd>
 909             <dt>firstletters</dt>
 910             <dd>
 911                 Behaves like wordstartswith, but non-matching words
 912                 aren't skipped.
 913             </dd>
 914             <dt>custom</dt>
 915             <dd>
 916                 Delegate to the function
 917                 <tt>dactyl.plugins.customHintMatcher</tt>.
 918             </dd>
 919             <dt>transliterated</dt>
 920             <dd>
 921                 Certain alphanumeric characters are transliterated into their
 922                 unaccented equivalents, such that ‘euro’ will match 'æuró',
 923                 and ‘Ångström’ will match ‘angstrom’.
 924             </dd>
 925         </dl>
 926     </description>
 927 </item>
 928
 929 <item>
 930     <tags>'ht' 'hinttags'</tags>
 931     <strut/>
 932     <spec>'hinttags' 'ht'</spec>
 933     <type>&option.hinttags.type;</type>
 934     <default>:-moz-any-link,area,button,iframe,input:not([type=hidden]),select,textarea,
 935           [onclick],[onmouseover],[onmousedown],[onmouseup],[oncommand],
 936           [tabindex],[role=link],[role=button],[contenteditable=true]</default>
 937     <description>
 938         <p>
 939             A list of CSS selectors or XPath expressions used to select elements
 940             for <link topic="hints">hinting</link>. Values beginning with the
 941             string <str>xpath:</str> are treated as XPath expressions, while any
 942             other values are treated as CSS selectors. Can be overridden for
 943             individual <t>extended-hints</t> modes with the
 944             <o>extendedhinttags</o> option.
 945         </p>
 946     </description>
 947 </item>
 948
 949 <item>
 950     <tags>'hto' 'hinttimeout'</tags>
 951     <spec>'hinttimeout' 'hto'</spec>
 952     <type>&option.hinttimeout.type;</type>
 953     <default>&option.hinttimeout.default;</default>
 954     <description>
 955         <p>
 956             Timeout in milliseconds before automatically following a non-unique
 957             hint. The timeout is measured since the last time a key listed in
 958             <o>hintkeys</o> was pressed. It has no effect when narrowing hints
 959             by typing part of their text. Set to 0 (the default) to only follow
 960             hints after pressing <k name="CR" link="false"/> or when the hint is unique.
 961         </p>
 962     </description>
 963 </item>
 964
 965 <item>
 966     <tags>'hi' 'history'</tags>
 967     <spec>'history' 'hi'</spec>
 968     <type>&option.history.type;</type>
 969     <default>&option.history.default;</default>
 970     <description>
 971         <p>
 972             Maximum number of Ex commands and find patterns to store in the
 973             <t>command-line</t> history.
 974         </p>
 975     </description>
 976 </item>
 977
 978 <item>
 979     <tags>'nohlf' 'nohlfind'</tags>
 980     <tags>'hlf' 'hlfind'</tags>
 981     <spec>'hlfind' 'hlf'</spec>
 982     <type>&option.hlfind.type;</type>
 983     <default>&option.hlfind.default;</default>
 984     <description>
 985         <p>Highlight previous find pattern matches.</p>
 986     </description>
 987 </item>
 988
 989 <item>
 990     <tags>'noif' 'noincfind'</tags>
 991     <tags>'if' 'incfind'</tags>
 992     <spec>'incfind' 'if'</spec>
 993     <type>&option.incfind.type;</type>
 994     <default>&option.incfind.default;</default>
 995     <description>
 996         <p>Show the first match for a find pattern as it is typed.</p>
 997     </description>
 998 </item>
 999
1000 <item>
1001     <tags>'noim' 'noinsertmode'</tags>
1002     <tags>'im' 'insertmode'</tags>
1003     <spec>'insertmode' 'im'</spec>
1004     <type>&option.insertmode.type;</type>
1005     <default>&option.insertmode.default;</default>
1006     <description>
1007         <p>
1008             Use Insert mode as the default for text areas. This is useful if you
1009             want to use the known &dactyl.host; interface for editing text areas.
1010             Input fields default to this behavior irrespective of this option's
1011             setting.
1012         </p>
1013
1014         <p>
1015             Text Edit mode can be entered with <k name="C-t" mode="I"/> from Insert mode.
1016         </p>
1017     </description>
1018 </item>
1019
1020 <item>
1021     <tags>'isk' 'iskeyword'</tags>
1022     <spec>'iskeyword' 'isk'</spec>
1023     <type>&option.iskeyword.type;</type>
1024     <default>&option.iskeyword.default;</default>
1025     <description>
1026         <p>Regular expression defining which characters constitute words.</p>
1027     </description>
1028 </item>
1029
1030 <item>
1031     <tags>'nojsd' 'nojsdebugger'</tags>
1032     <tags>'jsd' 'jsdebugger'</tags>
1033     <spec>'jsdebugger' 'jsd'</spec>
1034     <type>&option.jsdebugger.type;</type>
1035     <default>&option.jsdebugger.default;</default>
1036     <description>
1037         <p>
1038             Use the JavaScript debugger service for JavaScript completion.
1039         </p>
1040     </description>
1041 </item>
1042
1043 <item>
1044     <tags>'jt' 'jumptags'</tags>
1045     <spec>'jumptags' 'jt'</spec>
1046     <type>&option.jumptags.type;</type>
1047     <default>&option.jumptags.default;</default>
1048     <description>
1049         <p>XPath or CSS selector strings of jumpable elements for extended hint modes.</p>
1050     </description>
1051 </item>
1052
1053 <item>
1054     <tags>'ln' 'linenumbers'</tags>
1055     <spec>'linenumbers' 'ln'</spec>
1056     <type>&option.linenumbers.type;</type>
1057     <default><![CDATA['view-source:*':[id^=line],
1058           code.google.com:'#nums [id^="nums_table"] a[href^="#"]',
1059           github.com:.line_numbers>*,
1060           mxr.mozilla.org:a.l,
1061           pastebin.com:#code_frame>div>ol>li,
1062           addons.mozilla.org:.gutter>.line>a,
1063           bugzilla.mozilla.org:.bz_comment:not(.bz_first_comment):not(.ih_history),
1064           *:'/* Hgweb/Gitweb */ .completecodeline a.codeline, a.linenr']]></default>
1065     <description>
1066         <p>
1067             Patterns used to determine line numbers used by <k>G</k>. May be
1068             either a selector expression as accepted by <o>hinttags</o>, or the
1069             string <str delim="'">func:</str> followed by a JavaScript
1070             expression which evaluates to a function. In the former case, the
1071             first matching element whose text content is equal to the desired
1072             line number is used. If no such element exists, the <oa>count</oa>th
1073             matching element is used. In the latter case, the provided function
1074             must accept two arguments, the document in question and the desired
1075             line number, and must return the element corresponding to the given
1076             line.
1077         </p>
1078     </description>
1079 </item>
1080
1081
1082 <item>
1083     <tags>'lpl' 'loadplugins'</tags>
1084     <spec>'loadplugins' 'lpl'</spec>
1085     <type>&option.loadplugins.type;</type>
1086     <default>&option.loadplugins.default;</default>
1087     <description>
1088         <p>
1089             A regular expression list that defines which plugins are loaded at
1090             startup or via <ex>:loadplugins</ex>. The first item to match is
1091             the one that takes effect. If no items match, the file is not
1092             loaded. Setting this to a blank value effectively disables plugin
1093             loading.
1094         </p>
1095         <p>
1096             For example, to prepend to the default value of this option to load
1097             all plugins except for <em>foobar-plugin</em>, you could use:
1098         </p>
1099         <set opt="loadplugins" op="^=">!<str delim="'">foobar-plugin</str></set>
1100         <p>
1101             Alternatively, you can specify which plugins to load and which to
1102             omit in your <tt><t>&dactyl.name;rc</t></tt> using something like
1103             the following:
1104         </p>
1105         <set opt="loadplugins">!<str delim="'">foo|bar</str>,<str delim="'">\.(js|&dactyl.fileExt;)$</str></set>
1106         <p>
1107             That will load all plugins but <em>foo</em> and <em>bar</em>.
1108         </p>
1109         <p>
1110             Note that in the first expression of the latter example you don't
1111             need parentheses, as the <em>!</em> negates the whole of the
1112             following expression (cf. <t>regexplist</t>).
1113         </p>
1114         <p>
1115             See also <ex>:runtime</ex>.
1116         </p>
1117     </description>
1118 </item>
1119
1120 <item>
1121     <tags>'maxitems'</tags>
1122     <spec>'maxitems'</spec>
1123     <type>&option.maxitems.type;</type>
1124     <default>&option.maxitems.default;</default>
1125     <description>
1126         <p>Maximum number of items to display at once in a listing.</p>
1127     </description>
1128 </item>
1129
1130 <item>
1131     <tags>'msgs' 'messages'</tags>
1132     <spec>'messages' 'msgs'</spec>
1133     <type>&option.messages.type;</type>
1134     <default>&option.messages.default;</default>
1135     <description>
1136         <p>Maximum number of messages to store in the message history.</p>
1137     </description>
1138 </item>
1139
1140 <item>
1141     <tags>'nomore' 'more'</tags>
1142     <spec>'more'</spec>
1143     <type>&option.more.type;</type>
1144     <default>&option.more.default;</default>
1145     <description>
1146         <p>
1147             Pause the message list window when more than one screen of
1148             listings is displayed.
1149         </p>
1150     </description>
1151 </item>
1152
1153 <item>
1154     <tags>'newtab'</tags>
1155     <spec>'newtab'</spec>
1156     <type>&option.newtab.type;</type>
1157     <default>&option.newtab.default;</default>
1158     <description>
1159         <p>
1160             Defines which Ex commands open pages in new tabs rather than the
1161             current tab by default. This may be overridden with the
1162             <ex>:tab</ex> command, and is usually inverted by affixing a
1163             <em>!</em> to the command in question.
1164         </p>
1165
1166         <p>Possible values:</p>
1167
1168         <dl>
1169             <dt>all</dt>            <dd>All commands</dd>
1170             <dt>addons</dt>         <dd><ex>:addo<oa>ns</oa></ex> command</dd>
1171             <dt>downloads</dt>      <dd><ex>:downl<oa>oads</oa></ex> command</dd>
1172             <dt>extoptions</dt>     <dd><ex>:exto<oa>ptions</oa></ex> command</dd>
1173             <dt>help</dt>           <dd><ex>:h<oa>elp</oa></ex> command</dd>
1174             <dt>javascript</dt>     <dd><ex>:javascript!</ex> or <ex>:js!</ex> command</dd>
1175             <dt>prefs</dt>          <dd><ex>:pref<oa>erences</oa>!</ex> or <ex>:prefs!</ex> command</dd>
1176         </dl>
1177
1178     </description>
1179 </item>
1180
1181 <item>
1182     <tags>'nextpattern'</tags>
1183     <strut/>
1184     <spec>'nextpattern'</spec>
1185     <type>&option.nextpattern.type;</type>
1186     <default>&option.nextpattern.default;</default>
1187     <description>
1188         <p>
1189             Patterns to use when guessing the next page in a document
1190             sequence after pressing the <k>]]</k> key. Each pattern is
1191             successively tested against each link in the page (as defined by
1192             <o>hinttags</o>, starting with the last), and the first link to
1193             match is followed.
1194         </p>
1195     </description>
1196 </item>
1197
1198 <item>
1199     <tags>'noonline' 'online'</tags>
1200     <spec>'online'</spec>
1201     <type>&option.online.type;</type>
1202     <default>&option.online.default;</default>
1203     <description>
1204         <p>
1205             Enables or disables ‘offline’ mode, where network access is
1206             disabled and all web pages are loaded entirely from cache.
1207         </p>
1208     </description>
1209 </item>
1210
1211 <item>
1212     <tags>'pa' 'pageinfo'</tags>
1213     <spec>'pageinfo' 'pa'</spec>
1214     <type>&option.pageinfo.type;</type>
1215     <default>&option.pageinfo.default;</default>
1216     <description>
1217         <p>Info shown in the <ex>:pageinfo</ex> output.</p>
1218
1219         <p>Items available by default:</p>
1220
1221         <dl dt="width: 6em;">
1222             <dt>g</dt>      <dd>General info</dd>
1223             <dt>e</dt>      <dd>Search Engines</dd>
1224             <dt>f</dt>      <dd>Feeds</dd>
1225             <dt>m</dt>      <dd>Meta tags</dd>
1226             <dt>s</dt>      <dd>Security information</dd>
1227         </dl>
1228
1229         <p>
1230             The order of the options defines the order in which they appear in
1231             the result.
1232         </p>
1233     </description>
1234 </item>
1235
1236 <item>
1237     <tags>'pk' 'passkeys'</tags>
1238     <spec>'passkeys' 'pk'</spec>
1239     <type>&option.passkeys.type;</type>
1240     <default>&option.passkeys.default;</default>
1241     <description>
1242         <p>
1243             Pass certain keys through directly for the given URLs.
1244             For any page with a URL matching a given <t>site-filter</t>, all key
1245             events for keys listed in the corresponding value are passed
1246             through directly to &dactyl.host;, and are not processed
1247             by &dactyl.appName; in any way. Key names are separated
1248             by commas, where the first key name is treated as a list
1249             of individual keys and each subsequent key is treated as
1250             a key chain. Individual key entries always apply to all
1251             modes. Key chains apply only to non-input modes unless
1252             they begin with a key requiring a modifier other than
1253             shift.
1254         </p>
1255
1256         <example><set opt="passkeys" op="+="><str delim="">mail.google.com</str>:<str delim="">jk&lt;CR></str>,<str delim="">gi</str></set></example>
1257
1258         <p>
1259             More subtle and complex pass through can be achieved
1260             using <t>groups</t> and mode-specific mappings utilizing
1261             the <k name="Pass"/> pseudo-key.
1262         </p>
1263     </description>
1264 </item>
1265
1266 <item>
1267     <tags>'pu' 'passunknown'</tags>
1268     <spec>'passunknown' 'pu'</spec>
1269     <type>&option.showmode.type;</type>
1270     <default>&option.showmode.default;</default>
1271     <description>
1272         <p>
1273             Pass unknown keys through to &dactyl.host; in these
1274             <t>modes</t>. The first element matching a currently
1275             active mode is the one that takes effect. Modes may be
1276             negated by prefixing them with a <tt>!</tt>.
1277         </p>
1278     </description>
1279 </item>
1280
1281 <item>
1282     <tags>'pps' 'popups'</tags>
1283     <spec>'popups' 'pps'</spec>
1284     <type>&option.popups.type;</type>
1285     <default>&option.popups.default;</default>
1286     <description>
1287         <p>
1288             Defines where to show requested pop-up windows. Applies only to
1289             links which request to open in a new window. The behavior of
1290             middle-, shift-, or control- clicking a link is unaffected by this
1291             option.
1292         </p>
1293
1294         <p>Possible values are:</p>
1295
1296         <dl dt="width: 8em;">
1297             <dt>tab</dt>            <dd>Open pop-ups in a new tab</dd>
1298             <dt>window</dt>         <dd>Open pop-ups in a new window</dd>
1299             <dt>resized</dt>        <dd>Open resized pop-ups in a new window</dd>
1300         </dl>
1301
1302         <p>
1303             If neither <em>tab</em> nor <em>window</em> is provided, all
1304             pop-ups open in the current tab. <em>tab</em> and <em>window</em>
1305             are mutually exclusive, and the last one listed is effective.
1306         </p>
1307
1308         <note>
1309             This option does not alter the &dactyl.host; pop-up blocker behavior
1310             in any way.
1311         </note>
1312     </description>
1313 </item>
1314
1315 <item>
1316     <tags>'previouspattern'</tags>
1317     <strut/>
1318     <spec>'previouspattern'</spec>
1319     <type>&option.previouspattern.type;</type>
1320     <default>&option.previouspattern.default;</default>
1321     <description>
1322         <p>
1323             Patterns to use when guessing the previous page in a document
1324             sequence after pressing the <k>[[</k> key. Each pattern is
1325             successively tested against each link in the page (as defined by
1326             <o>hinttags</o>, starting with the last), and the first link to
1327             match is followed.
1328         </p>
1329     </description>
1330 </item>
1331
1332 <item>
1333     <tags>'noprivate' 'private'</tags>
1334     <spec>'private'</spec>
1335     <type>&option.private.type;</type>
1336     <default>&option.private.default;</default>
1337     <description>
1338         <p>
1339             Set the <str>private browsing</str> option. In private browsing mode
1340             history, cache files, cookies, form data, passwords, download list
1341             entries, local and URL <t>marks</t>, <t>command-line</t> history
1342             and macros are available only for the duration of the private
1343             browsing session and deleted when returning to normal browsing
1344             mode. See also <t>privacy</t>.
1345         </p>
1346     </description>
1347 </item>
1348
1349 <item>
1350     <tags>$&dactyl.idName;_RUNTIME</tags>
1351     <tags>'rtp' 'runtimepath'</tags>
1352     <spec>'runtimepath' 'rtp'</spec>
1353     <type>&option.runtimepath.type;</type>
1354     <default type="plain"><str>$&dactyl.idName;_RUNTIME</str> or
1355        Unix, Mac: <str>~/.&dactyl.name;</str>
1356          Windows: <str>~/&dactyl.name;</str></default>
1357     <description>
1358         <p>List of directories searched for runtime files:</p>
1359
1360         <ul>
1361             <li>colors/</li>
1362             <li>plugins/</li>
1363         </ul>
1364
1365         <p>Example:</p>
1366
1367         <set opt="runtimepath"><str delim="">~/my&dactyl.name;</str>,<str delim="">~/.&dactyl.name;</str></set>
1368
1369         <p>
1370             This will search for plugins in both
1371             <str>~/my&dactyl.name;/plugins</str> and
1372             <str>~/.&dactyl.name;/plugins</str>
1373         </p>
1374
1375         <p>
1376             On startup, if the environment variable <em>$&dactyl.idName;_RUNTIME</em> does not
1377             exist, &dactyl.appName; will set it to match this value.
1378         </p>
1379     </description>
1380 </item>
1381
1382 <item>
1383     <tags>'si' 'sanitizeitems'</tags>
1384     <spec>'sanitizeitems' 'si'</spec>
1385     <strut/>
1386     <type>&option.sanitizeitems.type;</type>
1387     <default>&option.sanitizeitems.default;</default>
1388     <description>
1389         <p>
1390             The default list of private items to sanitize. See
1391             <ex>:sanitize</ex> for a list and explanation of possible values. A
1392             value of <str>all</str> will cause all items to be sanitized. Items
1393             may be excluded by prefixing them with a <tt>!</tt>. The first
1394             matching item takes precedence.
1395         </p>
1396     </description>
1397 </item>
1398
1399 <item>
1400     <tags>'ss' 'sanitizeshutdown'</tags>
1401     <spec>'sanitizeshutdown' 'ss'</spec>
1402     <type>&option.sanitizeshutdown.type;</type>
1403     <default>&option.sanitizeshutdown.default;</default>
1404     <description>
1405         <p>The items to sanitize automatically at shutdown.</p>
1406     </description>
1407 </item>
1408
1409 <item>
1410     <tags>'sts' 'sanitizetimespan'</tags>
1411     <spec>'sanitizetimespan' 'sts'</spec>
1412     <strut/>
1413     <type>&option.sanitizetimespan.type;</type>
1414     <default>&option.sanitizetimespan.default;</default>
1415     <description>
1416         <p>
1417             The default sanitizer time span. Only items created within this timespan are
1418             deleted. The value must be of the one of:
1419         </p>
1420
1421         <dl dt="width: 8em;">
1422             <dt>all</dt>       <dd>Everything</dd>
1423             <dt>session</dt>   <dd>The current session</dd>
1424             <dt><a>n</a>m</dt> <dd>Past <a>n</a> Minutes</dd>
1425             <dt><a>n</a>h</dt> <dd>Past <a>n</a> Hours</dd>
1426             <dt><a>n</a>d</dt> <dd>Past <a>n</a> Days</dd>
1427             <dt><a>n</a>w</dt> <dd>Past <a>n</a> Weeks</dd>
1428         </dl>
1429     </description>
1430 </item>
1431
1432 <item>
1433     <tags>'scr' 'scroll'</tags>
1434     <spec>'scroll' 'scr'</spec>
1435     <type>&option.scroll.type;</type>
1436     <default>&option.scroll.default;</default>
1437     <description>
1438         <p>
1439             Number of lines to scroll with <k name="C-u"/> and <k name="C-d"/>
1440             commands. The number of lines scrolled defaults to half the window
1441             size. When a <oa>count</oa> is specified to the <k name="C-u"/> or
1442             <k name="C-d"/> commands, set this option to <oa>count</oa> before
1443             executing the command. Setting this to <em>0</em> restores the
1444             default behaviour.
1445         </p>
1446     </description>
1447 </item>
1448
1449 <item>
1450     <tags>'scs' 'scrollsteps'</tags>
1451     <spec>'scrollsteps' 'scs'</spec>
1452     <type>&option.scrollsteps.type;</type>
1453     <default>&option.scrollsteps.default;</default>
1454     <description>
1455         <p>
1456             The number of steps in which to smooth scroll to a new position. If
1457             set to 1, smooth scrolling is not used.
1458         </p>
1459     </description>
1460 </item>
1461
1462 <item>
1463     <tags>'sct' 'scrolltime'</tags>
1464     <spec>'scrolltime' 'sct'</spec>
1465     <type>&option.scrolltime.type;</type>
1466     <default>&option.scrolltime.default;</default>
1467     <description>
1468         <p>The time, in milliseconds, in which to smooth scroll to a new position.</p>
1469     </description>
1470     </item>
1471
1472 <item>
1473     <tags>'sh' 'shell'</tags>
1474     <spec>'shell' 'sh'</spec>
1475     <type>&option.shell.type;</type>
1476     <default type="plain"><em>$SHELL</em> or <str>sh</str>, Windows: <str>cmd.exe</str></default>
1477     <description>
1478         <p>Shell to use for executing <ex>:!</ex> and <ex>:run</ex> commands.</p>
1479     </description>
1480 </item>
1481
1482 <item>
1483     <tags>'shcf' 'shellcmdflag'</tags>
1484     <spec>'shellcmdflag' 'shcf'</spec>
1485     <strut/>
1486     <type>&option.shellcmdflag.type;</type>
1487     <default type="plain"><str>-c</str>, Windows: <str>/c</str></default>
1488     <description>
1489         <p>Flag passed to shell when executing <ex>:!</ex> and <ex>:run</ex> commands.</p>
1490     </description>
1491 </item>
1492
1493 <item>
1494     <tags>'smd' 'showmode'</tags>
1495     <spec>'showmode' 'smd'</spec>
1496     <type>&option.showmode.type;</type>
1497     <default>&option.showmode.default;</default>
1498     <description>
1499         <p>
1500             Show the current mode in the command line if it or any
1501             of its parent <t>modes</t> is included in the list.
1502             Modes may be negated by prefixing them with a
1503             <tt>!</tt>.
1504         </p>
1505     </description>
1506 </item>
1507
1508 <item>
1509     <tags>'ssli' 'showstatuslinks'</tags>
1510     <spec>'showstatuslinks' 'ssli'</spec>
1511     <strut/>
1512     <type>&option.showstatuslinks.type;</type>
1513     <default>&option.showstatuslinks.default;</default>
1514     <description>
1515         <p>
1516             When the mouse hovers over a link, or a link is otherwise focused,
1517             show its destination in the status bar.
1518         </p>
1519
1520         <p>Possible values are:</p>
1521
1522         <dl>
1523             <dt></dt> <dd>Don't show link destination</dd>
1524             <dt>status</dt> <dd>Show the link destination in the &tag.status-line;</dd>
1525             <dt>command</dt> <dd>Show the link destination in the &tag.command-line;</dd>
1526         </dl>
1527     </description>
1528 </item>
1529
1530 <item>
1531     <tags>'stal' 'showtabline'</tags>
1532     <spec>'showtabline' 'stal'</spec>
1533     <type>&option.showtabline.type;</type>
1534     <default>&option.showtabline.default;</default>
1535     <description>
1536         <p>Define when the tab bar is visible.</p>
1537
1538         <dl>
1539             <dt>always</dt>   <dd>Always show the tab bar</dd>
1540             <dt>multitab</dt> <dd>Show the tab bar when there are multiple tabs</dd>
1541             <dt>never</dt>    <dd>Never show the tab bar</dd>
1542         </dl>
1543     </description>
1544 </item>
1545
1546 <item>
1547     <tags>'spl' 'spelllang'</tags>
1548     <spec>'spelllang' 'spl'</spec>
1549     <type>&option.spelllang.type;</type>
1550     <default>&option.spelllang.default;</default>
1551     <description short="true">
1552         <p>The language used by the spell checker.</p>
1553     </description>
1554 </item>
1555
1556 <item>
1557     <tags>'sf' 'strictfocus'</tags>
1558     <spec>'strictfocus' 'sf'</spec>
1559     <type>&option.strictfocus.type;</type>
1560     <default>&option.strictfocus.default;</default>
1561     <description>
1562         <p>
1563             Prevent scripts from focusing input elements without user intervention.
1564         </p>
1565
1566         <p>Possible values:</p>
1567
1568         <dl>
1569             <dt>despotic</dt>      <dd>Only allow focus changes when explicitly requested by the user</dd>
1570             <dt>laissez-faire</dt> <dd>Always allow focus changes</dd>
1571             <dt>moderate</dt>      <dd>Allow focus changes after user-initiated focus change</dd>
1572         </dl>
1573     </description>
1574 </item>
1575
1576 <item>
1577     <tags>'suggestengines'</tags>
1578     <spec>'suggestengines'</spec>
1579     <type>&option.suggestengines.type;</type>
1580     <default>&option.suggestengines.default;</default>
1581     <description>
1582         <p>
1583             Set the search engines which can be used for completion
1584             suggestions when <o>complete</o> contains <em>S</em>.
1585         </p>
1586     </description>
1587 </item>
1588
1589 <item>
1590     <tags>'notmo' 'notimeout'</tags>
1591     <tags>'tmo' 'timeout'</tags>
1592     <spec>'timeout' 'tmo'</spec>
1593     <type>&option.timeout.type;</type>
1594     <default>&option.timeout.default;</default>
1595     <description>
1596         <p>
1597             When this option is set and a key sequence interpretable both as a
1598             complete command and as a start of a longer command is typed,
1599             execute the shorter command after <o>timeoutlen</o> milliseconds.
1600         </p>
1601     </description>
1602 </item>
1603
1604 <item>
1605     <tags>'tmol' 'timeoutlen'</tags>
1606     <spec>'timeoutlen' 'tmol'</spec>
1607     <type>&option.timeoutlen.type;</type>
1608     <default>&option.timeoutlen.default;</default>
1609     <description>
1610         <p>
1611             Maximum number of milliseconds to wait for a longer key command
1612             when a shorter one exists. Only effective when <o>timeout</o> is
1613             set.
1614         </p>
1615     </description>
1616 </item>
1617
1618 <item>
1619     <tags>'titlestring'</tags>
1620     <spec>'titlestring'</spec>
1621     <type>&option.titlestring.type;</type>
1622     <default>&option.titlestring.default;</default>
1623     <description>
1624         <p>
1625             Set the application name shown after the current page title in
1626             &dactyl.host;'s title bar.
1627         </p>
1628         <example><set opt="titlestring"><str>Mozilla &dactyl.host;</str></set></example>
1629     </description>
1630 </item>
1631
1632 <item>
1633     <tags>'us' 'urlsep' 'urlseparator'</tags>
1634     <spec>'urlseparator' 'urlsep' 'us'</spec>
1635     <type>&option.urlseparator.type;</type>
1636     <default>&option.urlseparator.default;</default>
1637     <description>
1638         <p>
1639             The regular expression used to split URL lists in commands
1640             like <ex>:open</ex>. When set to the empty string, URL lists
1641             are never split. With the default settings, the following will open
1642             three URLs (the first one in the current tab and the latter two in
1643             two new background tabs):
1644         </p>
1645         <code><ex>:open <str delim="">google Linux</str> | <str delim="">wikipedia Arch Linux</str> | <str delim="">imdb Serenity</str></ex></code>
1646     </description>
1647 </item>
1648
1649 <item>
1650     <tags>'noum' 'nousermode'</tags>
1651     <tags>'um' 'usermode'</tags>
1652     <spec>'usermode' 'um'</spec>
1653     <type>&option.usermode.type;</type>
1654     <default>&option.usermode.default;</default>
1655     <description>
1656         <p>Show current website with minimal styling.</p>
1657     </description>
1658 </item>
1659
1660 <item>
1661     <tags>'vbs' 'verbose'</tags>
1662     <spec>'verbose' 'vbs'</spec>
1663     <type>&option.verbose.type;</type>
1664     <default>&option.verbose.default;</default>
1665     <description>
1666         <p>
1667             Define which info messages are displayed. As the value increases,
1668             &dactyl.appName; will show more messages about its progress.
1669             These can be viewed at any time with the <ex>:messages</ex>
1670             command. The highest useful value is 15, being the most verbose
1671             mode.
1672         </p>
1673         <!-- TODO: list levels and associated messages -->
1674     </description>
1675 </item>
1676
1677 <item>
1678     <tags>'novb' 'novisualbell'</tags>
1679     <tags>'vb' 'visualbell'</tags>
1680     <spec>'visualbell' 'vb'</spec>
1681     <type>&option.visualbell.type;</type>
1682     <default>&option.visualbell.default;</default>
1683     <description>
1684         <p>
1685             Use visual bell instead of beeping on errors. The visual bell
1686             style is controlled by <ex>:highlight Bell</ex>. See also
1687             <o>errorbells</o>.
1688         </p>
1689     </description>
1690 </item>
1691
1692 <item>
1693     <tags>'wia' 'wildanchor'</tags>
1694     <strut/>
1695     <spec>'wildanchor' 'wia'</spec>
1696     <type>&option.wildanchor.type;</type>
1697     <default>&option.wildanchor.default;</default>
1698     <description>
1699         <p>
1700             Regular expression list defining which completion groups show only
1701             matches anchored to the beginning of the result. The first
1702             matching expression is the one that applies. If the match is
1703             negated, then the current filter may match anywhere in the result.
1704             If it is not negated, then the match may only occur at the
1705             beginning of the result. If no items match, then a
1706             context-dependent default value is used.
1707         </p>
1708     </description>
1709 </item>
1710
1711 <item>
1712     <tags>'wic' 'wildcase'</tags>
1713     <spec>'wildcase' 'wic'</spec>
1714     <type>&option.wildcase.type;</type>
1715     <default>&option.wildcase.default;</default>
1716     <description>
1717         <p>
1718             Defines how completions are matched with regard to character case.
1719             Keys in the <t>regexpmap</t> refer to completion context names (see
1720             <ex>:contexts</ex>) for which the value applies. Possible values
1721             are:
1722         </p>
1723
1724         <dl>
1725             <dt><str>smart</str></dt>  <dd>Case is significant when capital letters are typed</dd>
1726             <dt><str>match</str></dt>  <dd>Case is always significant</dd>
1727             <dt><str>ignore</str></dt> <dd>Case is never significant</dd>
1728         </dl>
1729     </description>
1730 </item>
1731
1732 <item>
1733     <tags>'wig' 'wildignore'</tags>
1734     <spec>'wildignore' 'wig'</spec>
1735     <type>&option.wildignore.type;</type>
1736     <default>&option.wildignore.default;</default>
1737     <description>
1738         <p>
1739             List of path name patterns to ignore when completing files and
1740             directories. For example, the following will ignore object files
1741             and Vim swap files:
1742         </p>
1743
1744         <set opt="wildignore"><str delim="'">\.o$</str>,<str delim="'">^\..*\.s[a-z]{2}$</str></set>
1745
1746         <note>Unlike Vim, each pattern is a regular expression rather than a glob.</note>
1747     </description>
1748 </item>
1749
1750 <item>
1751     <tags>'wim' 'wildmode'</tags>
1752     <spec>'wildmode' 'wim'</spec>
1753     <type>&option.wildmode.type;</type>
1754     <default>&option.wildmode.default;</default>
1755     <description>
1756         <p>
1757             Defines how command-line completion works. It is a comma-separated
1758             list of parts, where each part specifies what to do for each
1759             consecutive press of the <k name="Tab" mode="c"/> key. The last
1760             element in the list is used for each succeeding <k name="Tab" mode="c"/>
1761             after it has been reached.
1762         </p>
1763
1764         <p>These are the possible values for each part:</p>
1765
1766         <dl>
1767             <dt><str></str></dt>             <dd>Complete only the first match.</dd>
1768             <dt><str>full</str></dt>         <dd>Complete the next full match. After the last, the original string is used.</dd>
1769             <dt><str>longest</str></dt>      <dd>Complete the longest common substring of all completions.</dd>
1770             <dt><str>list</str></dt>         <dd>When more than one match, list all matches.</dd>
1771             <dt><str>list:full</str></dt>    <dd>When more than one match, list all matches and complete the first match.</dd>
1772             <dt><str>list:longest</str></dt>
1773             <dd>
1774                 When more than one match, list all matches and
1775                 complete till the longest common string. When there
1776                 is only a single match, it is fully completed
1777                 regardless of the case.
1778             </dd>
1779         </dl>
1780
1781         <p>
1782             See also <o>altwildmode</o>.
1783         </p>
1784
1785     </description>
1786 </item>
1787
1788 <item>
1789     <tags>'wis' 'wildsort'</tags>
1790     <spec>'wildsort' 'wis'</spec>
1791     <type>&option.wildsort.type;</type>
1792     <default>&option.wildsort.default;</default>
1793     <description>
1794         <p>
1795             A list of regular expressions defining which completion contexts
1796             should be sorted. The main purpose of this option is to prevent
1797             sorting of certain completion lists that don't perform well under
1798             load.
1799         </p>
1800
1801         <p>See also <ex>:contexts</ex>.</p>
1802     </description>
1803 </item>
1804
1805 <item>
1806     <tags>'wsp' 'wordseparators'</tags>
1807     <spec>'wordseparators' 'wsp'</spec>
1808     <strut/>
1809     <type>&option.wordseparators.type;</type>
1810     <default>&option.wordseparators.default;</default>
1811     <description>
1812         <p>
1813             A regular expression which defines how words are split for
1814             the <o>hintmatching</o> types <str>wordstartswith</str> and
1815             <str>firstletters</str>. Words are split on each occurrence of the
1816             given pattern.
1817         </p>
1818     </description>
1819 </item>
1820
1821 <item>
1822     <tags>'ys' 'yankshort'</tags>
1823     <spec>'yankshort' 'ys'</spec>
1824     <type>&option.yankshort.type;</type>
1825     <default>&option.yankshort.default;</default>
1826     <description>
1827         <p>Yank the canonical short URL of a web page where provided.</p>
1828     </description>
1829 </item>
1830
1831
1832 </document>
1833
1834 <!-- vim:se sts=4 sw=4 et: -->