remove leading spaces from <screen> and <programlisting> blocks
[privoxy.git] / doc / source / p-config.sgml
index 5398587..679aa03 100644 (file)
@@ -241,22 +241,22 @@ II. FORMAT OF THE CONFIGURATION FILE
   <para>
    Unix, in local filesystem (may not work with all browsers):
   </para>
-   <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file:///usr/share/doc/privoxy-&p-version;/user-manual/</screen>
+  <screen>user-manual  file:///usr/share/doc/privoxy-&p-version;/user-manual/</screen>
   <para>
    Windows, in local filesystem, <emphasis>must</emphasis> use forward slash notation:
   </para>
-   <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file:/c:/some-dir/privoxy-&p-version;/user-manual/</screen>
+  <screen>user-manual  file:/c:/some-dir/privoxy-&p-version;/user-manual/</screen>
   <para>
    Windows, UNC notation (with forward slashes):
   </para>
-   <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file://///some-server/some-path/privoxy-&p-version;/user-manual/</screen>
+  <screen>user-manual  file://///some-server/some-path/privoxy-&p-version;/user-manual/</screen>
  -->
   <para>
    The best all purpose solution is simply to put the full local
    <literal>PATH</literal> to where the <citetitle>User Manual</citetitle> is
    located:
   </para>
-   <screen>  user-manual  /usr/share/doc/privoxy/user-manual</screen>
+  <screen>user-manual  /usr/share/doc/privoxy/user-manual</screen>
   <para>
    The User Manual is then available to anyone with access to
    <application>Privoxy</application>, by following the built-in URL:
@@ -267,7 +267,7 @@ II. FORMAT OF THE CONFIGURATION FILE
    If the documentation is not on the local system, it can be accessed
    from a remote server, as:
   </para>
