<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="dactyl://content/help.xsl"?>
-<!DOCTYPE document SYSTEM "dactyl://content/dtd">
+<!DOCTYPE document SYSTEM "dactyl://cache/options.dtd">
<document
name="options"
<p>
&dactyl.appName; has a number of internal variables and switches which can be set to
- achieve special effects. These options come in 8 forms:
+ achieve special effects. These options come in the following forms:
</p>
<dl dt="width: 10em;">
- <dt>boolean</dt> <dd>Can only be <hl key="Boolean">on</hl> or <hl key="Boolean">off</hl></dd>
+ <dt/><dd tag="boolean"/>
+ <dt>boolean</dt>
+ <dd>
+ Can only be <hl key="Boolean">on</hl> (<ex>:set <a>option</a></ex>) or
+ <hl key="Boolean">off</hl> (<ex>:set no<a>option</a></ex>)
+ </dd>
+
<dt>number</dt> <dd>A numeric value</dd>
<dt>string</dt> <dd>A string value</dd>
<dt/><dd tag="regexpmap"/>
<dt>regexpmap</dt>
<dd>
- A combination of a <em>stringmap</em> and a <em>regexplist</em>. Each key
+ A combination of a <t>stringmap</t> and a <t>regexplist</t>. Each key
in the <a>key</a>:<a>value</a> pair is a regexp. If the regexp begins with a
<tt>!</tt>, the sense of the match is negated, such that a non-matching
expression will be considered a match and <html:i>vice versa</html:i>.
the form of <tt><e-<a>name</a>></tt>, its value is never shown but may be
used to test whether the given parameter is empty.
</p>
+<p>
+ Array elements, such as in the <tt><args></tt> parameter
+ of <ex>:command</ex> macros, may be accessed by appending
+ <tt>[<a>n</a>]</tt>, where <a>n</a> is the one-based array
+ index, to the macro name. The first argument of a command is
+ therefore accessed with <tt><args[1]></tt>.
+</p>
<p>
Any substring enclosed by <em><tt><{</tt></em> and <em><tt>}></tt></em>
is automatically elided if any of the contained macros aren't currently
</item>
<item>
- <spec>:se<oa>t</oa> <a>option</a> <oa>...</oa></spec>
+ <spec>:se<oa>t</oa> <a>option</a> <oa>…</oa></spec>
<description>
<p>
For boolean options, turn them on. For all other types,
</item>
<item>
- <spec>:se<oa>t</oa> no<a>option</a> <oa>...</oa></spec>
+ <spec>:se<oa>t</oa> no<a>option</a> <oa>…</oa></spec>
<description>
<p>
For boolean options, turn them off. For all other types,
</item>
<item>
- <spec>:se<oa>t</oa> <a>option</a>! <oa>...</oa></spec>
- <spec>:se<oa>t</oa> inv<a>option</a> <oa>...</oa></spec>
+ <spec>:se<oa>t</oa> <a>option</a>! <oa>…</oa></spec>
+ <spec>:se<oa>t</oa> inv<a>option</a> <oa>…</oa></spec>
<description>
<p>
For boolean options, invert their value. For all other types,
</item>
<item>
- <spec>:se<oa>t</oa> inv<a>option</a>=<a>value</a> <oa>...</oa></spec>
- <spec>:se<oa>t</oa> <a>option</a>!=<a>value</a> <oa>...</oa></spec>
+ <tags>:set!=</tags>
+ <spec>:se<oa>t</oa> inv<a>option</a>=<a>value</a> <oa>…</oa></spec>
+ <spec>:se<oa>t</oa> <a>option</a>!=<a>value</a> <oa>…</oa></spec>
<description>
<p>For list options, toggle the specified values.</p>
<item>
<tags>:set-default</tags>
- <spec>:se<oa>t</oa> <a>option</a>& <oa>...</oa></spec>
+ <spec>:se<oa>t</oa> <a>option</a>& <oa>…</oa></spec>
<description>
<p>Reset option to its default value.</p>
</description>
</item>
<item>
+ <tags>:set-default-all</tags>
<spec>:se<oa>t</oa> all&</spec>
<description>
<p>Set all options to their default value.</p>
<item>
<tags>:set-args E487 E521</tags>
- <spec>:se<oa>t</oa> <a>option</a>=<a>value</a> <oa>...</oa></spec>
+ <spec>:se<oa>t</oa> <a>option</a>=<a>value</a> <oa>…</oa></spec>
<description>
<p>
Set string or number option to <a>value</a>.
<item>
<tags>:set+=</tags>
- <spec>:se<oa>t</oa> <a>option</a>+=<a>value</a> <oa>...</oa></spec>
+ <spec>:se<oa>t</oa> <a>option</a>+=<a>value</a> <oa>…</oa></spec>
<description>
<p>
Add the <a>value</a> to a number option, or append the <a>value</a>
<item>
<tags>:set^=</tags>
- <spec>:se<oa>t</oa> <a>option</a>^=<a>value</a> <oa>...</oa></spec>
+ <spec>:se<oa>t</oa> <a>option</a>^=<a>value</a> <oa>…</oa></spec>
<description>
<p>
Multiply the <a>value</a> to a number option, or prepend the
<item>
<tags>:set-=</tags>
- <spec>:se<oa>t</oa> <a>option</a>-=<a>value</a> <oa>...</oa></spec>
+ <spec>:se<oa>t</oa> <a>option</a>-=<a>value</a> <oa>…</oa></spec>
<description>
<p>
Subtract the <a>value</a> from a number option, or remove the
<item>
<tags>:set! :set-!</tags>
- <spec>:se<oa>t</oa>! <a>preference</a>=<a>value</a></spec>
- <spec>:se<oa>t</oa>! <a>preference</a>&</spec>
+ <spec>:se<oa>t</oa>! …</spec>
<description>
<p>
- Change any &dactyl.host; <a>preference</a> (those on the about:config
- page). You can also reset/delete these preferences with
- <ex>:set! <a>preference</a>&</ex>.
+ The same as <ex>:set</ex> but operates on &dactyl.host; preferences
+ (those on the about:config page). See <ex>:set</ex> for operator
+ details.
</p>
+ <note>
+ The <em>no</em> and <em>inv</em> prefix operators are not available
+ for setting preferences.
+ </note>
</description>
</item>
<tags>'act' 'activate'</tags>
<strut/>
<spec>'activate' 'act'</spec>
- <type>stringlist</type>
+ <type>&option.activate.type;</type>
<default>addons,bookmarks,diverted,downloads,extoptions,
help,homepage,quickmark,tabopen,paste</default>
<description>
<item>
<tags>'awim' 'altwildmode'</tags>
<spec>'altwildmode' 'awim'</spec>
- <type>stringlist</type>
- <default>list:full</default>
+ <type>&option.altwildmode.type;</type>
+ <default>&option.altwildmode.default;</default>
<description>
<p>
Like <o>wildmode</o>, but when the <k name="A-Tab" mode="c"/> key
<item>
<tags>'au' 'autocomplete'</tags>
<spec>'autocomplete' 'au'</spec>
- <type>regexplist</type>
- <default>.*</default>
+ <type>&option.autocomplete.type;</type>
+ <default>&option.autocomplete.default;</default>
<description>
<p>
Enables automatic completion for completion contexts (see
<item>
<tags>'bh' 'banghist'</tags>
<spec>'banghist' 'bh'</spec>
- <type>boolean</type>
- <default>on</default>
+ <type>&option.banghist.type;</type>
+ <default>&option.banghist.default;</default>
<description>
<p>
Replace occurrences of ! with the previous command when
<tags>$CDPATH</tags>
<tags>'cd' 'cdpath'</tags>
<spec>'cdpath' 'cd'</spec>
- <type>stringlist</type>
+ <type>&option.cdpath.type;</type>
<default type="plain">equivalent to <str>.</str> or <str>.,$CDPATH</str></default>
<description>
<p>
<item>
<tags>'ca' 'cookieaccept'</tags>
<spec>'cookieaccept' 'ca'</spec>
- <type>string</type>
- <default>all</default>
+ <type>&option.cookieaccept.type;</type>
+ <default>&option.cookieaccept.default;</default>
<description>
<p>When to accept cookies.</p>
<item>
<tags>'cl' 'cookielifetime'</tags>
- <spec>'cookielifetime'</spec>
- <type>string</type>
- <default>default</default>
+ <spec>'cookielifetime' 'cl'</spec>
+ <type>&option.cookielifetime.type;</type>
+ <default>&option.cookielifetime.default;</default>
<description>
<p>
The lifetime for which to accept cookies. The available
<item>
<tags>'ck' 'cookies'</tags>
<spec>'cookies' 'ck'</spec>
- <type>stringlist</type> <default>session</default>
+ <type>&option.cookies.type;</type>
+ <default>&option.cookies.default;</default>
<description>
<p>The default action for the <ex>:cookies</ex> command.</p>
</description>
<item>
<tags>'cpt' 'complete'</tags>
<spec>'complete' 'cpt'</spec>
- <type>charlist</type>
- <default>slf</default>
+ <type>&option.complete.type;</type>
+ <default>&option.complete.default;</default>
<description>
<p>Items which are completed at the <ex>:open</ex> prompts. Available items:</p>
- <dl dt="width: 6em;">
- <dt>s</dt> <dd>Search engines and keyword URLs</dd>
- <dt>f</dt> <dd>Local files</dd>
- <dt>l</dt> <dd>&dactyl.host; location bar entries (bookmarks and history sorted in an intelligent way)</dd>
- <dt>b</dt> <dd>Bookmarks</dd>
- <dt>h</dt> <dd>History</dd>
- <dt>S</dt> <dd>Search engine suggestions</dd>
+ <dl dt="width: 6.5em;">
+ <dt>search</dt> <dd>Search engines and keyword URLs</dd>
+ <dt>file</dt> <dd>Local files</dd>
+ <dt>location</dt> <dd>&dactyl.host; location bar entries (bookmarks and history sorted in an intelligent way)</dd>
+ <dt>bookmark</dt> <dd>Bookmarks</dd>
+ <dt>history</dt> <dd>History</dd>
+ <dt>suggestion</dt> <dd>Search engine suggestions</dd>
</dl>
+ <p>
+ Additionally, native search providers can be added by prefixing
+ their names with the string <str delim="'">native:</str>. These
+ providers are often added by other add-ons and are occasionally
+ useful.
+ </p>
+
<p>
The order is important, such that <se opt="complete"><str delim="">bsf</str></se> will
list bookmarks followed by matching quick searches and then
matching files.
</p>
+ <note>
+ For backward compatibility, this option currently accepts a single
+ entry containing single-letter names for completers. This usage
+ is deprecated and will be removed in the future.
+ </note>
+
<warning>
- Using <em>b</em> and <em>h</em> can make completion very slow if
+ Using <em>bookmark</em> and <em>history</em> can make completion very slow if
there are many items.
</warning>
</description>
<item>
<tags>'ds' 'defsearch'</tags>
<spec>'defsearch' 'ds'</spec>
- <type>string</type>
- <default>google</default>
+ <type>&option.defsearch.type;</type>
+ <default>&option.defsearch.default;</default>
<description>
<p>
Sets the default search engine. The default search engine is
</description>
</item>
+<item>
+ <tags>'dls' 'dlsort' 'downloadsort'</tags>
+ <spec>'downloadsort' 'dlsort' 'dls'</spec>
+ <strut/>
+ <type>&option.downloadsort.type;</type>
+ <default>&option.downloadsort.default;</default>
+ <description>
+ <p>
+ <ex>:downloads</ex> sort order, in order of precedence.
+ Each element must be preceded by a <tt>+</tt> or
+ <tt>-</tt>, indicating ascending or descending sorting,
+ respectively. Valid sort orders are:
+ </p>
+
+ <dl>
+ <dt>active</dt> <dd>Whether download is active</dd>
+ <dt>complete</dt> <dd>Percent complete</dd>
+ <dt>date</dt> <dd>Date and time the download began</dd>
+ <dt>filename</dt> <dd>Target filename</dd>
+ <dt>size</dt> <dd>File size</dd>
+ <dt>speed</dt> <dd>Download speed</dd>
+ <dt>time</dt> <dd>Time remaining</dd>
+ <dt>url</dt> <dd>Source URL</dd>
+ </dl>
+ </description>
+</item>
+
<item>
<tags>'editor'</tags>
<spec>'editor'</spec>
- <type>string</type>
- <default><![CDATA[gvim -f +<line> <file>]]></default>
+ <type>&option.editor.type;</type>
+ <default>&option.editor.default;</default>
<description>
<p>
Set the external text editor.
<item>
<tags>'enc' 'encoding'</tags>
<spec>'encoding' 'enc'</spec>
- <type>string</type>
- <default>UTF-8</default>
+ <type>&option.encoding.type;</type>
+ <default>&option.encoding.default;</default>
<description>
<p>
Changes the character encoding of the current buffer. Valid only
<tags>'noeb' 'noerrorbells'</tags>
<tags>'eb' 'errorbells'</tags>
<spec>'errorbells' 'eb'</spec>
- <type>boolean</type>
- <default>off</default>
+ <type>&option.errorbells.type;</type>
+ <default>&option.errorbells.default;</default>
<description>
<p>
Ring the bell when an error message is displayed. See also
<item>
<tags>'ei' 'eventignore'</tags>
<spec>'eventignore' 'ei'</spec>
- <type>stringlist</type>
- <default></default>
+ <type>&option.eventignore.type;</type>
+ <default>&option.eventignore.default;</default>
<description>
<p>
A list of autocommand event names which should be ignored. If the
<tags>'noex' 'noexrc'</tags>
<tags>'ex' 'exrc'</tags>
<spec>'exrc' 'ex'</spec>
- <type>boolean</type>
- <default>off</default>
+ <type>&option.exrc.type;</type>
+ <default>&option.exrc.default;</default>
<description>
<p>
Allow reading of an RC file in the current directory. This file is
<tags>'eht' 'extendedhinttags'</tags>
<spec>'extendedhinttags' 'eht'</spec>
<strut/>
- <type>regexpmap</type>
- <default>[asOTivVWy]:a[href],area[href],img[src],iframe[src],
+ <type>&option.extendedhinttags.type;</type>
+ <default>[asOTvVWy]:':-moz-any-link',area[href],img[src],iframe[src],
+ [A]:[id],a[name],
[f]:body,
[F]:body,code,div,html,p,pre,span,
[iI]:img,
<item>
<tags>'fenc' 'fileencoding'</tags>
<spec>'fileencoding' 'fenc'</spec>
- <type>string</type>
- <default>UTF-8</default>
+ <type>&option.fileencoding.type;</type>
+ <default>&option.fileencoding.default;</default>
<description>
<p>
Changes the character encoding that &dactyl.appName; uses to read
<item>
<tags>'fc' 'findcase'</tags>
<spec>'findcase' 'fc'</spec>
- <type>string</type>
- <default>smart</default>
+ <type>&option.findcase.type;</type>
+ <default>&option.findcase.default;</default>
<description>
<p>Find case matching mode.</p>
</description>
</item>
+<item>
+ <tags>'ff' 'findflags'</tags>
+ <spec>'findflags' 'ff'</spec>
+ <type>&option.findflags.type;</type>
+ <default>&option.findflags.default;</default>
+ <description>
+ <p>Default flags for find invocations.</p>
+
+ <dl>
+ <dt>C</dt> <dd>Match case</dd>
+ <dt>L</dt> <dd>Search all text</dd>
+ <dt>R</dt> <dd>Perform a plain string search</dd>
+ <dt>c</dt> <dd>Ignore case</dd>
+ <dt>l</dt> <dd>Search only in links</dd>
+ <dt>r</dt> <dd>Perform a regular expression search</dd>
+ </dl>
+ </description>
+</item>
+
<item>
<tags>'fh' 'followhints'</tags>
<spec>'followhints' 'fh'</spec>
- <type>number</type>
- <default>0</default>
+ <type>&option.followhints.type;</type>
+ <default>&option.followhints.default;</default>
<description>
- <p>Changes how soon matching hints are followed in Hints mode.</p>
+ <p>
+ Define the conditions under which hints selected by typing the link
+ substring are followed. Hints selected by typing their label (as
+ specified by <o>hintkeys</o>) are always followed immediately.
+ </p>
<p>Possible values:</p>
<dl dt="width: 6em;">
<dt>0</dt> <dd>Follow the first hint as soon as typed text uniquely identifies it.</dd>
- <dt>1</dt> <dd>Follow the selected hint on <k name="CR"/>.</dd>
- <dt>2</dt> <dd>Follow the selected hint on <k name="CR"/> only if it's been <k name="Tab" mode="c"/>-selected.</dd>
+ <dt>1</dt> <dd>Follow the selected hint on <k name="CR" link="false"/>.</dd>
</dl>
</description>
</item>
<tags>'nofs' 'nofullscreen'</tags>
<tags>'fs' 'fullscreen'</tags>
<spec>'fullscreen' 'fs'</spec>
- <type>boolean</type>
- <default>off</default>
+ <type>&option.fullscreen.type;</type>
+ <default>&option.fullscreen.default;</default>
<description>
<p>
Show the current window full-screen. Also hide certain GUI elements, such as
<item>
<tags>'go' 'guioptions'</tags>
<spec>'guioptions' 'go'</spec>
- <type>charlist</type>
- <default>bCrs</default> <!-- TODO: make this config specific -->
+ <type>&option.guioptions.type;</type>
+ <default>&option.guioptions.default;</default>
<description>
<p>Show or hide certain GUI elements.</p>
<item>
<tags>'hf' 'helpfile'</tags>
<spec>'helpfile' 'hf'</spec>
- <type>string</type>
- <default>intro</default>
+ <type>&option.helpfile.type;</type>
+ <default>&option.helpfile.default;</default>
<description>
<p>
Name of the main help file. This is that page shown if the
<item>
<tags>'hin' 'hintinputs'</tags>
<spec>'hintinputs' 'hin'</spec>
- <type>stringlist</type>
- <default>label,value</default>
+ <type>&option.hintinputs.type;</type>
+ <default>&option.hintinputs.default;</default>
<description>
<p>
When generating hints for input elements that do not have an
<item>
<tags>'hk' 'hintkeys'</tags>
<spec>'hintkeys' 'hk'</spec>
- <type>string</type>
- <default>0123456789</default>
+ <type>&option.hintkeys.type;</type>
+ <default>&option.hintkeys.default;</default>
<description>
<p>
The keys used to label and select hints. With its default value,
<item>
<tags>'hm' 'hintmatching'</tags>
<spec>'hintmatching' 'hm'</spec>
- <type>stringlist</type>
- <default>contains</default>
+ <type>&option.hintmatching.type;</type>
+ <default>&option.hintmatching.default;</default>
<description>
<p>Change the hint matching algorithm used in Hints mode.</p>
<tags>'ht' 'hinttags'</tags>
<strut/>
<spec>'hinttags' 'ht'</spec>
- <type>stringlist</type>
- <default>a,area,button,iframe,input:not([type=hidden]),select,textarea,
+ <type>&option.hinttags.type;</type>
+ <default>:-moz-any-link,area,button,iframe,input:not([type=hidden]),
+ label[for],select,textarea,
[onclick],[onmouseover],[onmousedown],[onmouseup],[oncommand],
- [tabindex],[role=link],[role=button]</default>
+ [tabindex],[role=link],[role=button],[contenteditable=true]</default>
<description>
<p>
A list of CSS selectors or XPath expressions used to select elements
<item>
<tags>'hto' 'hinttimeout'</tags>
<spec>'hinttimeout' 'hto'</spec>
- <type>number</type>
- <default>0</default>
+ <type>&option.hinttimeout.type;</type>
+ <default>&option.hinttimeout.default;</default>
<description>
<p>
Timeout in milliseconds before automatically following a non-unique
hint. The timeout is measured since the last time a key listed in
<o>hintkeys</o> was pressed. It has no effect when narrowing hints
by typing part of their text. Set to 0 (the default) to only follow
- hints after pressing <k name="CR"/> or when the hint is unique.
+ hints after pressing <k name="CR" link="false"/> or when the hint is unique.
</p>
</description>
</item>
<item>
<tags>'hi' 'history'</tags>
<spec>'history' 'hi'</spec>
- <type>number</type>
- <default>500</default>
+ <type>&option.history.type;</type>
+ <default>&option.history.default;</default>
<description>
<p>
Maximum number of Ex commands and find patterns to store in the
<tags>'nohlf' 'nohlfind'</tags>
<tags>'hlf' 'hlfind'</tags>
<spec>'hlfind' 'hlf'</spec>
- <type>boolean</type>
- <default>off</default>
+ <type>&option.hlfind.type;</type>
+ <default>&option.hlfind.default;</default>
<description>
<p>Highlight previous find pattern matches.</p>
</description>
<tags>'noif' 'noincfind'</tags>
<tags>'if' 'incfind'</tags>
<spec>'incfind' 'if'</spec>
- <type>boolean</type>
- <default>on</default>
+ <type>&option.incfind.type;</type>
+ <default>&option.incfind.default;</default>
<description>
<p>Show the first match for a find pattern as it is typed.</p>
</description>
<tags>'noim' 'noinsertmode'</tags>
<tags>'im' 'insertmode'</tags>
<spec>'insertmode' 'im'</spec>
- <type>boolean</type>
- <default>on</default>
+ <type>&option.insertmode.type;</type>
+ <default>&option.insertmode.default;</default>
<description>
<p>
Use Insert mode as the default for text areas. This is useful if you
</p>
<p>
- TextEdit mode can be entered with <k name="C-t" mode="I"/> from Insert mode.
+ Text Edit mode can be entered with <k name="C-t" mode="I"/> from Insert mode.
</p>
</description>
</item>
+<item>
+ <tags>'isk' 'iskeyword'</tags>
+ <spec>'iskeyword' 'isk'</spec>
+ <type>&option.iskeyword.type;</type>
+ <default>&option.iskeyword.default;</default>
+ <description>
+ <p>Regular expression defining which characters constitute words.</p>
+ </description>
+</item>
+
<item>
<tags>'nojsd' 'nojsdebugger'</tags>
<tags>'jsd' 'jsdebugger'</tags>
<spec>'jsdebugger' 'jsd'</spec>
- <type>boolean</type>
- <default>off</default>
+ <type>&option.jsdebugger.type;</type>
+ <default>&option.jsdebugger.default;</default>
<description>
<p>
Use the JavaScript debugger service for JavaScript completion.
</item>
<item>
- <tags>'nolpl' 'noloadplugins'</tags>
+ <tags>'jt' 'jumptags'</tags>
+ <spec>'jumptags' 'jt'</spec>
+ <type>&option.jumptags.type;</type>
+ <default>&option.jumptags.default;</default>
+ <description>
+ <p>XPath or CSS selector strings of jumpable elements for extended hint modes.</p>
+ </description>
+</item>
+
+<item>
+ <tags>'ln' 'linenumbers'</tags>
+ <spec>'linenumbers' 'ln'</spec>
+ <type>&option.linenumbers.type;</type>
+ <default><![CDATA['view-source:*':[id^=line],
+ code.google.com:'#nums [id^="nums_table"] a[href^="#"]',
+ github.com:.line_numbers>*,
+ mxr.mozilla.org:a.l,
+ pastebin.com:#code_frame>div>ol>li,
+ addons.mozilla.org:.gutter>.line>a,
+ bugzilla.mozilla.org:.bz_comment:not(.bz_first_comment):not(.ih_history),
+ *:'/* Hgweb/Gitweb */ .completecodeline a.codeline, a.linenr']]></default>
+ <description>
+ <p>
+ Patterns used to determine line numbers used by <k>G</k>. May be
+ either a selector expression as accepted by <o>hinttags</o>, or the
+ string <str delim="'">func:</str> followed by a JavaScript
+ expression which evaluates to a function. In the former case, the
+ first matching element whose text content is equal to the desired
+ line number is used. If no such element exists, the <oa>count</oa>th
+ matching element is used. In the latter case, the provided function
+ must accept two arguments, the document in question and the desired
+ line number, and must return the element corresponding to the given
+ line.
+ </p>
+ </description>
+</item>
+
+
+<item>
<tags>'lpl' 'loadplugins'</tags>
<spec>'loadplugins' 'lpl'</spec>
- <type>regexplist</type>
- <default>'\.(js|&dactyl.fileExt;)$'</default>
+ <type>&option.loadplugins.type;</type>
+ <default>&option.loadplugins.default;</default>
<description>
<p>
A regular expression list that defines which plugins are loaded at
</description>
</item>
-<item>
- <tags>'ml' 'mapleader'</tags>
- <spec>'mapleader' 'ml'</spec>
- <type>string</type>
- <default>\</default>
- <description>
- <p>Defines the replacement keys for the <k name="Leader"/> pseudo-key.</p>
- </description>
-</item>
-
<item>
<tags>'maxitems'</tags>
<spec>'maxitems'</spec>
- <type>number</type>
- <default>20</default>
+ <type>&option.maxitems.type;</type>
+ <default>&option.maxitems.default;</default>
<description>
<p>Maximum number of items to display at once in a listing.</p>
</description>
<item>
<tags>'msgs' 'messages'</tags>
<spec>'messages' 'msgs'</spec>
- <type>number</type>
- <default>100</default>
+ <type>&option.messages.type;</type>
+ <default>&option.messages.default;</default>
<description>
<p>Maximum number of messages to store in the message history.</p>
</description>
<item>
<tags>'nomore' 'more'</tags>
<spec>'more'</spec>
- <type>boolean</type>
- <default>on</default>
+ <type>&option.more.type;</type>
+ <default>&option.more.default;</default>
<description>
<p>
Pause the message list window when more than one screen of
<item>
<tags>'newtab'</tags>
<spec>'newtab'</spec>
- <type>stringlist</type>
- <default></default>
+ <type>&option.newtab.type;</type>
+ <default>&option.newtab.default;</default>
<description>
<p>
Defines which Ex commands open pages in new tabs rather than the
<tags>'nextpattern'</tags>
<strut/>
<spec>'nextpattern'</spec>
- <type>stringlist</type>
- <default>'\bnext',^>$,'^(>>|»)$','^(>|»)','(>|»)$','\bmore\b'</default>
+ <type>&option.nextpattern.type;</type>
+ <default>&option.nextpattern.default;</default>
<description>
<p>
Patterns to use when guessing the next page in a document
<item>
<tags>'noonline' 'online'</tags>
<spec>'online'</spec>
- <type>boolean</type>
- <default>on</default>
+ <type>&option.online.type;</type>
+ <default>&option.online.default;</default>
<description>
<p>
Enables or disables ‘offline’ mode, where network access is
<item>
<tags>'pa' 'pageinfo'</tags>
<spec>'pageinfo' 'pa'</spec>
- <type>charlist</type>
- <default>gfm</default>
+ <type>&option.pageinfo.type;</type>
+ <default>&option.pageinfo.default;</default>
<description>
<p>Info shown in the <ex>:pageinfo</ex> output.</p>
<dl dt="width: 6em;">
<dt>g</dt> <dd>General info</dd>
+ <dt>e</dt> <dd>Search Engines</dd>
<dt>f</dt> <dd>Feeds</dd>
<dt>m</dt> <dd>Meta tags</dd>
+ <dt>s</dt> <dd>Security information</dd>
</dl>
<p>
<item>
<tags>'pk' 'passkeys'</tags>
<spec>'passkeys' 'pk'</spec>
- <type>sitemap</type>
- <default/>
+ <type>&option.passkeys.type;</type>
+ <default>&option.passkeys.default;</default>
<description>
<p>
Pass certain keys through directly for the given URLs.
- For any page with a URL matching a given regexp, all key
- events for keys listed in that regexp's value are passed
+ For any page with a URL matching a given <t>site-filter</t>, all key
+ events for keys listed in the corresponding value are passed
through directly to &dactyl.host;, and are not processed
by &dactyl.appName; in any way. Key names are separated
by commas, where the first key name is treated as a list
</description>
</item>
+<item>
+ <tags>'pu' 'passunknown'</tags>
+ <spec>'passunknown' 'pu'</spec>
+ <type>&option.passunknown.type;</type>
+ <default>&option.passunknown.default;</default>
+ <description>
+ <p>
+ Pass unknown keys through to &dactyl.host; in these
+ <t>modes</t>. The first element matching a currently
+ active mode is the one that takes effect. Modes may be
+ negated by prefixing them with a <tt>!</tt>.
+ </p>
+ </description>
+</item>
+
<item>
<tags>'pps' 'popups'</tags>
<spec>'popups' 'pps'</spec>
- <type>stringlist</type>
- <default>tab</default>
+ <type>&option.popups.type;</type>
+ <default>&option.popups.default;</default>
<description>
<p>
Defines where to show requested pop-up windows. Applies only to
<tags>'previouspattern'</tags>
<strut/>
<spec>'previouspattern'</spec>
- <type>stringlist</type>
- <default><![CDATA['\bprev|previous\b',^<$,'^(<<|«)$','^(<|«)','(<|«)$']]></default>
+ <type>&option.previouspattern.type;</type>
+ <default>&option.previouspattern.default;</default>
<description>
<p>
Patterns to use when guessing the previous page in a document
</description>
</item>
-<item>
- <tags>'noprivate' 'private'</tags>
- <spec>'private'</spec>
- <type>boolean</type>
- <default>off</default>
- <description>
- <p>
- Set the <str>private browsing</str> option. In private browsing mode
- history, cache files, cookies, form data, passwords, download list
- entries, local and URL <t>marks</t>, <t>command-line</t> history
- and macros are available only for the duration of the private
- browsing session and deleted when returning to normal browsing
- mode. See also <t>privacy</t>.
- </p>
- </description>
-</item>
-
<item>
<tags>$&dactyl.idName;_RUNTIME</tags>
<tags>'rtp' 'runtimepath'</tags>
<spec>'runtimepath' 'rtp'</spec>
- <type>stringlist</type>
+ <type>&option.runtimepath.type;</type>
<default type="plain"><str>$&dactyl.idName;_RUNTIME</str> or
Unix, Mac: <str>~/.&dactyl.name;</str>
Windows: <str>~/&dactyl.name;</str></default>
<ul>
<li>colors/</li>
- <li>macros/</li>
<li>plugins/</li>
</ul>
<tags>'si' 'sanitizeitems'</tags>
<spec>'sanitizeitems' 'si'</spec>
<strut/>
- <type>stringlist</type>
- <default>all</default>
+ <type>&option.sanitizeitems.type;</type>
+ <default>&option.sanitizeitems.default;</default>
<description>
<p>
The default list of private items to sanitize. See
- <ex>:sanitize</ex> for a list and explanation of possible values.
+ <ex>:sanitize</ex> for a list and explanation of possible values. A
+ value of <str>all</str> will cause all items to be sanitized. Items
+ may be excluded by prefixing them with a <tt>!</tt>. The first
+ matching item takes precedence.
</p>
</description>
</item>
<item>
<tags>'ss' 'sanitizeshutdown'</tags>
<spec>'sanitizeshutdown' 'ss'</spec>
- <type>stringlist</type>
- <default/>
+ <type>&option.sanitizeshutdown.type;</type>
+ <default>&option.sanitizeshutdown.default;</default>
<description>
<p>The items to sanitize automatically at shutdown.</p>
</description>
<tags>'sts' 'sanitizetimespan'</tags>
<spec>'sanitizetimespan' 'sts'</spec>
<strut/>
- <type>number</type>
- <default>all</default>
+ <type>&option.sanitizetimespan.type;</type>
+ <default>&option.sanitizetimespan.default;</default>
<description>
<p>
The default sanitizer time span. Only items created within this timespan are
<item>
<tags>'scr' 'scroll'</tags>
<spec>'scroll' 'scr'</spec>
- <type>number</type>
- <default>0</default>
+ <type>&option.scroll.type;</type>
+ <default>&option.scroll.default;</default>
<description>
<p>
Number of lines to scroll with <k name="C-u"/> and <k name="C-d"/>
commands. The number of lines scrolled defaults to half the window
size. When a <oa>count</oa> is specified to the <k name="C-u"/> or
- <k name="C-d"/> commands, that value is used instead. When the
- value is <em>0</em>, it defaults to half the window height.
+ <k name="C-d"/> commands, set this option to <oa>count</oa> before
+ executing the command. Setting this to <em>0</em> restores the
+ default behaviour.
+ </p>
+ </description>
+</item>
+
+<item>
+ <tags>'scs' 'scrollsteps'</tags>
+ <spec>'scrollsteps' 'scs'</spec>
+ <type>&option.scrollsteps.type;</type>
+ <default>&option.scrollsteps.default;</default>
+ <description>
+ <p>
+ The number of steps in which to smooth scroll to a new position. If
+ set to 1, smooth scrolling is not used.
</p>
</description>
</item>
+<item>
+ <tags>'sct' 'scrolltime'</tags>
+ <spec>'scrolltime' 'sct'</spec>
+ <type>&option.scrolltime.type;</type>
+ <default>&option.scrolltime.default;</default>
+ <description>
+ <p>The time, in milliseconds, in which to smooth scroll to a new position.</p>
+ </description>
+ </item>
+
<item>
<tags>'sh' 'shell'</tags>
<spec>'shell' 'sh'</spec>
- <type>string</type>
+ <type>&option.shell.type;</type>
<default type="plain"><em>$SHELL</em> or <str>sh</str>, Windows: <str>cmd.exe</str></default>
<description>
<p>Shell to use for executing <ex>:!</ex> and <ex>:run</ex> commands.</p>
<tags>'shcf' 'shellcmdflag'</tags>
<spec>'shellcmdflag' 'shcf'</spec>
<strut/>
- <type>string</type>
+ <type>&option.shellcmdflag.type;</type>
<default type="plain"><str>-c</str>, Windows: <str>/c</str></default>
<description>
<p>Flag passed to shell when executing <ex>:!</ex> and <ex>:run</ex> commands.</p>
</item>
<item>
- <tags>'nosmd' 'noshowmode'</tags>
<tags>'smd' 'showmode'</tags>
<spec>'showmode' 'smd'</spec>
- <type>regexplist</type>
- <default>!^normal$</default>
+ <type>&option.showmode.type;</type>
+ <default>&option.showmode.default;</default>
<description>
- <p>Show the current mode in the command line if it matches this expression.</p>
+ <p>
+ Show the current mode in the command line if it or any
+ of its parent <t>modes</t> is included in the list.
+ Modes may be negated by prefixing them with a
+ <tt>!</tt>.
+ </p>
</description>
</item>
<tags>'ssli' 'showstatuslinks'</tags>
<spec>'showstatuslinks' 'ssli'</spec>
<strut/>
- <type>string</type>
- <default>status</default>
+ <type>&option.showstatuslinks.type;</type>
+ <default>&option.showstatuslinks.default;</default>
<description>
<p>
When the mouse hovers over a link, or a link is otherwise focused,
<item>
<tags>'stal' 'showtabline'</tags>
<spec>'showtabline' 'stal'</spec>
- <type>string</type>
- <default>always</default>
+ <type>&option.showtabline.type;</type>
+ <default>&option.showtabline.default;</default>
<description>
<p>Define when the tab bar is visible.</p>
</item>
<item>
- <tags>'nosf' 'nostrictfocus'</tags>
+ <tags>'spl' 'spelllang'</tags>
+ <spec>'spelllang' 'spl'</spec>
+ <type>&option.spelllang.type;</type>
+ <default>&option.spelllang.default;</default>
+ <description short="true">
+ <p>The language used by the spell checker.</p>
+ </description>
+</item>
+
+<item>
<tags>'sf' 'strictfocus'</tags>
<spec>'strictfocus' 'sf'</spec>
- <type>boolean</type>
- <default>on</default>
+ <type>&option.strictfocus.type;</type>
+ <default>&option.strictfocus.default;</default>
<description>
<p>
Prevent scripts from focusing input elements without user intervention.
</p>
+
+ <p>Possible values:</p>
+
+ <dl>
+ <dt>despotic</dt> <dd>Only allow focus changes when explicitly requested by the user</dd>
+ <dt>laissez-faire</dt> <dd>Always allow focus changes</dd>
+ <dt>moderate</dt> <dd>Allow focus changes after user-initiated focus change</dd>
+ </dl>
</description>
</item>
<item>
<tags>'suggestengines'</tags>
<spec>'suggestengines'</spec>
- <type>stringlist</type>
- <default>google</default>
+ <type>&option.suggestengines.type;</type>
+ <default>&option.suggestengines.default;</default>
<description>
<p>
Set the search engines which can be used for completion
<tags>'notmo' 'notimeout'</tags>
<tags>'tmo' 'timeout'</tags>
<spec>'timeout' 'tmo'</spec>
- <type>boolean</type>
- <default>true</default>
+ <type>&option.timeout.type;</type>
+ <default>&option.timeout.default;</default>
<description>
<p>
When this option is set and a key sequence interpretable both as a
<item>
<tags>'tmol' 'timeoutlen'</tags>
<spec>'timeoutlen' 'tmol'</spec>
- <type>number</type>
- <default>1000</default>
+ <type>&option.timeoutlen.type;</type>
+ <default>&option.timeoutlen.default;</default>
<description>
<p>
Maximum number of milliseconds to wait for a longer key command
<item>
<tags>'titlestring'</tags>
<spec>'titlestring'</spec>
- <type>string</type>
- <default>&dactyl.appName;</default>
+ <type>&option.titlestring.type;</type>
+ <default>&option.titlestring.default;</default>
<description>
<p>
Set the application name shown after the current page title in
<item>
<tags>'us' 'urlsep' 'urlseparator'</tags>
<spec>'urlseparator' 'urlsep' 'us'</spec>
- <type>string</type>
- <default>\|</default>
+ <type>&option.urlseparator.type;</type>
+ <default>&option.urlseparator.default;</default>
<description>
<p>
The regular expression used to split URL lists in commands
like <ex>:open</ex>. When set to the empty string, URL lists
- are never split. With the default value, the following will open
- three URLs in the current tab and two new background tabs,
+ are never split. With the default settings, the following will open
+ three URLs (the first one in the current tab and the latter two in
+ two new background tabs):
</p>
<code><ex>:open <str delim="">google Linux</str> | <str delim="">wikipedia Arch Linux</str> | <str delim="">imdb Serenity</str></ex></code>
</description>
<tags>'noum' 'nousermode'</tags>
<tags>'um' 'usermode'</tags>
<spec>'usermode' 'um'</spec>
- <type>boolean</type>
- <default>off</default>
+ <type>&option.usermode.type;</type>
+ <default>&option.usermode.default;</default>
<description>
<p>Show current website with minimal styling.</p>
</description>
<item>
<tags>'vbs' 'verbose'</tags>
<spec>'verbose' 'vbs'</spec>
- <type>number</type>
- <default>1</default>
+ <type>&option.verbose.type;</type>
+ <default>&option.verbose.default;</default>
<description>
<p>
Define which info messages are displayed. As the value increases,
<tags>'novb' 'novisualbell'</tags>
<tags>'vb' 'visualbell'</tags>
<spec>'visualbell' 'vb'</spec>
- <type>boolean</type>
- <default>off</default>
+ <type>&option.visualbell.type;</type>
+ <default>&option.visualbell.default;</default>
<description>
<p>
Use visual bell instead of beeping on errors. The visual bell
<tags>'wia' 'wildanchor'</tags>
<strut/>
<spec>'wildanchor' 'wia'</spec>
- <type>regexplist</type>
- <default>!'/ex/(back|buffer|ext|forward|help|undo)'</default>
+ <type>&option.wildanchor.type;</type>
+ <default>&option.wildanchor.default;</default>
<description>
<p>
Regular expression list defining which completion groups show only
<item>
<tags>'wic' 'wildcase'</tags>
<spec>'wildcase' 'wic'</spec>
- <type>regexpmap</type>
- <default>.?:smart</default>
+ <type>&option.wildcase.type;</type>
+ <default>&option.wildcase.default;</default>
<description>
<p>
Defines how completions are matched with regard to character case.
<item>
<tags>'wig' 'wildignore'</tags>
<spec>'wildignore' 'wig'</spec>
- <type>regexplist</type>
- <default></default>
+ <type>&option.wildignore.type;</type>
+ <default>&option.wildignore.default;</default>
<description>
<p>
- List of file patterns to ignore when completing files. For example,
- the following will ignore object files and Vim swap files:
+ List of path name patterns to ignore when completing files and
+ directories. For example, the following will ignore object files
+ and Vim swap files:
</p>
<set opt="wildignore"><str delim="'">\.o$</str>,<str delim="'">^\..*\.s[a-z]{2}$</str></set>
<item>
<tags>'wim' 'wildmode'</tags>
<spec>'wildmode' 'wim'</spec>
- <type>stringlist</type>
- <default>list:full</default>
+ <type>&option.wildmode.type;</type>
+ <default>&option.wildmode.default;</default>
<description>
<p>
Defines how command-line completion works. It is a comma-separated
<item>
<tags>'wis' 'wildsort'</tags>
<spec>'wildsort' 'wis'</spec>
- <type>regexplist</type>
- <default>.*</default>
+ <type>&option.wildsort.type;</type>
+ <default>&option.wildsort.default;</default>
<description>
<p>
A list of regular expressions defining which completion contexts
<tags>'wsp' 'wordseparators'</tags>
<spec>'wordseparators' 'wsp'</spec>
<strut/>
- <type>string</type>
- <default><![CDATA[[.,!?:;\\/"^$%&?()[\]{}<>#*+|=~ _-]]]></default>
+ <type>&option.wordseparators.type;</type>
+ <default>&option.wordseparators.default;</default>
<description>
<p>
A regular expression which defines how words are split for
</description>
</item>
+<item>
+ <tags>'ys' 'yankshort'</tags>
+ <spec>'yankshort' 'ys'</spec>
+ <type>&option.yankshort.type;</type>
+ <default>&option.yankshort.default;</default>
+ <description>
+ <p>Yank the canonical short URL of a web page where provided.</p>
+ </description>
+</item>
+
+
</document>
<!-- vim:se sts=4 sw=4 et: -->
projects / dactyl.git / blobdiff