Generated
[privoxy.git] / config
diff --git a/config b/config
index 8ab0d1e..e1d3044 100644 (file)
--- a/config
+++ b/config
@@ -1,28 +1,28 @@
-#     Sample Configuration file for Privoxy v2.9.15
+#        Sample Configuration File for Privoxy v2.9.20
 #  
 #  Copyright (C) 2001, 2002 Privoxy Developers http://privoxy.org
 #  
-#  $Id: config,v 1.39 2002/05/12 03:21:21 hal9 Exp $
-#  
-##################################################################
-#                                                                #
-#                    Table of Contents                           #
-#                                                                #
-#      I. INTRODUCTION                                           #
-#     II. FORMAT OF THE CONFIGURATION FILE                       #
-#                                                                #
-#      1. CONFIGURATION AND LOG FILE LOCATIONS                   #
-#      2. LOCAL SET-UP DOCUMENTATION                             #
-#      3. DEBUGGING                                              #
-#      4. ACCESS CONTROL AND SECURITY                            #
-#      5. FORWARDING                                             #
-#      6. WINDOWS GUI OPTIONS                                    #
-#                                                                #
-##################################################################
-  
-#  
-#  I. INTRODUCTION 
-#  ===============
+#  $Id: config,v 1.39.2.4 2002/08/07 01:35:23 hal9 Exp $
+#  
+####################################################################
+#                                                                  #
+#                      Table of Contents                           #
+#                                                                  #
+#        I. INTRODUCTION                                           #
+#       II. FORMAT OF THE CONFIGURATION FILE                       #
+#                                                                  #
+#        1. CONFIGURATION AND LOG FILE LOCATIONS                   #
+#        2. LOCAL SET-UP DOCUMENTATION                             #
+#        3. DEBUGGING                                              #
+#        4. ACCESS CONTROL AND SECURITY                            #
+#        5. FORWARDING                                             #
+#        6. WINDOWS GUI OPTIONS                                    #
+#                                                                  #
+####################################################################
+#  
+#  
+#  I. INTRODUCTION
+#   ===============
 #  
 #  This file holds the Privoxy configuration. If you modify this file,
 #  you will need to send a couple of requests to the proxy before any
@@ -33,7 +33,7 @@
 #  with the name 'config.txt' in the same directory where Privoxy
 #  is installed.
 #  
-
+#  
 #  II. FORMAT OF THE CONFIGURATION FILE
 #  ====================================
 #  
@@ -59,8 +59,9 @@
 #  
 #  Long lines can be continued on the next line by using a `\' as the
 #  last character.
+#  
 
-
+#  
 #  1. CONFIGURATION AND LOG FILE LOCATIONS
 #  =======================================
 #  
 #  
 #  The user running Privoxy, must have read permission for all
 #  configuration files, and write permission to any files that would
-#  be modified, such as log files.
+#  be modified, such as log files and actions files.
 #  
 
+#  
 #  1.1. confdir
 #  ============
 #  
 #  
 confdir .
 
+#  
 #  1.2. logdir
 #  ===========
 #  
@@ -130,6 +133,7 @@ confdir .
 #  
 logdir .
 
+#  
 #  1.3. actionsfile
 #  ================
 #  
@@ -144,7 +148,9 @@ logdir .
 #  Default values:
 #  
 #        standard     # Internal purposes, no editing recommended
+#  
 #        default      # Main actions file
+#  
 #        user         # User customizations
 #  
 #  Effect if unset:
@@ -170,6 +176,7 @@ actionsfile standard  # Internal purpose, recommended
 actionsfile default   # Main actions file
 actionsfile user      # User customizations
 
+#  
 #  1.4. filterfile
 #  ===============
 #  
@@ -208,6 +215,7 @@ actionsfile user      # User customizations
 #  
 filterfile default.filter
 
+#  
 #  1.5. logfile
 #  ============
 #  
@@ -253,6 +261,7 @@ filterfile default.filter
 #  
 logfile logfile
 
