Rebuild docs for +limit-cookie-lifetime{} and forward-socks5t
authorFabian Keil <fk@fabiankeil.de>
Fri, 7 Dec 2012 12:48:23 +0000 (12:48 +0000)
committerFabian Keil <fk@fabiankeil.de>
Fri, 7 Dec 2012 12:48:23 +0000 (12:48 +0000)
doc/webserver/user-manual/actions-file.html
doc/webserver/user-manual/appendix.html
doc/webserver/user-manual/config.html
doc/webserver/user-manual/copyright.html
doc/webserver/user-manual/filter-file.html
doc/webserver/user-manual/index.html

index ce06322..37228d0 100644 (file)
         in <tt class="FILENAME">default.action</tt> are:</p>
 
         <div class="TABLE">
-          <a name="AEN2862" id="AEN2862"></a>
+          <a name="AEN2866" id="AEN2866"></a>
 
           <p><b>Table 1. Default Configurations</b></p>
 
     actions</a>.</p>
 
     <div class="SECT2">
-      <h2 class="SECT2"><a name="AEN2961" id="AEN2961">8.1. Finding the Right
+      <h2 class="SECT2"><a name="AEN2965" id="AEN2965">8.1. Finding the Right
       Mix</a></h2>
 
       <p>Note that some <a href="actions-file.html#ACTIONS">actions</a>, like
     </div>
 
     <div class="SECT2">
-      <h2 class="SECT2"><a name="AEN2968" id="AEN2968">8.2. How to
+      <h2 class="SECT2"><a name="AEN2972" id="AEN2972">8.2. How to
       Edit</a></h2>
 
       <p>The easiest way to edit the actions files is with a browser by using
       </div>
 
       <div class="SECT3">
-        <h3 class="SECT3"><a name="AEN3080" id="AEN3080">8.4.1. The Domain
+        <h3 class="SECT3"><a name="AEN3084" id="AEN3084">8.4.1. The Domain
         Pattern</a></h3>
 
         <p>The matching of the domain part offers some flexible options: if
       </div>
 
       <div class="SECT3">
-        <h3 class="SECT3"><a name="AEN3156" id="AEN3156">8.4.2. The Path
+        <h3 class="SECT3"><a name="AEN3160" id="AEN3160">8.4.2. The Path
         Pattern</a></h3>
 
         <p><span class="APPLICATION">Privoxy</span> uses <span class=
@@ -3545,6 +3545,88 @@ nasty-banner-server.example.com/junk.cgi\?output=trash
 +limit-connect{-3, 7, 20-100, 500-}   # Ports less than 3, 7, 20 to 100 and above 500 are OK.
 +limit-connect{-}                     # All ports are OK
 +limit-connect{,}                     # No HTTPS/SSL traffic is allowed