-   <screen>  user-manual  http://example.com/privoxy/user-manual/</screen>
+  <screen>user-manual  http://example.com/privoxy/user-manual/</screen>
   <![%user-man;[
    <!-- this gets hammered in conversion to config. Text repeated below. -->
   <warning>
@@ -1017,22 +1017,22 @@ actionsfile
     The available debug levels are:
    </para>
     <programlisting>
-  debug     1 # Log the destination for each request. See also debug 1024.
-  debug     2 # show each connection status
-  debug     4 # show tagging-related messages
-  debug     8 # show header parsing
-  debug    16 # log all data written to the network
-  debug    32 # debug force feature
-  debug    64 # debug regular expression filters
-  debug   128 # debug redirects
-  debug   256 # debug GIF de-animation
-  debug   512 # Common Log Format
-  debug  1024 # Log the destination for requests &my-app; didn't let through, and the reason why.
-  debug  2048 # CGI user interface
-  debug  4096 # Startup banner and warnings.
-  debug  8192 # Non-fatal errors
-  debug 32768 # log all data read from the network
-  debug 65536 # Log the applying actions
+debug     1 # Log the destination for each request. See also debug 1024.
+debug     2 # show each connection status
+debug     4 # show tagging-related messages
+debug     8 # show header parsing
+debug    16 # log all data written to the network
+debug    32 # debug force feature
+debug    64 # debug regular expression filters
+debug   128 # debug redirects
+debug   256 # debug GIF de-animation
+debug   512 # Common Log Format
+debug  1024 # Log the destination for requests &my-app; didn't let through, and the reason why.
+debug  2048 # CGI user interface
+debug  4096 # Startup banner and warnings.
+debug  8192 # Non-fatal errors
+debug 32768 # log all data read from the network
+debug 65536 # Log the applying actions
 </programlisting>
    <para>
     To select multiple debug levels, you can either add them or use
@@ -1312,7 +1312,7 @@ actionsfile
      You want it to serve requests from inside only:
    </para>
     <programlisting>
-  listen-address  192.168.0.1:8118
+listen-address  192.168.0.1:8118
 </programlisting>
    <para>
     Suppose you are running <application>Privoxy</application> on an
@@ -1320,7 +1320,7 @@ actionsfile
     of the loopback device:
    </para>
     <programlisting>
-  listen-address [::1]:8118
+listen-address [::1]:8118
 </programlisting>
   </listitem>
  </varlistentry>
@@ -1769,14 +1769,14 @@ ACLs: permit-access and deny-access</title>
     <emphasis>all</emphasis> destination addresses are OK:
    </para>
     <screen>
-  permit-access  localhost
+permit-access  localhost
 </screen>
    <para>
     Allow any host on the same class C subnet as www.privoxy.org access to
     nothing but www.example.com (or other domains hosted on the same system):
    </para>
     <screen>
-  permit-access  www.privoxy.org/24 www.example.com/32
+permit-access  www.privoxy.org/24 www.example.com/32
 </screen>
    <para>
     Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
@@ -1784,22 +1784,22 @@ ACLs: permit-access and deny-access</title>
     www.dirty-stuff.example.com:
    </para>
     <screen>
-  permit-access  192.168.45.64/26
-  deny-access    192.168.45.73    www.dirty-stuff.example.com
+permit-access  192.168.45.64/26
+deny-access    192.168.45.73    www.dirty-stuff.example.com
 </screen>
    <para>
      Allow access from the IPv4 network 192.0.2.0/24 even if listening on
      an IPv6 wild card address (not supported on all platforms):
    </para>
     <programlisting>
-  permit-access  192.0.2.0/24
+permit-access  192.0.2.0/24
 </programlisting>
    <para>
      This is equivalent to the following line even if listening on an
      IPv4 address (not supported on all platforms):
    </para>
     <programlisting>
-  permit-access  [::ffff:192.0.2.0]/120
+permit-access  [::ffff:192.0.2.0]/120
 </programlisting>
   </listitem>
  </varlistentry>
@@ -2180,30 +2180,30 @@ ACLs: permit-access and deny-access</title>
     Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
    </para>
     <screen>
-  forward   /      parent-proxy.example.org:8080
-  forward   :443   .
+forward   /      parent-proxy.example.org:8080
+forward   :443   .
 </screen>
    <para>
     Everything goes to our example ISP's caching proxy, except for requests
     to that ISP's sites:
    </para>
     <screen>
-  forward   /                  caching-proxy.isp.example.net:8000
-  forward   .isp.example.net   .
+forward   /                  caching-proxy.isp.example.net:8000
+forward   .isp.example.net   .
 </screen>
    <para>
     Parent proxy specified by an IPv6 address:
    </para>
     <programlisting>
-  forward   /                   [2001:DB8::1]:8000
+forward   /                   [2001:DB8::1]:8000
 </programlisting>
    <para>
     Suppose your parent proxy doesn't support IPv6:
    </para>
     <programlisting>
-  forward  /                        parent-proxy.example.org:8000
-  forward  ipv6-server.example.org  .
-  forward  &lt;[2-3][0-9a-f][0-9a-f][0-9a-f]:*&gt;   .
+forward  /                        parent-proxy.example.org:8000
+forward  ipv6-server.example.org  .
+forward  &lt;[2-3][0-9a-f][0-9a-f][0-9a-f]:*&gt;   .
 </programlisting>
   </listitem>
  </varlistentry>
@@ -2311,21 +2311,21 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
      the Internet.
    </para>
     <screen>
-  forward-socks4a   /              socks-gw.example.com:1080  www-cache.isp.example.net:8080
-  forward           .example.com   .
+forward-socks4a   /              socks-gw.example.com:1080  www-cache.isp.example.net:8080
+forward           .example.com   .
 </screen>
    <para>
     A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
    </para>
     <screen>
-  forward-socks4   /               socks-gw.example.com:1080  .
+forward-socks4   /               socks-gw.example.com:1080  .
 </screen>
 
    <para>
     To connect SOCKS5 proxy which requires username/password authentication:
    </para>
     <screen>
-  forward-socks5   /               user:pass@socks-gw.example.com:1080  .
+forward-socks5   /               user:pass@socks-gw.example.com:1080  .
 </screen>
 
     <para>
@@ -2333,7 +2333,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
     something like:
    </para>
     <screen>
-  forward-socks5t   /               127.0.0.1:9050 .
+forward-socks5t   /               127.0.0.1:9050 .
 </screen>
    <para>
     Note that if you got Tor through one of the bundles, you may
@@ -2347,9 +2347,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
     therefore might want to make some exceptions:
    </para>
     <screen>
-  forward         192.168.*.*/     .
-  forward          10.*.*.*/       .
-  forward         127.*.*.*/       .
+forward         192.168.*.*/     .
+forward          10.*.*.*/       .
+forward         127.*.*.*/       .
 </screen>
    <para>
     Unencrypted connections to systems in these address ranges will
@@ -2364,7 +2364,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
     this:
    </para>
     <screen>
- forward           localhost/     .
+forward           localhost/     .
 </screen>
 
   </listitem>
@@ -2393,18 +2393,18 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
  host-a:
 </para>
 
- <screen>
-  forward    /           .
-  forward    .isp-b.example.net  host-b:8118
+<screen>
+forward    /           .
+forward    .isp-b.example.net  host-b:8118
 </screen>
 
 <para>
  host-b:
 </para>
 
- <screen>
-  forward    /           .
-  forward    .isp-a.example.org  host-a:8118
+<screen>
+forward    /           .
+forward    .isp-a.example.org  host-a:8118
 </screen>
 
 <para>
@@ -2424,18 +2424,19 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
  run on the same box, your <application>squid</application> configuration could then look like this:
 </para>
 
- <screen>
-  # Define Privoxy as parent proxy (without ICP)
-  cache_peer 127.0.0.1 parent 8118 7 no-query
+<screen>
+# Define Privoxy as parent proxy (without ICP)
+cache_peer 127.0.0.1 parent 8118 7 no-query
 
-  # Define ACL for protocol FTP
-  acl ftp proto FTP
+# Define ACL for protocol FTP
+acl ftp proto FTP
 
-  # Do not forward FTP requests to Privoxy
-  always_direct allow ftp
+# Do not forward FTP requests to Privoxy
+always_direct allow ftp
 
-  # Forward all the rest to Privoxy
-  never_direct allow all</screen>
+# Forward all the rest to Privoxy
+never_direct allow all
+</screen>
 
 <para>
  You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
@@ -2448,9 +2449,10 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
  say, on <literal>antivir.example.com</literal>, port 8010:
 </para>
 
- <screen>
-  forward   /                          .
-  forward   /.*\.(exe|com|dll|zip)$    antivir.example.com:8010</screen>
+<screen>
+forward   /                          .
+forward   /.*\.(exe|com|dll|zip)$    antivir.example.com:8010
+</screen>
 
 </sect3>
 ]]>
