1 <?xml version="1.0" encoding="UTF-8"?>
2 <?xml-stylesheet type="text/xsl" href="dactyl://content/help.xsl"?>
4 <!DOCTYPE document SYSTEM "dactyl://cache/options.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 the following 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 <t>stringmap</t> and a <t>regexplist</t>. 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 Array elements, such as in the <tt><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><args[1]></tt>.
88 Any substring enclosed by <em><tt><{</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><</tt></em> or <em><tt>></tt></em> character may
91 be included with the special escape sequences <tt><lt></tt> or
92 <tt><gt></tt> respectively.
95 <p style="text-align: left">
96 For example, given the format string
97 <str><{(cmd: <column>) }><{line: <line> }><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>
104 <h2 tag="set-option E764">Setting options</h2>
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>
115 <spec>:se<oa>t</oa> all</spec>
116 <description short="true">
117 <p>Show all options.</p>
122 <tags>E518 E519</tags>
123 <spec>:se<oa>t</oa> <a>option</a>?</spec>
125 <p>Show value of <a>option</a>.</p>
130 <spec>:se<oa>t</oa> <a>option</a> <oa>...</oa></spec>
133 For boolean options, turn them on. For all other types,
140 <spec>:se<oa>t</oa> no<a>option</a> <oa>...</oa></spec>
143 For boolean options, turn them off. For all other types,
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>
154 For boolean options, invert their value. For all other types,
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>
165 <p>For list options, toggle the specified values.</p>
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>
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>
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.
185 <tags>:set-default</tags>
186 <spec>:se<oa>t</oa> <a>option</a>& <oa>...</oa></spec>
188 <p>Reset option to its default value.</p>
193 <tags>:set-default-all</tags>
194 <spec>:se<oa>t</oa> all&</spec>
196 <p>Set all options to their default value.</p>
201 <tags>:set-args E487 E521</tags>
202 <spec>:se<oa>t</oa> <a>option</a>=<a>value</a> <oa>...</oa></spec>
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"/>.
214 <spec>:se<oa>t</oa> <a>option</a>+=<a>value</a> <oa>...</oa></spec>
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.
228 <spec>:se<oa>t</oa> <a>option</a>^=<a>value</a> <oa>...</oa></spec>
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.
240 <spec>:se<oa>t</oa> <a>option</a>-=<a>value</a> <oa>...</oa></spec>
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.
255 <tags>:setlocal :setl</tags>
256 <spec>:setl<oa>ocal</oa> …</spec>
259 The same as <ex>:set</ex> command, but operates on current tab options
260 only. See <ex>:set</ex> for details.
266 <tags>:setglobal :setg</tags>
267 <spec>:setg<oa>lobal</oa> …</spec>
270 The same as <ex>:set</ex> command, but operates on global options only.
271 See <ex>:set</ex> for details.
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.
282 <h2 tag="&dactyl.host;-options preferences">Setting &dactyl.host; options</h2>
284 <p>&dactyl.host; options can be viewed and set with the following commands:</p>
287 <tags>:pref :prefs :preferences</tags>
288 <spec>:pref<oa>erences</oa></spec>
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.
300 <tags>:pref! :prefs! :preferences!</tags>
301 <spec>:pref<oa>erences</oa>!</spec>
304 Opens about:config in the current tab, where you can change advanced &dactyl.host;
311 <tags>:set! :set-!</tags>
312 <spec>:se<oa>t</oa>! …</spec>
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
320 The <em>no</em> and <em>inv</em> prefix operators are not available
321 for setting preferences.
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
335 <li><pref>accessibility.typeaheadfind</pref></li>
338 <h2 tag="list-options">List of options</h2>
341 <tags>'act' 'activate'</tags>
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>
349 A list of items which, when opened in a new tab, are
350 automatically focused. Available items:
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>
371 <tags>'awim' 'altwildmode'</tags>
372 <spec>'altwildmode' 'awim'</spec>
373 <type>&option.altwildmode.type;</type>
374 <default>&option.altwildmode.default;</default>
377 Like <o>wildmode</o>, but when the <k name="A-Tab" mode="c"/> key
384 <tags>'au' 'autocomplete'</tags>
385 <spec>'autocomplete' 'au'</spec>
386 <type>&option.autocomplete.type;</type>
387 <default>&option.autocomplete.default;</default>
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.
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
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>
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>
426 <tags>'bh' 'banghist'</tags>
427 <spec>'banghist' 'bh'</spec>
428 <type>&option.banghist.type;</type>
429 <default>&option.banghist.default;</default>
432 Replace occurrences of ! with the previous command when
433 executing external commands.
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>
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.
451 If the <em>CDPATH</em> environment variable is set this path list
452 is appended to the default value of <str>.</str>.
458 <tags>'ca' 'cookieaccept'</tags>
459 <spec>'cookieaccept' 'ca'</spec>
460 <type>&option.cookieaccept.type;</type>
461 <default>&option.cookieaccept.default;</default>
463 <p>When to accept cookies.</p>
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>
474 <tags>'cl' 'cookielifetime'</tags>
475 <spec>'cookielifetime' 'cl'</spec>
476 <type>&option.cookielifetime.type;</type>
477 <default>&option.cookielifetime.default;</default>
480 The lifetime for which to accept cookies. The available
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
495 <tags>'ck' 'cookies'</tags>
496 <spec>'cookies' 'ck'</spec>
497 <type>&option.cookies.type;</type>
498 <default>&option.cookies.default;</default>
500 <p>The default action for the <ex>:cookies</ex> command.</p>
505 <tags>'cpt' 'complete'</tags>
506 <spec>'complete' 'cpt'</spec>
507 <type>&option.complete.type;</type>
508 <default>&option.complete.default;</default>
510 <p>Items which are completed at the <ex>:open</ex> prompts. Available items:</p>
512 <dl dt="width: 6.5em;">
513 <dt>search</dt> <dd>Search engines and keyword URLs</dd>
514 <dt>file</dt> <dd>Local files</dd>
515 <dt>location</dt> <dd>&dactyl.host; location bar entries (bookmarks and history sorted in an intelligent way)</dd>
516 <dt>bookmark</dt> <dd>Bookmarks</dd>
517 <dt>history</dt> <dd>History</dd>
518 <dt>suggestion</dt> <dd>Search engine suggestions</dd>
522 Additionally, native search providers can be added by prefixing
523 their names with the string <str delim="'">native:</str>. These
524 providers are often added by other add-ons and are occasionally
529 The order is important, such that <se opt="complete"><str delim="">bsf</str></se> will
530 list bookmarks followed by matching quick searches and then
535 For backward compatibility, this option currently accepts a single
536 entry containing single-letter names for completers. This usage
537 is deprecated and will be removed in the future.
541 Using <em>bookmark</em> and <em>history</em> can make completion very slow if
542 there are many items.
548 <tags>'ds' 'defsearch'</tags>
549 <spec>'defsearch' 'ds'</spec>
550 <type>&option.defsearch.type;</type>
551 <default>&option.defsearch.default;</default>
554 Sets the default search engine. The default search engine is
555 used by <ex>:open</ex> and related commands for arguments which
556 include no search or bookmark keywords and can't otherwise be
557 converted into URLs or existing file names.
561 This means that with <o>defsearch</o> set to <str>youtube</str>,
562 <ex>:open Tim Minchin</ex> behaves exactly as
563 <ex>:open youtube Tim Minchin</ex>, so long as you don't have a
564 search or bookmark keyword called ‘Tim’.
570 <tags>'dls' 'dlsort' 'downloadsort'</tags>
571 <spec>'downloadsort' 'dlsort' 'dls'</spec>
573 <type>&option.downloadsort.type;</type>
574 <default>&option.downloadsort.default;</default>
577 <ex>:downloads</ex> sort order, in order of precedence.
578 Each element must be preceded by a <tt>+</tt> or
579 <tt>-</tt>, indicating ascending or descending sorting,
580 respectively. Valid sort orders are:
584 <dt>active</dt> <dd>Whether download is active</dd>
585 <dt>complete</dt> <dd>Percent complete</dd>
586 <dt>date</dt> <dd>Date and time the download began</dd>
587 <dt>filename</dt> <dd>Target filename</dd>
588 <dt>size</dt> <dd>File size</dd>
589 <dt>speed</dt> <dd>Download speed</dd>
590 <dt>time</dt> <dd>Time remaining</dd>
591 <dt>url</dt> <dd>Source URL</dd>
597 <tags>'editor'</tags>
598 <spec>'editor'</spec>
599 <type>&option.editor.type;</type>
600 <default>&option.editor.default;</default>
603 Set the external text editor.
604 This is the editor used by <k name="C-i" mode="I"/>, <k>gF</k>, and
605 other commands which launch an external text editor.
609 Accepts a <t>macro-string</t> with the following escapes available.
610 Arguments containing escapes which are not relevant to a given call
611 are automatically elided. All field splitting is done before format
612 characters are processed.
616 <dt><file></dt> <dd>The file to edit. Appended as the final argument if missing.</dd>
617 <dt><line></dt> <dd>The line number at which to position the cursor.</dd>
618 <dt><column></dt> <dd>The column at which to position the cursor.</dd>
622 &dactyl.appName; will not behave correctly if the editor forks its
623 own process rather than blocking until editing is complete. Gvim
624 invoked without the <em>-f</em> option is one such example.
630 <tags>'enc' 'encoding'</tags>
631 <spec>'encoding' 'enc'</spec>
632 <type>&option.encoding.type;</type>
633 <default>&option.encoding.default;</default>
636 Changes the character encoding of the current buffer. Valid only
637 until a new page is loaded.
643 <tags>'noeb' 'noerrorbells'</tags>
644 <tags>'eb' 'errorbells'</tags>
645 <spec>'errorbells' 'eb'</spec>
646 <type>&option.errorbells.type;</type>
647 <default>&option.errorbells.default;</default>
650 Ring the bell when an error message is displayed. See also
657 <tags>'ei' 'eventignore'</tags>
658 <spec>'eventignore' 'ei'</spec>
659 <type>&option.eventignore.type;</type>
660 <default>&option.eventignore.default;</default>
663 A list of autocommand event names which should be ignored. If the
664 list contains the value <str>all</str> then all events are
671 <tags>'noex' 'noexrc'</tags>
672 <tags>'ex' 'exrc'</tags>
673 <spec>'exrc' 'ex'</spec>
674 <type>&option.exrc.type;</type>
675 <default>&option.exrc.default;</default>
678 Allow reading of an RC file in the current directory. This file is
679 sourced after the default <tt><t>&dactyl.name;rc</t></tt> file in your
686 <tags>'eht' 'extendedhinttags'</tags>
687 <spec>'extendedhinttags' 'eht'</spec>
689 <type>&option.extendedhinttags.type;</type>
690 <default>[asOTvVWy]:':-moz-any-link',area[href],img[src],iframe[src],
692 [F]:body,code,div,html,p,pre,span,
694 [S]:button,'input:not([type=hidden])',select,textarea</default>
697 Defines specialized CSS selectors or XPath expressions for arbitrary
698 <t>extended-hints</t> modes. The syntax is the same as for
699 <o>hinttags</o>. If no matches are found, the value of
700 <o>hinttags</o> is used.
706 <tags>'fenc' 'fileencoding'</tags>
707 <spec>'fileencoding' 'fenc'</spec>
708 <type>&option.fileencoding.type;</type>
709 <default>&option.fileencoding.default;</default>
712 Changes the character encoding that &dactyl.appName; uses to read
719 <tags>'fc' 'findcase'</tags>
720 <spec>'findcase' 'fc'</spec>
721 <type>&option.findcase.type;</type>
722 <default>&option.findcase.default;</default>
724 <p>Find case matching mode.</p>
727 <dt>ignore</dt> <dd>Case is never significant</dd>
728 <dt>match</dt> <dd>Case is always significant</dd>
729 <dt>smart</dt> <dd>Case is significant when capital letters are typed</dd>
735 <tags>'ff' 'findflags'</tags>
736 <spec>'findflags' 'ff'</spec>
737 <type>&option.findflags.type;</type>
738 <default>&option.findflags.default;</default>
740 <p>Default flags for find invocations.</p>
743 <dt>C</dt> <dd>Match case</dd>
744 <dt>L</dt> <dd>Search all text</dd>
745 <dt>R</dt> <dd>Perform a plain string search</dd>
746 <dt>c</dt> <dd>Ignore case</dd>
747 <dt>l</dt> <dd>Search only in links</dd>
748 <dt>r</dt> <dd>Perform a regular expression search</dd>
754 <tags>'fh' 'followhints'</tags>
755 <spec>'followhints' 'fh'</spec>
756 <type>&option.followhints.type;</type>
757 <default>&option.followhints.default;</default>
760 Define the conditions under which hints selected by typing the link
761 substring are followed. Hints selected by typing their label (as
762 specified by <o>hintkeys</o>) are always followed immediately.
765 <p>Possible values:</p>
767 <dl dt="width: 6em;">
768 <dt>0</dt> <dd>Follow the first hint as soon as typed text uniquely identifies it.</dd>
769 <dt>1</dt> <dd>Follow the selected hint on <k name="CR" link="false"/>.</dd>
775 <tags>'nofs' 'nofullscreen'</tags>
776 <tags>'fs' 'fullscreen'</tags>
777 <spec>'fullscreen' 'fs'</spec>
778 <type>&option.fullscreen.type;</type>
779 <default>&option.fullscreen.default;</default>
782 Show the current window full-screen. Also hide certain GUI elements, such as
783 <t>status-line</t> and tab bar.
789 <tags>'go' 'guioptions'</tags>
790 <spec>'guioptions' 'go'</spec>
791 <type>&option.guioptions.type;</type>
792 <default>&option.guioptions.default;</default>
794 <p>Show or hide certain GUI elements.</p>
796 <p>Supported characters:</p>
798 <dl dt="width: 6em;">
799 <dt>B</dt> <dd>Bookmark bar</dd>
800 <dt>C</dt> <dd>Always show the command line outside of the status line</dd>
801 <dt>M</dt> <dd>Always show messages outside of the status line</dd>
802 <dt>N</dt> <dd>Tab number over image</dd>
803 <dt>T</dt> <dd>Toolbar</dd>
804 <dt>b</dt> <dd>Bottom scrollbar</dd>
805 <dt>c</dt> <dd>Always show the command line, even when empty</dd>
806 <dt>l</dt> <dd>Left scrollbar (<em>l</em> and <em>r</em> are mutually exclusive)</dd>
807 <dt>m</dt> <dd>Menu bar</dd>
808 <dt>n</dt> <dd>Tab number</dd>
809 <dt>r</dt> <dd>Right scrollbar</dd>
810 <dt>s</dt> <dd>Status bar</dd>
813 <p>See also <o>showtabline</o>.</p>
815 <note>Scrollbar changes require a page reload to take effect.</note>
816 <note>Only one of <em>l</em> or <em>r</em> may be included.</note>
821 <tags>'hf' 'helpfile'</tags>
822 <spec>'helpfile' 'hf'</spec>
823 <type>&option.helpfile.type;</type>
824 <default>&option.helpfile.default;</default>
827 Name of the main help file. This is that page shown if the
828 <ex>:help</ex> command is called without any arguments.
834 <tags>'hin' 'hintinputs'</tags>
835 <spec>'hintinputs' 'hin'</spec>
836 <type>&option.hintinputs.type;</type>
837 <default>&option.hintinputs.default;</default>
840 When generating hints for input elements that do not have an
841 explicit caption, this specifies the methods used to generate a
842 textual hint. The options are attempted in the order they are
843 given, and the first successful value is used.
846 <dl dt="width: 8em;">
847 <dt>value</dt> <dd>The hint is the value displayed in a text input, or the selected option for a drop-down.</dd>
848 <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>
849 <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>
855 <tags>'hk' 'hintkeys'</tags>
856 <spec>'hintkeys' 'hk'</spec>
857 <type>&option.hintkeys.type;</type>
858 <default>&option.hintkeys.default;</default>
861 The keys used to label and select hints. With its default value,
862 each hint has a unique number which can be typed to select it,
863 while all other characters are used to filter hints based on their
864 text. With a value such as <str>asdfg;lkjh</str>, each hint is
865 ‘numbered’ based on the characters of the home row.
871 <tags>'hm' 'hintmatching'</tags>
872 <spec>'hintmatching' 'hm'</spec>
873 <type>&option.hintmatching.type;</type>
874 <default>&option.hintmatching.default;</default>
876 <p>Change the hint matching algorithm used in Hints mode.</p>
878 <p>Possible values:</p>
883 The typed characters are split on whitespace, and
884 these character groups have to match anywhere inside
885 the text of the link.
887 <dt>wordstartswith</dt>
889 The typed characters are matched with the beginning
890 of the first word (see <o>wordseparators</o>) in the
891 link as long as possible. If no matches occur in the
892 current word, then the matching is continued at the
893 beginning of the next word. The words are worked
894 through in the order they appear in the link. If the
895 typed characters contain spaces, then the characters
896 are split on whitespace. These character groups are
897 then matched with the beginning of the words,
898 beginning at the first one and continuing with the
899 following words in the order they appear in the
902 <dt>firstletters</dt>
904 Behaves like wordstartswith, but non-matching words
909 Delegate to the function
910 <tt>dactyl.plugins.customHintMatcher</tt>.
912 <dt>transliterated</dt>
914 Certain alphanumeric characters are transliterated into their
915 unaccented equivalents, such that ‘euro’ will match 'æuró',
916 and ‘Ångström’ will match ‘angstrom’.
923 <tags>'ht' 'hinttags'</tags>
925 <spec>'hinttags' 'ht'</spec>
926 <type>&option.hinttags.type;</type>
927 <default>:-moz-any-link,area,button,iframe,input:not([type=hidden]),select,textarea,
928 [onclick],[onmouseover],[onmousedown],[onmouseup],[oncommand],
929 [tabindex],[role=link],[role=button],[contenteditable=true]</default>
932 A list of CSS selectors or XPath expressions used to select elements
933 for <link topic="hints">hinting</link>. Values beginning with the
934 string <str>xpath:</str> are treated as XPath expressions, while any
935 other values are treated as CSS selectors. Can be overridden for
936 individual <t>extended-hints</t> modes with the
937 <o>extendedhinttags</o> option.
943 <tags>'hto' 'hinttimeout'</tags>
944 <spec>'hinttimeout' 'hto'</spec>
945 <type>&option.hinttimeout.type;</type>
946 <default>&option.hinttimeout.default;</default>
949 Timeout in milliseconds before automatically following a non-unique
950 hint. The timeout is measured since the last time a key listed in
951 <o>hintkeys</o> was pressed. It has no effect when narrowing hints
952 by typing part of their text. Set to 0 (the default) to only follow
953 hints after pressing <k name="CR" link="false"/> or when the hint is unique.
959 <tags>'hi' 'history'</tags>
960 <spec>'history' 'hi'</spec>
961 <type>&option.history.type;</type>
962 <default>&option.history.default;</default>
965 Maximum number of Ex commands and find patterns to store in the
966 <t>command-line</t> history.
972 <tags>'nohlf' 'nohlfind'</tags>
973 <tags>'hlf' 'hlfind'</tags>
974 <spec>'hlfind' 'hlf'</spec>
975 <type>&option.hlfind.type;</type>
976 <default>&option.hlfind.default;</default>
978 <p>Highlight previous find pattern matches.</p>
983 <tags>'noif' 'noincfind'</tags>
984 <tags>'if' 'incfind'</tags>
985 <spec>'incfind' 'if'</spec>
986 <type>&option.incfind.type;</type>
987 <default>&option.incfind.default;</default>
989 <p>Show the first match for a find pattern as it is typed.</p>
994 <tags>'noim' 'noinsertmode'</tags>
995 <tags>'im' 'insertmode'</tags>
996 <spec>'insertmode' 'im'</spec>
997 <type>&option.insertmode.type;</type>
998 <default>&option.insertmode.default;</default>
1001 Use Insert mode as the default for text areas. This is useful if you
1002 want to use the known &dactyl.host; interface for editing text areas.
1003 Input fields default to this behavior irrespective of this option's
1008 Text Edit mode can be entered with <k name="C-t" mode="I"/> from Insert mode.
1014 <tags>'isk' 'iskeyword'</tags>
1015 <spec>'iskeyword' 'isk'</spec>
1016 <type>&option.iskeyword.type;</type>
1017 <default>&option.iskeyword.default;</default>
1019 <p>Regular expression defining which characters constitute words.</p>
1024 <tags>'nojsd' 'nojsdebugger'</tags>
1025 <tags>'jsd' 'jsdebugger'</tags>
1026 <spec>'jsdebugger' 'jsd'</spec>
1027 <type>&option.jsdebugger.type;</type>
1028 <default>&option.jsdebugger.default;</default>
1031 Use the JavaScript debugger service for JavaScript completion.
1037 <tags>'jt' 'jumptags'</tags>
1038 <spec>'jumptags' 'jt'</spec>
1039 <type>&option.jumptags.type;</type>
1040 <default>&option.jumptags.default;</default>
1042 <p>XPath or CSS selector strings of jumpable elements for extended hint modes.</p>
1047 <tags>'ln' 'linenumbers'</tags>
1048 <spec>'linenumbers' 'ln'</spec>
1049 <type>&option.linenumbers.type;</type>
1050 <default>&option.linenumbers.default;</default>
1053 Patterns used to determine line numbers used by <k>G</k>. May be
1054 either a selector expression as accepted by <o>hinttags</o>, in
1055 which case the first matching element whose text content is equal to
1056 the desired line number is used or the <oa>count</oa>th element
1057 failing that, or the string <str delim="'">func:</str> followed by a
1058 function which, given arguments for the document and desired line
1059 number, must return the target element.
1066 <tags>'lpl' 'loadplugins'</tags>
1067 <spec>'loadplugins' 'lpl'</spec>
1068 <type>&option.loadplugins.type;</type>
1069 <default>&option.loadplugins.default;</default>
1072 A regular expression list that defines which plugins are loaded at
1073 startup or via <ex>:loadplugins</ex>. The first item to match is
1074 the one that takes effect. If no items match, the file is not
1075 loaded. Setting this to a blank value effectively disables plugin
1079 For example, to prepend to the default value of this option to load
1080 all plugins except for <em>foobar-plugin</em>, you could use:
1082 <set opt="loadplugins" op="^=">!<str delim="'">foobar-plugin</str></set>
1084 Alternatively, you can specify which plugins to load and which to
1085 omit in your <tt><t>&dactyl.name;rc</t></tt> using something like
1088 <set opt="loadplugins">!<str delim="'">foo|bar</str>,<str delim="'">\.(js|&dactyl.fileExt;)$</str></set>
1090 That will load all plugins but <em>foo</em> and <em>bar</em>.
1093 Note that in the first expression of the latter example you don't
1094 need parentheses, as the <em>!</em> negates the whole of the
1095 following expression (cf. <t>regexplist</t>).
1098 See also <ex>:runtime</ex>.
1104 <tags>'ml' 'mapleader'</tags>
1105 <spec>'mapleader' 'ml'</spec>
1106 <type>&option.mapleader.type;</type>
1107 <default>&option.mapleader.default;</default>
1109 <p>Defines the replacement keys for the <k name="Leader"/> pseudo-key.</p>
1114 <tags>'maxitems'</tags>
1115 <spec>'maxitems'</spec>
1116 <type>&option.maxitems.type;</type>
1117 <default>&option.maxitems.default;</default>
1119 <p>Maximum number of items to display at once in a listing.</p>
1124 <tags>'msgs' 'messages'</tags>
1125 <spec>'messages' 'msgs'</spec>
1126 <type>&option.messages.type;</type>
1127 <default>&option.messages.default;</default>
1129 <p>Maximum number of messages to store in the message history.</p>
1134 <tags>'nomore' 'more'</tags>
1136 <type>&option.more.type;</type>
1137 <default>&option.more.default;</default>
1140 Pause the message list window when more than one screen of
1141 listings is displayed.
1147 <tags>'newtab'</tags>
1148 <spec>'newtab'</spec>
1149 <type>&option.newtab.type;</type>
1150 <default>&option.newtab.default;</default>
1153 Defines which Ex commands open pages in new tabs rather than the
1154 current tab by default. This may be overridden with the
1155 <ex>:tab</ex> command, and is usually inverted by affixing a
1156 <em>!</em> to the command in question.
1159 <p>Possible values:</p>
1162 <dt>all</dt> <dd>All commands</dd>
1163 <dt>addons</dt> <dd><ex>:addo<oa>ns</oa></ex> command</dd>
1164 <dt>downloads</dt> <dd><ex>:downl<oa>oads</oa></ex> command</dd>
1165 <dt>extoptions</dt> <dd><ex>:exto<oa>ptions</oa></ex> command</dd>
1166 <dt>help</dt> <dd><ex>:h<oa>elp</oa></ex> command</dd>
1167 <dt>javascript</dt> <dd><ex>:javascript!</ex> or <ex>:js!</ex> command</dd>
1168 <dt>prefs</dt> <dd><ex>:pref<oa>erences</oa>!</ex> or <ex>:prefs!</ex> command</dd>
1175 <tags>'nextpattern'</tags>
1177 <spec>'nextpattern'</spec>
1178 <type>&option.nextpattern.type;</type>
1179 <default>&option.nextpattern.default;</default>
1182 Patterns to use when guessing the next page in a document
1183 sequence after pressing the <k>]]</k> key. Each pattern is
1184 successively tested against each link in the page (as defined by
1185 <o>hinttags</o>, starting with the last), and the first link to
1192 <tags>'noonline' 'online'</tags>
1193 <spec>'online'</spec>
1194 <type>&option.online.type;</type>
1195 <default>&option.online.default;</default>
1198 Enables or disables ‘offline’ mode, where network access is
1199 disabled and all web pages are loaded entirely from cache.
1205 <tags>'pa' 'pageinfo'</tags>
1206 <spec>'pageinfo' 'pa'</spec>
1207 <type>&option.pageinfo.type;</type>
1208 <default>&option.pageinfo.default;</default>
1210 <p>Info shown in the <ex>:pageinfo</ex> output.</p>
1212 <p>Items available by default:</p>
1214 <dl dt="width: 6em;">
1215 <dt>g</dt> <dd>General info</dd>
1216 <dt>e</dt> <dd>Search Engines</dd>
1217 <dt>f</dt> <dd>Feeds</dd>
1218 <dt>m</dt> <dd>Meta tags</dd>
1219 <dt>s</dt> <dd>Security information</dd>
1223 The order of the options defines the order in which they appear in
1230 <tags>'pk' 'passkeys'</tags>
1231 <spec>'passkeys' 'pk'</spec>
1232 <type>&option.passkeys.type;</type>
1233 <default>&option.passkeys.default;</default>
1236 Pass certain keys through directly for the given URLs.
1237 For any page with a URL matching a given regexp, all key
1238 events for keys listed in that regexp's value are passed
1239 through directly to &dactyl.host;, and are not processed
1240 by &dactyl.appName; in any way. Key names are separated
1241 by commas, where the first key name is treated as a list
1242 of individual keys and each subsequent key is treated as
1243 a key chain. Individual key entries always apply to all
1244 modes. Key chains apply only to non-input modes unless
1245 they begin with a key requiring a modifier other than
1249 <example><set opt="passkeys" op="+="><str delim="">mail.google.com</str>:<str delim="">jk<CR></str>,<str delim="">gi</str></set></example>
1252 More subtle and complex pass through can be achieved
1253 using <t>groups</t> and mode-specific mappings utilizing
1254 the <k name="Pass"/> pseudo-key.
1260 <tags>'pu' 'passunknown'</tags>
1261 <spec>'passunknown' 'pu'</spec>
1262 <type>&option.showmode.type;</type>
1263 <default>&option.showmode.default;</default>
1266 Pass unknown keys through to &dactyl.host; in these
1267 <t>modes</t>. The first element matching a currently
1268 active mode is the one that takes effect. Modes may be
1269 negated by prefixing them with a <tt>!</tt>.
1275 <tags>'pps' 'popups'</tags>
1276 <spec>'popups' 'pps'</spec>
1277 <type>&option.popups.type;</type>
1278 <default>&option.popups.default;</default>
1281 Defines where to show requested pop-up windows. Applies only to
1282 links which request to open in a new window. The behavior of
1283 middle-, shift-, or control- clicking a link is unaffected by this
1287 <p>Possible values are:</p>
1289 <dl dt="width: 8em;">
1290 <dt>tab</dt> <dd>Open pop-ups in a new tab</dd>
1291 <dt>window</dt> <dd>Open pop-ups in a new window</dd>
1292 <dt>resized</dt> <dd>Open resized pop-ups in a new window</dd>
1296 If neither <em>tab</em> nor <em>window</em> is provided, all
1297 pop-ups open in the current tab. <em>tab</em> and <em>window</em>
1298 are mutually exclusive, and the last one listed is effective.
1302 This option does not alter the &dactyl.host; pop-up blocker behavior
1309 <tags>'previouspattern'</tags>
1311 <spec>'previouspattern'</spec>
1312 <type>&option.previouspattern.type;</type>
1313 <default>&option.previouspattern.default;</default>
1316 Patterns to use when guessing the previous page in a document
1317 sequence after pressing the <k>[[</k> key. Each pattern is
1318 successively tested against each link in the page (as defined by
1319 <o>hinttags</o>, starting with the last), and the first link to
1326 <tags>'noprivate' 'private'</tags>
1327 <spec>'private'</spec>
1328 <type>&option.private.type;</type>
1329 <default>&option.private.default;</default>
1332 Set the <str>private browsing</str> option. In private browsing mode
1333 history, cache files, cookies, form data, passwords, download list
1334 entries, local and URL <t>marks</t>, <t>command-line</t> history
1335 and macros are available only for the duration of the private
1336 browsing session and deleted when returning to normal browsing
1337 mode. See also <t>privacy</t>.
1343 <tags>$&dactyl.idName;_RUNTIME</tags>
1344 <tags>'rtp' 'runtimepath'</tags>
1345 <spec>'runtimepath' 'rtp'</spec>
1346 <type>&option.runtimepath.type;</type>
1347 <default type="plain"><str>$&dactyl.idName;_RUNTIME</str> or
1348 Unix, Mac: <str>~/.&dactyl.name;</str>
1349 Windows: <str>~/&dactyl.name;</str></default>
1351 <p>List of directories searched for runtime files:</p>
1361 <set opt="runtimepath"><str delim="">~/my&dactyl.name;</str>,<str delim="">~/.&dactyl.name;</str></set>
1364 This will search for plugins in both
1365 <str>~/my&dactyl.name;/plugins</str> and
1366 <str>~/.&dactyl.name;/plugins</str>
1370 On startup, if the environment variable <em>$&dactyl.idName;_RUNTIME</em> does not
1371 exist, &dactyl.appName; will set it to match this value.
1377 <tags>'si' 'sanitizeitems'</tags>
1378 <spec>'sanitizeitems' 'si'</spec>
1380 <type>&option.sanitizeitems.type;</type>
1381 <default>&option.sanitizeitems.default;</default>
1384 The default list of private items to sanitize. See
1385 <ex>:sanitize</ex> for a list and explanation of possible values. A
1386 value of <str>all</str> will cause all items to be sanitized. Items
1387 may be excluded by prefixing them with a <tt>!</tt>. The first
1388 matching item takes precedence.
1394 <tags>'ss' 'sanitizeshutdown'</tags>
1395 <spec>'sanitizeshutdown' 'ss'</spec>
1396 <type>&option.sanitizeshutdown.type;</type>
1397 <default>&option.sanitizeshutdown.default;</default>
1399 <p>The items to sanitize automatically at shutdown.</p>
1404 <tags>'sts' 'sanitizetimespan'</tags>
1405 <spec>'sanitizetimespan' 'sts'</spec>
1407 <type>&option.sanitizetimespan.type;</type>
1408 <default>&option.sanitizetimespan.default;</default>
1411 The default sanitizer time span. Only items created within this timespan are
1412 deleted. The value must be of the one of:
1415 <dl dt="width: 8em;">
1416 <dt>all</dt> <dd>Everything</dd>
1417 <dt>session</dt> <dd>The current session</dd>
1418 <dt><a>n</a>m</dt> <dd>Past <a>n</a> Minutes</dd>
1419 <dt><a>n</a>h</dt> <dd>Past <a>n</a> Hours</dd>
1420 <dt><a>n</a>d</dt> <dd>Past <a>n</a> Days</dd>
1421 <dt><a>n</a>w</dt> <dd>Past <a>n</a> Weeks</dd>
1427 <tags>'scr' 'scroll'</tags>
1428 <spec>'scroll' 'scr'</spec>
1429 <type>&option.scroll.type;</type>
1430 <default>&option.scroll.default;</default>
1433 Number of lines to scroll with <k name="C-u"/> and <k name="C-d"/>
1434 commands. The number of lines scrolled defaults to half the window
1435 size. When a <oa>count</oa> is specified to the <k name="C-u"/> or
1436 <k name="C-d"/> commands, set this option to <oa>count</oa> before
1437 executing the command. Setting this to <em>0</em> restores the
1444 <tags>'scs' 'scrollsteps'</tags>
1445 <spec>'scrollsteps' 'scs'</spec>
1446 <type>&option.scrollsteps.type;</type>
1447 <default>&option.scrollsteps.default;</default>
1450 The number of steps in which to smooth scroll to a new position. If
1451 set to 1, smooth scrolling is not used.
1457 <tags>'sct' 'scrolltime'</tags>
1458 <spec>'scrolltime' 'sct'</spec>
1459 <type>&option.scrolltime.type;</type>
1460 <default>&option.scrolltime.default;</default>
1462 <p>The time, in milliseconds, in which to smooth scroll to a new position.</p>
1467 <tags>'sh' 'shell'</tags>
1468 <spec>'shell' 'sh'</spec>
1469 <type>&option.shell.type;</type>
1470 <default type="plain"><em>$SHELL</em> or <str>sh</str>, Windows: <str>cmd.exe</str></default>
1472 <p>Shell to use for executing <ex>:!</ex> and <ex>:run</ex> commands.</p>
1477 <tags>'shcf' 'shellcmdflag'</tags>
1478 <spec>'shellcmdflag' 'shcf'</spec>
1480 <type>&option.shellcmdflag.type;</type>
1481 <default type="plain"><str>-c</str>, Windows: <str>/c</str></default>
1483 <p>Flag passed to shell when executing <ex>:!</ex> and <ex>:run</ex> commands.</p>
1488 <tags>'smd' 'showmode'</tags>
1489 <spec>'showmode' 'smd'</spec>
1490 <type>&option.showmode.type;</type>
1491 <default>&option.showmode.default;</default>
1494 Show the current mode in the command line if it or any
1495 of its parent <t>modes</t> is included in the list.
1496 Modes may be negated by prefixing them with a
1503 <tags>'ssli' 'showstatuslinks'</tags>
1504 <spec>'showstatuslinks' 'ssli'</spec>
1506 <type>&option.showstatuslinks.type;</type>
1507 <default>&option.showstatuslinks.default;</default>
1510 When the mouse hovers over a link, or a link is otherwise focused,
1511 show its destination in the status bar.
1514 <p>Possible values are:</p>
1517 <dt></dt> <dd>Don't show link destination</dd>
1518 <dt>status</dt> <dd>Show the link destination in the &tag.status-line;</dd>
1519 <dt>command</dt> <dd>Show the link destination in the &tag.command-line;</dd>
1525 <tags>'stal' 'showtabline'</tags>
1526 <spec>'showtabline' 'stal'</spec>
1527 <type>&option.showtabline.type;</type>
1528 <default>&option.showtabline.default;</default>
1530 <p>Define when the tab bar is visible.</p>
1533 <dt>always</dt> <dd>Always show the tab bar</dd>
1534 <dt>multitab</dt> <dd>Show the tab bar when there are multiple tabs</dd>
1535 <dt>never</dt> <dd>Never show the tab bar</dd>
1541 <tags>'spl' 'spelllang'</tags>
1542 <spec>'spelllang' 'spl'</spec>
1543 <type>&option.spelllang.type;</type>
1544 <default>&option.spelllang.default;</default>
1545 <description short="true">
1546 <p>The language used by the spell checker.</p>
1551 <tags>'sf' 'strictfocus'</tags>
1552 <spec>'strictfocus' 'sf'</spec>
1553 <type>&option.strictfocus.type;</type>
1554 <default>&option.strictfocus.default;</default>
1557 Prevent scripts from focusing input elements without user intervention.
1560 <p>Possible values:</p>
1563 <dt>despotic</dt> <dd>Only allow focus changes when explicitly requested by the user</dd>
1564 <dt>laissez-faire</dt> <dd>Always allow focus changes</dd>
1565 <dt>moderate</dt> <dd>Allow focus changes after user-initiated focus change</dd>
1571 <tags>'suggestengines'</tags>
1572 <spec>'suggestengines'</spec>
1573 <type>&option.suggestengines.type;</type>
1574 <default>&option.suggestengines.default;</default>
1577 Set the search engines which can be used for completion
1578 suggestions when <o>complete</o> contains <em>S</em>.
1584 <tags>'notmo' 'notimeout'</tags>
1585 <tags>'tmo' 'timeout'</tags>
1586 <spec>'timeout' 'tmo'</spec>
1587 <type>&option.timeout.type;</type>
1588 <default>&option.timeout.default;</default>
1591 When this option is set and a key sequence interpretable both as a
1592 complete command and as a start of a longer command is typed,
1593 execute the shorter command after <o>timeoutlen</o> milliseconds.
1599 <tags>'tmol' 'timeoutlen'</tags>
1600 <spec>'timeoutlen' 'tmol'</spec>
1601 <type>&option.timeoutlen.type;</type>
1602 <default>&option.timeoutlen.default;</default>
1605 Maximum number of milliseconds to wait for a longer key command
1606 when a shorter one exists. Only effective when <o>timeout</o> is
1613 <tags>'titlestring'</tags>
1614 <spec>'titlestring'</spec>
1615 <type>&option.titlestring.type;</type>
1616 <default>&option.titlestring.default;</default>
1619 Set the application name shown after the current page title in
1620 &dactyl.host;'s title bar.
1622 <example><set opt="titlestring"><str>Mozilla &dactyl.host;</str></set></example>
1627 <tags>'us' 'urlsep' 'urlseparator'</tags>
1628 <spec>'urlseparator' 'urlsep' 'us'</spec>
1629 <type>&option.urlseparator.type;</type>
1630 <default>&option.urlseparator.default;</default>
1633 The regular expression used to split URL lists in commands
1634 like <ex>:open</ex>. When set to the empty string, URL lists
1635 are never split. With the default value, the following will open
1636 three URLs in the current tab and two new background tabs,
1638 <code><ex>:open <str delim="">google Linux</str> | <str delim="">wikipedia Arch Linux</str> | <str delim="">imdb Serenity</str></ex></code>
1643 <tags>'noum' 'nousermode'</tags>
1644 <tags>'um' 'usermode'</tags>
1645 <spec>'usermode' 'um'</spec>
1646 <type>&option.usermode.type;</type>
1647 <default>&option.usermode.default;</default>
1649 <p>Show current website with minimal styling.</p>
1654 <tags>'vbs' 'verbose'</tags>
1655 <spec>'verbose' 'vbs'</spec>
1656 <type>&option.verbose.type;</type>
1657 <default>&option.verbose.default;</default>
1660 Define which info messages are displayed. As the value increases,
1661 &dactyl.appName; will show more messages about its progress.
1662 These can be viewed at any time with the <ex>:messages</ex>
1663 command. The highest useful value is 15, being the most verbose
1666 <!-- TODO: list levels and associated messages -->
1671 <tags>'novb' 'novisualbell'</tags>
1672 <tags>'vb' 'visualbell'</tags>
1673 <spec>'visualbell' 'vb'</spec>
1674 <type>&option.visualbell.type;</type>
1675 <default>&option.visualbell.default;</default>
1678 Use visual bell instead of beeping on errors. The visual bell
1679 style is controlled by <ex>:highlight Bell</ex>. See also
1686 <tags>'wia' 'wildanchor'</tags>
1688 <spec>'wildanchor' 'wia'</spec>
1689 <type>&option.wildanchor.type;</type>
1690 <default>&option.wildanchor.default;</default>
1693 Regular expression list defining which completion groups show only
1694 matches anchored to the beginning of the result. The first
1695 matching expression is the one that applies. If the match is
1696 negated, then the current filter may match anywhere in the result.
1697 If it is not negated, then the match may only occur at the
1698 beginning of the result. If no items match, then a
1699 context-dependent default value is used.
1705 <tags>'wic' 'wildcase'</tags>
1706 <spec>'wildcase' 'wic'</spec>
1707 <type>&option.wildcase.type;</type>
1708 <default>&option.wildcase.default;</default>
1711 Defines how completions are matched with regard to character case.
1712 Keys in the <t>regexpmap</t> refer to completion context names (see
1713 <ex>:contexts</ex>) for which the value applies. Possible values
1718 <dt><str>smart</str></dt> <dd>Case is significant when capital letters are typed</dd>
1719 <dt><str>match</str></dt> <dd>Case is always significant</dd>
1720 <dt><str>ignore</str></dt> <dd>Case is never significant</dd>
1726 <tags>'wig' 'wildignore'</tags>
1727 <spec>'wildignore' 'wig'</spec>
1728 <type>&option.wildignore.type;</type>
1729 <default>&option.wildignore.default;</default>
1732 List of path name patterns to ignore when completing files and
1733 directories. For example, the following will ignore object files
1737 <set opt="wildignore"><str delim="'">\.o$</str>,<str delim="'">^\..*\.s[a-z]{2}$</str></set>
1739 <note>Unlike Vim, each pattern is a regular expression rather than a glob.</note>
1744 <tags>'wim' 'wildmode'</tags>
1745 <spec>'wildmode' 'wim'</spec>
1746 <type>&option.wildmode.type;</type>
1747 <default>&option.wildmode.default;</default>
1750 Defines how command-line completion works. It is a comma-separated
1751 list of parts, where each part specifies what to do for each
1752 consecutive press of the <k name="Tab" mode="c"/> key. The last
1753 element in the list is used for each succeeding <k name="Tab" mode="c"/>
1754 after it has been reached.
1757 <p>These are the possible values for each part:</p>
1760 <dt><str></str></dt> <dd>Complete only the first match.</dd>
1761 <dt><str>full</str></dt> <dd>Complete the next full match. After the last, the original string is used.</dd>
1762 <dt><str>longest</str></dt> <dd>Complete the longest common substring of all completions.</dd>
1763 <dt><str>list</str></dt> <dd>When more than one match, list all matches.</dd>
1764 <dt><str>list:full</str></dt> <dd>When more than one match, list all matches and complete the first match.</dd>
1765 <dt><str>list:longest</str></dt>
1767 When more than one match, list all matches and
1768 complete till the longest common string. When there
1769 is only a single match, it is fully completed
1770 regardless of the case.
1775 See also <o>altwildmode</o>.
1782 <tags>'wis' 'wildsort'</tags>
1783 <spec>'wildsort' 'wis'</spec>
1784 <type>&option.wildsort.type;</type>
1785 <default>&option.wildsort.default;</default>
1788 A list of regular expressions defining which completion contexts
1789 should be sorted. The main purpose of this option is to prevent
1790 sorting of certain completion lists that don't perform well under
1794 <p>See also <ex>:contexts</ex>.</p>
1799 <tags>'wsp' 'wordseparators'</tags>
1800 <spec>'wordseparators' 'wsp'</spec>
1802 <type>&option.wordseparators.type;</type>
1803 <default>&option.wordseparators.default;</default>
1806 A regular expression which defines how words are split for
1807 the <o>hintmatching</o> types <str>wordstartswith</str> and
1808 <str>firstletters</str>. Words are split on each occurrence of the
1815 <tags>'ys' 'yankshort'</tags>
1816 <spec>'yankshort' 'ys'</spec>
1817 <type>&option.yankshort.type;</type>
1818 <default>&option.yankshort.default;</default>
1820 <p>Yank the canonical short URL of a web page where provided.</p>
1827 <!-- vim:se sts=4 sw=4 et: -->