+</pre>
+                  </td>
+                </tr>
+              </table>
+            </dd>
+          </dl>
+        </div>
+      </div>
+
+      <div class="SECT3">
+        <h4 class="SECT3"><a name="LIMIT-COOKIE-LIFETIME" id=
+        "LIMIT-COOKIE-LIFETIME">8.5.27. limit-cookie-lifetime</a></h4>
+
+        <div class="VARIABLELIST">
+          <dl>
+            <dt>Typical use:</dt>
+
+            <dd>
+              <p>Limit the lifetime of HTTP cookies to a couple of minutes or
+              hours.</p>
+            </dd>
+
+            <dt>Effect:</dt>
+
+            <dd>
+              <p>Overwrites the expires field in Set-Cookie server headers if
+              it's above the specified limit.</p>
+            </dd>
+
+            <dt>Type:</dt>
+
+            <dd>
+              <p>Parameterized.</p>
+            </dd>
+
+            <dt>Parameter:</dt>
+
+            <dd>
+              <p>The lifetime limit in minutes, or 0.</p>
+            </dd>
+
+            <dt>Notes:</dt>
+
+            <dd>
+              <p>This action reduces the lifetime of HTTP cookies coming from
+              the server to the specified number of minutes, starting from
+              the time the cookie passes Privoxy.</p>
+
+              <p>Cookies with a lifetime below the limit are not modified.
+              The lifetime of session cookies is set to the specified
+              limit.</p>
+
+              <p>The effect of this action depends on the server.</p>
+
+              <p>In case of servers which refresh their cookies with each
+              response (or at least frequently), the lifetime limit set by
+              this action is updated as well. Thus, a session associated with
+              the cookie continues to work with this action enabled, as long
+              as a new request is made before the last limit set is
+              reached.</p>
+
+              <p>However, some servers send their cookies once, with a
+              lifetime of several years (the year 2037 is a popular choice),
+              and do not refresh them until a certain event in the future,
+              for example the user logging out. In this case this action may
+              limit the absolute lifetime of the session, even if requests
+              are made frequently.</p>
+
+              <p>If the parameter is <span class="QUOTE">"0"</span>, this
+              action behaves like <tt class="LITERAL"><a href=
+              "actions-file.html#SESSION-COOKIES-ONLY">session-cookies-only</a></tt>.</p>
+            </dd>
+
+            <dt>Example usages:</dt>
+
+            <dd>
+              <table border="0" bgcolor="#E0E0E0" width="90%">
+                <tr>
+                  <td>
+                    <pre class="SCREEN">
++limit-cookie-lifetime{60}
+
 </pre>
                   </td>
                 </tr>
@@ -3556,7 +3638,7 @@ nasty-banner-server.example.com/junk.cgi\?output=trash
 
       <div class="SECT3">
         <h4 class="SECT3"><a name="PREVENT-COMPRESSION" id=
-        "PREVENT-COMPRESSION">8.5.27. prevent-compression</a></h4>
+        "PREVENT-COMPRESSION">8.5.28. prevent-compression</a></h4>
 
         <div class="VARIABLELIST">
           <dl>
@@ -3660,7 +3742,7 @@ nasty-banner-server.example.com/junk.cgi\?output=trash
 
       <div class="SECT3">
         <h4 class="SECT3"><a name="OVERWRITE-LAST-MODIFIED" id=
-        "OVERWRITE-LAST-MODIFIED">8.5.28. overwrite-last-modified</a></h4>
+        "OVERWRITE-LAST-MODIFIED">8.5.29. overwrite-last-modified</a></h4>
 
         <div class="VARIABLELIST">
           <dl>
@@ -3756,7 +3838,7 @@ nasty-banner-server.example.com/junk.cgi\?output=trash
       </div>
 
       <div class="SECT3">
-        <h4 class="SECT3"><a name="REDIRECT" id="REDIRECT">8.5.29.
+        <h4 class="SECT3"><a name="REDIRECT" id="REDIRECT">8.5.30.
         redirect</a></h4>
 
         <div class="VARIABLELIST">
@@ -3860,7 +3942,7 @@ www.privoxy.org/user-manual/
 
       <div class="SECT3">
         <h4 class="SECT3"><a name="SERVER-HEADER-FILTER" id=
-        "SERVER-HEADER-FILTER">8.5.30. server-header-filter</a></h4>
+        "SERVER-HEADER-FILTER">8.5.31. server-header-filter</a></h4>
 
         <div class="VARIABLELIST">
           <dl>
@@ -3932,7 +4014,7 @@ example.org/instance-that-is-delivered-as-xml-but-is-not
 
       <div class="SECT3">
         <h4 class="SECT3"><a name="SERVER-HEADER-TAGGER" id=
-        "SERVER-HEADER-TAGGER">8.5.31. server-header-tagger</a></h4>
+        "SERVER-HEADER-TAGGER">8.5.32. server-header-tagger</a></h4>
 
         <div class="VARIABLELIST">
           <dl>
@@ -4005,7 +4087,7 @@ example.org/instance-that-is-delivered-as-xml-but-is-not
 
       <div class="SECT3">
         <h4 class="SECT3"><a name="SESSION-COOKIES-ONLY" id=