@@ -3514,18 +3516,18 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
   <term>Examples:</term>
   <listitem>
     <screen>
-    # Best speed (compared to the other levels)
-    compression-level 1
-
-    # Best compression
-    compression-level 9
-
-    # No compression. Only useful for testing as the added header
-    # slightly increases the amount of data that has to be sent.
-    # If your benchmark shows that using this compression level
-    # is superior to using no compression at all, the benchmark
-    # is likely to be flawed.
-    compression-level 0
+# Best speed (compared to the other levels)
+compression-level 1
+
+# Best compression
+compression-level 9
+
+# No compression. Only useful for testing as the added header
+# slightly increases the amount of data that has to be sent.
+# If your benchmark shows that using this compression level
+# is superior to using no compression at all, the benchmark
+# is likely to be flawed.
+compression-level 0
 </screen>
   </listitem>
  </varlistentry>
@@ -3676,15 +3678,15 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
   <term>Examples:</term>
   <listitem>
     <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
-    client-specific-tag disable-content-filters Disable content-filters but do not affect other actions
-    client-specific-tag overrule-redirects Overrule redirect sections
-    client-specific-tag allow-cookies Do not crunch cookies in either direction
-    client-specific-tag change-tor-socks-port Change forward-socks5 settings to use a different Tor socks port (and circuits)
-    client-specific-tag no-https-inspection Disable HTTPS inspection
-    client-specific-tag no-tls-verification Don't verify certificates when http-inspection is enabled
+  # 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
+  client-specific-tag disable-content-filters Disable content-filters but do not affect other actions
+  client-specific-tag overrule-redirects Overrule redirect sections
+  client-specific-tag allow-cookies Do not crunch cookies in either direction
+  client-specific-tag change-tor-socks-port Change forward-socks5 settings to use a different Tor socks port (and circuits)
+  client-specific-tag no-https-inspection Disable HTTPS inspection
+  client-specific-tag no-tls-verification Don't verify certificates when http-inspection is enabled
 </screen>
   </listitem>
  </varlistentry>
