Added new config options, and FTP request error.
[privoxy.git] / config
diff --git a/config b/config
index de69de6..b3bee1e 100644 (file)
--- a/config
+++ b/config
@@ -1,8 +1,8 @@
-#        Sample Configuration File for Privoxy v3.1.1
+#        Sample Configuration File for Privoxy v3.0.4
 #
-#  Copyright (C) 2001, 2002 Privoxy Developers http://privoxy.org
+#  $Id: config,v 1.51 2006/09/04 18:09:05 hal9 Exp $
 #
-#  $Id: config,v 1.44 2003/04/20 17:37:28 hal9 Exp $
+#  Copyright (C) 2001-2006 Privoxy Developers http://privoxy.org
 #
 ####################################################################
 #                                                                  #
@@ -25,8 +25,8 @@
 #   ===============
 #
 #  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
-#  changes take effect.
+#  you will need to send a couple of requests (of any kind) to the
+#  proxy before any changes take effect.
 #
 #  When starting Privoxy on Unix systems, give the name of this file as
 #  an argument. On Windows systems, Privoxy will look for this file
 #      flat, except for confdir/templates, where the HTML templates
 #      for CGI output reside (e.g. Privoxy's 404 error page).
 #
-confdir /home/hal/ptmp/etc
+confdir .
 
 #
 #  1.2. logdir
@@ -131,7 +131,7 @@ confdir /home/hal/ptmp/etc
 #
 #      No trailing "/", please
 #
-logdir /home/hal/ptmp/var/log/privoxy
+logdir .
 
 #
 #  1.3. actionsfile
@@ -182,7 +182,7 @@ actionsfile user      # User customizations
 #
 #  Specifies:
 #
-#      The filter file to use
+#      The filter file(s) to use
 #
 #  Type of value:
 #
@@ -199,21 +199,27 @@ actionsfile user      # User customizations
 #
 #  Notes:
 #
-#      The filter file contains content modification rules that use
-#      regular expressions. These rules permit powerful changes on the
-#      content of Web pages, e.g., you could disable your favorite
-#      JavaScript annoyances, re-write the actual displayed text,
-#      or just have some fun replacing "Microsoft" with "MicroSuck"
-#      wherever it appears on a Web page.
+#      Multiple filterfiles lines are permitted.
+#
+#      The filter files contain content modification rules that use
+#      regular expressions. These rules permit powerful changes on
+#      the content of Web pages, and optionally the headers as well,
+#      e.g., you could disable your favorite JavaScript annoyances,
+#      re-write the actual displayed text, or just have some fun
+#      playing buzzword bingo with web pages.
 #
 #      The +filter{name} actions rely on the relevant filter (name)
-#      to be defined in the filter file!
+#      to be defined in a filter file!
 #
-#      A pre-defined filter file called default.filter that contains
-#      a bunch of handy filters for common problems is included in the
+#      A pre-defined filter file called default.filter that contains a
+#      number of useful filters for common problems is included in the
 #      distribution. See the section on the filter action for a list.
 #
+#      It is recommended to place any locally adapted filters into a
+#      separate file, such as user.filter.
+#
 filterfile default.filter
+#filterfile user.filter      # User customizations
 
 #
 #  1.5. logfile
@@ -273,17 +279,21 @@ logfile logfile
 #
 #  Default value:
 #
-#      jarfile (Unix) or privoxy.jar (Windows)
+#      Unset (commented out). When activated: jarfile (Unix) or
+#      privoxy.jar (Windows)
 #
 #  Effect if unset:
 #
-#      Intercepted cookies are not stored at all.
+#      Intercepted cookies are not stored in a dedicated log file.
 #
 #  Notes:
 #
 #      The jarfile may grow to ridiculous sizes over time.
 #
-jarfile jarfile
+#      If debug 8 (show header parsing) is enabled, cookies are written
+#      to the logfile with the rest of the headers.
+#
+#jarfile jarfile
 
 #
 #  1.7. trustfile
@@ -304,7 +314,7 @@ jarfile jarfile
 #
 #  Effect if unset:
 #
-#      The whole trust mechanism is turned off.
+#      The entire trust mechanism is turned off.
 #
 #  Notes:
 #
@@ -313,48 +323,31 @@ jarfile jarfile
 #      for the casual user.
 #
 #      If you specify a trust file, Privoxy will only allow access to
-#      sites that are named in the trustfile. You can also mark sites
-#      as trusted referrers (with +), with the effect that access
-#      to untrusted sites will be granted, if a link from a trusted
-#      referrer was used. The link target will then be added to the
-#      "trustfile". Possible applications include limiting Internet
-#      access for children.
-#
-#      If you use + operator in the trust file, it may grow considerably
-#      over time.
-#
-#trustfile trust
-
-#
-#  1.8. image-blocker-custom-file
-#  ==============
+#      sites that are specified in the trustfile. Sites can be listed
+#      in one of two ways:
 #