+#  
 #  1.6. jarfile
 #  ============
 #  
@@ -278,6 +287,7 @@ logfile logfile
 #  
 jarfile jarfile
 
+#  
 #  1.7. trustfile
 #  ==============
 #  
@@ -315,16 +325,18 @@ jarfile jarfile
 #      If you use + operator in the trust file, it may grow considerably
 #      over time.
 #  
-#trusfile trust
-
+#trustfile trust
 
+#  
 #  2. LOCAL SET-UP DOCUMENTATION
 #  =============================
 #  
 #  If you intend to operate Privoxy for more users than just yourself,
 #  it might be a good idea to let them know how to reach you, what
 #  you block and why you do that, your policies, etc.
+#  
 
+#  
 #  2.1. user-manual
 #  ================
 #  
@@ -358,21 +370,20 @@ jarfile jarfile
 #  
 #      Unix, in local filesystem:
 #  
-#      user-manual  file:///usr/share/doc/privoxy-2.9.15/user-manual/
+#      user-manual  file:///usr/share/doc/privoxy-2.9.18/user-manual/
 #  
 #      Any platform, on local webserver (called "local-webserver"):
 #  
 #      user-manual  http://local-webserver/privoxy-user-manual/
 #  
-#   +-----------------------------------------------------------------+
-#   |                             Warning                             |
-#   |-----------------------------------------------------------------|
-#   |If this option is defined, it must come first! It is needed      |
-#   |before the rest of config is read.                               |
-#   +-----------------------------------------------------------------+
+#      WARNING!!!
+#  
+#          If set, this option should be the first option in the config
+#          file, because it is used while the config file is being read.
 #  
 #user-manual http://www.privoxy.org/user-manual/
 
+#  
 #  2.2. trust-info-url
 #  ===================
 #  
@@ -409,6 +420,7 @@ jarfile jarfile
 trust-info-url  http://www.example.com/why_we_block.html
 trust-info-url  http://www.example.com/what_we_allow.html
 
+#  
 #  2.3. admin-address
 #  ==================
 #  
@@ -437,6 +449,7 @@ trust-info-url  http://www.example.com/what_we_allow.html
 #  
 #admin-address privoxy-admin@example.com
 
+#  
 #  2.4. proxy-info-url
 #  ===================
 #  
@@ -468,14 +481,16 @@ trust-info-url  http://www.example.com/what_we_allow.html
 #  
 #proxy-info-url http://www.example.com/proxy-service.html
 
-
+#  
 #  3. DEBUGGING
 #  ============
 #  
 #  These options are mainly useful when tracing a problem. Note that
 #  you might also want to invoke Privoxy with the --no-daemon command
 #  line option when debugging.
+#  
 
+#  
 #  3.1. debug
 #  ==========
 #  
@@ -500,19 +515,20 @@ trust-info-url  http://www.example.com/what_we_allow.html
 #  
 #      The available debug levels are:
 #  
-#        debug         1 # show each GET/POST/CONNECT request 
-#        debug         2 # show each connection status 
-#        debug         4 # show I/O status 
-#        debug         8 # show header parsing 
-#        debug        16 # log all data into the logfile 
-#        debug        32 # debug force feature 
-#        debug        64 # debug regular expression filter
-#        debug       128 # debug fast redirects 
-#        debug       256 # debug GIF de-animation 
-#        debug       512 # Common Log Format
-#        debug      1024 # debug kill pop-ups 
-#        debug      4096 # Startup banner and warnings.  
-#        debug      8192 # Non-fatal errors
+#          debug         1 # show each GET/POST/CONNECT request 
+#          debug         2 # show each connection status 
+#          debug         4 # show I/O status 
+#          debug         8 # show header parsing 
+#          debug        16 # log all data into the logfile 
+#          debug        32 # debug force feature 
+#          debug        64 # debug regular expression filter
+#          debug       128 # debug fast redirects 
+#          debug       256 # debug GIF de-animation 
+#          debug       512 # Common Log Format
+#          debug      1024 # debug kill pop-ups 
+#          debug      2048 # CGI user interface 
+#          debug      4096 # Startup banner and warnings.
+#          debug      8192 # Non-fatal errors
 #  
 #      To select multiple debug levels, you can either add them or
 #      use multiple debug lines.
