path: root/common/locale/en-US/various.xml

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="dactyl://content/help.xsl"?>

<!DOCTYPE document SYSTEM "dactyl://content/dtd">

<document
    name="various"
    title="&dactyl.appName; Other"
    xmlns="&xmlns.dactyl;"
    xmlns:html="&xmlns.html;">

<h1>Other help</h1>
<toc start="2"/>

<h2 tag="various">Various commands</h2>

<item>
    <tags>:contexts</tags>
    <spec>:contexts <a>ex-command</a></spec>
    <description>
        <p>
            Lists the completion contexts used during the completion of its
            arguments. These context names may be used to tune the function of
            the completion system via options like <o>autocomplete</o> and
            <o>wildcase</o>. Note that completion must be triggered in order
            for this command to be effective, so if auto-completion is not
            active, you'll need to press the <k name="Tab" mode="c"/> key at
            least once. You should also be aware that this command is only
            useful from the command line.
        </p>
    </description>
</item>

<item>
    <tags>:fk :feedkeys</tags>
    <spec>feedkeys<oa>!</oa></spec>
    <description>
        <p>Fake key events.</p>

        <dl>
            <dt>-mode</dt> <dd>The mode in which to feed the keys (short name: <em>-m</em>)</dd>
        </dl>
    </description>
</item>

<item>
    <tags>:norm :normal</tags>
    <spec>:norm<oa>al</oa><oa>!</oa> <a>keys</a></spec>
    <description>
        <p>
            Execute key mappings for <a>keys</a> as if they were typed in
            Normal mode. If <oa>!</oa> is provided, only builtin key mappings
            are executed. This makes it possible to fake Normal mode key
            presses from scripts, key mappings, autocommands, and the command
            line.
        </p>
    </description>
</item>

<item>
    <tags>:mks :mksyntax</tags>
    <spec>:mks<oa>yntax</oa><oa>!</oa> <oa>path</oa></spec>
    <description>
        <p>
            Generate a Vim syntax file. If <oa>path</oa> is not given, the local
            Vim runtime path is guessed. If <oa>path</oa> is a directory, the
            file <str delim="">&dactyl.name;.vim</str> in that directory is
            used. An existing file will never be overwritten unless
            <oa>bang</oa> is given.
        </p>
    </description>
</item>

<item>
    <tags><![CDATA[<C-l> CTRL-L :redr :redraw]]></tags>
    <strut/>
    <spec>:redr<oa>aw</oa></spec>
    <description>
        <p>Redraws the screen. Useful for updating the screen during the execution of a script or function.</p>
    </description>
</item>

<item>
    <tags>:run :! :!cmd</tags>
    <strut/>
    <spec>:!<a>cmd</a></spec>
    <description>
        <p>
            Run an external command. Runs <a>cmd</a> through system()
            and displays its output. Any ‘!’ in <a>cmd</a> is replaced with
            the previous external command, so long as it is not preceded by a
            backslash and <o>banghist</o> is enabled.
        </p>
    </description>
</item>

<item>
    <tags>:!!</tags>
    <spec>:!!</spec>
    <description short="true">
        <p>Repeat last <ex>:!<a>cmd</a></ex>.</p>
    </description>
</item>

<item>
    <tags>:sil :silent</tags>
    <spec>:sil<oa>ent</oa> <a>command</a></spec>
    <description>
        <p>
            Execute a command silently. Normal messages and error messages
            generated by the command invocation will not be displayed and will
            not be added to the message history.
        </p>
    </description>
</item>

<item>
    <tags>:verb :verbose</tags>
    <spec>:<oa>count</oa>verb<oa>ose</oa> <a>command</a></spec>
    <description>
        <p>
            Execute a command with <o>verbose</o> set to <oa>count</oa>. If
            <oa>count</oa> is not specified then 1 is used.
        </p>
    </description>
</item>

<item>
    <tags>:ve :version</tags>
    <strut/>
    <spec>:ve<oa>rsion</oa><oa>!</oa></spec>
    <description>
        <p>
            Print &dactyl.appName; and &dactyl.host; version information. When
            <oa>!</oa> is provided, show the &dactyl.host; version page.
        </p>
    </description>
</item>

<item>
    <tags>:yank :y</tags>
    <spec>:y[ank] :<a>cmd</a></spec>
    <spec>:y[ank] <a>js</a></spec>
    <description>
        <p>
            Yanks the output of the given Ex command <a>cmd</a> or JavaScript <a>js</a> to the clipboard.
        </p>
    </description>
</item>

<h2 tag="privacy">Privacy and sensitive information</h2>

