Unified blocklist/imagelist/permissionslist.
[privoxy.git] / config
diff --git a/config b/config
index b5b3975..88529d0 100644 (file)
--- a/config
+++ b/config
@@ -1,7 +1,7 @@
 #  Sample Configuration file for the Internet Junkbuster 2.0
 
 #
-# $Id: config,v 1.2 2001/05/17 22:37:46 oes Exp $
+# $Id: config,v 1.6 2001/05/26 17:25:14 jongfoster Exp $
 #
 
 #  Table of Contents
@@ -33,8 +33,8 @@
 #
 #  Indicates that the blockfile is named 'blocklist.ini'.
 #
-#  The '#' indicates a comment.  Any part of a line following a # is
-#  ignored
+#  The '#' indicates a comment.  Any part of a line following a '#' is
+#  ignored, except if the '#' is preceded by a '\'.
 #
 #  Thus, by placing a # at the start of an existing configuration line,
 #  you can make it a comment and it will be treated as if it weren't there. 
 #  off features: If you comment out the "logfile" line, junkbuster will
 #  not log at all. Watch for the "default:" section in each explanation
 #  to see what happens if the option is left unset (or commented out). 
+#
+#  Long lines can be continued on the next line by using a `\' as
+#  the last character. This also works if comments are present in
+#  between.
 #  
 
 #
 #  files in the current working directory.  In either case, an
 #  absolute path name can be used to avoid problems.
 
-#
-#  The blockfile contains regular expressions, one per line, of URLs
-#  to be blocked by Junkbuster.
-#
-#  Default: Don't block anything.
-#
-blockfile   ./blocklist
-
-#
-#  The imagefile contains regular expressions, one per line, of URLs
-#  to be blocked as images by Junkbuster, regardless of whether they
-#  look like image URLs or not.
-#
-#  Default: Block all URLs as HTML requests.
-#
-imagefile   ./imagelist 
-
 #
 #  The permissions file contains patterns to specify the
-#  cookie and filtering rules to apply to each site.
+#  filtering rules to apply to each site.
 #
 #  Default: Cookies to and from all destinations are filtered.
 #           Popups are disabled for all sites.
 #           All sites are filtered if re_filterfile specified.
+#           No sites are blocked.  Nothing is an image.
 #
 permissionsfile ./permissionsfile
 
@@ -101,8 +89,7 @@ re_filterfile   ./re_filterfile
 #  Junkbuster (e.g., it's not blocking an ad you think it should
 #  block) but in most cases you probably will never look at it.
 #
-#  If you do not use 'log-buffer-size'/'log-max-lines' (see below)
-#  your logfile will grow indefinitely, and you will probably want to
+#  Your logfile will grow indefinitely, and you will probably want to
 #  periodically remove it.  On Unix systems, you can do this with a
 #  cron job (see 'man cron').
 #
@@ -288,18 +275,22 @@ user-agent    .
 #  Junkbuster has the ability to mask the Referer header.  Referer
 #  headers can be used to track users as they browse around the web,
 #  and many consider them invasive.  Junkbuster provides several
-#  options for dealing with referer headers:
+#  options for dealing with referer headers.
+#
+#  Note that the setting of this value can be overridden on a
+#  site-by-site basis in the permissionsfile, in order to send
+#  the unmodified Referer header to sites which require it.
+#  This option controls what to do for sites without that
+#  permission.
 #
 #       VALUE       EFFECT
 #       =====       ======
 #       default     Kill the referrer-header from the client.
-#       .           Pass the referrer unchanged.
-#       @           Pass the referrer if the server is in the cookie file,
-#                   kill the referrer otherwise.
-#       L           Pass the referrer if the server is in the cookie file,
-#                   send a forged referrer that points to the
+#       @           Kill the referrer-header from the client.
+#       .           Always pass the referrer unchanged.
+#       L           Send a forged referrer that points to the
 #                   root-directory URL of the current request otherwise.
-#       'text'      Always send <text> as the referrer.
+#       'text'      Send <text> as the referrer.
 #
 #  L is probably preferable to @, because it will break fewer Web
 #  sites while still concealing your browsing path.