@@ -531,8 +547,9 @@ trust-info-url  http://www.example.com/what_we_allow.html
 #  
 debug   1    # show each GET/POST/CONNECT request
 debug   4096 # Startup banner and warnings
-debug   8192 # Errors - *we highly recommended enabling this
+debug   8192 # Errors - *we highly recommended enabling this*
 
+#  
 #  3.2. single-threaded
 #  ====================
 #  
@@ -560,13 +577,15 @@ debug   8192 # Errors - *we highly recommended enabling this
 #  
 #single-threaded
 
-
+#  
 #  4. ACCESS CONTROL AND SECURITY
 #  ==============================
 #  
 #  This section of the config file controls the security-relevant
 #  aspects of Privoxy's configuration.
+#  
 
+#  
 #  4.1. listen-address
 #  ===================
 #  
@@ -618,6 +637,7 @@ debug   8192 # Errors - *we highly recommended enabling this
 #  
 listen-address  127.0.0.1:8118
 
+#  
 #  4.2. toggle
 #  ===========
 #  
@@ -650,6 +670,7 @@ listen-address  127.0.0.1:8118
 #  
 toggle  1
 
+#  
 #  4.3. enable-remote-toggle
 #  =========================
 #  
@@ -686,6 +707,7 @@ toggle  1
 #  
 enable-remote-toggle  1
 
+#  
 #  4.4. enable-edit-actions
 #  ========================
 #  
@@ -718,6 +740,7 @@ enable-remote-toggle  1
 #  
 enable-edit-actions 1
 
+#  
 #  4.5. ACLs: permit-access and deny-access
 #  ========================================
 #  
@@ -800,6 +823,7 @@ enable-edit-actions 1
 #        deny-access    192.168.45.73     www.dirty-stuff.example.com
 #  
 
+#  
 #  4.6. buffer-limit
 #  =================
 #  
@@ -835,7 +859,7 @@ enable-edit-actions 1
 #  
 buffer-limit 4096
 
-
+#  
 #  5. FORWARDING
 #  =============
 #  
@@ -850,7 +874,9 @@ buffer-limit 4096
 #  
 #  Also specified here are SOCKS proxies. Privoxy supports the SOCKS
 #  4 and SOCKS 4A protocols.
+#  
 
+#  
 #  5.1. forward
 #  ============
 #  
@@ -860,14 +886,14 @@ buffer-limit 4096
 #  
 #  Type of value:
 #  
-#      target_domain[:port] http_parent[/port]
+#      target_pattern http_parent[:port]
 #  
-#      Where target_domain is a domain name pattern (see the chapter
-#      on domain matching in the default.action file), http_parent
-#      is the address of the parent HTTP proxy as an IP addresses in
-#      dotted decimal notation or as a valid DNS name (or "." to denote
-#      "no forwarding", and the optional port parameters are TCP ports,
-#      i.e. integer values from 1 to 64535
+#      where target_pattern is a URL pattern that specifies to which
+#      requests (i.e. URLs) this forward rule shall apply. Use /
+#      to denote "all URLs".  http_parent[:port] is the DNS name or
+#      IP address of the parent HTTP proxy through which the requests
+#      should be forwarded, optionally followed by its listening port
+#      (default: 8080). Use a single dot (.) to denote "no forwarding".
 #  
 #  Default value:
 #  
@@ -890,16 +916,17 @@ buffer-limit 4096
 #      Everything goes to an example anonymizing proxy, except SSL on
 #      port 443 (which it doesn't handle):
 #  
-#        forward   .*     anon-proxy.example.org:8080 
+#        forward        anon-proxy.example.org:8080 
 #        forward   :443   .
 #  
 #      Everything goes to our example ISP's caching proxy, except for
 #      requests to that ISP's sites:
 #  
