- Show forwarding settings on the show-url-info page
[privoxy.git] / templates / show-url-info
index 1b4a69b..3fc9f6f 100644 (file)
@@ -1,8 +1,34 @@
-##########################################################
+########################################################################
 #
-# Show-Url-Info-CGI Output template for Privoxy.
+# File        :  $Source:$
 #
+# Purpose     :  Template for Privoxy's show-url-info CGI page.
 #
+# Copyright   :  Written by and Copyright (C) 2001-2007 the SourceForge
+#                Privoxy team. http://www.privoxy.org/
+#
+#                This program is free software; you can redistribute it 
+#                and/or modify it under the terms of the GNU General
+#                Public License as published by the Free Software
+#                Foundation; either version 2 of the License, or (at
+#                your option) any later version.
+#
+#                This program is distributed in the hope that it will
+#                be useful, but WITHOUT ANY WARRANTY; without even the
+#                implied warranty of MERCHANTABILITY or FITNESS FOR A
+#                PARTICULAR PURPOSE.  See the GNU General Public
+#                License for more details.
+#
+#                The GNU General Public License should be included with
+#                this file.  If not, you can view it at
+#                http://www.gnu.org/copyleft/gpl.html
+#                or write to the Free Software Foundation, Inc., 59
+#                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+#
+# Revisions   :
+#    $Log: show-url-info,v $
+#
+#########################################################################
 # USING HTML TEMPLATES:
 # ---------------------
 #
 # --------------------------------
 #
 #  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 Privoxy's "main menu" builtin CGI page
 #  menu:
 #    List of <li> elements linking to the other available CGIs
 #  version:
-#    The version number of the proxy software
+#    Privoxy's version number
 #  code-status:
-#    The development status of the proxy software: "alpha", "beta",
-#    or "stable".
+#    Privoxy's development status: "alpha", "beta", or "stable".
 #  homepage:
-#    The URL of the SourceForge ijbswa project, who maintains this
-#    software.
+#    The Privoxy web site.
 #
 # CONDITIONAL SYMBOLS FOR THIS TEMPLATE AND THEIR DEPANDANT SYMBOLS:
 # ------------------------------------------------------------------
 #    final:
 #      The actions that are associated with the URL at the end of
 #      the matching process
+#  no-forwarder: Requests to url will be made directly.
+#  http-forwarder:
+#      Requests to url will be made through a HTTP proxy
+#      forward-host:
+#         The IP address or its hostname
+#      forward-port.
+#         The proxy port
+#  socks-forwarder:
+#      Requests to url will be made through a socks proxy
+#      socks-type:
+#         The socks type: socks4 or socks4a
+#      gateway-host:
+#         The IP address or its hostname
+#      gateway-port:
+#         The proxy port.
 #
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
 <html>
 <!-- if-unstable-end@ -->
 
 <!-- @if-url-given-start -->
+    <tr>
+      <td class="box">
+        <h2>Forwarding settings:</h2>
+        <p>
+          Requests for <a href="@url@">@url@</a> will be <!--
+
+# "Interesting" formatting to prevent white space at the end of the sentence..
+
+          @if-no-forwarder-start -->
+
+             made <b>directly</b>, no forwarding settings apply<!--
+
+          if-no-forwarder-end@--><!--
+          @if-http-forwarder-start --><!-- @if-socks-forwarder-start -->
+
+             first <!--
+
+          if-socks-forwarder-end@ --><!-- if-http-forwarder-end@ --><!--
+          @if-socks-forwarder-start -->
+
+             forwarded through <b>@socks-type@-proxy @gateway-host@:@gateway-port@</b><!--
+
+          if-socks-forwarder-end@ --><!--
+          @if-http-forwarder-start --><!-- @if-socks-forwarder-start -->
+
+             and then <!--
+
+          if-socks-forwarder-end@ --><!-- if-http-forwarder-end@ --><!--
+          @if-http-forwarder-start -->
+
+             forwarded through <b>HTTP-proxy @forward-host@:@forward-port@</b><!--
+
+          if-http-forwarder-end@ -->.
+      </td>
+    </tr>
     <tr>
       <td class="box">
 <!-- @if-https-start -->
         <p>&nbsp;</p>
 <!-- if-https-end@ -->
         <h2>Matches for <a href="@url@">@url@</a>:</h2>
-        <p>@matches@</p>
+        @matches@
       </td>
     </tr>