Correcting misleading comments
[privoxy.git] / config
diff --git a/config b/config
index b5b3975..2dea618 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.5 2001/05/23 10:39:05 oes 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.
 #  
 
 #
@@ -339,9 +343,9 @@ referer     L
 #
 #  As an example of the last option:
 #
-#    tinygif 3 http://www.junkbusters.com/images/fb.gif
+#    tinygif 3 http://no.where/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 +357,31 @@ referer     L
 #
 tinygif   2
 
+#
+#  Many sites, like yahoo.com, don't just link to other sites.
+#  Instead, they will link to some script on their own server,
+#  giving the destination as a parameter, which will then redirect
+#  you to the final target. 
+#
+#  URLs resulting from this scheme typically look like:
+#  http://some.place/some_script?http://some.where-else
+#
+#  Sometimes, there are even multiple consecutive redirects encoded
+#  in the URL. These redirections via scripts make your web browing
+#  more traceable, since the server from which you follow such a link
+#  can see where you go to. Apart from that, valuable bandwidth and
+#  time is wasted, while your browser aks the server for one redirect
+#  after the other. Plus, it feeds the advertisers.
+#
+#  The fast-redirects option enables interception of these requests
+#  by junkbuster, who will cut off all but the last valid URL in the
+#  request and send a local redirect back to your browser without
+#  contacting the remote site.
+#
+#  Default: Don't intercept script-redirect URLs
+#
+fast-redirects 
+
 #
 #  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 +396,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