1
0
mirror of https://github.com/gryf/pentadactyl-pm.git synced 2025-12-23 01:57:59 +01:00

Add new privacy.xml help file.

--HG--
extra : rebase_source : e141c5426e02dc38e38acb11fbf94ce4e5d62fc9
This commit is contained in:
Doug Kearns
2011-02-01 20:08:46 +11:00
parent a21db1858a
commit 35a6b6eaf4
5 changed files with 163 additions and 139 deletions

View File

@@ -31,6 +31,7 @@
<include href="gui" tag="gui.xml"/>
<include href="styling" tag="styling.xml"/>
<include href="message" tag="message.xml"/>
<include href="privacy" tag="privacy.xml"/>
<include href="developer" tag="developer.xml"/>
<include href="various" tag="various.xml"/>
<include href="plugins" tag="plugins.xml"/>

View File

@@ -0,0 +1,156 @@
<?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="privacy"
title="&dactyl.appName; Privacy"
xmlns="&xmlns.dactyl;"
xmlns:html="&xmlns.html;">
<h1 tag="privacy">Privacy and sensitive information</h1>
<toc start="2"/>
<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>
<h2 tag="private-mode porn-mode">Private mode browsing</h2>
<p>
&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>
<h2 tag="sanitizing clearing-data">Clearing private data</h2>
<p>
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>host </dt> <dd>All data from the given host</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>host</em>, <em>offlineapps</em>,
<em>passwords</em>, <em>sessions</em>, <em>sitesettings</em>.
Conversely, <em>host</em> and <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 either of <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>host</em>,
when a request is made to &dactyl.host; to purge all data for
<a>host</a>. Included in this purge are all matching history
entries, cookies, closed tabs, form data, and location bar
entries.
</note>
</description>
</item>
<h2 tag="cookie-settings">Cookie settings</h2>
<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>
</document>
<!-- vim:se sts=4 sw=4 et: -->

View File

@@ -152,143 +152,6 @@
</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>host </dt> <dd>All data from the given host</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>host</em>, <em>offlineapps</em>,
<em>passwords</em>, <em>sessions</em>, <em>sitesettings</em>.
Conversely, <em>host</em> and <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 either of <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>host</em>,
when a request is made to &dactyl.host; to purge all data for
<a>host</a>. 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>

View File

@@ -17,8 +17,8 @@ var setupTest = function (test) {
const HELP_FILES = ["all", "tutorial", "intro", "starting", "browsing",
"buffer", "cmdline", "insert", "options", "pattern", "tabs", "hints",
"map", "eval", "marks", "repeat", "autocommands", "print", "gui",
"styling", "message", "developer", "various", "plugins", "faq", "versions",
"index"];
"styling", "message", "privacy", "developer", "various", "plugins", "faq",
"versions", "index"];
var testViHelpCommand_OpensIntroHelpPage = function () {
assertHelpOpensPageWithTag({

View File

@@ -94,6 +94,10 @@
<link topic="message">Error and informational messages</link>:
A description of informational and error messages.
</li>
<li>
<link topic="privacy">Privacy and sensitive information</link>:
How to manage your private data while browsing.
</li>
<li>
<link topic="developer">Developer information</link>:
How to write plugins and documentation.