Show FEATURE_COMPRESSION on the show-status page
[privoxy.git] / templates / show-status
index 5336d85..4283058 100644 (file)
 # --------------------------------
 #
 #  my-ip-addr:
-#    The IP-address that the client used to reach this proxy
+#    The IP-address that the client used to reach Privoxy
 #  my-hostname:
 #    The hostname associated with my-ip-addr
 #  admin-address:
-#    The email address of the pxoxy's administrator, as configured
+#    The email address of the Privoxy administrator, as configured
 #    in the config file
 #  default-cgi:
-#    The URL for the "main menu" builtin CGI of this proxy
+#    The URL for the "main menu" builtin CGI of Privoxy
 #  menu:
 #    List of <li> elements linking to the other available CGIs
 #  version:
-#    The version number of the proxy software
+#    The Privoxy version number
 #  code-status:
-#    The development status of the proxy software: "alpha", "beta",
-#    or "stable".
+#    The Privoxy development status: "alpha", "beta", or "stable".
 #  homepage:
 #    The URL of the SourceForge ijbswa project, who maintains this
 #    software.
@@ -50,7 +49,7 @@
 #    The URL to a script that will redirect to the Privoxy
 #    documentation for a given item  
 #  invocation:
-#    The command line with whitch Privoxy was invoked
+#    The command line with which Privoxy was invoked
 #  options:
 #    The options read from the configfile, linked to their
 #    explanations, plus warnings if parsing acl or forward
 # ------------------------------------------------------------------
 #
 #  unstable:
-#    This is an alpha or beta release of the proxy software
+#    This is an alpha or beta Privoxy release
 #  have-adminaddr-info:
 #    An e-mail address for the local Privoxy adminstrator has
 #    been specified and is available through the "admin-address"
 #    symbol
 #  have-proxy-info:
-#    A URL for online documentation about this proxy has been
+#    A URL for Privoxy's online documentation has been
 #    specified and is available through the "proxy-info-url"
 #    symbol
 #  have-help-info:
 #    Privoxy was compiled with pcrs support
 #  trust-support:
 #    Privoxy was compiled with trust support
-#  actions-filename:
-#    The path to the actions file.
-#  re-filter-filename:
-#    The path to the re_filter file. Only available if
+#  actions-filenames:
+#    The path to the actions files.
+#  re-filter-filenames:
+#    The path to the re_filter files. Only available if
 #    pcrs-support is set
 #  trust-filename:
-#    The path to the trust file.Only available if
+#    The path to the trust file. Only available if
 #    trust-support is set
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
 <html>
   <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   <meta name="robots" content="noindex,nofollow">
   <link rel="stylesheet" type="text/css" href="@default-cgi@send-stylesheet">
+  <link rel="shortcut icon" href="@default-cgi@favicon.ico" type="image/x-icon">
 </head>
 
 <body>
 
-  <table cellpadding="20" cellspacing="10" border="0" width="100%">
+  <table summary="" cellpadding="20" cellspacing="10" border="0" width="100%">
     <tr>
       <td class="title">
-        <h1>
-          This is <a href="@homepage@">Privoxy</a> @version@ on @my-hostname@ (@my-ip-address@), port @my-port@,
-          @if-enabled-display-then@enabled@else-not-enabled-display@disabled@endif-enabled-display@
-        </h1>
+
+#include mod-title
+
       </td>
     </tr>
 
 # This will only appear if CODE_STATUS is "alpha" or "beta". See configure.in
     <tr>
       <td class="warning">
-        <h2>Warning:</h2>
-          <p>
-            <b>Please note that this <em class="warning">@code-status@</em> release
-            of the proxy software is not intended for production systems!
-            <br>Use at your own risk. See the <a href="http://www.gnu.org/copyleft/gpl.html">license</a> for details.</b>
-          </p>
+
+#include mod-unstable-warning
+
       </td>
     </tr>
 <!-- if-unstable-end@ -->
 
     <tr>
       <td class="box">