<p>
    Part of &dactyl.appName;'s user efficiency comes at the cost of storing a
    lot of potentially private data, including <t>command-line</t> history, page
    marks, visited page history, and the like. Because we know that keeping a
    detailed trail of all of your activities isn't always welcome,
    &dactyl.appName; provides comprehensive facilities for erasing potentially
    sensitive data.
</p>

<p tag="private-mode porn-mode">
    &dactyl.appName; fully supports &dactyl.host;'s private browsing mode.
    When in private browsing mode, no data other than Bookmarks and QuickMarks
    are written to disk. Further, upon exiting private mode, all newly
    accumulated data, including <t>command-line</t> history, local and URL
    marks, and macros, are purged from memory. For more information, see
    <o>private</o>.
</p>

<p tag="sanitizing clearing-data">
    In addition to private mode, &dactyl.appName; provides a comprehensive
    facility for clearing any potentially sensitive data generated by either
    &dactyl.appName; or &dactyl.host;. It directly integrates with
    &dactyl.host;'s own sanitization facility, and so automatically clears any
    domain data and session history when requested. Further, &dactyl.appName;
    provides its own more granular sanitization facility, which allows, e.g.,
    clearing only the command-line and macro history for the past ten minutes.
</p>

<item>
    <tags>:sa :sanitize</tags>
    <spec>:sa<oa>nitize</oa> <oa>-host=<a>host</a></oa> <oa>-older</oa> <oa>-timespan=<a>timespan</a></oa> <a>item</a> …</spec>
    <spec>:sa<oa>nitize</oa>! <oa>-host=<a>host</a></oa> <oa>-older</oa> <oa>-timespan=<a>timespan</a></oa></spec>
    <description>
        <p>
            Clear private data items for <a>timespan</a>, where <a>item</a> …
            is a list of private items to delete. If <oa>!</oa> is specified,
            then <o>sanitizeitems</o> is used for the list of items to delete.
            Items may be any of:
        </p>

        <dl>
            <dt>all         </dt>       <dd>All items</dd>
            <dt>cache       </dt>       <dd>Cache</dd>
            <dt>commandline </dt>       <dd>Command-line history</dd>
            <dt>cookies     </dt>       <dd>Cookies</dd>
            <dt>downloads   </dt>       <dd>Download history</dd>
            <dt>formdata    </dt>       <dd>Saved form and search history</dd>
            <dt>history     </dt>       <dd>Browsing history</dd>
            <dt>marks       </dt>       <dd>Local and URL marks</dd>
            <dt>macros      </dt>       <dd>Saved macros</dd>
            <dt>messages    </dt>       <dd>Saved <ex>:messages</ex></dd>
            <dt>offlineapps </dt>       <dd>Offline website data</dd>
            <dt>options     </dt>       <dd>Options containing hostname data</dd>
            <dt>passwords   </dt>       <dd>Saved passwords</dd>
            <dt>sessions    </dt>       <dd>Authenticated sessions</dd>
            <dt>sitesettings</dt>       <dd>Site preferences</dd>
        </dl>

        <p>
            When <em>history</em> items are sanitized, all command-line
            history items containing URLs or page titles (other than bookmark
            commands) are additionally cleared. Invocations of the
            <em>:sanitize</em> command are included in this set.
        </p>

        <p>
            If <a>timespan</a> (short name <em>-t</em>) is specified, only
            items within that timespan are deleted, otherwise the value of
            <o>sanitizetimespan</o> is used.  If <oa>-older</oa> (short name
            <em>-o</em>) is specified, then only items older than
            <a>timespan</a> are deleted.
        </p>

        <note>
            The following items are always cleared entirely, regardless of
            <a>timeframe</a>: <em>cache</em>, <em>offlineapps</em>,
            <em>passwords</em>, <em>sessions</em>, <em>sitesettings</em>.
            Conversely, <em>options</em> are never cleared unless a host is
            specified.
        </note>

        <p>
            If <a>host</a> (short name <em>-h</em>) is specified, only items
            containing a reference to that domain or a subdomain thereof are
            cleared. Moreover, if <em>commandline</em> or <em>history</em> is
            specified, the invocation of the <em>:sanitize</em> command is
            naturally cleared as well.
        </p>

        <note>
            This only applies to <em>commandline</em>, <em>cookies</em>,
            <em>history</em>, <em>marks</em>, <em>messages</em>,
            <em>options</em>, and <em>sitesettings</em>. All other
            domain-specific data is cleared only along with <em>history</em>,
            when a request is made to &dactyl.host; to purge all data for
            <em>host</em>. Included in this purge are all matching history
            entries, cookies, closed tabs, form data, and location bar
            entries.
        </note>
    </description>
</item>

