1 <?xml version="1.0" encoding="UTF-8"?>
2 <?xml-stylesheet type="text/xsl" href="dactyl://content/help.xsl"?>
4 <!DOCTYPE document SYSTEM "dactyl://content/dtd">
8 title="&dactyl.appName; Options"
10 xmlns:html="&xmlns.html;">
12 <h1 tag="options">Options</h1>
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:
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>
25 <dt/><dd tag="charlist"/>
27 <dd>A string containing a discrete set of distinct characters</dd>
29 <dt/><dd tag="stringlist"/>
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
37 <dt/><dd tag="stringmap"/>
39 <dd>A comma-separated list of key-value pairs, e.g., <str delim="">key:val,foo:bar</str></dd>
41 <dt/><dd tag="regexplist"/>
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.
53 <dt/><dd tag="regexpmap"/>
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.
63 <dt>sitelist</dt> <dd tag="sitelist sitemap"/>
66 Like <t>regexplist</t> and <t>regexpmap</t>, but the keys are
67 <t>site-filters</t> rather than regular expressions.
71 <p tag="macro-string">
72 Some options may be given format strings containing macro replacements in
73 the form of <tt><<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><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><e-<a>name</a>></tt>, its value is never shown but may be
78 used to test whether the given parameter is empty.
81 Any substring enclosed by <em><tt><{</tt></em> and <em><tt>}></tt></em>
82 is automatically elided if any of the contained macros aren't currently
83 valid. A literal <em><tt><</tt></em> or <em><tt>></tt></em> character may
84 be included with the special escape sequences <tt><lt></tt> or
85 <tt><gt></tt> respectively.
88 <p style="text-align: left">
89 For example, given the format string
90 <str><{(cmd: <column>) }><{line: <line> }><file></str>,
91 where <em>line</em>=<hl key="Number">32</hl> and
92 <em>file</em>=<str delim="'">Lieder eines fahrenden Gesellen.txt</str>,
93 the result is formatted as
94 <str>line: 32 'Lieder eines fahrenden Gesellen.txt'</str>
97 <h2 tag="set-option E764">Setting options</h2>
100 <tags>:set :se</tags>
101 <spec>:se<oa>t</oa></spec>
102 <description short="true">
103 <p>Show all options which differ from their default values.</p>
108 <spec>:se<oa>t</oa> all</spec>
109 <description short="true">
110 <p>Show all options.</p>
115 <tags>E518 E519</tags>
116 <spec>:se<oa>t</oa> <a>option</a>?</spec>
118 <p>Show value of <a>option</a>.</p>
123 <spec>:se<oa>t</oa> <a>option</a> <oa>...</oa></spec>
126 For boolean options, turn them on. For all other types,
133 <spec>:se<oa>t</oa> no<a>option</a> <oa>...</oa></spec>
136 For boolean options, turn them off. For all other types,
143 <spec>:se<oa>t</oa> <a>option</a>! <oa>...</oa></spec>
144 <spec>:se<oa>t</oa> inv<a>option</a> <oa>...</oa></spec>
147 For boolean options, invert their value. For all other types,
154 <spec>:se<oa>t</oa> inv<a>option</a>=<a>value</a> <oa>...</oa></spec>
155 <spec>:se<oa>t</oa> <a>option</a>!=<a>value</a> <oa>...</oa></spec>
157 <p>For list options, toggle the specified values.</p>
159 <p style="text-align: left;">
160 If the option is a list, the given values are toggled. Given,
161 <se opt="opt" link="false"><str delim="">foo</str>,<str delim="">bar</str></se>
163 <se opt="opt" op="!=" link="false"><str delim="">foo</str>,<str delim="">baz</str></se>
164 has the same result as
165 <se opt="opt" link="false"><str delim="">bar</str>,<str delim="">baz</str></se>
169 This extends to string options in a natural way, e.g.,
170 <se opt="stal" op="!="><str delim="">always</str>,<str delim="">never</str></se>
171 toggles between the two values.
177 <tags>:set-default</tags>
178 <spec>:se<oa>t</oa> <a>option</a>& <oa>...</oa></spec>
180 <p>Reset option to its default value.</p>
185 <spec>:se<oa>t</oa> all&</spec>
187 <p>Set all options to their default value.</p>
192 <tags>:set-args E487 E521</tags>
193 <spec>:se<oa>t</oa> <a>option</a>=<a>value</a> <oa>...</oa></spec>
196 Set string or number option to <a>value</a>.
197 For numeric options the value must be given in decimal.
198 The old value can be inserted by typing <k name="Tab" mode="c"/>.
205 <spec>:se<oa>t</oa> <a>option</a>+=<a>value</a> <oa>...</oa></spec>
208 Add the <a>value</a> to a number option, or append the <a>value</a>
209 to a string option. When the option is a comma separated list, a
210 comma is added, unless the value was empty. If the option is a list
211 of flags, superfluous flags are removed. When adding a flag that
212 was already present the option value doesn't change.
219 <spec>:se<oa>t</oa> <a>option</a>^=<a>value</a> <oa>...</oa></spec>
222 Multiply the <a>value</a> to a number option, or prepend the
223 <a>value</a> to a string option. When the option is a comma
224 separated list, a comma is added, unless the value was empty.
231 <spec>:se<oa>t</oa> <a>option</a>-=<a>value</a> <oa>...</oa></spec>
234 Subtract the <a>value</a> from a number option, or remove the
235 <a>value</a> from a string option if it is there. If the
236 <a>value</a> is not found in a string option, there is no error or
237 warning. When the option is a comma separated list, a comma is
238 deleted, unless the option becomes empty. When the option is a list
239 of flags, <a>value</a> must be exactly as they appear in the option.
240 Remove flags one by one to avoid problems.
246 <tags>:setlocal :setl</tags>
247 <spec>:setl<oa>ocal</oa> …</spec>
250 The same as <ex>:set</ex> command, but operates on current tab options
251 only. See <ex>:set</ex> for details.
257 <tags>:setglobal :setg</tags>
258 <spec>:setg<oa>lobal</oa> …</spec>
261 The same as <ex>:set</ex> command, but operates on global options only.
262 See <ex>:set</ex> for details.
267 <p tag="expand-environment-var expand-env :set_env">
268 Environment variables are expanded for path options like <o>cdpath</o> and
269 <o>runtimepath</o>. The variable notation is <em>$VAR</em> (terminated by a non-word
270 character) or <em>${VAR}</em>. <em>%VAR%</em> is also supported on Windows.
273 <h2 tag="&dactyl.host;-options preferences">Setting &dactyl.host; options</h2>
275 <p>&dactyl.host; options can be viewed and set with the following commands:</p>
278 <tags>:pref :prefs :preferences</tags>
279 <spec>:pref<oa>erences</oa></spec>
282 Show the &dactyl.host; preferences dialog. You can change the browser
283 preferences from this dialog. Be aware that not all &dactyl.host;
284 preferences work, because &dactyl.appName; overrides some key bindings and
285 changes &dactyl.host;'s GUI.
291 <tags>:pref! :prefs! :preferences!</tags>
292 <spec>:pref<oa>erences</oa>!</spec>
295 Opens about:config in the current tab, where you can change advanced &dactyl.host;
302 <tags>:set! :set-!</tags>
303 <spec>:se<oa>t</oa>! <a>preference</a>=<a>value</a></spec>
304 <spec>:se<oa>t</oa>! <a>preference</a>&</spec>
307 Change any &dactyl.host; <a>preference</a> (those on the about:config
308 page). You can also reset/delete these preferences with
309 <ex>:set! <a>preference</a>&</ex>.
314 <p tag="overridden-preferences">
315 &dactyl.appName; needs to set several &dactyl.host; preferences at
316 startup in order to function properly. If this is unacceptable,
317 they can be changed in your RC file with the <ex>:set!</ex>
318 command, but beware of unexpected behavior. The affected
323 <li><pref>accessibility.typeaheadfind</pref></li>
326 <h2 tag="list-options">List of options</h2>
329 <tags>'act' 'activate'</tags>
331 <spec>'activate' 'act'</spec>
332 <type>stringlist</type>
333 <default>addons,bookmarks,diverted,downloads,extoptions,
334 help,homepage,quickmark,tabopen,paste</default>
337 A list of items which, when opened in a new tab, are
338 automatically focused. Available items:
342 <dt>all</dt> <dd>Activate all items.</dd>
343 <dt>addons</dt> <dd><ex>:addo<oa>ns</oa></ex> command</dd>
344 <dt>bookmarks</dt> <dd>Tabs loaded from bookmarks</dd>
345 <dt>diverted</dt> <dd>Links with targets set to new tabs</dd>
346 <dt>downloads</dt> <dd><ex>:downl<oa>oads</oa></ex> command</dd>
347 <dt>extoptions</dt> <dd><ex>:exto<oa>ptions</oa></ex> command</dd>
348 <dt>help</dt> <dd><ex>:h<oa>elp</oa></ex> command</dd>
349 <dt>homepage</dt> <dd><k>gH</k> mapping</dd>
350 <dt>links</dt> <dd>Middle- or Control-clicked links</dd>
351 <dt>quickmark</dt> <dd><k>go</k> and <k>gn</k> mappings</dd>
352 <dt>tabopen</dt> <dd><ex>:tabopen<oa>!</oa></ex> command</dd>
353 <dt>paste</dt> <dd><k>P</k> and <k>gP</k> mappings</dd>
359 <tags>'awim' 'altwildmode'</tags>
360 <spec>'altwildmode' 'awim'</spec>
361 <type>stringlist</type>
362 <default>list:full</default>
365 Like <o>wildmode</o>, but when the <k name="A-Tab" mode="c"/> key
372 <tags>'au' 'autocomplete'</tags>
373 <spec>'autocomplete' 'au'</spec>
374 <type>regexplist</type>
375 <default>.*</default>
378 Enables automatic completion for completion contexts (see
379 <ex>:contexts</ex>) matching the given regular expressions. When
380 automatic completion is enabled, the completion list is
381 automatically opened when the &tag.command-line; is focused.
382 Thereafter, any key press triggers a completion update for the
383 matching contexts. Non-matching contexts will only be updated when
384 the <k name="Tab" mode="c"/> key is pressed. This option is useful
385 for disabling auto-completion for computationally intensive
386 contexts that don't perform well when your system is under load.
390 Completion contexts have names very much like Unix path names.
391 These denote the tree in which they're called. A completer will
392 never be called unless every completer preceding it in the tree
393 was also called. For example, if your completer excludes
394 <str>/ex/</str>, it will also exclude <str>/ex/bmarks</str>, and
399 To enable auto-completion for everything but <ex>:history</ex> or
400 <ex>:bmarks</ex>, you would choose a value such as
401 <str delim="">!/ex/(bmarks|history),.?</str>
405 To go in the other direction, i.e. <em>only</em> enable
406 auto-completion for those commands, you have to jump through
407 some hoops, due to the way contexts work (see the note above):
408 <str delim="">/ex/(bmarks|history),^(/|/ex/?)$</str>
414 <tags>'bh' 'banghist'</tags>
415 <spec>'banghist' 'bh'</spec>
417 <default>on</default>
420 Replace occurrences of ! with the previous command when
421 executing external commands.
428 <tags>'cd' 'cdpath'</tags>
429 <spec>'cdpath' 'cd'</spec>
430 <type>stringlist</type>
431 <default type="plain">equivalent to <str>.</str> or <str>.,$CDPATH</str></default>
434 List of directories searched when executing the <ex>:cd</ex>
435 command. This is only used for relative paths; if an absolute path is
436 specified, this option is ignored.
439 If the <em>CDPATH</em> environment variable is set this path list
440 is appended to the default value of <str>.</str>.
446 <tags>'ca' 'cookieaccept'</tags>
447 <spec>'cookieaccept' 'ca'</spec>
449 <default>all</default>
451 <p>When to accept cookies.</p>
454 <dt>all</dt> <dd>Accept all cookies</dd>
455 <dt>none</dt> <dd>Accept no cookies</dd>
456 <dt>samesite</dt> <dd>Accept all non-third-party cookies</dd>
462 <tags>'cl' 'cookielifetime'</tags>
463 <spec>'cookielifetime'</spec>
465 <default>default</default>
468 The lifetime for which to accept cookies. The available
472 <dt>default</dt> <dd>The lifetime requested by the setter</dd>
473 <dt>prompt</dt> <dd>Always prompt for a lifetime</dd>
474 <dt>session</dt> <dd>The current session</dd>
475 <dt><a>days</a></dt> <dd>When a number is given, it is
476 interpreted as the number of days for which to keep
483 <tags>'ck' 'cookies'</tags>
484 <spec>'cookies' 'ck'</spec>
485 <type>stringlist</type> <default>session</default>
487 <p>The default action for the <ex>:cookies</ex> command.</p>
492 <tags>'cpt' 'complete'</tags>
493 <spec>'complete' 'cpt'</spec>
494 <type>charlist</type>
495 <default>slf</default>
497 <p>Items which are completed at the <ex>:open</ex> prompts. Available items:</p>
499 <dl dt="width: 6em;">
500 <dt>s</dt> <dd>Search engines and keyword URLs</dd>
501 <dt>f</dt> <dd>Local files</dd>
502 <dt>l</dt> <dd>&dactyl.host; location bar entries (bookmarks and history sorted in an intelligent way)</dd>
503 <dt>b</dt> <dd>Bookmarks</dd>
504 <dt>h</dt> <dd>History</dd>
505 <dt>S</dt> <dd>Search engine suggestions</dd>
509 The order is important, such that <se opt="complete"><str delim="">bsf</str></se> will
510 list bookmarks followed by matching quick searches and then
515 Using <em>b</em> and <em>h</em> can make completion very slow if
516 there are many items.
522 <tags>'ds' 'defsearch'</tags>
523 <spec>'defsearch' 'ds'</spec>
525 <default>google</default>
528 Sets the default search engine. The default search engine is
529 used by <ex>:open</ex> and related commands for arguments which
530 include no search or bookmark keywords and can't otherwise be
531 converted into URLs or existing file names.
535 This means that with <o>defsearch</o> set to <str>youtube</str>,
536 <ex>:open Tim Minchin</ex> behaves exactly as
537 <ex>:open youtube Tim Minchin</ex>, so long as you don't have a
538 search or bookmark keyword called ‘Tim’.
544 <tags>'editor'</tags>
545 <spec>'editor'</spec>
547 <default><![CDATA[gvim -f +<line> <file>]]></default>
550 Set the external text editor.
551 This is the editor used by <k name="C-i" mode="I"/>, <k>gF</k>, and
552 other commands which launch an external text editor.
556 Accepts a <t>macro-string</t> with the following escapes available.
557 Arguments containing escapes which are not relevant to a given call
558 are automatically elided. All field splitting is done before format
559 characters are processed.
563 <dt><file></dt> <dd>The file to edit. Appended as the final argument if missing.</dd>
564 <dt><line></dt> <dd>The line number at which to position the cursor.</dd>
565 <dt><column></dt> <dd>The column at which to position the cursor.</dd>
569 &dactyl.appName; will not behave correctly if the editor forks its
570 own process rather than blocking until editing is complete. Gvim
571 invoked without the <em>-f</em> option is one such example.
577 <tags>'enc' 'encoding'</tags>
578 <spec>'encoding' 'enc'</spec>
580 <default>UTF-8</default>
583 Changes the character encoding of the current buffer. Valid only
584 until a new page is loaded.
590 <tags>'noeb' 'noerrorbells'</tags>
591 <tags>'eb' 'errorbells'</tags>
592 <spec>'errorbells' 'eb'</spec>
594 <default>off</default>
597 Ring the bell when an error message is displayed. See also
604 <tags>'ei' 'eventignore'</tags>
605 <spec>'eventignore' 'ei'</spec>
606 <type>stringlist</type>
610 A list of autocommand event names which should be ignored. If the
611 list contains the value <str>all</str> then all events are
618 <tags>'noex' 'noexrc'</tags>
619 <tags>'ex' 'exrc'</tags>
620 <spec>'exrc' 'ex'</spec>
622 <default>off</default>
625 Allow reading of an RC file in the current directory. This file is
626 sourced after the default <tt><t>&dactyl.name;rc</t></tt> file in your
633 <tags>'eht' 'extendedhinttags'</tags>
634 <spec>'extendedhinttags' 'eht'</spec>
636 <type>regexpmap</type>
637 <default>[asOTivVWy]:a[href],area[href],img[src],iframe[src],
639 [F]:body,code,div,html,p,pre,span,
641 [S]:button,'input:not([type=hidden])',select,textarea</default>
644 Defines specialized CSS selectors or XPath expressions for arbitrary
645 <t>extended-hints</t> modes. The syntax is the same as for
646 <o>hinttags</o>. If no matches are found, the value of
647 <o>hinttags</o> is used.
653 <tags>'fenc' 'fileencoding'</tags>
654 <spec>'fileencoding' 'fenc'</spec>
656 <default>UTF-8</default>
659 Changes the character encoding that &dactyl.appName; uses to read
666 <tags>'fc' 'findcase'</tags>
667 <spec>'findcase' 'fc'</spec>
669 <default>smart</default>
671 <p>Find case matching mode.</p>
674 <dt>ignore</dt> <dd>Case is never significant</dd>
675 <dt>match</dt> <dd>Case is always significant</dd>
676 <dt>smart</dt> <dd>Case is significant when capital letters are typed</dd>
682 <tags>'fh' 'followhints'</tags>
683 <spec>'followhints' 'fh'</spec>
687 <p>Changes how soon matching hints are followed in Hints mode.</p>
689 <p>Possible values:</p>
691 <dl dt="width: 6em;">
692 <dt>0</dt> <dd>Follow the first hint as soon as typed text uniquely identifies it.</dd>
693 <dt>1</dt> <dd>Follow the selected hint on <k name="CR"/>.</dd>
694 <dt>2</dt> <dd>Follow the selected hint on <k name="CR"/> only if it's been <k name="Tab" mode="c"/>-selected.</dd>
700 <tags>'nofs' 'nofullscreen'</tags>
701 <tags>'fs' 'fullscreen'</tags>
702 <spec>'fullscreen' 'fs'</spec>
704 <default>off</default>
707 Show the current window full-screen. Also hide certain GUI elements, such as
708 <t>status-line</t> and tab bar.
714 <tags>'go' 'guioptions'</tags>
715 <spec>'guioptions' 'go'</spec>
716 <type>charlist</type>
717 <default>bCrs</default> <!-- TODO: make this config specific -->
719 <p>Show or hide certain GUI elements.</p>
721 <p>Supported characters:</p>
723 <dl dt="width: 6em;">
724 <dt>B</dt> <dd>Bookmark bar</dd>
725 <dt>C</dt> <dd>Always show the command line outside of the status line</dd>
726 <dt>M</dt> <dd>Always show messages outside of the status line</dd>
727 <dt>N</dt> <dd>Tab number over image</dd>
728 <dt>T</dt> <dd>Toolbar</dd>
729 <dt>b</dt> <dd>Bottom scrollbar</dd>
730 <dt>c</dt> <dd>Always show the command line, even when empty</dd>
731 <dt>l</dt> <dd>Left scrollbar (<em>l</em> and <em>r</em> are mutually exclusive)</dd>
732 <dt>m</dt> <dd>Menu bar</dd>
733 <dt>n</dt> <dd>Tab number</dd>
734 <dt>r</dt> <dd>Right scrollbar</dd>
735 <dt>s</dt> <dd>Status bar</dd>
738 <p>See also <o>showtabline</o>.</p>
740 <note>Scrollbar changes require a page reload to take effect.</note>
741 <note>Only one of <em>l</em> or <em>r</em> may be included.</note>
746 <tags>'hf' 'helpfile'</tags>
747 <spec>'helpfile' 'hf'</spec>
749 <default>intro</default>
752 Name of the main help file. This is that page shown if the
753 <ex>:help</ex> command is called without any arguments.
759 <tags>'hin' 'hintinputs'</tags>
760 <spec>'hintinputs' 'hin'</spec>
761 <type>stringlist</type>
762 <default>label,value</default>
765 When generating hints for input elements that do not have an
766 explicit caption, this specifies the methods used to generate a
767 textual hint. The options are attempted in the order they are
768 given, and the first successful value is used.
771 <dl dt="width: 8em;">
772 <dt>value</dt> <dd>The hint is the value displayed in a text input, or the selected option for a drop-down.</dd>
773 <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>
774 <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>
780 <tags>'hk' 'hintkeys'</tags>
781 <spec>'hintkeys' 'hk'</spec>
783 <default>0123456789</default>
786 The keys used to label and select hints. With its default value,
787 each hint has a unique number which can be typed to select it,
788 while all other characters are used to filter hints based on their
789 text. With a value such as <str>asdfg;lkjh</str>, each hint is
790 ‘numbered’ based on the characters of the home row.
796 <tags>'hm' 'hintmatching'</tags>
797 <spec>'hintmatching' 'hm'</spec>
798 <type>stringlist</type>
799 <default>contains</default>
801 <p>Change the hint matching algorithm used in Hints mode.</p>
803 <p>Possible values:</p>
808 The typed characters are split on whitespace, and
809 these character groups have to match anywhere inside
810 the text of the link.
812 <dt>wordstartswith</dt>
814 The typed characters are matched with the beginning
815 of the first word (see <o>wordseparators</o>) in the
816 link as long as possible. If no matches occur in the
817 current word, then the matching is continued at the
818 beginning of the next word. The words are worked
819 through in the order they appear in the link. If the
820 typed characters contain spaces, then the characters
821 are split on whitespace. These character groups are
822 then matched with the beginning of the words,
823 beginning at the first one and continuing with the
824 following words in the order they appear in the
827 <dt>firstletters</dt>
829 Behaves like wordstartswith, but non-matching words
834 Delegate to the function
835 <tt>dactyl.plugins.customHintMatcher</tt>.
837 <dt>transliterated</dt>
839 Certain alphanumeric characters are transliterated into their
840 unaccented equivalents, such that ‘euro’ will match 'æuró',
841 and ‘Ångström’ will match ‘angstrom’.
848 <tags>'ht' 'hinttags'</tags>
850 <spec>'hinttags' 'ht'</spec>
851 <type>stringlist</type>
852 <default>a,area,button,iframe,input:not([type=hidden]),select,textarea,
853 [onclick],[onmouseover],[onmousedown],[onmouseup],[oncommand],
854 [tabindex],[role=link],[role=button]</default>
857 A list of CSS selectors or XPath expressions used to select elements
858 for <link topic="hints">hinting</link>. Values beginning with the
859 string <str>xpath:</str> are treated as XPath expressions, while any
860 other values are treated as CSS selectors. Can be overridden for
861 individual <t>extended-hints</t> modes with the
862 <o>extendedhinttags</o> option.
868 <tags>'hto' 'hinttimeout'</tags>
869 <spec>'hinttimeout' 'hto'</spec>
874 Timeout in milliseconds before automatically following a non-unique
875 hint. The timeout is measured since the last time a key listed in
876 <o>hintkeys</o> was pressed. It has no effect when narrowing hints
877 by typing part of their text. Set to 0 (the default) to only follow
878 hints after pressing <k name="CR"/> or when the hint is unique.
884 <tags>'hi' 'history'</tags>
885 <spec>'history' 'hi'</spec>
887 <default>500</default>
890 Maximum number of Ex commands and find patterns to store in the
891 <t>command-line</t> history.
897 <tags>'nohlf' 'nohlfind'</tags>
898 <tags>'hlf' 'hlfind'</tags>
899 <spec>'hlfind' 'hlf'</spec>
901 <default>off</default>
903 <p>Highlight previous find pattern matches.</p>
908 <tags>'noif' 'noincfind'</tags>
909 <tags>'if' 'incfind'</tags>
910 <spec>'incfind' 'if'</spec>
912 <default>on</default>
914 <p>Show the first match for a find pattern as it is typed.</p>
919 <tags>'noim' 'noinsertmode'</tags>
920 <tags>'im' 'insertmode'</tags>
921 <spec>'insertmode' 'im'</spec>
923 <default>on</default>
926 Use Insert mode as the default for text areas. This is useful if you
927 want to use the known &dactyl.host; interface for editing text areas.
928 Input fields default to this behavior irrespective of this option's
933 TextEdit mode can be entered with <k name="C-t" mode="I"/> from Insert mode.
939 <tags>'nojsd' 'nojsdebugger'</tags>
940 <tags>'jsd' 'jsdebugger'</tags>
941 <spec>'jsdebugger' 'jsd'</spec>
943 <default>off</default>
946 Use the JavaScript debugger service for JavaScript completion.
952 <tags>'nolpl' 'noloadplugins'</tags>
953 <tags>'lpl' 'loadplugins'</tags>
954 <spec>'loadplugins' 'lpl'</spec>
955 <type>regexplist</type>
956 <default>'\.(js|&dactyl.fileExt;)$'</default>
959 A regular expression list that defines which plugins are loaded at
960 startup or via <ex>:loadplugins</ex>. The first item to match is
961 the one that takes effect. If no items match, the file is not
962 loaded. Setting this to a blank value effectively disables plugin
966 For example, to prepend to the default value of this option to load
967 all plugins except for <em>foobar-plugin</em>, you could use:
969 <set opt="loadplugins" op="^=">!<str delim="'">foobar-plugin</str></set>
971 Alternatively, you can specify which plugins to load and which to
972 omit in your <tt><t>&dactyl.name;rc</t></tt> using something like
975 <set opt="loadplugins">!<str delim="'">foo|bar</str>,<str delim="'">\.(js|&dactyl.fileExt;)$</str></set>
977 That will load all plugins but <em>foo</em> and <em>bar</em>.
980 Note that in the first expression of the latter example you don't
981 need parentheses, as the <em>!</em> negates the whole of the
982 following expression (cf. <t>regexplist</t>).
985 See also <ex>:runtime</ex>.
991 <tags>'ml' 'mapleader'</tags>
992 <spec>'mapleader' 'ml'</spec>
996 <p>Defines the replacement keys for the <k name="Leader"/> pseudo-key.</p>
1001 <tags>'maxitems'</tags>
1002 <spec>'maxitems'</spec>
1004 <default>20</default>
1006 <p>Maximum number of items to display at once in a listing.</p>
1011 <tags>'msgs' 'messages'</tags>
1012 <spec>'messages' 'msgs'</spec>
1014 <default>100</default>
1016 <p>Maximum number of messages to store in the message history.</p>
1021 <tags>'nomore' 'more'</tags>
1023 <type>boolean</type>
1024 <default>on</default>
1027 Pause the message list window when more than one screen of
1028 listings is displayed.
1034 <tags>'newtab'</tags>
1035 <spec>'newtab'</spec>
1036 <type>stringlist</type>
1040 Defines which Ex commands open pages in new tabs rather than the
1041 current tab by default. This may be overridden with the
1042 <ex>:tab</ex> command, and is usually inverted by affixing a
1043 <em>!</em> to the command in question.
1046 <p>Possible values:</p>
1049 <dt>all</dt> <dd>All commands</dd>
1050 <dt>addons</dt> <dd><ex>:addo<oa>ns</oa></ex> command</dd>
1051 <dt>downloads</dt> <dd><ex>:downl<oa>oads</oa></ex> command</dd>
1052 <dt>extoptions</dt> <dd><ex>:exto<oa>ptions</oa></ex> command</dd>
1053 <dt>help</dt> <dd><ex>:h<oa>elp</oa></ex> command</dd>
1054 <dt>javascript</dt> <dd><ex>:javascript!</ex> or <ex>:js!</ex> command</dd>
1055 <dt>prefs</dt> <dd><ex>:pref<oa>erences</oa>!</ex> or <ex>:prefs!</ex> command</dd>
1062 <tags>'nextpattern'</tags>
1064 <spec>'nextpattern'</spec>
1065 <type>stringlist</type>
1066 <default>'\bnext',^>$,'^(>>|»)$','^(>|»)','(>|»)$','\bmore\b'</default>
1069 Patterns to use when guessing the next page in a document
1070 sequence after pressing the <k>]]</k> key. Each pattern is
1071 successively tested against each link in the page (as defined by
1072 <o>hinttags</o>, starting with the last), and the first link to
1079 <tags>'noonline' 'online'</tags>
1080 <spec>'online'</spec>
1081 <type>boolean</type>
1082 <default>on</default>
1085 Enables or disables ‘offline’ mode, where network access is
1086 disabled and all web pages are loaded entirely from cache.
1092 <tags>'pa' 'pageinfo'</tags>
1093 <spec>'pageinfo' 'pa'</spec>
1094 <type>charlist</type>
1095 <default>gfm</default>
1097 <p>Info shown in the <ex>:pageinfo</ex> output.</p>
1099 <p>Items available by default:</p>
1101 <dl dt="width: 6em;">
1102 <dt>g</dt> <dd>General info</dd>
1103 <dt>f</dt> <dd>Feeds</dd>
1104 <dt>m</dt> <dd>Meta tags</dd>
1108 The order of the options defines the order in which they appear in
1115 <tags>'pk' 'passkeys'</tags>
1116 <spec>'passkeys' 'pk'</spec>
1117 <type>sitemap</type>
1121 Pass certain keys through directly for the given URLs.
1122 For any page with a URL matching a given regexp, all key
1123 events for keys listed in that regexp's value are passed
1124 through directly to &dactyl.host;, and are not processed
1125 by &dactyl.appName; in any way. Key names are separated
1126 by commas, where the first key name is treated as a list
1127 of individual keys and each subsequent key is treated as
1128 a key chain. Individual key entries always apply to all
1129 modes. Key chains apply only to non-input modes unless
1130 they begin with a key requiring a modifier other than
1134 <example><set opt="passkeys" op="+="><str delim="">mail.google.com</str>:<str delim="">jk<CR></str>,<str delim="">gi</str></set></example>
1137 More subtle and complex pass through can be achieved
1138 using <t>groups</t> and mode-specific mappings utilizing
1139 the <k name="Pass"/> pseudo-key.
1145 <tags>'pps' 'popups'</tags>
1146 <spec>'popups' 'pps'</spec>
1147 <type>stringlist</type>
1148 <default>tab</default>
1151 Defines where to show requested pop-up windows. Applies only to
1152 links which request to open in a new window. The behavior of
1153 middle-, shift-, or control- clicking a link is unaffected by this
1157 <p>Possible values are:</p>
1159 <dl dt="width: 8em;">
1160 <dt>tab</dt> <dd>Open pop-ups in a new tab</dd>
1161 <dt>window</dt> <dd>Open pop-ups in a new window</dd>
1162 <dt>resized</dt> <dd>Open resized pop-ups in a new window</dd>
1166 If neither <em>tab</em> nor <em>window</em> is provided, all
1167 pop-ups open in the current tab. <em>tab</em> and <em>window</em>
1168 are mutually exclusive, and the last one listed is effective.
1172 This option does not alter the &dactyl.host; pop-up blocker behavior
1179 <tags>'previouspattern'</tags>
1181 <spec>'previouspattern'</spec>
1182 <type>stringlist</type>
1183 <default><![CDATA['\bprev|previous\b',^<$,'^(<<|«)$','^(<|«)','(<|«)$']]></default>
1186 Patterns to use when guessing the previous page in a document
1187 sequence after pressing the <k>[[</k> key. Each pattern is
1188 successively tested against each link in the page (as defined by
1189 <o>hinttags</o>, starting with the last), and the first link to
1196 <tags>'noprivate' 'private'</tags>
1197 <spec>'private'</spec>
1198 <type>boolean</type>
1199 <default>off</default>
1202 Set the <str>private browsing</str> option. In private browsing mode
1203 history, cache files, cookies, form data, passwords, download list
1204 entries, local and URL <t>marks</t>, <t>command-line</t> history
1205 and macros are available only for the duration of the private
1206 browsing session and deleted when returning to normal browsing
1207 mode. See also <t>privacy</t>.
1213 <tags>$&dactyl.idName;_RUNTIME</tags>
1214 <tags>'rtp' 'runtimepath'</tags>
1215 <spec>'runtimepath' 'rtp'</spec>
1216 <type>stringlist</type>
1217 <default type="plain"><str>$&dactyl.idName;_RUNTIME</str> or
1218 Unix, Mac: <str>~/.&dactyl.name;</str>
1219 Windows: <str>~/&dactyl.name;</str></default>
1221 <p>List of directories searched for runtime files:</p>
1231 <set opt="runtimepath"><str delim="">~/my&dactyl.name;</str>,<str delim="">~/.&dactyl.name;</str></set>
1234 This will search for plugins in both
1235 <str>~/my&dactyl.name;/plugins</str> and
1236 <str>~/.&dactyl.name;/plugins</str>
1240 On startup, if the environment variable <em>$&dactyl.idName;_RUNTIME</em> does not
1241 exist, &dactyl.appName; will set it to match this value.
1247 <tags>'si' 'sanitizeitems'</tags>
1248 <spec>'sanitizeitems' 'si'</spec>
1250 <type>stringlist</type>
1251 <default>all</default>
1254 The default list of private items to sanitize. See
1255 <ex>:sanitize</ex> for a list and explanation of possible values.
1261 <tags>'ss' 'sanitizeshutdown'</tags>
1262 <spec>'sanitizeshutdown' 'ss'</spec>
1263 <type>stringlist</type>
1266 <p>The items to sanitize automatically at shutdown.</p>
1271 <tags>'sts' 'sanitizetimespan'</tags>
1272 <spec>'sanitizetimespan' 'sts'</spec>
1275 <default>all</default>
1278 The default sanitizer time span. Only items created within this timespan are
1279 deleted. The value must be of the one of:
1282 <dl dt="width: 8em;">
1283 <dt>all</dt> <dd>Everything</dd>
1284 <dt>session</dt> <dd>The current session</dd>
1285 <dt><a>n</a>m</dt> <dd>Past <a>n</a> Minutes</dd>
1286 <dt><a>n</a>h</dt> <dd>Past <a>n</a> Hours</dd>
1287 <dt><a>n</a>d</dt> <dd>Past <a>n</a> Days</dd>
1288 <dt><a>n</a>w</dt> <dd>Past <a>n</a> Weeks</dd>
1294 <tags>'scr' 'scroll'</tags>
1295 <spec>'scroll' 'scr'</spec>
1297 <default>0</default>
1300 Number of lines to scroll with <k name="C-u"/> and <k name="C-d"/>
1301 commands. The number of lines scrolled defaults to half the window
1302 size. When a <oa>count</oa> is specified to the <k name="C-u"/> or
1303 <k name="C-d"/> commands, that value is used instead. When the
1304 value is <em>0</em>, it defaults to half the window height.
1310 <tags>'sh' 'shell'</tags>
1311 <spec>'shell' 'sh'</spec>
1313 <default type="plain"><em>$SHELL</em> or <str>sh</str>, Windows: <str>cmd.exe</str></default>
1315 <p>Shell to use for executing <ex>:!</ex> and <ex>:run</ex> commands.</p>
1320 <tags>'shcf' 'shellcmdflag'</tags>
1321 <spec>'shellcmdflag' 'shcf'</spec>
1324 <default type="plain"><str>-c</str>, Windows: <str>/c</str></default>
1326 <p>Flag passed to shell when executing <ex>:!</ex> and <ex>:run</ex> commands.</p>
1331 <tags>'nosmd' 'noshowmode'</tags>
1332 <tags>'smd' 'showmode'</tags>
1333 <spec>'showmode' 'smd'</spec>
1334 <type>regexplist</type>
1335 <default>!^normal$</default>
1337 <p>Show the current mode in the command line if it matches this expression.</p>
1342 <tags>'ssli' 'showstatuslinks'</tags>
1343 <spec>'showstatuslinks' 'ssli'</spec>
1346 <default>status</default>
1349 When the mouse hovers over a link, or a link is otherwise focused,
1350 show its destination in the status bar.
1353 <p>Possible values are:</p>
1356 <dt></dt> <dd>Don't show link destination</dd>
1357 <dt>status</dt> <dd>Show the link destination in the &tag.status-line;</dd>
1358 <dt>command</dt> <dd>Show the link destination in the &tag.command-line;</dd>
1364 <tags>'stal' 'showtabline'</tags>
1365 <spec>'showtabline' 'stal'</spec>
1367 <default>always</default>
1369 <p>Define when the tab bar is visible.</p>
1372 <dt>always</dt> <dd>Always show the tab bar</dd>
1373 <dt>multitab</dt> <dd>Show the tab bar when there are multiple tabs</dd>
1374 <dt>never</dt> <dd>Never show the tab bar</dd>
1380 <tags>'nosf' 'nostrictfocus'</tags>
1381 <tags>'sf' 'strictfocus'</tags>
1382 <spec>'strictfocus' 'sf'</spec>
1383 <type>boolean</type>
1384 <default>on</default>
1387 Prevent scripts from focusing input elements without user intervention.
1393 <tags>'suggestengines'</tags>
1394 <spec>'suggestengines'</spec>
1395 <type>stringlist</type>
1396 <default>google</default>
1399 Set the search engines which can be used for completion
1400 suggestions when <o>complete</o> contains <em>S</em>.
1406 <tags>'notmo' 'notimeout'</tags>
1407 <tags>'tmo' 'timeout'</tags>
1408 <spec>'timeout' 'tmo'</spec>
1409 <type>boolean</type>
1410 <default>true</default>
1413 When this option is set and a key sequence interpretable both as a
1414 complete command and as a start of a longer command is typed,
1415 execute the shorter command after <o>timeoutlen</o> milliseconds.
1421 <tags>'tmol' 'timeoutlen'</tags>
1422 <spec>'timeoutlen' 'tmol'</spec>
1424 <default>1000</default>
1427 Maximum number of milliseconds to wait for a longer key command
1428 when a shorter one exists. Only effective when <o>timeout</o> is
1435 <tags>'titlestring'</tags>
1436 <spec>'titlestring'</spec>
1438 <default>&dactyl.appName;</default>
1441 Set the application name shown after the current page title in
1442 &dactyl.host;'s title bar.
1444 <example><set opt="titlestring"><str>Mozilla &dactyl.host;</str></set></example>
1449 <tags>'us' 'urlsep' 'urlseparator'</tags>
1450 <spec>'urlseparator' 'urlsep' 'us'</spec>
1452 <default>\|</default>
1455 The regular expression used to split URL lists in commands
1456 like <ex>:open</ex>. When set to the empty string, URL lists
1457 are never split. With the default value, the following will open
1458 three URLs in the current tab and two new background tabs,
1460 <code><ex>:open <str delim="">google Linux</str> | <str delim="">wikipedia Arch Linux</str> | <str delim="">imdb Serenity</str></ex></code>
1465 <tags>'noum' 'nousermode'</tags>
1466 <tags>'um' 'usermode'</tags>
1467 <spec>'usermode' 'um'</spec>
1468 <type>boolean</type>
1469 <default>off</default>
1471 <p>Show current website with minimal styling.</p>
1476 <tags>'vbs' 'verbose'</tags>
1477 <spec>'verbose' 'vbs'</spec>
1479 <default>1</default>
1482 Define which info messages are displayed. As the value increases,
1483 &dactyl.appName; will show more messages about its progress.
1484 These can be viewed at any time with the <ex>:messages</ex>
1485 command. The highest useful value is 15, being the most verbose
1488 <!-- TODO: list levels and associated messages -->
1493 <tags>'novb' 'novisualbell'</tags>
1494 <tags>'vb' 'visualbell'</tags>
1495 <spec>'visualbell' 'vb'</spec>
1496 <type>boolean</type>
1497 <default>off</default>
1500 Use visual bell instead of beeping on errors. The visual bell
1501 style is controlled by <ex>:highlight Bell</ex>. See also
1508 <tags>'wia' 'wildanchor'</tags>
1510 <spec>'wildanchor' 'wia'</spec>
1511 <type>regexplist</type>
1512 <default>!'/ex/(back|buffer|ext|forward|help|undo)'</default>
1515 Regular expression list defining which completion groups show only
1516 matches anchored to the beginning of the result. The first
1517 matching expression is the one that applies. If the match is
1518 negated, then the current filter may match anywhere in the result.
1519 If it is not negated, then the match may only occur at the
1520 beginning of the result. If no items match, then a
1521 context-dependent default value is used.
1527 <tags>'wic' 'wildcase'</tags>
1528 <spec>'wildcase' 'wic'</spec>
1529 <type>regexpmap</type>
1530 <default>.?:smart</default>
1533 Defines how completions are matched with regard to character case.
1534 Keys in the <t>regexpmap</t> refer to completion context names (see
1535 <ex>:contexts</ex>) for which the value applies. Possible values
1540 <dt><str>smart</str></dt> <dd>Case is significant when capital letters are typed</dd>
1541 <dt><str>match</str></dt> <dd>Case is always significant</dd>
1542 <dt><str>ignore</str></dt> <dd>Case is never significant</dd>
1548 <tags>'wig' 'wildignore'</tags>
1549 <spec>'wildignore' 'wig'</spec>
1550 <type>regexplist</type>
1554 List of file patterns to ignore when completing files. For example,
1555 the following will ignore object files and Vim swap files:
1558 <set opt="wildignore"><str delim="'">\.o$</str>,<str delim="'">^\..*\.s[a-z]{2}$</str></set>
1560 <note>Unlike Vim, each pattern is a regular expression rather than a glob.</note>
1565 <tags>'wim' 'wildmode'</tags>
1566 <spec>'wildmode' 'wim'</spec>
1567 <type>stringlist</type>
1568 <default>list:full</default>
1571 Defines how command-line completion works. It is a comma-separated
1572 list of parts, where each part specifies what to do for each
1573 consecutive press of the <k name="Tab" mode="c"/> key. The last
1574 element in the list is used for each succeeding <k name="Tab" mode="c"/>
1575 after it has been reached.
1578 <p>These are the possible values for each part:</p>
1581 <dt><str></str></dt> <dd>Complete only the first match.</dd>
1582 <dt><str>full</str></dt> <dd>Complete the next full match. After the last, the original string is used.</dd>
1583 <dt><str>longest</str></dt> <dd>Complete the longest common substring of all completions.</dd>
1584 <dt><str>list</str></dt> <dd>When more than one match, list all matches.</dd>
1585 <dt><str>list:full</str></dt> <dd>When more than one match, list all matches and complete the first match.</dd>
1586 <dt><str>list:longest</str></dt>
1588 When more than one match, list all matches and
1589 complete till the longest common string. When there
1590 is only a single match, it is fully completed
1591 regardless of the case.
1596 See also <o>altwildmode</o>.
1603 <tags>'wis' 'wildsort'</tags>
1604 <spec>'wildsort' 'wis'</spec>
1605 <type>regexplist</type>
1606 <default>.*</default>
1609 A list of regular expressions defining which completion contexts
1610 should be sorted. The main purpose of this option is to prevent
1611 sorting of certain completion lists that don't perform well under
1615 <p>See also <ex>:contexts</ex>.</p>
1620 <tags>'wsp' 'wordseparators'</tags>
1621 <spec>'wordseparators' 'wsp'</spec>
1624 <default><![CDATA[[.,!?:;\\/"^$%&?()[\]{}<>#*+|=~ _-]]]></default>
1627 A regular expression which defines how words are split for
1628 the <o>hintmatching</o> types <str>wordstartswith</str> and
1629 <str>firstletters</str>. Words are split on each occurrence of the
1637 <!-- vim:se sts=4 sw=4 et: -->