-        <h2>The program was invoked as follows</h2>
+        <h2>The following files are in use:</h2>
+        <table summary="Action, filter and trust files in use." class="transparent">
+          <tr>
+            <th colspan="2"><a href="@user-manual@@actions-help-prefix@ACTIONS-FILE">Actions Files:</a></th>
+          </tr>
+            @actions-filenames@
+          <tr>
+            <th colspan="2"><a href="@user-manual@filter-file.html">Filter Files:</a></th>
+          </tr>
+            @re-filter-filenames@
+<!-- @if-trust-support-start -->
+          <tr>
+            <th colspan="2"><a href="@user-manual@config.html#TRUSTFILE">Trust File:</a></th>
+          </tr>
+          <tr>
+            <td>
+              @trust-filename@
+            </td>
+            <td class="buttons">
+              <!-- @if-have-trustfile-start -->
+              <a href="show-status?file=trust">View</a>
+              <!-- if-have-trustfile-end@ -->
+            </td>
+          </tr>
+<!-- if-trust-support-end@ -->
+        </table>
+<!-- @if-cgi-editor-is-disabled-start -->
+        <p>
+          The CGI editor is currently disabled, thus no edit buttons are shown.<br>
+          Please have a look at the
+           <a href="@user-manual@config.html#ENABLE-EDIT-ACTIONS">enable-edit-actions documentation</a>
+          to learn how to enable it and what the risks are.
+        </p>
+<!--  if-cgi-editor-is-disabled-end@ -->
+      </td>
+    </tr>
+
+    <tr>
+      <td class="box">
+        <h2>Privoxy was <a href="@user-manual@startup.html#CMDOPTIONS">invoked</a> as follows:</h2>
         <p>@invocation@</p>
       </td>
     </tr>
 
     <tr>
       <td class="box">
-        <h2>The following options were given in the config file:</h2>
+        <h2>The following options were given in the <a href="@user-manual@config.html">config file</a>:</h2>
         <p>@options@</p>
       </td>
     </tr>
   <!-- @if-have-stats-start -->
           @requests-blocked@ out of @requests-received@ requests have been blocked,
           which equals a block rate of @percent-blocked@%.
+        </p>
+        <p>
+          <strong>Note that the statistics currently don't work properly for
+          reused connections where only the last request gets counted.
+          You may want to look into Privoxy-Log-Parser's --statistics option,
+          which doesn't have this limitation.</strong>
 <!-- if-have-stats-end@ -->
 <!-- @if-have-no-stats-start -->
           There haven't been any requests so far.
 <!-- if-have-no-stats-end@ -->
-        </p>
+        </p>                                   
       </td>
     </tr>
 <!-- if-statistics-end@ -->
 
-    <tr>
-      <td class="box">
-        <h2>The following files are in use:</h2>
-        <p>Click a filename to browse</p>
-        <ul>
-          <li>Actions List: <a href="show-status?file=permit">@actions-filename@</a></li>
-<!-- @if-pcrs-support-start -->
-          <li>Regex Filter List: <a href="show-status?file=re">@re-filter-filename@</a></li>
-<!-- if-pcrs-support-end@ -->
-<!-- @if-trust-support-start -->
-          <li>Trust List: <a href="show-status?file=trust">@trust-filename@</a></li>
-<!-- if-trust-support-end@ -->
-        </ul>
-      </td>
-    </tr>
-
     <tr>
       <td class="box">
         <h2>Conditional #defines:</h2>
