<?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/><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>
<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],
[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]),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>&option.linenumbers.default;</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>, in
+ which case the first matching element whose text content is equal to
+ the desired line number is used or the <oa>count</oa>th element
+ failing that, or the string <str delim="'">func:</str> followed by a
+ function which, given arguments for the document and desired line
+ number, must return the target element.
+ </p>
+ </description>
+</item>
+
+
<item>
<tags>'lpl' 'loadplugins'</tags>
<spec>'loadplugins' 'lpl'</spec>
<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>
</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