Regenerate user-manual
[privoxy.git] / doc / webserver / user-manual / config.html
index 0d13a39..d0cd99a 100644 (file)
@@ -6,7 +6,7 @@
   <title>The Main Configuration File</title>
   <meta name="GENERATOR" content=
   "Modular DocBook HTML Stylesheet Version 1.79">
-  <link rel="HOME" title="Privoxy 3.0.24 User Manual" href="index.html">
+  <link rel="HOME" title="Privoxy 3.0.25 User Manual" href="index.html">
   <link rel="PREVIOUS" title="Privoxy Configuration" href=
   "configuration.html">
   <link rel="NEXT" title="Actions Files" href="actions-file.html">
@@ -21,7 +21,7 @@
     <table summary="Header navigation table" width="100%" border="0"
     cellpadding="0" cellspacing="0">
       <tr>
-        <th colspan="3" align="center">Privoxy 3.0.24 User Manual</th>
+        <th colspan="3" align="center">Privoxy 3.0.25 User Manual</th>
       </tr>
 
       <tr>
           </dl>
         </div>
       </div>
+
+      <div class="SECT3">
+        <h4 class="SECT3"><a name="CLIENT-SPECIFIC-TAG" id=
+        "CLIENT-SPECIFIC-TAG">7.6.14. client-specific-tag</a></h4>
+
+        <div class="VARIABLELIST">
+          <dl>
+            <dt>Specifies:</dt>
+
+            <dd>
+              <p>The name of a tag that will always be set for clients that
+              requested it through the webinterface.</p>
+            </dd>
+
+            <dt>Type of value:</dt>
+
+            <dd>
+              <p><tt class="REPLACEABLE"><i>Tag name followed by a
+              description that will be shown in the webinterface</i></tt></p>
+            </dd>
+
+            <dt>Default value:</dt>
+
+            <dd>
+              <p>None</p>
+            </dd>
+
+            <dt>Notes:</dt>
+
+            <dd>
+              <div class="WARNING">
+                <table class="WARNING" border="1" width="90%">
+                  <tr>
+                    <td align="center"><b>Warning</b></td>
+                  </tr>
+
+                  <tr>
+                    <td align="left">
+                      <p>This is an experimental feature. The syntax is
+                      likely to change in future versions.</p>
+                    </td>
+                  </tr>
+                </table>
+              </div>
+
+              <p>Client-specific tags allow Privoxy admins to create
+              different profiles and let the users chose which one they want
+              without impacting other users.</p>
+
+              <p>One use case is allowing users to circumvent certain blocks
+              without having to allow them to circumvent all blocks. This is
+              not possible with the <a href=
+              "config.html#ENABLE-REMOTE-TOGGLE">enable-remote-toggle
+              feature</a> because it would bluntly disable all blocks for all
+              users and also affect other actions like filters. It also is
+              set globally which renders it useless in most multi-user
+              setups.</p>
+
+              <p>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 <a href=
+              "actions-file.html#CLIENT-TAG-PATTERN" target=
+              "_top">CLIENT-TAG</a> 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 later on and can
+              overrule CLIENT-TAG and URL patterns!</p>
+
+              <p>The tag is set for all requests that come from clients that
+              requested it to be set. Note that "clients" are differentiated
+              by IP address, if the IP address changes the tag has to be
+              requested again.</p>
+
+              <p>Clients can request tags to be set by using the CGI
+              interface <a href="http://config.privoxy.org/show-client-tags"
+              target="_top">http://config.privoxy.org/show-client-tags</a>.
+              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.</p>
+            </dd>
+
+            <dt>Examples:</dt>
+
+            <dd>
+              <table border="0" bgcolor="#E0E0E0" width="90%">
+                <tr>
+                  <td>
+                    <pre class="SCREEN">
+    # Define a couple of tags, the described effect requires action sections
+    # that are enabled based on CLIENT-TAG patterns.
+    client-specific-tag circumvent-blocks Overrule blocks but do not affect other actions
+    disable-content-filters Disable content-filters but do not affect other actions
+
+</pre>
+                  </td>
+                </tr>
+              </table>
+            </dd>
+          </dl>
+        </div>
+      </div>
+
+      <div class="SECT3">
+        <h4 class="SECT3"><a name="CLIENT-TAG-LIFETIME" id=
+        "CLIENT-TAG-LIFETIME">7.6.15. client-tag-lifetime</a></h4>
+
+        <div class="VARIABLELIST">
+          <dl>
+            <dt>Specifies:</dt>
+
+            <dd>
+              <p>How long a temporarily enabled tag remains enabled.</p>
+            </dd>
+
+            <dt>Type of value:</dt>
+
+            <dd>
+              <p><tt class="REPLACEABLE"><i>Time in seconds.</i></tt></p>
+            </dd>
+
+            <dt>Default value:</dt>
+
+            <dd>
+              <p>60</p>
+            </dd>
+
+            <dt>Notes:</dt>
+
+            <dd>
+              <div class="WARNING">
+                <table class="WARNING" border="1" width="90%">
+                  <tr>
+                    <td align="center"><b>Warning</b></td>
+                  </tr>
+
+                  <tr>
+                    <td align="left">
+                      <p>This is an experimental feature. The syntax is
+                      likely to change in future versions.</p>
+                    </td>
+                  </tr>
+                </table>
+              </div>
+
+              <p>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.</p>
+
+              <p>The CGI interface <a href=
+              "http://config.privoxy.org/show-client-tags" target=
+              "_top">http://config.privoxy.org/show-client-tags</a> therefore
+              provides a "enable this tag temporarily" option. If it is used,
+              the tag will be set until the client-tag-lifetime is over.</p>
+            </dd>
+
+            <dt>Examples:</dt>
+
+            <dd>
+              <table border="0" bgcolor="#E0E0E0" width="90%">
+                <tr>
+                  <td>
+                    <pre class="SCREEN">
+      # Increase the time to life for temporarily enabled tags to 3 minutes
+      client-tag-lifetime 180
+
+</pre>
+                  </td>
+                </tr>
+              </table>
+            </dd>
+          </dl>
+        </div>
+      </div>
     </div>
 
     <div class="SECT2">