-        "SESSION-COOKIES-ONLY">8.5.32. session-cookies-only</a></h4>
+        "SESSION-COOKIES-ONLY">8.5.33. session-cookies-only</a></h4>
 
         <div class="VARIABLELIST">
           <dl>
@@ -4103,7 +4185,7 @@ example.org/instance-that-is-delivered-as-xml-but-is-not
 
       <div class="SECT3">
         <h4 class="SECT3"><a name="SET-IMAGE-BLOCKER" id=
-        "SET-IMAGE-BLOCKER">8.5.33. set-image-blocker</a></h4>
+        "SET-IMAGE-BLOCKER">8.5.34. set-image-blocker</a></h4>
 
         <div class="VARIABLELIST">
           <dl>
@@ -4242,7 +4324,7 @@ example.org/instance-that-is-delivered-as-xml-but-is-not
       </div>
 
       <div class="SECT3">
-        <h3 class="SECT3"><a name="AEN4792" id="AEN4792">8.5.34.
+        <h3 class="SECT3"><a name="AEN4832" id="AEN4832">8.5.35.
         Summary</a></h3>
 
         <p>Note that many of these actions have the potential to cause a page
@@ -4401,7 +4483,7 @@ example.org/instance-that-is-delivered-as-xml-but-is-not
       together:</p>
 
       <div class="SECT3">
-        <h3 class="SECT3"><a name="AEN4856" id="AEN4856">8.7.1.
+        <h3 class="SECT3"><a name="AEN4896" id="AEN4896">8.7.1.
         match-all.action</a></h3>
 
         <p>Remember <span class="emphasis"><i class="EMPHASIS">all actions
@@ -4450,7 +4532,7 @@ example.org/instance-that-is-delivered-as-xml-but-is-not
       </div>
 
       <div class="SECT3">
-        <h3 class="SECT3"><a name="AEN4878" id="AEN4878">8.7.2.
+        <h3 class="SECT3"><a name="AEN4918" id="AEN4918">8.7.2.
         default.action</a></h3>
 
         <p>If you aren't a developer, there's no need for you to edit the
@@ -4793,7 +4875,7 @@ wiki.
       </div>
 
       <div class="SECT3">
-        <h3 class="SECT3"><a name="AEN4991" id="AEN4991">8.7.3.
+        <h3 class="SECT3"><a name="AEN5031" id="AEN5031">8.7.3.
         user.action</a></h3>
 
         <p>So far we are painting with a broad brush by setting general
index 49e26d2..00c9d3d 100644 (file)
     </div>
 
     <div class="SECT2">
-      <h2 class="SECT2"><a name="AEN5872" id="AEN5872">14.2. Privoxy's
+      <h2 class="SECT2"><a name="AEN5912" id="AEN5912">14.2. Privoxy's
       Internal Pages</a></h2>
 
       <p>Since <span class="APPLICATION">Privoxy</span> proxies each
 
       <ul>
         <li>
-          <p>Privoxy main page:</p><a name="AEN5886" id="AEN5886"></a>
+          <p>Privoxy main page:</p><a name="AEN5926" id="AEN5926"></a>
 
           <blockquote class="BLOCKQUOTE">
             <p><a href="http://config.privoxy.org/" target=
 
         <li>
           <p>Show information about the current configuration, including
-          viewing and editing of actions files:</p><a name="AEN5894" id=
-          "AEN5894"></a>
+          viewing and editing of actions files:</p><a name="AEN5934" id=
+          "AEN5934"></a>
 
           <blockquote class="BLOCKQUOTE">
             <p><a href="http://config.privoxy.org/show-status" target=
         </li>
 
         <li>
-          <p>Show the source code version numbers:</p><a name="AEN5899" id=
-          "AEN5899"></a>
+          <p>Show the source code version numbers:</p><a name="AEN5939" id=
+          "AEN5939"></a>
 
           <blockquote class="BLOCKQUOTE">
             <p><a href="http://config.privoxy.org/show-version" target=
         </li>
 
         <li>