-        <table border="1" style="margin-left: 10px">
-          <tr> 
-            <th>#define</th> <th>Enabled?</th> <th>Effects when enabled</th>
-          </tr>
-          <tr>
-            <td><code>FEATURE_ACL</code></td>
-            <td>@if-FEATURE_ACL-then@ Yes @else-not-FEATURE_ACL@ No @endif-FEATURE_ACL@</td>
-            <td>Allows the use of an ACL to control access to the proxy by IP address.</td>
-          </tr>
-          <tr>
-            <td><code>FEATURE_CGI_EDIT_ACTIONS</code></td>
-            <td>@if-FEATURE_CGI_EDIT_ACTIONS-then@ Yes @else-not-FEATURE_CGI_EDIT_ACTIONS@ No @endif-FEATURE_CGI_EDIT_ACTIONS@</td>
-            <td>Allows the use of the web-based actions file 
-               editor@if-FEATURE_CGI_EDIT_ACTIONS-then@, which is <a href="@default-cgi@edit-actions">here</a>@else-not-FEATURE_CGI_EDIT_ACTIONS@@endif-FEATURE_CGI_EDIT_ACTIONS@.</td>
-          </tr>
-          <tr>
-            <td><code>FEATURE_COOKIE_JAR</code></td>
-            <td>@if-FEATURE_COOKIE_JAR-then@ Yes @else-not-FEATURE_COOKIE_JAR@ No @endif-FEATURE_COOKIE_JAR@</td>
-            <td>Allows the use of a "cookie jar" file to capture cookies.</td>
-          </tr>
-          <tr>
-            <td><code>FEATURE_FAST_REDIRECTS</code></td>
-            <td>@if-FEATURE_FAST_REDIRECTS-then@ Yes @else-not-FEATURE_FAST_REDIRECTS@ No @endif-FEATURE_FAST_REDIRECTS@</td>
-            <td>Allows the +fast-redirects action, to bypass redirect and logging scripts.</td>
-          </tr>
-          <tr>
-            <td><code>FEATURE_FORCE_LOAD</code></td>
-            <td>@if-FEATURE_FORCE_LOAD-then@ Yes @else-not-FEATURE_FORCE_LOAD@ No @endif-FEATURE_FORCE_LOAD@</td>
-            <td>Allows bypassing all filtering for a single page using the prefix "<code>@FORCE_PREFIX@</code>".</td>
-          </tr>
-          <tr>
-            <td><code>FEATURE_IMAGE_BLOCKING</code></td>
-            <td>@if-FEATURE_IMAGE_BLOCKING-then@ Yes @else-not-FEATURE_IMAGE_BLOCKING@ No @endif-FEATURE_IMAGE_BLOCKING@</td>
-            <td>Allows the +image ation, to send "blocked" images instead of HTML.</td>
-          </tr>
-          <tr>
-            <td><code>FEATURE_IMAGE_DETECT_MSIE</code></td>
-            <td>@if-FEATURE_IMAGE_DETECT_MSIE-then@ Yes @else-not-FEATURE_IMAGE_DETECT_MSIE@ No @endif-FEATURE_IMAGE_DETECT_MSIE@</td>
-            <td>Enables automatic detection of image and HTML requests from
-             Microsoft Internet Explorer users, overriding the setting of 
-             +image in the actions file.</td>
-          </tr>
-          <tr>
-            <td><code>FEATURE_KILL_POPUPS</code></td>
-            <td>@if-FEATURE_KILL_POPUPS-then@ Yes @else-not-FEATURE_KILL_POPUPS@ No @endif-FEATURE_KILL_POPUPS@</td>
-            <td>Allows the +no-popups action, to block JavaScript popups.</td>
-          </tr>
-          <tr>
-            <td><code>FEATURE_NO_GIFS</code></td>
-            <td>@if-FEATURE_NO_GIFS-then@ Yes @else-not-FEATURE_NO_GIFS@ No @endif-FEATURE_NO_GIFS@</td>
-            <td>Use PNG instead of GIF for the built-in images.</td>
-          </tr>
-          <tr>
-            <td><code>FEATURE_PTHREAD</code></td>
-            <td>@if-FEATURE_PTHREAD-then@ Yes @else-not-FEATURE_PTHREAD@ No @endif-FEATURE_PTHREAD@</td>
-            <td>Use POSIX threads rather than native threads</td>
-          </tr>
-          <tr>
-            <td><code>FEATURE_STATISTICS</code></td>
-            <td>@if-FEATURE_STATISTICS-then@ Yes @else-not-FEATURE_STATISTICS@ No @endif-FEATURE_STATISTICS@</td>
-            <td>Enables the statistics function.</td>
-          </tr>
-          <tr>
-            <td><code>FEATURE_TOGGLE</code></td>
-            <td>@if-FEATURE_TOGGLE-then@ Yes @else-not-FEATURE_TOGGLE@ No @endif-FEATURE_TOGGLE@</td>
-            <td>Allow Privoxy to be "disabled" so it is just a normal non-blocking non-anonymizing proxy.</td>
-          </tr>
-          <tr>
-            <td><code>FEATURE_TRUST</code></td>
-            <td>@if-FEATURE_TRUST-then@ Yes @else-not-FEATURE_TRUST@ No @endif-FEATURE_TRUST@</td>
-            <td>Allows the use of trust files.</td>
-          </tr>
-          <tr>
-            <td><code>STATIC_PCRE</code></td>
-            <td>@if-STATIC_PCRE-then@ Yes @else-not-STATIC_PCRE@ No @endif-STATIC_PCRE@</td>
-            <td>Use the supplied statically-linked PCRE library.  This is set automatically
-             by <code>./configure</code> if you do not have the libpcre installed.</td>
-          </tr>
-          <tr>
-            <td><code>STATIC_PCRS</code></td>
-            <td>@if-STATIC_PCRS-then@ Yes @else-not-STATIC_PCRS@ No @endif-STATIC_PCRS@</td>
-            <td>Use the supplied statically-linked PCRS library.  This is set automatically
-             by <code>./configure</code> if you do not have the libpcrs installed.</td>
-          </tr>
-        </table>
+          <table summary="The state of some ./configure options and what they do." border="1" style="margin-left: 10px">
+            <tr> 
+              <th>#define</th> <th>Enabled?</th> <th>Effects when enabled</th>
+            </tr>
+
+            <tr>
+              <td><code>FEATURE_ACCEPT_FILTER</code></td>
+              <td>@if-FEATURE_ACCEPT_FILTER-then@ Yes @else-not-FEATURE_ACCEPT_FILTER@ No @endif-FEATURE_ACCEPT_FILTER@</td>
+              <td>Support for FreeBSD's accf_http(9) which is also available on some other BSDs.</td>
+            </tr>
+            <tr>
+              <td><code>FEATURE_ACL</code></td>
+              <td>@if-FEATURE_ACL-then@ Yes @else-not-FEATURE_ACL@ No @endif-FEATURE_ACL@</td>
+              <td>Allows the use of an ACL to control access to Privoxy by IP address.</td>
+            </tr>
+            <tr>
+              <td><code>FEATURE_CGI_EDIT_ACTIONS</code></td>
+              <td>@if-FEATURE_CGI_EDIT_ACTIONS-then@ Yes @else-not-FEATURE_CGI_EDIT_ACTIONS@ No @endif-FEATURE_CGI_EDIT_ACTIONS@</td>
+              <td>Allows the use of the @if-FEATURE_CGI_EDIT_ACTIONS-then@<a
+                 href="@default-cgi@edit-actions">@else-not-FEATURE_CGI_EDIT_ACTIONS@
+                 @endif-FEATURE_CGI_EDIT_ACTIONS@web-based actions file
+                 editor@if-FEATURE_CGI_EDIT_ACTIONS-then@</a>@else-not-FEATURE_CGI_EDIT_ACTIONS@@endif-FEATURE_CGI_EDIT_ACTIONS@.</td>
+            </tr>
+            <tr>
+              <td><code>FEATURE_COMPRESSION</code></td>
+              <td>@if-FEATURE_COMPRESSION-then@ Yes @else-not-FEATURE_COMPRESSION@ No @endif-FEATURE_COMPRESSION@</td>
+              <td>
+               Allows compress buffered content before sending it to the client, assuming the client supports it.
+              </td>
+            </tr>
+            <tr>
+              <td><code>FEATURE_CONNECTION_KEEP_ALIVE</code></td>
+              <td>@if-FEATURE_CONNECTION_KEEP_ALIVE-then@ Yes @else-not-FEATURE_CONNECTION_KEEP_ALIVE@ No @endif-FEATURE_CONNECTION_KEEP_ALIVE@</td>
+              <td>
+               Allows to send multiple request through the same connections if the server supports it.
+               Requires the keep-alive-timeout config directive to be set.
+              </td>
+            </tr>
+            <tr>
+              <td><code>FEATURE_CONNECTION_SHARING</code></td>
+              <td>@if-FEATURE_CONNECTION_SHARING-then@ Yes @else-not-FEATURE_CONNECTION_SHARING@ No @endif-FEATURE_CONNECTION_SHARING@</td>
+              <td>
+               Allows to share outgoing connections between incoming connections.
+               Requires the connection-sharing config directive to be set.
+              </td>
+            </tr>
+            <tr>
+              <td><code>FEATURE_FAST_REDIRECTS</code></td>
+              <td>@if-FEATURE_FAST_REDIRECTS-then@ Yes @else-not-FEATURE_FAST_REDIRECTS@ No @endif-FEATURE_FAST_REDIRECTS@</td>
+              <td>Allows the +fast-redirects action, to bypass redirect and logging scripts.</td>
+            </tr>
+            <tr>
+              <td><code>FEATURE_FORCE_LOAD</code></td>
+              <td>@if-FEATURE_FORCE_LOAD-then@ Yes @else-not-FEATURE_FORCE_LOAD@ No @endif-FEATURE_FORCE_LOAD@</td>
+              <td>Allows bypassing all filtering for a single page using the prefix
+                  <q><code>@FORCE_PREFIX@</code></q>.</td>
+            </tr>
+            <tr>
+              <td><code>FEATURE_GRACEFUL_TERMINATION</code></td>
+              <td>@if-FEATURE_GRACEFUL_TERMINATION-then@ Yes @else-not-FEATURE_GRACEFUL_TERMINATION@ No @endif-FEATURE_GRACEFUL_TERMINATION@</td>
+              <td>Allows to shutdown Privoxy through the web interface.</td>
+            </tr>
+            <tr>
+              <td><code>FEATURE_IMAGE_BLOCKING</code></td>
+              <td>@if-FEATURE_IMAGE_BLOCKING-then@ Yes @else-not-FEATURE_IMAGE_BLOCKING@ No @endif-FEATURE_IMAGE_BLOCKING@</td>
+              <td>Allows the +handle-as-image action, to send <q>blocked</q> images instead of HTML.</td>
+            </tr>
+            <tr>
+              <td><code>FEATURE_IPV6_SUPPORT</code></td>
+              <td>@if-FEATURE_IPV6_SUPPORT-then@ Yes @else-not-FEATURE_IPV6_SUPPORT@ No @endif-FEATURE_IPV6_SUPPORT@</td>
+              <td>
+               Allows IPv6 addresses in incoming requests, when resolving domains to
+               IP addresses and in the configuration files.
+              </td>
+            </tr>
+            <tr>
+              <td><code>FEATURE_IMAGE_DETECT_MSIE</code></td>
+              <td>@if-FEATURE_IMAGE_DETECT_MSIE-then@ Yes @else-not-FEATURE_IMAGE_DETECT_MSIE@ No @endif-FEATURE_IMAGE_DETECT_MSIE@</td>
+              <td>Enables automatic detection of image and HTML requests from
+               Microsoft Internet Explorer users, overriding the setting of 
+               +image in the actions file.</td>
+            </tr>
+            <tr>
+              <td><code>FEATURE_NO_GIFS</code></td>
+              <td>@if-FEATURE_NO_GIFS-then@ Yes @else-not-FEATURE_NO_GIFS@ No @endif-FEATURE_NO_GIFS@</td>
+              <td>Use PNG instead of GIF for the built-in images.</td>
+            </tr>
+            <tr>
+              <td><code>FEATURE_PTHREAD</code></td>
+              <td>@if-FEATURE_PTHREAD-then@ Yes @else-not-FEATURE_PTHREAD@ No @endif-FEATURE_PTHREAD@</td>
+              <td>Use POSIX threads rather than native threads</td>
+            </tr>
+            <tr>
+              <td><code>FEATURE_STATISTICS</code></td>
+              <td>@if-FEATURE_STATISTICS-then@ Yes @else-not-FEATURE_STATISTICS@ No @endif-FEATURE_STATISTICS@</td>
+              <td>Enables the statistics function.</td>
+            </tr>
+            <tr>
+              <td><code>FEATURE_TOGGLE</code></td>
+              <td>@if-FEATURE_TOGGLE-then@ Yes @else-not-FEATURE_TOGGLE@ No @endif-FEATURE_TOGGLE@</td>
+              <td>Allow Privoxy to be <q>disabled</q> so it is just a normal non-blocking non-anonymizing proxy.</td>
+            </tr>
+            <tr>
+              <td><code>FEATURE_TRUST</code></td>
+              <td>@if-FEATURE_TRUST-then@ Yes @else-not-FEATURE_TRUST@ No @endif-FEATURE_TRUST@</td>
+              <td>Allows the use of trust files.</td>
+            </tr>
+            <tr>
+              <td><code>FEATURE_ZLIB</code></td>
+              <td>@if-FEATURE_ZLIB-then@ Yes @else-not-FEATURE_ZLIB@ No @endif-FEATURE_ZLIB@</td>
+              <td>Allows to decompress gzip and zlib compressed documents for filtering.
+                Requires external zlib library and hasn't been tested on all platforms.</td>
+            </tr>
+            <tr>
+              <td><code>STATIC_PCRE</code></td>
+              <td>@if-STATIC_PCRE-then@ Yes @else-not-STATIC_PCRE@ No @endif-STATIC_PCRE@</td>
+              <td>Use the supplied statically-linked PCRE library. This is set automatically
+               by <code>./configure</code> if you do not have the libpcre installed.
+               Dynamically linking to an external libpcre is recommended as the internal
+               one is outdated and lacks various features and bug-fixes you may be interested in.</td>
+            </tr>
+            <tr>
+              <td><code>STATIC_PCRS</code></td>
+              <td>@if-STATIC_PCRS-then@ Yes @else-not-STATIC_PCRS@ No @endif-STATIC_PCRS@</td>
+              <td>Use the supplied statically-linked PCRS library.  This is set automatically
+               by <code>./configure</code> if you do not have the libpcrs installed.</td>
+            </tr>
+          </table>
       </td>
     </tr>
 
     <tr>
       <td class="box">
         <h2>More Privoxy:</h2>
