<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="dactyl://content/help.xsl"?>
-<!DOCTYPE document SYSTEM "dactyl://content/options.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>.
</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>
<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>
+ <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>
<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>'cl' 'cookielifetime'</tags>
- <spec>'cookielifetime'</spec>
+ <spec>'cookielifetime' 'cl'</spec>
<type>&option.cookielifetime.type;</type>
<default>&option.cookielifetime.default;</default>
<description>
<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>
+<item>
+ <tags>'ds' 'defsearch'</tags>
+ <spec>'defsearch' 'ds'</spec>
+ <type>&option.defsearch.type;</type>
+ <default>&option.defsearch.default;</default>
+ <description>
+ <p>
+ Sets the default search engine. The default search engine is
+ used by <ex>:open</ex> and related commands for arguments which
+ include no search or bookmark keywords and can't otherwise be
+ converted into URLs or existing file names.
+ </p>
+
+ <p>
+ This means that with <o>defsearch</o> set to <str>youtube</str>,
+ <ex>:open Tim Minchin</ex> behaves exactly as
+ <ex>:open youtube Tim Minchin</ex>, so long as you don't have a
+ search or bookmark keyword called ‘Tim’.
+ </p>
+ </description>
+</item>
+
<item>
<tags>'dls' 'dlsort' 'downloadsort'</tags>
- <spec>'downloadsort'</spec>
- <type>stringlist</type>
- <default>-active,+filename</default>
+ <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.
</description>
</item>
-
-<item>
- <tags>'ds' 'defsearch'</tags>
- <spec>'defsearch' 'ds'</spec>
- <type>&option.defsearch.type;</type>
- <default>&option.defsearch.default;</default>
- <description>
- <p>
- Sets the default search engine. The default search engine is
- used by <ex>:open</ex> and related commands for arguments which
- include no search or bookmark keywords and can't otherwise be
- converted into URLs or existing file names.
- </p>
-
- <p>
- This means that with <o>defsearch</o> set to <str>youtube</str>,
- <ex>:open Tim Minchin</ex> behaves exactly as
- <ex>:open youtube Tim Minchin</ex>, so long as you don't have a
- search or bookmark keyword called ‘Tim’.
- </p>
- </description>
-</item>
-
<item>
<tags>'editor'</tags>
<spec>'editor'</spec>
<spec>'extendedhinttags' 'eht'</spec>
<strut/>
<type>&option.extendedhinttags.type;</type>
- <default>[asOTvVWy]:a[href],area[href],img[src],iframe[src],
+ <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,
</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>
<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>1</dt> <dd>Follow the selected hint on <k name="CR" link="false"/>.</dd>
</dl>
</description>
</item>
<strut/>
<spec>'hinttags' 'ht'</spec>
<type>&option.hinttags.type;</type>
- <default>a,area,button,iframe,input:not([type=hidden]),select,textarea,
+ <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
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>
</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>
<item>
<tags>'jt' 'jumptags'</tags>
- <spec>'jumptags'</spec>
+ <spec>'jumptags' 'jt'</spec>
<type>&option.jumptags.type;</type>
<default>&option.jumptags.default;</default>
<description>
</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>
</description>
</item>
-<item>
- <tags>'ml' 'mapleader'</tags>
- <spec>'mapleader' 'ml'</spec>
- <type>&option.mapleader.type;</type>
- <default>&option.mapleader.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>
<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
<item>
<tags>'pu' 'passunknown'</tags>
<spec>'passunknown' 'pu'</spec>
- <type>&option.showmode.type;</type>
- <default>&option.showmode.default;</default>
+ <type>&option.passunknown.type;</type>
+ <default>&option.passunknown.default;</default>
<description>
<p>
Pass unknown keys through to &dactyl.host; in these
</description>
</item>
-<item>
- <tags>'noprivate' 'private'</tags>
- <spec>'private'</spec>
- <type>&option.private.type;</type>
- <default>&option.private.default;</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>
<ul>
<li>colors/</li>
- <li>macros/</li>
<li>plugins/</li>
</ul>
<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>
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>
</description>
</item>
+<item>
+ <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>
<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>
</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