Changed version string only to 3.0.12
[privoxy.git] / config
diff --git a/config b/config
index 32e5157..a2d564e 100644 (file)
--- a/config
+++ b/config
@@ -1,8 +1,8 @@
-#        Sample Configuration File for Privoxy v3.0.9
+#        Sample Configuration File for Privoxy v3.0.12
 #
-#  $Id: p-config.sgml,v 2.30 2008/03/27 18:31:20 fabiankeil Exp $
+#  $Id: config,v 1.74 2009/02/19 17:26:26 fabiankeil Exp $
 #
-#  Copyright (C) 2001-2008 Privoxy Developers http://www.privoxy.org/
+#  Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/
 #
 ####################################################################
 #                                                                  #
@@ -70,6 +70,7 @@
 #
 #
 #  1. 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
@@ -78,6 +79,7 @@
 #
 #
 #  1.1. user-manual
+#  =================
 #
 #  Specifies:
 #
 #          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/
+user-manual /home/halb/privoxy/share/doc/privoxy/user-manual/
 #
 #
 #  1.2. trust-info-url
+#  ====================
 #
 #  Specifies:
 #
 #
 #  Default value:
 #
-#      Two example URLs are provided
+#      Unset
 #
 #  Effect if unset:
 #
 #      don't end up locked out from the information on why they were
 #      locked out in the first place!
 #
-trust-info-url  http://www.example.com/why_we_block.html
-trust-info-url  http://www.example.com/what_we_allow.html
+#trust-info-url  http://www.example.com/why_we_block.html
+#trust-info-url  http://www.example.com/what_we_allow.html
 #
 #
 #  1.3. admin-address
+#  ===================
 #
 #  Specifies:
 #
@@ -196,6 +200,7 @@ trust-info-url  http://www.example.com/what_we_allow.html
 #
 #
 #  1.4. proxy-info-url
+#  ====================
 #
 #  Specifies:
 #
@@ -227,6 +232,7 @@ trust-info-url  http://www.example.com/what_we_allow.html
 #
 #
 #  2. CONFIGURATION AND LOG FILE LOCATIONS
+#  ========================================
 #
 #  Privoxy can (and normally does) use a number of other files for
 #  additional configuration, help and logging. This section of the
@@ -239,6 +245,7 @@ trust-info-url  http://www.example.com/what_we_allow.html
 #
 #
 #  2.1. confdir
+#  =============
 #
 #  Specifies:
 #
@@ -260,10 +267,11 @@ trust-info-url  http://www.example.com/what_we_allow.html
 #
 #      No trailing "/", please.
 #
-confdir .
+confdir /home/halb/privoxy/etc
 #
 #
 #  2.2. templdir
+#  ==============
 #
 #  Specifies:
 #
@@ -293,11 +301,12 @@ confdir .
 #
 #
 #  2.3. logdir
+#  ============
 #
 #  Specifies:
 #
-#      The directory where all logging takes place (i.e. where logfile
-#      and jarfile are located).
+#      The directory where all logging takes place (i.e. where the
+#      logfile is located).
 #
 #  Type of value:
 #
@@ -315,10 +324,11 @@ confdir .
 #
 #      No trailing "/", please.
 #
-logdir .
+logdir /home/halb/privoxy/var/log/privoxy
 #
 #
 #  2.4. actionsfile
+#  =================
 #
 #  Specifies:
 #
@@ -330,11 +340,11 @@ logdir .
 #
 #  Default values:
 #
-#        standard.action     # Internal purposes, no editing recommended
+#        match-all.action # Actions that are applied to all sites and maybe overruled later on.
 #
-#        default.action      # Main actions file
+#        default.action   # Main actions file
 #
-#        user.action         # User customizations
+#        user.action      # User customizations
 #
 #  Effect if unset:
 #
@@ -345,10 +355,9 @@ logdir .
 #      Multiple actionsfile lines are permitted, and are in fact
 #      recommended!
 #
-#      The default values include standard.action, which is used
-#      for internal purposes and should be loaded, default.action,
-#      which is the "main" actions file maintained by the developers,
-#      and user.action, where you can make your personal additions.
+#      The default values are default.action, which is the "main"
+#      actions file maintained by the developers, and user.action,
+#      where you can make your personal additions.
 #
 #      Actions files contain all the per site and per URL configuration
 #      for ad blocking, cookie management, privacy considerations,