-          <p>Show the browser's request headers:</p><a name="AEN5904" id=
-          "AEN5904"></a>
+          <p>Show the browser's request headers:</p><a name="AEN5944" id=
+          "AEN5944"></a>
 
           <blockquote class="BLOCKQUOTE">
             <p><a href="http://config.privoxy.org/show-request" target=
         </li>
 
         <li>
-          <p>Show which actions apply to a URL and why:</p><a name="AEN5909"
-          id="AEN5909"></a>
+          <p>Show which actions apply to a URL and why:</p><a name="AEN5949"
+          id="AEN5949"></a>
 
           <blockquote class="BLOCKQUOTE">
             <p><a href="http://config.privoxy.org/show-url-info" target=
           <span class="QUOTE">"off"</span>, <span class=
           "QUOTE">"Privoxy"</span> continues to run, but only as a
           pass-through proxy, with no actions taking place:</p><a name=
-          "AEN5917" id="AEN5917"></a>
+          "AEN5957" id="AEN5957"></a>
 
           <blockquote class="BLOCKQUOTE">
             <p><a href="http://config.privoxy.org/toggle" target=
             "_top">http://config.privoxy.org/toggle</a></p>
           </blockquote>
 
-          <p>Short cuts. Turn off, then on:</p><a name="AEN5921" id=
-          "AEN5921"></a>
+          <p>Short cuts. Turn off, then on:</p><a name="AEN5961" id=
+          "AEN5961"></a>
 
           <blockquote class="BLOCKQUOTE">
             <p><a href="http://config.privoxy.org/toggle?set=disable" target=
             "_top">http://config.privoxy.org/toggle?set=disable</a></p>
-          </blockquote><a name="AEN5924" id="AEN5924"></a>
+          </blockquote><a name="AEN5964" id="AEN5964"></a>
 
           <blockquote class="BLOCKQUOTE">
             <p><a href="http://config.privoxy.org/toggle?set=enable" target=
index 8918b32..35a12fb 100644 (file)
 
       <div class="SECT3">
         <h4 class="SECT3"><a name="SOCKS" id="SOCKS">7.5.2. forward-socks4,
-        forward-socks4a and forward-socks5</a></h4><a name="FORWARD-SOCKS4"
-        id="FORWARD-SOCKS4"></a><a name="FORWARD-SOCKS4A" id=
-        "FORWARD-SOCKS4A"></a>
+        forward-socks4a, forward-socks5 and forward-socks5t</a></h4><a name=
+        "FORWARD-SOCKS4" id="FORWARD-SOCKS4"></a><a name="FORWARD-SOCKS4A"
+        id="FORWARD-SOCKS4A"></a>
 
         <div class="VARIABLELIST">
           <dl>
               <p>With <tt class="LITERAL">forward-socks5</tt> the DNS
               resolution will happen on the remote server as well.</p>
 