<h3 tag="cookie-settings">Cookie Settings</h3>
<item>
    <tags>:cookies :ck</tags>
    <spec>:cookies <a>host</a> <oa>action</oa> …</spec>
    <description>
        <p>
            Manage cookies for <a>host</a>. Additionally, the completion
            list will show you information about the cookies and
            permissions for the current page.
        </p>

        <p>Available actions:</p>

        <dl dt="width: 12em">
            <dt>unset</dt>            <dd>Unset special permissions for <a>host</a></dd>
            <dt>allow</dt>            <dd>Allow cookies from <a>host</a></dd>
            <dt>deny</dt>             <dd>Deny cookies from <a>host</a></dd>
            <dt>session</dt>          <dd>Allow cookies from <a>host</a> for the current session</dd>
            <dt>list</dt>             <dd>List all cookies for <a>host</a></dd>
            <dt>clear</dt>            <dd>Clear all cookies for <a>host</a></dd>
            <dt>clear-persistent</dt> <dd>Clear all persistent cookies for <a>host</a></dd>
            <dt>clear-session</dt>    <dd>Clear all session cookies for <a>host</a></dd>
        </dl>

        <p>
            If no <oa>action</oa> is given, the value of <o>cookies</o> is used.
        </p>

        <example><ex>:map -b</ex> <k>c</k> <ex>:cookies</ex> <k name="A-Tab"/></example>
    </description>
</item>

<h2 tag="online-help">Online help</h2>

<item>
    <tags><![CDATA[<F1> :help :h help]]></tags>
    <spec>:h<oa>elp</oa> <oa>subject</oa></spec>
    <spec>&lt;F1></spec>
    <description>
        <p>
            Open a help page for <oa>subject</oa>. If <oa>subject</oa> is
            omitted, open the default page as specified in <o>helpfile</o>.
            If you're not sure of the exact topic you need help with, try
            <k name="Tab" mode="c"/> completion or <ex>:help overview</ex>.
        </p>
    </description>
</item>

<item>
    <tags><![CDATA[<A-F1> :helpall :helpa help-all]]></tags>
    <spec>:helpa<oa>ll</oa> <oa>subject</oa></spec>
    <spec>&lt;A-F1></spec>
    <description>
        <p>
            Open all help pages coalesced into a single page and scroll to
            <oa>subject</oa> if given.
        </p>

        <p>See <ex>:help</ex>.</p>
    </description>
</item>

<item>
    <tags>:lc :listcommands</tags>
    <spec>:listc<oa>ommands</oa> <oa>filter</oa></spec>
    <spec>:lc <oa>filter</oa></spec>
    <description>
        <p>
            List all Ex commands matching <oa>filter</oa> along with their
            short descriptions. The output contains links to the source code
            definitions.
        </p>
    </description>
</item>

<item>
    <tags>:lk :listkeys</tags>
    <spec>:listk<oa>eys</oa> <oa>-mode <a>mode</a></oa> <oa>filter</oa></spec>
    <spec>:lk <oa>-mode <a>mode</a></oa> <oa>filter</oa></spec>
    <description>
        <p>
            List the key mappings defined for <a>mode</a> (Normal by default)
            matching <oa>filter</oa> along with their short descriptions. The
            output contains links to the source code definitions.
        </p>
    </description>
</item>

<item>
    <tags>:lo :listoptions</tags>
    <spec>:listo<oa>ptions</oa> <oa>filter</oa></spec>
    <spec>:lo <oa>filter</oa></spec>
    <description>
        <p>
            List all options matching <oa>filter</oa> along with their short
            descriptions. The output contains links to the source code
            definitions.
        </p>
    </description>
</item>

<tags>42</tags>

<p>
    What is the meaning of life, the universe and everything? Douglas Adams,
    the only person who knew what this question really was about is now dead,
    unfortunately. So now you might wonder what the meaning of death is...
</p>

<h2 tag="uncategorized">Uncategorized help</h2>

<item>
    <tags><![CDATA[<C-[> <Esc>]]></tags>
    <strut/>
    <spec>&lt;Esc></spec>
    <description>
        <p>
            Exits Command-line, Insert, or Hints mode and returns to
            Normal mode. Focuses the content web page.
        </p>
    </description>
</item>

<item>
    <tags><![CDATA[<Insert> i]]></tags>
    <strut/>
    <spec>i</spec>
    <description>
        <p>
            Start Caret mode. This mode resembles the Vim's Normal mode where
            the text cursor is visible on the web page. The <k>v</k> key
            enters visual mode, where text is selected as the cursor moves.
        </p>
    </description>
</item>

</document>

<!-- vim:se sts=4 sw=4 et: -->