@@ -360,12 +369,13 @@ logdir .
 #      was necessary to be consistent with the other file options and
 #      to allow previously forbidden characters.
 #
-actionsfile standard.action  # Internal purpose, recommended
+actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on.
 actionsfile default.action   # Main actions file
 actionsfile user.action      # User customizations
 #
 #
 #  2.5. filterfile
+#  ================
 #
 #  Specifies:
 #
@@ -410,6 +420,7 @@ filterfile default.filter
 #
 #
 #  2.6. logfile
+#  =============
 #
 #  Specifies:
 #
@@ -456,39 +467,8 @@ filterfile default.filter
 logfile logfile
 #
 #
-#  2.7. jarfile
-#
-#  Specifies:
-#
-#      The file to store intercepted cookies in
-#
-#  Type of value:
-#
-#      File name, relative to logdir
-#
-#  Default value:
-#
-#      Unset (commented out). When activated: jarfile (Unix) or
-#      privoxy.jar (Windows).
-#
-#  Effect if unset:
-#
-#      Intercepted cookies are not stored in a dedicated log file.
-#
-#  Notes:
-#
-#      The jarfile may grow to ridiculous sizes over time.
-#
-#      If debug 8 (show header parsing) is enabled, cookies are also
-#      written to the logfile with the rest of the headers. Therefore
-#      this option isn't very useful and may be removed in future
-#      releases. Please report to the developers if you are still
-#      using it.
-#
-#jarfile jarfile
-#
-#
-#  2.8. trustfile
+#  2.7. trustfile
+#  ===============
 #
 #  Specifies:
 #
@@ -545,6 +525,7 @@ logfile logfile
 #
 #
 #  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
@@ -553,6 +534,7 @@ logfile logfile
 #
 #
 #  3.1. debug
+#  ===========
 #
 #  Specifies:
 #
@@ -574,7 +556,7 @@ logfile logfile
 #
 #      The available debug levels are:
 #
-#        debug         1 # log each request destination (and the crunch reason if Privoxy intercepted the request)
+#        debug         1 # Log the destination for each request Privoxy let through. See also debug 1024.
 #        debug         2 # show each connection status
 #        debug         4 # show I/O status
 #        debug         8 # show header parsing
@@ -584,7 +566,7 @@ logfile logfile
 #        debug       128 # debug redirects
 #        debug       256 # debug GIF de-animation
 #        debug       512 # Common Log Format
-#        debug      1024 # Unused
+#        debug      1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
 #        debug      2048 # CGI user interface
 #        debug      4096 # Startup banner and warnings.
 #        debug      8192 # Non-fatal errors
@@ -618,12 +600,14 @@ logfile logfile
 #      you read the log messages, you may even be able to solve the
 #      problem on your own.
 #
-#debug      1 # log each request destination (and the crunch reason if Privoxy intercepted the request)
+#debug      1 # Log the destination for each request Privoxy let through.
+#debug   1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
 #debug   4096 # Startup banner and warnings
 #debug   8192 # Non-fatal errors
 #
 #
 #  3.2. single-threaded
+#  =====================
 #
 #  Specifies:
 #
@@ -651,6 +635,7 @@ logfile logfile
 #
 #
 #  3.3. hostname
+#  ==============
 #
 #  Specifies:
 #
@@ -685,6 +670,7 @@ logfile logfile
 #
 #
 #  4. ACCESS CONTROL AND SECURITY
+#  ===============================
 #
 #  This section of the config file controls the security-relevant
 #  aspects of Privoxy's configuration.
@@ -692,6 +678,7 @@ logfile logfile
 #
 #
 #  4.1. listen-address
+#  ====================
 #
 #  Specifies:
 #
@@ -744,6 +731,7 @@ listen-address  127.0.0.1:8118
 #
 #
 #  4.2. toggle
+#  ============
 #
 #  Specifies:
 #
@@ -775,6 +763,7 @@ toggle  1
 #
 #
 #  4.3. enable-remote-toggle
+#  ==========================
 #
 #  Specifies:
 #
@@ -816,6 +805,7 @@ enable-remote-toggle  0
 #
 #
 #  4.4. enable-remote-http-toggle