-#  Specifies:
-#
-#      The custom image to display for blocked images when
-#      +set-image-blocker{custom} is in effect in an action file
-#
-#  Type of value:
-#
-#      File name, relative to confdir; can be a jpeg, png or gif image
-#
-#  Default value:
-#
-#      Unset
+#      Prepending a ~ character limits access to this site only (and
+#      any sub-paths within this site), e.g. ~www.example.com.
 #
-#  Effect if unset:
+#      Or, you can designate sites as trusted referrers, by prepending
+#      the name with a + character. The effect is that access to
+#      untrusted sites will be granted -- but only if a link from this
+#      trusted referrer was used. The link target will then be added
+#      to the "trustfile" so that future, direct accesses will be
+#      granted. Sites added via this mechanism do not become trusted
+#      referrers themselves (i.e. they are added with a ~ designation).
 #
-#      If a custom image is called for and it is unset, the "pattern"
-#      built-in image will be sent instead.  I.e. it is as if you had
-#      specified "+set-image-blocker{pattern}" instead of
-#      "+set-image-blocker{custom}".
+#      If you use the + operator in the trust file, it may grow
+#      considerably over time.
 #
-#  Notes:
+#      It is recommended that Privoxy be compiled with the
+#      --disable-force, --disable-toggle and --disable-editor options,
+#      if this feature is to be used.
 #
-#      If the specified file signature is not found to be jpeg, png
-#      or gif, the the built-in "pattern" image will be sent instead.
+#      Possible applications include limiting Internet access for
+#      children.
 #
-#image-blocker-custom-file my-custom-image.jpg
+#trustfile trust
 
 #
 #  2. LOCAL SET-UP DOCUMENTATION
@@ -399,11 +392,20 @@ jarfile jarfile
 #
 #      Unix, in local filesystem:
 #
-#      user-manual  file:///usr/share/doc/privoxy-2.9.18/user-manual/
+#        user-manual  file:///usr/share/doc/privoxy-3.0.4/user-manual/
+#
+#      Windows, in local filesystem, must use forward slash notation:
+#
+#        user-manual  file:/c:/some-dir/privoxy-3.0.4/user-manual/
+#
+#      Windows, UNC notation (with forward slashes):
+#
+#        user-manual
+#        file://///some-server/some-path/privoxy-3.0.4/user-manual/
 #
 #      Any platform, on local webserver (called "local-webserver"):
 #
-#      user-manual  http://local-webserver/privoxy-user-manual/
+#        user-manual  http://local-webserver/privoxy-user-manual/
 #
 #      WARNING!!!
 #
@@ -544,20 +546,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      2048 # CGI user interface
-#          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.
@@ -848,7 +850,7 @@ enable-edit-actions 1
 #      to anywhere, with the exception that 192.168.45.73 may not
 #      access www.dirty-stuff.example.com:
 #
-#        permit-access  192.168.45.64/26
+#        permit-access  192.168.45.64/26 
 #        deny-access    192.168.45.73     www.dirty-stuff.example.com
 #
 
@@ -945,7 +947,7 @@ 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
@@ -1004,13 +1006,35 @@ 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           .example.com   .
+#        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  .
+#
+#      To chain Privoxy and Tor, both running on the same system,
+#      you should use the rule:
+#
+#        forward-socks4   /               127.0.0.1:9050 .
+#
+#      The public Tor network can't be used to reach your local network,
+#      therefore it's a good idea to make some exceptions:
+#
+#        forward         192.168.*.*/     .  
+#        forward           10.*.*.*/      .  
+#        forward          127.*.*.*/      .
+#
+#      Unencrypted connections to systems in these address ranges will
+#      be as (un)secure as the local network is, but the alternative
+#      is that you can't reach the network at all.
+#
+#      If you also want to be able to reach servers in your local
+#      network by using their names, you will need additional exceptions
+#      that look like this:
+#
+#       forward           localhost/     .
 #
 
 #
@@ -1075,16 +1099,4 @@ buffer-limit 4096
 #
 #hide-console
 
-#  The experimental "activity-console-address" option is used to
-#  specify where statistical information should be sent for monitoring
-#  by the activity console.
-#
-#activity-console-address 127.0.0.1:8119
-
-#  The experimental "activity-console-update-freq" option is used to
-#  specify how often (in seconds) statistics should be forwarded to the
-#  activity console.
-#
-#activity-console-update-freq 5
-
 #