@@ -3738,8 +3740,8 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
   <term>Example:</term>
   <listitem>
     <screen>
-      # Increase the time to life for temporarily enabled tags to 3 minutes
-      client-tag-lifetime 180
+    # Increase the time to life for temporarily enabled tags to 3 minutes
+    client-tag-lifetime 180
 </screen>
   </listitem>
  </varlistentry>
@@ -3804,9 +3806,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
   <term>Example:</term>
   <listitem>
     <screen>
-      # Allow systems that can reach Privoxy to provide the client
-      # IP address with a X-Forwarded-For header.
-      trust-x-forwarded-for 1
+    # Allow systems that can reach Privoxy to provide the client
+    # IP address with a X-Forwarded-For header.
+    trust-x-forwarded-for 1
 </screen>
   </listitem>
  </varlistentry>
@@ -3877,8 +3879,8 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
   <term>Example:</term>
   <listitem>
     <screen>
-      # Increase the receive buffer size
-      receive-buffer-size 32768
+    # Increase the receive buffer size
+    receive-buffer-size 32768
 </screen>
   </listitem>
  </varlistentry>
@@ -4302,8 +4304,8 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
   <term>Examples:</term>
   <listitem>
    <screen>
-    # Explicitly set a couple of ciphers with names used by MbedTLS
-    cipher-list cipher-list TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256:\
+  # Explicitly set a couple of ciphers with names used by MbedTLS
+cipher-list cipher-list TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256:\
 TLS-ECDHE-ECDSA-WITH-CHACHA20-POLY1305-SHA256:\
 TLS-DHE-RSA-WITH-CHACHA20-POLY1305-SHA256:\
 TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256:\
@@ -4334,9 +4336,9 @@ TLS-ECDH-ECDSA-WITH-AES-128-GCM-SHA256:\
 TLS-ECDH-ECDSA-WITH-AES-256-GCM-SHA384:\
 TLS-ECDH-ECDSA-WITH-CAMELLIA-128-GCM-SHA256:\
 TLS-ECDH-ECDSA-WITH-CAMELLIA-256-GCM-SHA384
-   </screen>
+</screen>
    <screen>
-    # Explicitly set a couple of ciphers with names used by OpenSSL
+  # Explicitly set a couple of ciphers with names used by OpenSSL
 cipher-list ECDHE-RSA-AES256-GCM-SHA384:\
 ECDHE-ECDSA-AES256-GCM-SHA384:\
 DH-DSS-AES256-GCM-SHA384:\
@@ -4355,11 +4357,11 @@ ECDH-RSA-AES128-GCM-SHA256:\
 ECDH-ECDSA-AES128-GCM-SHA256:\
 ECDHE-RSA-AES256-GCM-SHA384:\
 AES128-SHA
-   </screen>
+</screen>
    <screen>
-    # Use keywords instead of explicitly naming the ciphers (Does not work with MbedTLS)
-    cipher-list ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH
-   </screen>
+  # Use keywords instead of explicitly naming the ciphers (Does not work with MbedTLS)
+cipher-list ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH
+</screen>
   </listitem>
  </varlistentry>
 </variablelist>