+              <p><tt class="LITERAL">forward-socks5t</tt> works like vanilla
+              <tt class="LITERAL">forward-socks5</tt> but lets <span class=
+              "APPLICATION">Privoxy</span> additionally use Tor-specific
+              SOCKS extensions. Currently the only supported SOCKS extension
+              is optimistic data which can reduce the latency for the first
+              request made on a newly created connection.</p>
+
               <p><tt class="REPLACEABLE"><i>socks_proxy</i></tt> and
               <tt class="REPLACEABLE"><i>http_parent</i></tt> can be a
               numerical IPv6 address (if <a href=
       "LOG-MESSAGES"></a>
 
       <p>If <span class="QUOTE">"log-messages"</span> is set to 1,
-      <span class="APPLICATION">Privoxy</span> copy log messages to the
+      <span class="APPLICATION">Privoxy</span> copies log messages to the
       console window. The log detail depends on the <a href=
       "config.html#DEBUG">debug</a> directive.</p>
 
index 18e058e..9bb3b35 100644 (file)
@@ -51,7 +51,7 @@
     "CITETITLE">GNU General Public License</i>.</p>
 
     <div class="SECT2">
-      <h2 class="SECT2"><a name="AEN5628" id="AEN5628">12.1. License</a></h2>
+      <h2 class="SECT2"><a name="AEN5668" id="AEN5668">12.1. License</a></h2>
 
       <p><span class="APPLICATION">Privoxy</span> is free software; you can
       redistribute it and/or modify it under the terms of the <i class=
       &nbsp;F&eacute;lix&nbsp;Rauch<br>
       &nbsp;Maynard&nbsp;Riley<br>
       &nbsp;Andreas&nbsp;Rutkauskas<br>
-      &nbsp;Chung-chieh&nbsp;Shan<br>
-      &nbsp;Spinor&nbsp;S.<br>
       &nbsp;Bart&nbsp;Schelstraete<br>
+      &nbsp;Chung-chieh&nbsp;Shan<br>
       &nbsp;Dan&nbsp;Stahlke<br>
       &nbsp;Oliver&nbsp;Stoeneberg<br>
+      &nbsp;Rick&nbsp;Sykes<br>
+      &nbsp;Spinor&nbsp;S.<br>
       &nbsp;Peter&nbsp;Thoenen<br>
       &nbsp;Martin&nbsp;Thomas<br>
       &nbsp;Bobby&nbsp;G.&nbsp;Vinyard<br>
index 3a69b31..f2534c3 100644 (file)
@@ -151,7 +151,7 @@ FILTER: foo Replace all "foo" with "bar"
     started.</p>
 
     <div class="SECT2">
-      <h2 class="SECT2"><a name="AEN5146" id="AEN5146">9.1. Filter File
+      <h2 class="SECT2"><a name="AEN5186" id="AEN5186">9.1. Filter File
       Tutorial</a></h2>
 
       <p>Now, let's complete our <span class="QUOTE">"foo"</span> content
index f98ed65..fdd5c05 100644 (file)
@@ -23,7 +23,7 @@
       2001-2011 by <a href="http://www.privoxy.org/" target="_top">Privoxy
       Developers</a></sub><br></p>
 
-      <p class="PUBDATE">$Id: user-manual.sgml,v 2.152 2012/10/29 12:02:55
+      <p class="PUBDATE">$Id: user-manual.sgml,v 2.154 2012/11/11 12:39:15
       fabiankeil Exp $<br></p>
 
       <div>
                 <dt>7.5.1. <a href="config.html#FORWARD">forward</a></dt>
 
                 <dt>7.5.2. <a href="config.html#SOCKS">forward-socks4,
-                forward-socks4a and forward-socks5</a></dt>
+                forward-socks4a, forward-socks5 and forward-socks5t</a></dt>
 
                 <dt>7.5.3. <a href=
                 "config.html#ADVANCED-FORWARDING-EXAMPLES">Advanced
 
         <dd>
           <dl>
-            <dt>8.1. <a href="actions-file.html#AEN2961">Finding the Right
+            <dt>8.1. <a href="actions-file.html#AEN2965">Finding the Right
             Mix</a></dt>
 
-            <dt>8.2. <a href="actions-file.html#AEN2968">How to Edit</a></dt>
+            <dt>8.2. <a href="actions-file.html#AEN2972">How to Edit</a></dt>
 
             <dt>8.3. <a href="actions-file.html#ACTIONS-APPLY">How Actions
             are Applied to Requests</a></dt>
 
             <dd>
               <dl>
-                <dt>8.4.1. <a href="actions-file.html#AEN3080">The Domain
+                <dt>8.4.1. <a href="actions-file.html#AEN3084">The Domain
                 Pattern</a></dt>
 
-                <dt>8.4.2. <a href="actions-file.html#AEN3156">The Path
+                <dt>8.4.2. <a href="actions-file.html#AEN3160">The Path
                 Pattern</a></dt>
 
                 <dt>8.4.3. <a href="actions-file.html#TAG-PATTERN">The Tag
                 "actions-file.html#LIMIT-CONNECT">limit-connect</a></dt>
 
                 <dt>8.5.27. <a href=
-                "actions-file.html#PREVENT-COMPRESSION">prevent-compression</a></dt>
+                "actions-file.html#LIMIT-COOKIE-LIFETIME">limit-cookie-lifetime</a></dt>
 
                 <dt>8.5.28. <a href=
-                "actions-file.html#OVERWRITE-LAST-MODIFIED">overwrite-last-modified</a></dt>
+                "actions-file.html#PREVENT-COMPRESSION">prevent-compression</a></dt>
 
                 <dt>8.5.29. <a href=
-                "actions-file.html#REDIRECT">redirect</a></dt>
+                "actions-file.html#OVERWRITE-LAST-MODIFIED">overwrite-last-modified</a></dt>
 
                 <dt>8.5.30. <a href=
-                "actions-file.html#SERVER-HEADER-FILTER">server-header-filter</a></dt>
+                "actions-file.html#REDIRECT">redirect</a></dt>
 
                 <dt>8.5.31. <a href=
-                "actions-file.html#SERVER-HEADER-TAGGER">server-header-tagger</a></dt>
+                "actions-file.html#SERVER-HEADER-FILTER">server-header-filter</a></dt>
 
                 <dt>8.5.32. <a href=
-                "actions-file.html#SESSION-COOKIES-ONLY">session-cookies-only</a></dt>
+                "actions-file.html#SERVER-HEADER-TAGGER">server-header-tagger</a></dt>
 
                 <dt>8.5.33. <a href=
-                "actions-file.html#SET-IMAGE-BLOCKER">set-image-blocker</a></dt>
+                "actions-file.html#SESSION-COOKIES-ONLY">session-cookies-only</a></dt>
 
                 <dt>8.5.34. <a href=
-                "actions-file.html#AEN4792">Summary</a></dt>
+                "actions-file.html#SET-IMAGE-BLOCKER">set-image-blocker</a></dt>
+
+                <dt>8.5.35. <a href=
+                "actions-file.html#AEN4832">Summary</a></dt>
               </dl>
             </dd>
 
             <dd>
               <dl>
                 <dt>8.7.1. <a href=
-                "actions-file.html#AEN4856">match-all.action</a></dt>
+                "actions-file.html#AEN4896">match-all.action</a></dt>
 
                 <dt>8.7.2. <a href=
-                "actions-file.html#AEN4878">default.action</a></dt>
+                "actions-file.html#AEN4918">default.action</a></dt>
 
                 <dt>8.7.3. <a href=
-                "actions-file.html#AEN4991">user.action</a></dt>
+                "actions-file.html#AEN5031">user.action</a></dt>
               </dl>
             </dd>
           </dl>
 
         <dd>
           <dl>
-            <dt>9.1. <a href="filter-file.html#AEN5146">Filter File
+            <dt>9.1. <a href="filter-file.html#AEN5186">Filter File
             Tutorial</a></dt>
 
             <dt>9.2. <a href="filter-file.html#PREDEFINED-FILTERS">The
 
         <dd>
           <dl>
-            <dt>12.1. <a href="copyright.html#AEN5628">License</a></dt>
+            <dt>12.1. <a href="copyright.html#AEN5668">License</a></dt>
 
             <dt>12.2. <a href="copyright.html#HISTORY">History</a></dt>
 
             <dt>14.1. <a href="appendix.html#REGEX">Regular
             Expressions</a></dt>
 
-            <dt>14.2. <a href="appendix.html#AEN5872">Privoxy's Internal
+            <dt>14.2. <a href="appendix.html#AEN5912">Privoxy's Internal
             Pages</a></dt>
 
             <dd>