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">
 536             <str delim="">bookmark,search,file</str></se> will list bookmarks
 537             followed by matching quick searches and then 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         <note>
 600             This option is currently unavailable in &dactyl.host; 26 and greater.
 601         </note>
 602     </description>
 603 </item>
 604
 605 <item>
 606     <tags>'editor'</tags>
 607     <spec>'editor'</spec>
 608     <type>&option.editor.type;</type>
 609     <default>&option.editor.default;</default>
 610     <description>
 611         <p>
 612             Set the external text editor.
 613             This is the editor used by <k name="C-i" mode="I"/>, <k>gF</k>, and
 614             other commands which launch an external text editor.
 615         </p>
 616
 617         <p>
 618             Accepts a <t>macro-string</t> with the following escapes available.
 619             Arguments containing escapes which are not relevant to a given call
 620             are automatically elided. All field splitting is done before format
 621             characters are processed.
 622         </p>
 623
 624         <dl>
 625             <dt>&lt;file></dt>   <dd>The file to edit. Appended as the final argument if missing.</dd>
 626             <dt>&lt;line></dt>   <dd>The line number at which to position the cursor.</dd>
 627             <dt>&lt;column></dt> <dd>The column at which to position the cursor.</dd>
 628         </dl>
 629
 630         <warning>
 631             &dactyl.appName; will not behave correctly if the editor forks its
 632             own process rather than blocking until editing is complete. Gvim
 633             invoked without the <em>-f</em> option is one such example.
 634         </warning>
 635     </description>
 636 </item>
 637
 638 <item>
 639     <tags>'enc' 'encoding'</tags>
 640     <spec>'encoding' 'enc'</spec>
 641     <type>&option.encoding.type;</type>
 642     <default>&option.encoding.default;</default>
 643     <description>
 644         <p>
 645             Changes the character encoding of the current buffer. Valid only
 646             until a new page is loaded.
 647         </p>
 648     </description>
 649 </item>
 650
 651 <item>
 652     <tags>'noeb' 'noerrorbells'</tags>
 653     <tags>'eb' 'errorbells'</tags>
 654     <spec>'errorbells' 'eb'</spec>
 655     <type>&option.errorbells.type;</type>
 656     <default>&option.errorbells.default;</default>
 657     <description>
 658         <p>
 659             Ring the bell when an error message is displayed. See also
 660             <o>visualbell</o>.
 661         </p>
 662     </description>
 663 </item>
 664
 665 <item>
 666     <tags>'ei' 'eventignore'</tags>
 667     <spec>'eventignore' 'ei'</spec>
 668     <type>&option.eventignore.type;</type>
 669     <default>&option.eventignore.default;</default>
 670     <description>
 671         <p>
 672             A list of autocommand event names which should be ignored. If the
 673             list contains the value <str>all</str> then all events are
 674             ignored.
 675         </p>
 676     </description>
 677 </item>
 678
 679 <item>
 680     <tags>'noex' 'noexrc'</tags>
 681     <tags>'ex' 'exrc'</tags>
 682     <spec>'exrc' 'ex'</spec>
 683     <type>&option.exrc.type;</type>
 684     <default>&option.exrc.default;</default>
 685     <description>
 686         <p>
 687             Allow reading of an RC file in the current directory. This file is
 688             sourced after the default <tt><t>&dactyl.name;rc</t></tt> file in your
 689             home directory.
 690         </p>
 691     </description>
 692 </item>
 693
 694 <item>
 695     <tags>'eht' 'extendedhinttags'</tags>
 696     <spec>'extendedhinttags' 'eht'</spec>
 697     <strut/>
 698     <type>&option.extendedhinttags.type;</type>
 699     <default>[asOTvVWy]:':-moz-any-link',area[href],img[src],iframe[src],
 700           [A]:[id],a[name],
 701           [f]:body,
 702           [F]:body,code,div,html,p,pre,span,
 703           [iI]:img,
 704           [S]:button,'input:not([type=hidden])',select,textarea</default>
 705     <description>
 706         <p>
 707             Defines specialized CSS selectors or XPath expressions for arbitrary
 708             <t>extended-hints</t> modes. The syntax is the same as for
 709             <o>hinttags</o>. If no matches are found, the value of
 710             <o>hinttags</o> is used.
 711         </p>
 712     </description>
 713 </item>
 714
 715 <item>
 716     <tags>'fenc' 'fileencoding'</tags>
 717     <spec>'fileencoding' 'fenc'</spec>
 718     <type>&option.fileencoding.type;</type>
 719     <default>&option.fileencoding.default;</default>
 720     <description>
 721         <p>
 722             Changes the character encoding that &dactyl.appName; uses to read
 723             and write files.
 724         </p>
 725     </description>
 726 </item>
 727
 728 <item>
 729     <tags>'fc' 'findcase'</tags>
 730     <spec>'findcase' 'fc'</spec>
 731     <type>&option.findcase.type;</type>
 732     <default>&option.findcase.default;</default>
 733     <description>
 734         <p>Find case matching mode.</p>
 735
 736         <dl>
 737             <dt>ignore</dt> <dd>Case is never significant</dd>
 738             <dt>match</dt> <dd>Case is always significant</dd>
 739             <dt>smart</dt> <dd>Case is significant when capital letters are typed</dd>
 740         </dl>
 741     </description>
 742 </item>
 743
 744 <item>
 745     <tags>'ff' 'findflags'</tags>
 746     <spec>'findflags' 'ff'</spec>
 747     <type>&option.findflags.type;</type>
 748     <default>&option.findflags.default;</default>
 749     <description>
 750         <p>Default flags for find invocations.</p>
 751
 752         <dl>
 753             <dt>C</dt> <dd>Match case</dd>
 754             <dt>L</dt> <dd>Search all text</dd>
 755             <dt>R</dt> <dd>Perform a plain string search</dd>
 756             <dt>c</dt> <dd>Ignore case</dd>
 757             <dt>l</dt> <dd>Search only in links</dd>
 758             <dt>r</dt> <dd>Perform a regular expression search</dd>
 759         </dl>
 760     </description>
 761 </item>
 762
 763 <item>
 764     <tags>'fh' 'followhints'</tags>
 765     <spec>'followhints' 'fh'</spec>
 766     <type>&option.followhints.type;</type>
 767     <default>&option.followhints.default;</default>
 768     <description>
 769         <p>
 770             Define the conditions under which hints selected by typing the link
 771             substring are followed. Hints selected by typing their label (as
 772             specified by <o>hintkeys</o>) are always followed immediately.
 773         </p>
 774
 775         <p>Possible values:</p>
 776
 777         <dl dt="width: 6em;">
 778             <dt>0</dt>      <dd>Follow the first hint as soon as typed text uniquely identifies it.</dd>
 779             <dt>1</dt>      <dd>Follow the selected hint on <k name="CR" link="false"/>.</dd>
 780         </dl>
 781     </description>
 782 </item>
 783
 784 <item>
 785     <tags>'nofs' 'nofullscreen'</tags>
 786     <tags>'fs' 'fullscreen'</tags>
 787     <spec>'fullscreen' 'fs'</spec>
 788     <type>&option.fullscreen.type;</type>
 789     <default>&option.fullscreen.default;</default>
 790     <description>
 791         <p>
 792             Show the current window full-screen. Also hide certain GUI elements, such as
 793             <t>status-line</t> and tab bar.
 794         </p>
 795     </description>
 796 </item>
 797
 798 <item>
 799     <tags>'go' 'guioptions'</tags>
 800     <spec>'guioptions' 'go'</spec>
 801     <type>&option.guioptions.type;</type>
 802     <default>&option.guioptions.default;</default>
 803     <description>
 804         <p>Show or hide certain GUI elements.</p>
 805
 806         <p>Supported characters:</p>
 807
 808         <dl dt="width: 6em;">
 809             <dt>B</dt>      <dd>Bookmark bar</dd>
 810             <dt>C</dt>      <dd>Always show the command line outside of the status line</dd>
 811             <dt>M</dt>      <dd>Always show messages outside of the status line</dd>
 812             <dt>N</dt>      <dd>Tab number over image</dd>
 813             <dt>T</dt>      <dd>Toolbar</dd>
 814             <dt>b</dt>      <dd>Bottom scrollbar</dd>
 815             <dt>c</dt>      <dd>Always show the command line, even when empty</dd>
 816             <dt>l</dt>      <dd>Left scrollbar (<em>l</em> and <em>r</em> are mutually exclusive)</dd>
 817             <dt>m</dt>      <dd>Menu bar</dd>
 818             <dt>n</dt>      <dd>Tab number</dd>
 819             <dt>r</dt>      <dd>Right scrollbar</dd>
 820             <dt>s</dt>      <dd>Status bar</dd>
 821         </dl>
 822
 823         <p>See also <o>showtabline</o>.</p>
 824
 825         <note>Scrollbar changes require a page reload to take effect.</note>
 826         <note>Only one of <em>l</em> or <em>r</em> may be included.</note>
 827     </description>
 828 </item>
 829
 830 <item>
 831     <tags>'hf' 'helpfile'</tags>
 832     <spec>'helpfile' 'hf'</spec>
 833     <type>&option.helpfile.type;</type>
 834     <default>&option.helpfile.default;</default>
 835     <description>
 836         <p>
 837             Name of the main help file. This is that page shown if the
 838             <ex>:help</ex> command is called without any arguments.
 839         </p>
 840     </description>
 841 </item>
 842
 843 <item>
 844     <tags>'hin' 'hintinputs'</tags>
 845     <spec>'hintinputs' 'hin'</spec>
 846     <type>&option.hintinputs.type;</type>
 847     <default>&option.hintinputs.default;</default>
 848     <description>
 849         <p>
 850             When generating hints for input elements that do not have an
 851             explicit caption, this specifies the methods used to generate a
 852             textual hint. The options are attempted in the order they are
 853             given, and the first successful value is used.
 854         </p>
 855
 856         <dl dt="width: 8em;">
 857             <dt>value</dt>      <dd>The hint is the value displayed in a text input, or the selected option for a drop-down.</dd>
 858             <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>
 859             <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>
 860         </dl>
 861     </description>
 862 </item>
 863
 864 <item>
 865     <tags>'hk' 'hintkeys'</tags>
 866     <spec>'hintkeys' 'hk'</spec>
 867     <type>&option.hintkeys.type;</type>
 868     <default>&option.hintkeys.default;</default>
 869     <description>
 870         <p>
 871             The keys used to label and select hints. With its default value,
 872             each hint has a unique number which can be typed to select it,
 873             while all other characters are used to filter hints based on their
 874             text. With a value such as <str>asdfg;lkjh</str>, each hint is
 875             ‘numbered’ based on the characters of the home row.
 876         </p>
 877     </description>
 878 </item>
 879
 880 <item>
 881     <tags>'hm' 'hintmatching'</tags>
 882     <spec>'hintmatching' 'hm'</spec>
 883     <type>&option.hintmatching.type;</type>
 884     <default>&option.hintmatching.default;</default>
 885     <description>
 886         <p>Change the hint matching algorithm used in Hints mode.</p>
 887
 888         <p>Possible values are one of:</p>
 889
 890         <dl>
 891             <dt>contains</dt>
 892             <dd>
 893                 The typed characters are split on whitespace, and
 894                 these character groups have to match anywhere inside
 895                 the text of the link.
 896             </dd>
 897             <dt>wordstartswith</dt>
 898             <dd>
 899                 The typed characters are matched with the beginning
 900                 of the first word (see <o>wordseparators</o>) in the
 901                 link as long as possible. If no matches occur in the
 902                 current word, then the matching is continued at the
 903                 beginning of the next word. The words are worked
 904                 through in the order they appear in the link. If the
 905                 typed characters contain spaces, then the characters
 906                 are split on whitespace. These character groups are
 907                 then matched with the beginning of the words,
 908                 beginning at the first one and continuing with the
 909                 following words in the order they appear in the
 910                 link.
 911             </dd>
 912             <dt>firstletters</dt>
 913             <dd>
 914                 Behaves like wordstartswith, but non-matching words
 915                 aren't skipped.
 916             </dd>
 917             <dt>custom</dt>
 918             <dd>
 919                 Delegate to the function
 920                 <tt>dactyl.plugins.customHintMatcher</tt>.
 921             </dd>
 922         </dl>
 923         <p>and optionally:</p>
 924         <dl>
 925             <dt>transliterated</dt>
 926             <dd>
 927                 Certain alphanumeric characters are transliterated into their
 928                 unaccented equivalents, such that ‘euro’ will match 'æuró',
 929                 and ‘Ångström’ will match ‘angstrom’.
 930             </dd>
 931         </dl>
 932     </description>
 933 </item>
 934
 935 <item>
 936     <tags>'ht' 'hinttags'</tags>
 937     <strut/>
 938     <spec>'hinttags' 'ht'</spec>
 939     <type>&option.hinttags.type;</type>
 940     <default>:-moz-any-link,area,button,iframe,input:not([type=hidden]),
 941           label[for],select,textarea,
 942           [onclick],[onmouseover],[onmousedown],[onmouseup],[oncommand],
 943           [tabindex],[role=link],[role=button],[contenteditable=true]</default>
 944     <description>
 945         <p>
 946             A list of CSS selectors or XPath expressions used to select elements
 947             for <link topic="hints">hinting</link>. Values beginning with the
 948             string <str>xpath:</str> are treated as XPath expressions, while any
 949             other values are treated as CSS selectors. Can be overridden for
 950             individual <t>extended-hints</t> modes with the
 951             <o>extendedhinttags</o> option.
 952         </p>
 953     </description>
 954 </item>
 955
 956 <item>
 957     <tags>'hto' 'hinttimeout'</tags>
 958     <spec>'hinttimeout' 'hto'</spec>
 959     <type>&option.hinttimeout.type;</type>
 960     <default>&option.hinttimeout.default;</default>
 961     <description>
 962         <p>
 963             Timeout in milliseconds before automatically following a non-unique
 964             hint. The timeout is measured since the last time a key listed in
 965             <o>hintkeys</o> was pressed. It has no effect when narrowing hints
 966             by typing part of their text. Set to 0 (the default) to only follow
 967             hints after pressing <k name="CR" link="false"/> or when the hint is unique.
 968         </p>
 969     </description>
 970 </item>
 971
 972 <item>
 973     <tags>'hi' 'history'</tags>
 974     <spec>'history' 'hi'</spec>
 975     <type>&option.history.type;</type>
 976     <default>&option.history.default;</default>
 977     <description>
 978         <p>
 979             Maximum number of Ex commands and find patterns to store in the
 980             <t>command-line</t> history.
 981         </p>
 982     </description>
 983 </item>
 984
 985 <item>
 986     <tags>'nohlf' 'nohlfind'</tags>
 987     <tags>'hlf' 'hlfind'</tags>
 988     <spec>'hlfind' 'hlf'</spec>
 989     <type>&option.hlfind.type;</type>
 990     <default>&option.hlfind.default;</default>
 991     <description>
 992         <p>Highlight previous find pattern matches.</p>
 993     </description>
 994 </item>
 995
 996 <item>
 997     <tags>'noif' 'noincfind'</tags>
 998     <tags>'if' 'incfind'</tags>
 999     <spec>'incfind' 'if'</spec>