+#  ===============================
 #
 #  Specifies:
 #
@@ -854,6 +844,7 @@ enable-remote-http-toggle  0
 #
 #
 #  4.5. enable-edit-actions
+#  =========================
 #
 #  Specifies:
 #
@@ -894,6 +885,7 @@ enable-edit-actions 0
 #
 #
 #  4.6. enforce-blocks
+#  ====================
 #
 #  Specifies:
 #
@@ -942,6 +934,7 @@ enforce-blocks 0
 #
 #
 #  4.7. ACLs: permit-access and deny-access
+#  =========================================
 #
 #  Specifies:
 #
@@ -1026,6 +1019,7 @@ enforce-blocks 0
 #
 #
 #  4.8. buffer-limit
+#  ==================
 #
 #  Specifies:
 #
@@ -1061,6 +1055,7 @@ buffer-limit 4096
 #
 #
 #  5. FORWARDING
+#  ==============
 #
 #  This feature allows routing of HTTP requests through a chain of
 #  multiple proxies.
@@ -1083,6 +1078,7 @@ buffer-limit 4096
 #
 #
 #  5.1. forward
+#  =============
 #
 #  Specifies:
 #
@@ -1134,6 +1130,7 @@ buffer-limit 4096
 #
 #
 #  5.2. forward-socks4, forward-socks4a and forward-socks5
+#  ========================================================
 #
 #  Specifies:
 #
@@ -1224,6 +1221,7 @@ buffer-limit 4096
 #
 #
 #  5.3. forwarded-connect-retries
+#  ===============================
 #
 #  Specifies:
 #
@@ -1270,6 +1268,7 @@ forwarded-connect-retries  0
 #
 #
 #  5.4. accept-intercepted-requests
+#  =================================
 #
 #  Specifies:
 #
@@ -1308,6 +1307,7 @@ accept-intercepted-requests 0
 #
 #
 #  5.5. allow-cgi-request-crunching
+#  =================================
 #
 #  Specifies:
 #
@@ -1345,6 +1345,7 @@ allow-cgi-request-crunching 0
 #
 #
 #  5.6. split-large-forms
+#  =======================
 #
 #  Specifies:
 #
@@ -1385,22 +1386,103 @@ allow-cgi-request-crunching 0
 split-large-forms 0
 #
 #
+#  5.7. keep-alive-timeout
+#  ========================
+#
+#  Specifies:
+#
+#      Number of seconds after which an open connection will no longer
+#      be reused.
+#
+#  Type of value:
+#
+#      Time in seconds.
+#
+#  Default value:
+#
+#      None
+#
+#  Effect if unset:
+#
+#      Connections are not reused.
+#
+#  Notes:
+#
+#      This option has no effect if Privoxy has been compiled without
+#      keep-alive support.
+#
+#  Notes:
+#
+#      Note that reusing connections doesn't necessary cause
+#      speedups. There are also a few privacy implications you should
+#      be aware of.
+#
+#      Outgoing connections are shared between clients (if there are
+#      more than one) and closing the client that initiated the outgoing
+#      connection does not affect the connection between Privoxy and
+#      the server unless the client's request hasn't been completed
+#      yet. If the outgoing connection is idle, it will not be closed
+#      until either Privoxy's or the server's timeout is reached. While
+#      it's open, the server knows that the system running Privoxy is
+#      still there.
+#
+#  Examples:
+#
+#      keep-alive-timeout 300
+#
+keep-alive-timeout 300
+#
+#
+#  5.8. socket-timeout
+#  ====================
+#
+#  Specifies:
+#
+#      Number of seconds after which a socket times out if no data
+#      is received.
+#
+#  Type of value:
+#
+#      Time in seconds.
+#
+#  Default value:
+#
+#      None
+#
+#  Effect if unset:
+#
+#      A default value of 300 seconds is used.
+#
+#  Notes:
+#
+#      For SOCKS requests the timeout currently doesn't start until
+#      the SOCKS server accepted the request. This will be fixed in
+#      the next release.
+#
+#  Examples:
+#
+#      socket-timeout 300
+#
+socket-timeout 300
+#
+#
 #  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
 #  the console window, will be limited to "log-max-lines" (see below).
@@ -1409,36 +1491,36 @@ split-large-forms 0
 #  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.