-        <ul>@menu@</ul>
+        <ul>@menu@<li><a href="@user-manual@">Documentation</a></li></ul>
       </td>
     </tr>
 
     <tr>
       <td class="info">
-        <h2>Support and Service via Sourceforge:</h2>
-        <p>
-          We value your feedback. To provide you with the best support,
-          we ask that you:
-        </p>
-        <ul>
-          <li>
-            use the <a href="http://sourceforge.net/tracker/?group_id=11118&amp;atid=211118">support forum</a> or (better) the
-            <a href="http://sourceforge.net/mail/?group_id=11118">mailing lists</a> to get help.
-          </li>
-          <li>
-            submit banners and all problems with the actions file only through the
-            <a href="javascript:void(window.open('http://www.privoxy.org/actions','Feedback','width=600,scrollbars=yes,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">actions
-            file feedback system</a>.
-          </li>
-          <li>
-            submit bugs only through our <a href="http://sourceforge.net/tracker/?group_id=11118&amp;atid=111118">bug tracker</a>.
-            Make sure that the bug has not yet been submitted.
-          </li>
-          <li>
-            submit feature requests only through our <a href="http://sourceforge.net/tracker/?atid=361118&amp;group_id=11118&amp;func=browse">feature
-            request tracker</a>.
-          </li>
-        </ul>
+
+#include mod-support-and-service
+
       </td>
     </tr>
 
 <!-- @if-have-help-info-start -->
     <tr>
       <td class="info">
-        <h2>Local Privoxy support:</h2>
 
-<!-- @if-have-proxy-info-start -->
-        <p>
-          You can consult the <a href="@proxy-info-url@">online documentation</a> for more information
-          about this Privoxy installation.
-        </p>
-<!-- if-have-proxy-info-end@ -->
+#include mod-local-help
 
-<!-- @if-have-adminaddr-info-start -->
-        <p>Address e-mail questions about this service to
-          <a href="mailto:@admin-address@"><code>@admin-address@</code></a>,
-          who will be glad to help you.
-        </p>
-<!-- if-have-adminaddr-info-end@ -->
       </td>
     </tr>
 <!-- if-have-help-info-end@ -->
 
-     <tr>
-      <td>
-        <p class="small">Valid <a href="http://validator.w3.org/">HTML 4.01 Strict</a></p>
-      </td>
-    </tr>   
   </table>
 
 </body>