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