@@ -339,9 +330,9 @@ referer     L
 #
 #  As an example of the last option:
 #
-#    tinygif 3 http://www.junkbusters.com/images/fb.gif
+#    tinygif 3 http://i.j.b/ijb-send-banner.gif
 #
-#  Will replace every blocked image with the "fb.gif" image.
+#  Will replace every blocked image with an image built into junkbuster.
 #
 #  There is one non-obvious benefit to using option "3".  If you use
 #  option 3, your Web browser will likely cache the image you specify
@@ -353,6 +344,7 @@ referer     L
 #
 tinygif   2
 
+
 #
 #  The debug option sets the level of debugging information to log in
 #  the logfile (and to the console in the Windows version).  A debug
@@ -367,15 +359,29 @@ tinygif   2
 #   debug        16 # LOG  = log all data into the logfile
 #   debug        32 # FRC  = debug force feature
 #   debug        64 # REF  = debug regular expression filter 
+#   debug       128 # RED  = debug fast redirects
+#   debug       256 # CLF  = Common Log Format
+#   debug      4096 # INFO = Startup banner and warnings.
+#   debug      8192 # ERROR = Non-fatal errors
+#
+#  It is *highly recommended* that you enable ERROR
+#  reporting.  (debug 8192).
+#
+#  The reporting of FATAL errors (i.e. ones which crash 
+#  JunkBuster) is always on and cannot be disabled.
+#
+#  If you want to use CLF, you should set "debug 256" ONLY,
+#  do not enable anything else.
 #
 #  Multiple "debug" directives, are OK - they're logical-OR'd
 #  together. 
 #
 #   debug         15 # same as setting the first 4 listed above
 #
-#  Default: 0, i.e. log nothing but errors and infos
+#  Default: 0, i.e. log nothing but fatal errors
 #
 debug   1
+debug   8192 # Errors - *we highly recommended enabling this*
 
 #
 #  Junkbuster normally uses "multi-threading", a software technique
@@ -389,28 +395,27 @@ debug   1
 #single-threaded
 
 #
-#    'toggle' controls whether Junkbuster can temporarily be toggled on
-#    and off.
+#    'toggle' allows you to temporarily disable all Junkbuster's 
+#    filtering.  Just set "toggle 0".
 #    
 #    The Windows version of Junkbuster puts an icon in the system
-#    tray.  If you right-click on that icon (or select the 'Options'
-#    menu), one choice is "Enable".  Clicking on enable toggles
-#    Junkbuster on and off.  This is useful if you want to temporarily
-#    disable Junkbuster, e.g., to access a site that requires cookies
-#    which you normally have blocked.
-#
-#    Unix versions of Junkbuster are toggled on and off by sending a
-#    SIGHUP to Junkbuster.
+#    tray, which allows you to change this option without having
+#    to edit this file.  If you right-click on that icon (or select
+#    the 'Options' menu), one choice is "Enable".  Clicking on enable
+#    toggles Junkbuster on and off.  This is useful if you want to
+#    temporarily disable Junkbuster, e.g., to access a site that
+#    requires cookies which you normally have blocked.
 #
-#    'toggle 1' means permit toggling of Junkbuster, 'toggle 0' means
-#    don't.
+#    'toggle 1' means Junkbuster runs normally, 'toggle 0' means
+#    that Junkbuster becomes a non-anonymizing non-blocking
+#    proxy.
 #
 #  Default: 1
 #
 toggle 1
 
 #
-#  5. WINDOWS GUI OTPIONS
+#  5. WINDOWS GUI OPTIONS
 #
 #  Junkbuster has a number of options specific to the Windows GUI
 #  interface:
@@ -466,8 +471,8 @@ toggle 1
 
 #    show-on-task-bar        {1 or 0}
 #
-#    Controls whether or not Junkbuster will appear on the Task bar
-#    when minimized.
+#    Controls whether or not Junkbuster will appear as a button on the Task
+#    bar when minimized.
 #
 #Win32-only: show-on-task-bar        0