-#        forward   .*.                caching-proxy.example-isp.net:8000
+#        forward   /                  caching-proxy.example-isp.net:8000
 #        forward   .example-isp.net   .
 #  
 
+#  
 #  5.2. forward-socks4 and forward-socks4a
 #  =======================================
 #  
@@ -910,14 +937,14 @@ buffer-limit 4096
 #  
 #  Type of value:
 #  
-#      target_domain[:port] socks_proxy[/port] http_parent[/port]
+#      target_pattern socks_proxy[:port] http_parent[:port]
 #  
-#      Where target_domain is a domain name pattern (see the chapter
-#      on domain matching in the default.action file), http_parent
-#      and socks_proxy are IP addresses in dotted decimal notation
-#      or valid DNS names (http_parent may be "." to denote "no HTTP
-#      forwarding"), and the optional port parameters are TCP ports,
-#      i.e. integer values from 1 to 64535
+#      where target_pattern is a URL pattern that specifies to which
+#      requests (i.e. URLs) this forward rule shall apply. Use / to
+#      denote "all URLs".  http_parent and socks_proxy are IP addresses
+#      in dotted decimal notation or valid DNS names (http_parent may
+#      be "." to denote "no HTTP forwarding"), and the optional port
+#      parameters are TCP ports, i.e. integer values from 1 to 64535
 #  
 #  Default value:
 #  
@@ -948,32 +975,32 @@ buffer-limit 4096
 #      ISP's proxy by way of example.com's corporate SOCKS 4A gateway
 #      to the Internet.
 #  
-#        forward-socks4a   .*.        socks-gw.example.com:1080     www-cache.example-isp.net:8080 
+#        forward-socks4a   /              socks-gw.example.com:1080   www-cache.example-isp.net:8080 
 #        forward           .example.com   .
 #  
 #      A rule that uses a SOCKS 4 gateway for all destinations but no
 #      HTTP parent looks like this:
 #  
-#        forward-socks4   .*.            socks-gw.example.com:1080  .
-
+#        forward-socks4   /               socks-gw.example.com:1080  .
+#  
 
+#  
 #  6. WINDOWS GUI OPTIONS
 #  ======================
 #  
 #  Privoxy has a number of options specific to the Windows GUI
 #  interface:
+#  
 
 #  If "activity-animation" is set to 1, the Privoxy icon will animate
 #  when "Privoxy" is active. To turn off, set to 0.
 #  
 #activity-animation   1
-#  
 
 #  If "log-messages" is set to 1, Privoxy will log messages to the
 #  console window:
 #  
 #log-messages   1
-#  
 
 #  If "log-buffer-size" is set to 1, the size of the log buffer,
 #  i.e. the amount of memory used for the log messages displayed in
@@ -983,46 +1010,40 @@ buffer-limit 4096
 #  infinitely and eat up all your memory!
 #  
 #log-buffer-size 1
-#  
 
 #  log-max-lines is the maximum number of lines held in the log
 #  buffer. See above.
 #  
 #log-max-lines 200
-#  
 
 #  If "log-highlight-messages" is set to 1, Privoxy will highlight
 #  portions of the log messages with a bold-faced font:
 #  
 #log-highlight-messages 1
-#  
 
 #  The font used in the console window:
 #  
 #log-font-name Comic Sans MS
-#  
 
 #  Font size used in the console window:
 #  
 #log-font-size 8
-#  
 
 #  "show-on-task-bar" controls whether or not Privoxy will appear as
 #  a button on the Task bar when minimized:
 #  
 #show-on-task-bar 0
-#  
 
 #  If "close-button-minimizes" is set to 1, the Windows close button
 #  will minimize Privoxy instead of closing the program (close with
 #  the exit option on the File menu).
 #  
 #close-button-minimizes 1
-#  
 
 #  The "hide-console" option is specific to the MS-Win console version
 #  of Privoxy.  If this option is used, Privoxy will disconnect from
 #  and hide the command console.
 #  
 #hide-console
+
 #