1000     <type>&option.incfind.type;</type>
1001     <default>&option.incfind.default;</default>
1002     <description>
1003         <p>Show the first match for a find pattern as it is typed.</p>
1004     </description>
1005 </item>
1006
1007 <item>
1008     <tags>'noim' 'noinsertmode'</tags>
1009     <tags>'im' 'insertmode'</tags>
1010     <spec>'insertmode' 'im'</spec>
1011     <type>&option.insertmode.type;</type>
1012     <default>&option.insertmode.default;</default>
1013     <description>
1014         <p>
1015             Use Insert mode as the default for text areas. This is useful if you
1016             want to use the known &dactyl.host; interface for editing text areas.
1017             Input fields default to this behavior irrespective of this option's
1018             setting.
1019         </p>
1020
1021         <p>
1022             Text Edit mode can be entered with <k name="C-t" mode="I"/> from Insert mode.
1023         </p>
1024     </description>
1025 </item>
1026
1027 <item>
1028     <tags>'isk' 'iskeyword'</tags>
1029     <spec>'iskeyword' 'isk'</spec>
1030     <type>&option.iskeyword.type;</type>
1031     <default>&option.iskeyword.default;</default>
1032     <description>
1033         <p>Regular expression defining which characters constitute words.</p>
1034     </description>
1035 </item>
1036
1037 <item>
1038     <tags>'nojsd' 'nojsdebugger'</tags>
1039     <tags>'jsd' 'jsdebugger'</tags>
1040     <spec>'jsdebugger' 'jsd'</spec>
1041     <type>&option.jsdebugger.type;</type>
1042     <default>&option.jsdebugger.default;</default>
1043     <description>
1044         <p>
1045             Use the JavaScript debugger service for JavaScript completion.
1046         </p>
1047     </description>
1048 </item>
1049
1050 <item>
1051     <tags>'jt' 'jumptags'</tags>
1052     <spec>'jumptags' 'jt'</spec>
1053     <type>&option.jumptags.type;</type>
1054     <default>&option.jumptags.default;</default>
1055     <description>
1056         <p>XPath or CSS selector strings of jumpable elements for extended hint modes.</p>
1057     </description>
1058 </item>
1059
1060 <item>
1061     <tags>'ln' 'linenumbers'</tags>
1062     <spec>'linenumbers' 'ln'</spec>
1063     <type>&option.linenumbers.type;</type>
1064     <default><![CDATA['view-source:*':[id^=line],
1065           code.google.com:'#nums [id^="nums_table"] a[href^="#"]',
1066           github.com:.line_numbers>*,
1067           mxr.mozilla.org:a.l,
1068           pastebin.com:#code_frame>div>ol>li,
1069           addons.mozilla.org:.gutter>.line>a,
1070           bugzilla.mozilla.org:.bz_comment:not(.bz_first_comment):not(.ih_history),
1071           *:'/* Hgweb/Gitweb */ .completecodeline a.codeline, a.linenr']]></default>
1072     <description>
1073         <p>
1074             Patterns used to determine line numbers used by <k>G</k>. May be
1075             either a selector expression as accepted by <o>hinttags</o>, or the
1076             string <str delim="'">func:</str> followed by a JavaScript
1077             expression which evaluates to a function. In the former case, the
1078             first matching element whose text content is equal to the desired
1079             line number is used. If no such element exists, the <oa>count</oa>th
1080             matching element is used. In the latter case, the provided function
1081             must accept two arguments, the document in question and the desired
1082             line number, and must return the element corresponding to the given
1083             line.
1084         </p>
1085     </description>
1086 </item>
1087
1088
1089 <item>
1090     <tags>'lpl' 'loadplugins'</tags>
1091     <spec>'loadplugins' 'lpl'</spec>
1092     <type>&option.loadplugins.type;</type>
1093     <default>&option.loadplugins.default;</default>
1094     <description>
1095         <p>
1096             A regular expression list that defines which plugins are loaded at
1097             startup or via <ex>:loadplugins</ex>. The first item to match is
1098             the one that takes effect. If no items match, the file is not
1099             loaded. Setting this to a blank value effectively disables plugin
1100             loading.
1101         </p>
1102         <p>
1103             For example, to prepend to the default value of this option to load
1104             all plugins except for <em>foobar-plugin</em>, you could use:
1105         </p>
1106         <set opt="loadplugins" op="^=">!<str delim="'">foobar-plugin</str></set>
1107         <p>
1108             Alternatively, you can specify which plugins to load and which to
1109             omit in your <tt><t>&dactyl.name;rc</t></tt> using something like
1110             the following:
1111         </p>
1112         <set opt="loadplugins">!<str delim="'">foo|bar</str>,<str delim="'">\.(js|&dactyl.fileExt;)$</str></set>
1113         <p>
1114             That will load all plugins but <em>foo</em> and <em>bar</em>.
1115         </p>
1116         <p>
1117             Note that in the first expression of the latter example you don't
1118             need parentheses, as the <em>!</em> negates the whole of the
1119             following expression (cf. <t>regexplist</t>).
1120         </p>
1121         <p>
1122             See also <ex>:runtime</ex>.
1123         </p>
1124     </description>
1125 </item>
1126
1127 <item>
1128     <tags>'maxitems'</tags>
1129     <spec>'maxitems'</spec>
1130     <type>&option.maxitems.type;</type>
1131     <default>&option.maxitems.default;</default>
1132     <description>
1133         <p>Maximum number of items to display at once in a listing.</p>
1134     </description>
1135 </item>
1136
1137 <item>
1138     <tags>'msgs' 'messages'</tags>
1139     <spec>'messages' 'msgs'</spec>
1140     <type>&option.messages.type;</type>
1141     <default>&option.messages.default;</default>
1142     <description>
1143         <p>Maximum number of messages to store in the message history.</p>
1144     </description>
1145 </item>
1146
1147 <item>
1148     <tags>'nomore' 'more'</tags>
1149     <spec>'more'</spec>
1150     <type>&option.more.type;</type>
1151     <default>&option.more.default;</default>
1152     <description>
1153         <p>
1154             Pause the message list window when more than one screen of
1155             listings is displayed.
1156         </p>
1157     </description>
1158 </item>
1159
1160 <item>
1161     <tags>'newtab'</tags>
1162     <spec>'newtab'</spec>
1163     <type>&option.newtab.type;</type>
1164     <default>&option.newtab.default;</default>
1165     <description>
1166         <p>
1167             Defines which Ex commands open pages in new tabs rather than the
1168             current tab by default. This may be overridden with the
1169             <ex>:tab</ex> command, and is usually inverted by affixing a
1170             <em>!</em> to the command in question.
1171         </p>
1172
1173         <p>Possible values:</p>
1174
1175         <dl>
1176             <dt>all</dt>            <dd>All commands</dd>
1177             <dt>addons</dt>         <dd><ex>:addo<oa>ns</oa></ex> command</dd>
1178             <dt>downloads</dt>      <dd><ex>:downl<oa>oads</oa></ex> command</dd>
1179             <dt>extoptions</dt>     <dd><ex>:exto<oa>ptions</oa></ex> command</dd>
1180             <dt>help</dt>           <dd><ex>:h<oa>elp</oa></ex> command</dd>
1181             <dt>javascript</dt>     <dd><ex>:javascript!</ex> or <ex>:js!</ex> command</dd>
1182             <dt>prefs</dt>          <dd><ex>:pref<oa>erences</oa>!</ex> or <ex>:prefs!</ex> command</dd>
1183         </dl>
1184
1185     </description>
1186 </item>
1187
1188 <item>
1189     <tags>'nextpattern'</tags>
1190     <strut/>
1191     <spec>'nextpattern'</spec>
1192     <type>&option.nextpattern.type;</type>
1193     <default>&option.nextpattern.default;</default>
1194     <description>
1195         <p>
1196             Patterns to use when guessing the next page in a document
1197             sequence after pressing the <k>]]</k> key. Each pattern is
1198             successively tested against each link in the page (as defined by
1199             <o>hinttags</o>, starting with the last), and the first link to
1200             match is followed.
1201         </p>
1202     </description>
1203 </item>
1204
1205 <item>
1206     <tags>'noonline' 'online'</tags>
1207     <spec>'online'</spec>
1208     <type>&option.online.type;</type>
1209     <default>&option.online.default;</default>
1210     <description>
1211         <p>
1212             Enables or disables ‘offline’ mode, where network access is
1213             disabled and all web pages are loaded entirely from cache.
1214         </p>
1215     </description>
1216 </item>
1217
1218 <item>
1219     <tags>'pa' 'pageinfo'</tags>
1220     <spec>'pageinfo' 'pa'</spec>
1221     <type>&option.pageinfo.type;</type>
1222     <default>&option.pageinfo.default;</default>
1223     <description>
1224         <p>Info shown in the <ex>:pageinfo</ex> output.</p>
1225
1226         <p>Items available by default:</p>
1227
1228         <dl dt="width: 6em;">
1229             <dt>g</dt>      <dd>General info</dd>
1230             <dt>e</dt>      <dd>Search Engines</dd>
1231             <dt>f</dt>      <dd>Feeds</dd>
1232             <dt>m</dt>      <dd>Meta tags</dd>
1233             <dt>s</dt>      <dd>Security information</dd>
1234         </dl>
1235
1236         <p>
1237             The order of the options defines the order in which they appear in
1238             the result.
1239         </p>
1240     </description>
1241 </item>
1242
1243 <item>
1244     <tags>'pk' 'passkeys'</tags>
1245     <spec>'passkeys' 'pk'</spec>
1246     <type>&option.passkeys.type;</type>
1247     <default>&option.passkeys.default;</default>
1248     <description>
1249         <p>
1250             Pass certain keys through directly for the given URLs.
1251             For any page with a URL matching a given <t>site-filter</t>, all key
1252             events for keys listed in the corresponding value are passed
1253             through directly to &dactyl.host;, and are not processed
1254             by &dactyl.appName; in any way. Key names are separated
1255             by commas, where the first key name is treated as a list
1256             of individual keys and each subsequent key is treated as
1257             a key chain. Individual key entries always apply to all
1258             modes. Key chains apply only to non-input modes unless
1259             they begin with a key requiring a modifier other than
1260             shift.
1261         </p>
1262
1263         <example><set opt="passkeys" op="+="><str delim="">mail.google.com</str>:<str delim="">jk&lt;CR></str>,<str delim="">gi</str></set></example>
1264
1265         <p>
1266             More subtle and complex pass through can be achieved
1267             using <t>groups</t> and mode-specific mappings utilizing
1268             the <k name="Pass"/> pseudo-key.
1269         </p>
1270     </description>
1271 </item>
1272
1273 <item>
1274     <tags>'pu' 'passunknown'</tags>
1275     <spec>'passunknown' 'pu'</spec>
1276     <type>&option.passunknown.type;</type>
1277     <default>&option.passunknown.default;</default>
1278     <description>
1279         <p>
1280             Pass unknown keys through to &dactyl.host; in these
1281             <t>modes</t>. The first element matching a currently
1282             active mode is the one that takes effect. Modes may be
1283             negated by prefixing them with a <tt>!</tt>.
1284         </p>
1285     </description>
1286 </item>
1287
1288 <item>
1289     <tags>'pps' 'popups'</tags>
1290     <spec>'popups' 'pps'</spec>
1291     <type>&option.popups.type;</type>
1292     <default>&option.popups.default;</default>
1293     <description>
1294         <p>
1295             Defines where to show requested pop-up windows. Applies only to
1296             links which request to open in a new window. The behavior of
1297             middle-, shift-, or control- clicking a link is unaffected by this
1298             option.
1299         </p>
1300
1301         <p>Possible values are:</p>
1302
1303         <dl dt="width: 8em;">
1304             <dt>tab</dt>            <dd>Open pop-ups in a new tab</dd>
1305             <dt>window</dt>         <dd>Open pop-ups in a new window</dd>
1306             <dt>resized</dt>        <dd>Open resized pop-ups in a new window</dd>
1307         </dl>
1308
1309         <p>
1310             If neither <em>tab</em> nor <em>window</em> is provided, all
1311             pop-ups open in the current tab. <em>tab</em> and <em>window</em>
1312             are mutually exclusive, and the last one listed is effective.
1313         </p>
1314
1315         <note>
1316             This option does not alter the &dactyl.host; pop-up blocker behavior
1317             in any way.
1318         </note>
1319     </description>
1320 </item>
1321
1322 <item>
1323     <tags>'previouspattern'</tags>
1324     <strut/>
1325     <spec>'previouspattern'</spec>
1326     <type>&option.previouspattern.type;</type>
1327     <default>&option.previouspattern.default;</default>
1328     <description>
1329         <p>
1330             Patterns to use when guessing the previous page in a document
1331             sequence after pressing the <k>[[</k> key. Each pattern is
1332             successively tested against each link in the page (as defined by
1333             <o>hinttags</o>, starting with the last), and the first link to
1334             match is followed.
1335         </p>
1336     </description>
1337 </item>
1338
1339 <item>
1340     <tags>$&dactyl.idName;_RUNTIME</tags>
1341     <tags>'rtp' 'runtimepath'</tags>
1342     <spec>'runtimepath' 'rtp'</spec>
1343     <type>&option.runtimepath.type;</type>
1344     <default type="plain"><str>$&dactyl.idName;_RUNTIME</str> or
1345        Unix, Mac: <str>~/.&dactyl.name;</str>
1346          Windows: <str>~/&dactyl.name;</str></default>
1347     <description>
1348         <p>List of directories searched for runtime files:</p>
1349
1350         <ul>
1351             <li>colors/</li>
1352             <li>plugins/</li>
1353         </ul>
1354
1355         <p>Example:</p>
1356
1357         <set opt="runtimepath"><str delim="">~/my&dactyl.name;</str>,<str delim="">~/.&dactyl.name;</str></set>
1358
1359         <p>
1360             This will search for plugins in both
1361             <str>~/my&dactyl.name;/plugins</str> and
1362             <str>~/.&dactyl.name;/plugins</str>
1363         </p>
1364
1365         <p>
1366             On startup, if the environment variable <em>$&dactyl.idName;_RUNTIME</em> does not
1367             exist, &dactyl.appName; will set it to match this value.
1368         </p>
1369     </description>
1370 </item>
1371
1372 <item>
1373     <tags>'si' 'sanitizeitems'</tags>
1374     <spec>'sanitizeitems' 'si'</spec>
1375     <strut/>
1376     <type>&option.sanitizeitems.type;</type>
1377     <default>&option.sanitizeitems.default;</default>
1378     <description>
1379         <p>
1380             The default list of private items to sanitize. See
1381             <ex>:sanitize</ex> for a list and explanation of possible values. A
1382             value of <str>all</str> will cause all items to be sanitized. Items
1383             may be excluded by prefixing them with a <tt>!</tt>. The first
1384             matching item takes precedence.
1385         </p>
1386     </description>
1387 </item>
1388
1389 <item>
1390     <tags>'ss' 'sanitizeshutdown'</tags>
1391     <spec>'sanitizeshutdown' 'ss'</spec>
1392     <type>&option.sanitizeshutdown.type;</type>
1393     <default>&option.sanitizeshutdown.default;</default>
1394     <description>
1395         <p>The items to sanitize automatically at shutdown.</p>
1396     </description>
1397 </item>
1398
1399 <item>
1400     <tags>'sts' 'sanitizetimespan'</tags>
1401     <spec>'sanitizetimespan' 'sts'</spec>
1402     <strut/>
1403     <type>&option.sanitizetimespan.type;</type>
1404     <default>&option.sanitizetimespan.default;</default>
1405     <description>
1406         <p>
1407             The default sanitizer time span. Only items created within this timespan are
1408             deleted. The value must be of the one of:
1409         </p>
1410
1411         <dl dt="width: 8em;">
1412             <dt>all</dt>       <dd>Everything</dd>
1413             <dt>session</dt>   <dd>The current session</dd>
1414             <dt><a>n</a>m</dt> <dd>Past <a>n</a> Minutes</dd>
1415             <dt><a>n</a>h</dt> <dd>Past <a>n</a> Hours</dd>
1416             <dt><a>n</a>d</dt> <dd>Past <a>n</a> Days</dd>
1417             <dt><a>n</a>w</dt> <dd>Past <a>n</a> Weeks</dd>
1418         </dl>
1419     </description>
1420 </item>
1421
1422 <item>
1423     <tags>'scr' 'scroll'</tags>
1424     <spec>'scroll' 'scr'</spec>
1425     <type>&option.scroll.type;</type>
1426     <default>&option.scroll.default;</default>
1427     <description>
1428         <p>
1429             Number of lines to scroll with <k name="C-u"/> and <k name="C-d"/>
1430             commands. The number of lines scrolled defaults to half the window
1431             size. When a <oa>count</oa> is specified to the <k name="C-u"/> or
1432             <k name="C-d"/> commands, set this option to <oa>count</oa> before
1433             executing the command. Setting this to <em>0</em> restores the
1434             default behaviour.
1435         </p>
1436     </description>
1437 </item>
1438
1439 <item>
1440     <tags>'scs' 'scrollsteps'</tags>
1441     <spec>'scrollsteps' 'scs'</spec>
1442     <type>&option.scrollsteps.type;</type>
1443     <default>&option.scrollsteps.default;</default>
1444     <description>
1445         <p>
1446             The number of steps in which to smooth scroll to a new position. If
1447             set to 1, smooth scrolling is not used.
1448         </p>
1449     </description>
1450 </item>
1451
1452 <item>
1453     <tags>'sct' 'scrolltime'</tags>
1454     <spec>'scrolltime' 'sct'</spec>
1455     <type>&option.scrolltime.type;</type>
1456     <default>&option.scrolltime.default;</default>
1457     <description>
1458         <p>The time, in milliseconds, in which to smooth scroll to a new position.</p>
1459     </description>
1460     </item>
1461
1462 <item>
1463     <tags>'sh' 'shell'</tags>
1464     <spec>'shell' 'sh'</spec>
1465     <type>&option.shell.type;</type>
1466     <default type="plain"><em>$SHELL</em> or <str>sh</str>, Windows: <str>cmd.exe</str></default>
1467     <description>
1468         <p>Shell to use for executing <ex>:!</ex> and <ex>:run</ex> commands.</p>
1469     </description>
1470 </item>
1471
1472 <item>
1473     <tags>'shcf' 'shellcmdflag'</tags>
1474     <spec>'shellcmdflag' 'shcf'</spec>
1475     <strut/>
1476     <type>&option.shellcmdflag.type;</type>
1477     <default type="plain"><str>-c</str>, Windows: <str>/c</str></default>
1478     <description>
1479         <p>Flag passed to shell when executing <ex>:!</ex> and <ex>:run</ex> commands.</p>
1480     </description>
1481 </item>
1482
1483 <item>
1484     <tags>'smd' 'showmode'</tags>
1485     <spec>'showmode' 'smd'</spec>
1486     <type>&option.showmode.type;</type>
1487     <default>&option.showmode.default;</default>
1488     <description>
1489         <p>
1490             Show the current mode in the command line if it or any
1491             of its parent <t>modes</t> is included in the list.
1492             Modes may be negated by prefixing them with a
1493             <tt>!</tt>.
1494         </p>
1495     </description>
1496 </item>
1497
1498 <item>
1499     <tags>'ssli' 'showstatuslinks'</tags>
1500     <spec>'showstatuslinks' 'ssli'</spec>
1501     <strut/>
1502     <type>&option.showstatuslinks.type;</type>
1503     <default>&option.showstatuslinks.default;</default>
1504     <description>
1505         <p>
1506             When the mouse hovers over a link, or a link is otherwise focused,
1507             show its destination in the status bar.
1508         </p>
1509
1510         <p>Possible values are:</p>
1511
1512         <dl>
1513             <dt></dt> <dd>Don't show link destination</dd>
1514             <dt>status</dt> <dd>Show the link destination in the &tag.status-line;</dd>
1515             <dt>command</dt> <dd>Show the link destination in the &tag.command-line;</dd>
1516         </dl>
1517     </description>
1518 </item>
1519
1520 <item>
1521     <tags>'stal' 'showtabline'</tags>
1522     <spec>'showtabline' 'stal'</spec>
1523     <type>&option.showtabline.type;</type>
1524     <default>&option.showtabline.default;</default>
1525     <description>
1526         <p>Define when the tab bar is visible.</p>
1527
1528         <dl>
1529             <dt>always</dt>   <dd>Always show the tab bar</dd>
1530             <dt>multitab</dt> <dd>Show the tab bar when there are multiple tabs</dd>
1531             <dt>never</dt>    <dd>Never show the tab bar</dd>
1532         </dl>
1533     </description>
1534 </item>
1535
1536 <item>
1537     <tags>'spl' 'spelllang'</tags>
1538     <spec>'spelllang' 'spl'</spec>
1539     <type>&option.spelllang.type;</type>
1540     <default>&option.spelllang.default;</default>
1541     <description short="true">
1542         <p>The language used by the spell checker.</p>
1543     </description>
1544 </item>
1545
1546 <item>
1547     <tags>'sf' 'strictfocus'</tags>
1548     <spec>'strictfocus' 'sf'</spec>
1549     <type>&option.strictfocus.type;</type>
1550     <default>&option.strictfocus.default;</default>
1551     <description>
1552         <p>
1553             Prevent scripts from focusing input elements without user intervention.
1554         </p>
1555
1556         <p>Possible values:</p>
1557
1558         <dl>
1559             <dt>despotic</dt>      <dd>Only allow focus changes when explicitly requested by the user</dd>
1560             <dt>laissez-faire</dt> <dd>Always allow focus changes</dd>
1561             <dt>moderate</dt>      <dd>Allow focus changes after user-initiated focus change</dd>
1562         </dl>
1563     </description>
1564 </item>
1565
1566 <item>
1567     <tags>'suggestengines'</tags>
1568     <spec>'suggestengines'</spec>
1569     <type>&option.suggestengines.type;</type>
1570     <default>&option.suggestengines.default;</default>
1571     <description>
1572         <p>
1573             Set the search engines which can be used for completion
1574             suggestions when <o>complete</o> contains <em>S</em>.
1575         </p>
1576     </description>
1577 </item>
1578
1579 <item>
1580     <tags>'notmo' 'notimeout'</tags>
1581     <tags>'tmo' 'timeout'</tags>
1582     <spec>'timeout' 'tmo'</spec>
1583     <type>&option.timeout.type;</type>
1584     <default>&option.timeout.default;</default>
1585     <description>
1586         <p>
1587             When this option is set and a key sequence interpretable both as a
1588             complete command and as a start of a longer command is typed,
1589             execute the shorter command after <o>timeoutlen</o> milliseconds.
1590         </p>
1591     </description>
1592 </item>
1593
1594 <item>
1595     <tags>'tmol' 'timeoutlen'</tags>
1596     <spec>'timeoutlen' 'tmol'</spec>
1597     <type>&option.timeoutlen.type;</type>
1598     <default>&option.timeoutlen.default;</default>
1599     <description>
1600         <p>
1601             Maximum number of milliseconds to wait for a longer key command
1602             when a shorter one exists. Only effective when <o>timeout</o> is
1603             set.
1604         </p>
1605     </description>
1606 </item>
1607
1608 <item>
1609     <tags>'titlestring'</tags>
1610     <spec>'titlestring'</spec>
1611     <type>&option.titlestring.type;</type>
1612     <default>&option.titlestring.default;</default>
1613     <description>
1614         <p>
1615             Set the application name shown after the current page title in
1616             &dactyl.host;'s title bar.
1617         </p>
1618         <example><set opt="titlestring"><str>Mozilla &dactyl.host;</str></set></example>
1619     </description>
1620 </item>
1621
1622 <item>
1623     <tags>'us' 'urlsep' 'urlseparator'</tags>
1624     <spec>'urlseparator' 'urlsep' 'us'</spec>
1625     <type>&option.urlseparator.type;</type>
1626     <default>&option.urlseparator.default;</default>
1627     <description>
1628         <p>
1629             The regular expression used to split URL lists in commands
1630             like <ex>:open</ex>. When set to the empty string, URL lists
1631             are never split. With the default settings, the following will open
1632             three URLs (the first one in the current tab and the latter two in
1633             two new background tabs):
1634         </p>
1635         <code><ex>:open <str delim="">google Linux</str> | <str delim="">wikipedia Arch Linux</str> | <str delim="">imdb Serenity</str></ex></code>
1636     </description>
1637 </item>
1638
1639 <item>
1640     <tags>'noum' 'nousermode'</tags>
1641     <tags>'um' 'usermode'</tags>
1642     <spec>'usermode' 'um'</spec>
1643     <type>&option.usermode.type;</type>
1644     <default>&option.usermode.default;</default>
1645     <description>
1646         <p>Show current website with minimal styling.</p>
1647     </description>
1648 </item>
1649
1650 <item>
1651     <tags>'vbs' 'verbose'</tags>
1652     <spec>'verbose' 'vbs'</spec>
1653     <type>&option.verbose.type;</type>
1654     <default>&option.verbose.default;</default>
1655     <description>
1656         <p>
1657             Define which info messages are displayed. As the value increases,
1658             &dactyl.appName; will show more messages about its progress.
1659             These can be viewed at any time with the <ex>:messages</ex>
1660             command. The highest useful value is 15, being the most verbose
1661             mode.
1662         </p>
1663         <!-- TODO: list levels and associated messages -->
1664     </description>
1665 </item>
1666
1667 <item>
1668     <tags>'novb' 'novisualbell'</tags>
1669     <tags>'vb' 'visualbell'</tags>
1670     <spec>'visualbell' 'vb'</spec>
1671     <type>&option.visualbell.type;</type>
1672     <default>&option.visualbell.default;</default>
1673     <description>
1674         <p>
1675             Use visual bell instead of beeping on errors. The visual bell
1676             style is controlled by <ex>:highlight Bell</ex>. See also
1677             <o>errorbells</o>.
1678         </p>
1679     </description>
1680 </item>
1681
1682 <item>
1683     <tags>'wia' 'wildanchor'</tags>
1684     <strut/>
1685     <spec>'wildanchor' 'wia'</spec>
1686     <type>&option.wildanchor.type;</type>
1687     <default>&option.wildanchor.default;</default>
1688     <description>
1689         <p>
1690             Regular expression list defining which completion groups show only
1691             matches anchored to the beginning of the result. The first
1692             matching expression is the one that applies. If the match is
1693             negated, then the current filter may match anywhere in the result.
1694             If it is not negated, then the match may only occur at the
1695             beginning of the result. If no items match, then a
1696             context-dependent default value is used.
1697         </p>
1698     </description>
1699 </item>
1700
1701 <item>
1702     <tags>'wic' 'wildcase'</tags>
1703     <spec>'wildcase' 'wic'</spec>
1704     <type>&option.wildcase.type;</type>
1705     <default>&option.wildcase.default;</default>
1706     <description>
1707         <p>
1708             Defines how completions are matched with regard to character case.
1709             Keys in the <t>regexpmap</t> refer to completion context names (see
1710             <ex>:contexts</ex>) for which the value applies. Possible values
1711             are:
1712         </p>
1713
1714         <dl>
1715             <dt><str>smart</str></dt>  <dd>Case is significant when capital letters are typed</dd>
1716             <dt><str>match</str></dt>  <dd>Case is always significant</dd>
1717             <dt><str>ignore</str></dt> <dd>Case is never significant</dd>
1718         </dl>
1719     </description>
1720 </item>
1721
1722 <item>
1723     <tags>'wig' 'wildignore'</tags>
1724     <spec>'wildignore' 'wig'</spec>
1725     <type>&option.wildignore.type;</type>
1726     <default>&option.wildignore.default;</default>
1727     <description>
1728         <p>
1729             List of path name patterns to ignore when completing files and
1730             directories. For example, the following will ignore object files
1731             and Vim swap files:
1732         </p>
1733
1734         <set opt="wildignore"><str delim="'">\.o$</str>,<str delim="'">^\..*\.s[a-z]{2}$</str></set>
1735
1736         <note>Unlike Vim, each pattern is a regular expression rather than a glob.</note>
1737     </description>
1738 </item>
1739
1740 <item>
1741     <tags>'wim' 'wildmode'</tags>
1742     <spec>'wildmode' 'wim'</spec>
1743     <type>&option.wildmode.type;</type>
1744     <default>&option.wildmode.default;</default>
1745     <description>
1746         <p>
1747             Defines how command-line completion works. It is a comma-separated
1748             list of parts, where each part specifies what to do for each
1749             consecutive press of the <k name="Tab" mode="c"/> key. The last
1750             element in the list is used for each succeeding <k name="Tab" mode="c"/>
1751             after it has been reached.
1752         </p>
1753
1754         <p>These are the possible values for each part:</p>
1755
1756         <dl>
1757             <dt><str></str></dt>             <dd>Complete only the first match.</dd>
1758             <dt><str>full</str></dt>         <dd>Complete the next full match. After the last, the original string is used.</dd>
1759             <dt><str>longest</str></dt>      <dd>Complete the longest common substring of all completions.</dd>
1760             <dt><str>list</str></dt>         <dd>When more than one match, list all matches.</dd>
1761             <dt><str>list:full</str></dt>    <dd>When more than one match, list all matches and complete the first match.</dd>
1762             <dt><str>list:longest</str></dt>
1763             <dd>
1764                 When more than one match, list all matches and
1765                 complete till the longest common string. When there
1766                 is only a single match, it is fully completed
1767                 regardless of the case.
1768             </dd>
1769         </dl>
1770
1771         <p>
1772             See also <o>altwildmode</o>.
1773         </p>
1774
1775     </description>
1776 </item>
1777
1778 <item>
1779     <tags>'wis' 'wildsort'</tags>
1780     <spec>'wildsort' 'wis'</spec>
1781     <type>&option.wildsort.type;</type>
1782     <default>&option.wildsort.default;</default>
1783     <description>
1784         <p>
1785             A list of regular expressions defining which completion contexts
1786             should be sorted. The main purpose of this option is to prevent
1787             sorting of certain completion lists that don't perform well under
1788             load.
1789         </p>
1790
1791         <p>See also <ex>:contexts</ex>.</p>
1792     </description>
1793 </item>
1794
1795 <item>
1796     <tags>'wsp' 'wordseparators'</tags>
1797     <spec>'wordseparators' 'wsp'</spec>
1798     <strut/>
1799     <type>&option.wordseparators.type;</type>
1800     <default>&option.wordseparators.default;</default>
1801     <description>
1802         <p>
1803             A regular expression which defines how words are split for
1804             the <o>hintmatching</o> types <str>wordstartswith</str> and
1805             <str>firstletters</str>. Words are split on each occurrence of the
1806             given pattern.
1807         </p>
1808     </description>
1809 </item>
1810
1811 <item>
1812     <tags>'ys' 'yankshort'</tags>
1813     <spec>'yankshort' 'ys'</spec>
1814     <type>&option.yankshort.type;</type>
1815     <default>&option.yankshort.default;</default>
1816     <description>
1817         <p>Yank the canonical short URL of a web page where provided.</p>
1818     </description>
1819 </item>
1820
1821
1822 </document>
1823
1824 <!-- vim:se sts=4 sw=4 et: -->