current/doc/source p-config.sgml,2.114,2.115

Update of /cvsroot/ijbswa/current/doc/source
In directory sfp-cvs-1.v30.ch3.sourceforge.com:/tmp/cvs-serv6482/doc/source

Modified Files:
	p-config.sgml 
Log Message:
Document the client-specific-tag directive


Index: p-config.sgml
===================================================================
RCS file: /cvsroot/ijbswa/current/doc/source/p-config.sgml,v
retrieving revision 2.114
retrieving revision 2.115
diff -C2 -d -r2.114 -r2.115
*** p-config.sgml	26 Feb 2016 12:32:56 -0000	2.114
--- p-config.sgml	17 Mar 2016 10:43:20 -0000	2.115
***************
*** 3351,3354 ****
--- 3351,3441 ----
  
  
+ <sect3 renderas="sect4" id="client-specific-tag"><title>client-specific-tag</title>
+ <variablelist>
+  <varlistentry>
+   <term>Specifies:</term>
+   <listitem>
+    <para>
+     The name of a tag that will always be set for clients that
+     requested it through the webinterface.
+    </para>
+   </listitem>
+  </varlistentry>
+  <varlistentry>
+   <term>Type of value:</term>
+   <listitem>
+    <para>
+     <replaceable>Tag name followed by a description that will be shown in the webinterface</replaceable>
+    </para>
+   </listitem>
+  </varlistentry>
+  <varlistentry>
+   <term>Default value:</term>
+   <listitem>
+    <para>None</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>
+     Client-specific tags allow Privoxy admins to create different
+     profiles and let the users chose which one they want without
+     impacting other users.
+    </para>
+    <para>
+     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
+     <link linkend="enable-remote-toggle">enable-remote-toggle feature</link>
+     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.
+    </para>
+    <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.
+     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!
+    </para>
+    <para>
+     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.
+    </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>.
+     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>
+   </listitem>
+  </varlistentry>
+  <varlistentry>
+   <term>Examples:</term>
+   <listitem>
+    <para>
+     <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
+     </screen>
+    </para>
+   </listitem>
+  </varlistentry>
+ </variablelist>
+ </sect3>
+ 
  </sect2>
  


------------------------------------------------------------------------------
Transform Data into Opportunity.
Accelerate data analysis in your applications with
Intel Data Analytics Acceleration Library.
Click to learn more.
http://pubads.g.doubleclick.net/gampad/clk?id=278785231&iu=/4140