Update links to the client-tags CGI page

[privoxy.git] / doc / source / p-config.sgml

diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml
index da88c4b..208887e 100644 (file)
--- a/doc/source/p-config.sgml
+++ b/doc/source/p-config.sgml
@@ -3,7 +3,7 @@
 
  Purpose     :  Used with other docs and files only.
 
- $Id: p-config.sgml,v 2.114 2016/02/26 12:32:56 fabiankeil Exp $
+ $Id: p-config.sgml,v 2.119 2016/03/30 11:14:46 fabiankeil Exp $
 
  Copyright (C) 2001-2016 Privoxy Developers http://www.privoxy.org/
  See LICENSE.
@@ -97,7 +97,7 @@
  Sample Configuration File for Privoxy &p-version;
 </title>
 <para>
- $Id: p-config.sgml,v 2.114 2016/02/26 12:32:56 fabiankeil Exp $
+ $Id: p-config.sgml,v 2.119 2016/03/30 11:14:46 fabiankeil Exp $
 </para>
 <para>
 Copyright (C) 2001-2016 Privoxy Developers http://www.privoxy.org/
@@ -2478,6 +2478,12 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
     <application>Privoxy's</application> listening port is reachable
     by the outside or an attacker has access to the pages you visit.
    </para>
+   <para>
+    If you are running Privoxy as intercepting proxy without being
+    able to intercept all client requests you may want to adjust
+    the CGI templates to make sure they don't reference content from
+    config.privoxy.org.
+   </para>
   </listitem>
  </varlistentry>
  <varlistentry>
@@ -3401,7 +3407,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
    <para>
     After a client-specific tag has been defined with the client-specific-tag
     directive, action sections can be activated based on the tag by using a
-    <ulink url="#CLIENT-TAG-PATTERN">CLIENT-TAG</ulink> pattern.
+    <ulink url="actions-file.html#CLIENT-TAG-PATTERN">CLIENT-TAG</ulink> pattern.
     The CLIENT-TAG pattern is evaluated at the same priority
     as URL patterns, as a result the last matching pattern wins.
     Tags that are created based on client or server headers are evaluated
@@ -3415,7 +3421,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
    </para>
    <para>
     Clients can request tags to be set by using the CGI interface <ulink
-     url="http://config.privoxy.org/show-client-tags">http://config.privoxy.org/show-client-tags</ulink>.
+     url="http://config.privoxy.org/client-tags">http://config.privoxy.org/client-tags</ulink>.
     The specific tag description is only used on the web page and should
     be phrased in away that the user understand the effect of the tag.
    </para>
@@ -3437,6 +3443,69 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
 </variablelist>
 </sect3>
 
+<!--  ~  End section  ~  -->
+
+<sect3 renderas="sect4" id="client-tag-lifetime"><title>client-tag-lifetime</title>
+<variablelist>
+ <varlistentry>
+  <term>Specifies:</term>
+  <listitem>
+   <para>
+    How long a temporarily enabled tag remains enabled.
+   </para>
+  </listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>Type of value:</term>
+  <listitem>
+   <para>
+    <replaceable>Time in seconds.</replaceable>
+   </para>
+  </listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>Default value:</term>
+  <listitem>
+   <para>60</para>
+  </listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>Notes:</term>
+  <listitem>
+   <warning>
+   <para>
+    This is an experimental feature. The syntax is likely to change
+    in future versions.
+   </para>
+   </warning>
+   <para>
+    In case of some tags users may not want to enable them permanently,
+    but only for a short amount of time, for example to circumvent a block
+    that is the result of an overly-broad URL pattern.
+   </para>
+   <para>
+    The CGI interface <ulink
+     url="http://config.privoxy.org/client-tags">http://config.privoxy.org/client-tags</ulink>
+    therefore provides a "enable this tag temporarily" option.
+    If it is used, the tag will be set until the client-tag-lifetime
+    is over.
+   </para>
+  </listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>Examples:</term>
+  <listitem>
+   <para>
+    <screen>
+      # Increase the time to life for temporarily enabled tags to 3 minutes
+      client-tag-lifetime 180
+    </screen>
+   </para>
+  </listitem>
+ </varlistentry>
+</variablelist>
+</sect3>
+
 </sect2>
 
 <!--  ~  End section  ~  -->