1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
3 File : $Source: /cvsroot/ijbswa/current/doc/source/user-manual.sgml,v $
7 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
9 $Id: user-manual.sgml,v 1.40 2002/03/07 16:28:39 swa Exp $
11 Written by and Copyright (C) 2001 the SourceForge
12 IJBSWA team. http://ijbswa.sourceforge.net
14 Based on the Internet Junkbuster originally written
15 by and Copyright (C) 1997 Anonymous Coders and
16 Junkbusters Corporation. http://www.junkbusters.com
20 Sat 03/02/02 04:53:47 PM
22 This should be ready for BETA release.
24 Hal Burgiss <hal@foobox.net>
29 <title>Junkbuster User Manual</title>
31 <pubdate>$Id: user-manual.sgml,v 1.40 2002/03/07 16:28:39 swa Exp $</pubdate>
36 <orgname>By: Junkbuster Developers</orgname>
43 The user manual gives users information on how to install, configure
44 and use <application>Internet Junkbuster</application>.
45 <application>Internet Junkbuster</application> is an application that
46 provides privacy and security to users of the World Wide Web.
49 You can find the latest version of the user manual at <ulink url="http://ijbswa.sourceforge.net/user-manual/">http://ijbswa.sourceforge.net/user-manual/</ulink>.
53 Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>.
60 <!-- ~~~~~ New section ~~~~~ -->
62 <sect1 id="introduction"><title>Introduction</title>
64 <application>Internet Junkbuster</application> is a web proxy with advanced
65 filtering capabilities for protecting privacy, filtering and modifying web
66 page content, managing cookies, controlling access, and removing ads,
67 banners, pop-ups and other obnoxious Internet Junk.
68 <application>Junkbuster</application> has a very flexible configuration and
69 can be customized to suit individual needs and tastes. <application>Internet
70 Junkbuster</application> has application for both stand-alone systems and
75 This documentation is included with the current BETA version of
76 <application>Internet Junkbuster</application> and is mostly complete at this
77 point. The most up to date reference for the time being is still the comments
78 in the source files and in the individual configuration files. Development
79 of version 3.0 is currently nearing completion, and includes many significant
80 changes and enhancements over earlier versions. The target release date for
81 stable v3.0 is <quote>soon</quote> ;-)
85 Since this is a BETA version, not all new features are well tested. This
86 documentation may be slightly out of sync as a result (especially with
87 CVS sources). And there <emphasis>may be</emphasis> bugs, though hopefully
92 <!-- ~~~~~ New section ~~~~~ -->
94 <title>New Features</title>
96 In addition to <application>Junkbuster's</application> traditional features
97 of ad and banner blocking and cookie management, this is a list of new
98 features currently under development:
106 Integrated browser based configuration and control utility (<ulink
107 url="http://i.j.b">http://i.j.b</ulink>). Browser-based tracing of rule
114 Modularized configuration that will allow for system wide settings, and
115 individual user settings. (not implemented yet, probably a 3.1 feature)
121 Blocking of annoying pop-up browser windows.
127 HTTP/1.1 compliant (most, but not all 1.1 features are supported).
133 Support for Perl Compatible Regular Expressions in the configuration files, and
134 generally a more sophisticated and flexible configuration syntax over
147 Web page content filtering (removes banners based on size,
148 invisible <quote>web-bugs</quote>, JavaScript, pop-ups, status bar abuse,
155 Bypass many click-tracking scripts (avoids script redirection).
162 Multi-threaded (POSIX and native threads).
168 Auto-detection and re-reading of config file changes.
174 User-customizable HTML templates (e.g. 404 error page).
180 Improved cookie management features (e.g. session based cookies).
186 Builds from source on most UNIX-like systems. Packages available for: Linux
187 (RedHat, SuSE, or Debian), Windows, Sun Solaris, Mac OSX, OS/2.
194 In addition, the configuration is much more powerful and versatile over-all.
205 <!-- ~ End section ~ -->
208 <!-- ~~~~~ New section ~~~~~ -->
209 <sect1 id="installation"><title>Installation</title>
211 <application>Junkbuster</application> is available as raw source code, or
212 pre-compiled binaries. See the <ulink
213 url="http://sourceforge.net/projects/ijbswa/">Junkbuster Home Page</ulink>
214 for binaries and current release info. <application>Junkbuster</application>
215 is also available via <ulink
216 url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/">CVS</ulink>.
217 This is the recommended approach at this time. But please be aware that CVS
218 is constantly changing, and it may break in mysterious ways.
221 <!-- ~~~~~ New section ~~~~~ -->
222 <sect2 id="installation-source"><title>Source</title>
224 For gzipped tar archives, unpack the source:
229 tar xzvf ijb_source_* [.tgz or .tar.gz]
230 cd ijb_source_2.9.11_beta
235 For retrieving the current CVS sources, you'll need the CVS
236 package installed first. To download CVS source:
241 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
242 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
248 This will create a directory named <filename>current/</filename>, which will
249 contain the source tree.
253 Then, in either case, to build from tarball/CVS source:
258 ./configure (--help to see options)
259 make (the make from gnu, gmake for *BSD)
261 make -n install (to see where all the files will go)
262 make install (to really install)
267 For Redhat and SuSE Linux RPM packages, see below.
273 <!-- ~~~~~ New section ~~~~~ -->
274 <sect2 id="installation-rh"><title>Red Hat</title>
276 To build Redhat RPM packages, install source as above. Then:
281 autoheader [suggested for CVS source]
282 autoconf [suggested for CVS source]
289 This will create both binary and src RPMs in the usual places. Example:
293 /usr/src/redhat/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
296 /usr/src/redhat/SRPMS/junkbuster-2.9.11-1.src.rpm
300 To install, of course:
305 rpm -Uvv /usr/src/redhat/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
310 This will place the <application>Junkbuster</application> configuration
311 files in <filename>/etc/junkbuster/</filename>, and log files in
312 <filename>/var/log/junkbuster/</filename>.
317 <!-- ~~~~~ New section ~~~~~ -->
318 <sect2 id="installation-suse"><title>SuSE</title>
320 To build SuSE RPM packages, install source as above. Then:
325 autoheader [suggested for CVS source]
326 autoconf [suggested for CVS source]
333 This will create both binary and src RPMs in the usual places. Example:
337 /usr/src/packages/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
340 /usr/src/packages/SRPMS/junkbuster-2.9.11-1.src.rpm
344 To install, of course:
349 rpm -Uvv /usr/src/packages/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
354 This will place the <application>Junkbuster</application> configuration
355 files in <filename>/etc/junkbuster/</filename>, and log files in
356 <filename>/var/log/junkbuster/</filename>.
362 <!-- ~~~~~ New section ~~~~~ -->
363 <sect2 id="installation-os2"><title>OS/2</title>
370 <application>Junkbuster</application> is packaged in a WarpIN self-
371 installing archive. The self-installing program will be named depending
372 on the release version, something like:
373 <filename>ijbos2_setup_1.2.3.exe</filename>. In order to install it, simply
374 run this executable or double-click on its icon and follow the WarpIN
375 installation panels. A shadow of the <application>Junkbuster</application>
376 executable will be placed in your startup folder so it will start
377 automatically whenever OS/2 starts.
381 The directory you choose to install <application>Junkbuster</application>
382 into will contain all of the configuration files.
386 If you would like to build binary images on OS/2 yourself, you will need
387 a few Unix-like tools: autoconf, autoheader and sh. These tools will be
388 used to create the required config.h file, which is not part of the
389 source distribution because it differs based on platform. You will also
391 The distribution has been created using IBM VisualAge compilers, but you
392 can use any compiler you like. GCC/EMX has the disadvantage of needing
393 to be single-threaded due to a limitation of EMX's implementation of the
394 select() socket call.
398 In addition to needing the source code distribution as outlined earlier,
399 you will want to extract the <filename>os2seutp</filename> directory from CVS:
401 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
402 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
404 This will create a directory named os2setup/, which will contain the
405 <filename>Makefile.vac</filename> makefile and <filename>os2build.cmd</filename>
406 which is used to completely create the binary distribution. The sequence
407 of events for building the executable for yourself goes something like this:
414 nmake -f Makefile.vac
416 You will see this sequence laid out in <filename>os2build.cmd</filename>.
422 <!-- ~~~~~ New section ~~~~~ -->
423 <sect2 id="installation-win"><title>Windows</title>
424 <para>Click-click. (I need help on this. Not a clue here. Also for
425 configuration section below. HB.)
429 <!-- ~~~~~ New section ~~~~~ -->
430 <sect2 id="installation-other"><title>Other</title>
432 Some quick notes on other Operating Systems.
436 For FreeBSD (and other *BSDs?), the build will require <command>gmake</command>
437 instead of the included <command>make</command>. <command>gmake</command> is
438 available from <ulink url="http://www.gnu.org">http://www.gnu.org</ulink>.
439 The rest should be the same as above for Linux/Unix.
446 <!-- ~ End section ~ -->
449 <!-- ~~~~~ New section ~~~~~ -->
450 <sect1 id="configuration"><title>Invoking and Configuring JunkBuster</title>
452 For Unix, *BSD and Linux, all configuration files are located in
453 <filename>/etc/junkbuster/</filename> by default. For MS Windows, OS/2, and
454 AmigaOS these are all in the same directory as the
455 <application>Junkbuster</application> executable. The name and number of
456 configuration files has changed from previous versions, and is subject to
457 change as development progresses.
461 The installed defaults provide a reasonable starting point, though possibly
462 aggressive by some standards. For the time being, there are only three
463 default configuration files (this will change in time):
471 The main configuration file is named <filename>config</filename>
472 on Linux, Unix, BSD, OS/2, and AmigaOS and <filename>config.txt</filename>
479 The <filename>ijb.action</filename> file is used to define various
480 <quote>actions</quote> relating to images, banners, pop-ups, access
481 restrictions, banners and cookies. There is a CGI based editor for this
482 file that can be accessed via <ulink
483 url="http://i.j.b">http://i.j.b</ulink>. This is the easiest method of
484 configuring actions. (Other actions
485 files are included as well with differing levels of filtering
486 and blocking, e.g. <filename>ijb-basic.action</filename>.)
492 The <filename>re_filterfile</filename> file can be used to rewrite the raw
493 page content, including text as well as embedded HTML and JavaScript.
501 <filename>ijb.action</filename> and <filename>re_filterfile</filename>
502 can use Perl style regular expressions for maximum flexibility. All files use
503 the <quote><literal>#</literal></quote> character to denote a comment. Such
504 lines are not processed by <application>Junkbuster</application>. After
505 making any changes, there is no need to restart
506 <application>Junkbuster</application> in order for the changes to take
507 effect. <application>Junkbuster</application> should detect such changes
512 While under development, the configuration content is subject to change.
513 The below documentation may not be accurate by the time you read this.
514 Also, what constitutes a <quote>default</quote> setting, may change, so
515 please check all your configuration files on important issues.
520 <!-- ~~~~~ New section ~~~~~ -->
523 <title>Command Line Options</title>
525 <application>JunkBuster</application> may be invoked with the following
526 command-line options:
534 <emphasis>--version</emphasis>
537 Print version info and exit, Unix only.
542 <emphasis>--help</emphasis>
545 Print a short usage info and exit, Unix only.
550 <emphasis>--no-daemon</emphasis>
553 Don't become a daemon, i.e. don't fork and become process group
554 leader, don't detach from controlling tty. Unix only.
559 <emphasis>--pidfile FILE</emphasis>
563 On startup, write the process ID to <emphasis>FILE</emphasis>. Delete the
564 <emphasis>FILE</emphasis> on exit. Failiure to create or delete the
565 <emphasis>FILE</emphasis> is non-fatal. If no <emphasis>FILE</emphasis>
566 option is given, no PID file will be used. Unix only.
571 <emphasis>--user USER</emphasis>
575 After (optionally) writing the PID file, assume the user ID of
576 <emphasis>USER</emphasis>. Exit if the privileges are not sufficient to do
582 <emphasis>configfile</emphasis>
585 If no <emphasis>configfile</emphasis> is included on the command line,
586 <application>JunkBuster</application> will look for a file named
587 <quote>config</quote> in the current directory (except on Win32
588 where it will look for <quote>config.txt</quote> instead). Specify
589 full path to avoid confusion.
598 <!-- ~ End section ~ -->
601 <!-- ~~~~~ New section ~~~~~ -->
604 <title>The Main Configuration File</title>
606 Again, the main configuration file is named <filename>config</filename> on
607 Linux/Unix/BSD and OS/2, and <filename>config.txt</filename> on Windows.
608 Configuration lines consist of an initial keyword followed by a list of
609 values, all separated by whitespace (any number of spaces or tabs). For
617 <emphasis>blockfile blocklist.ini</emphasis>
624 Indicates that the blockfile is named <quote>blocklist.ini</quote>.
628 A <quote><literal>#</literal></quote> indicates a comment. Any part of a
629 line following a <quote><literal>#</literal></quote> is ignored, except if
630 the <quote><literal>#</literal></quote> is preceded by a
631 <quote><literal>\</literal></quote>.
635 Thus, by placing a <quote><literal>#</literal></quote> at the start of an
636 existing configuration line, you can make it a comment and it will be treated
637 as if it weren't there. This is called <quote>commenting out</quote> an
638 option and can be useful to turn off features: If you comment out the
639 <quote>logfile</quote> line, <application>junkbuster</application> will not
640 log to a file at all. Watch for the <quote>default:</quote> section in each
641 explanation to see what happens if the option is left unset (or commented
646 Long lines can be continued on the next line by using a
647 <quote><literal>\</literal></quote> as the very last character.
651 There are various aspects of <application>Junkbuster</application> behavior
656 <!-- ~~~~~ New section ~~~~~ -->
659 <title>Defining Other Configuration Files</title>
662 <application>Junkbuster</application> can use a number of other files to tell it
663 what ads to block, what cookies to accept, etc. This section of the
664 configuration file tells <application>Junkbuster</application> where to find
665 all those other files.
669 On <application>Windows</application> and <application>AmigaOS</application>,
670 <application>Junkbuster</application> looks for these files in the same
671 directory as the executable. On Unix and OS/2,
672 <application>Junkbuster</application> looks for these files in the current
673 working directory. In either case, an absolute path name can be used to
678 When development goes modular and multi-user, the blocker, filter, and
679 per-user config will be stored in subdirectories of <quote>confdir</quote>.
680 For now, only <filename>confdir/templates</filename> is used for storing HTML
681 templates for CGI results.
685 The location of the configuration files:
692 <emphasis>confdir /etc/junkbuster</emphasis> # No trailing /, please.
699 The directory where all logging (i.e. <filename>logfile</filename> and
700 <filename>jarfile</filename>) takes place. No trailing
701 <quote><literal>/</literal></quote>, please:
708 <emphasis>logdir /var/log/junkbuster</emphasis>
715 Note that all file specifications below are relative to
716 the above two directories!
720 The <quote>ijb.action</quote> file contains patterns to specify the actions to
721 apply to requests for each site. Default: Cookies to and from all
722 destinations are kept only during the current browser session (i.e. they
723 are not saved to disk). Pop-ups are disabled for all sites. All sites are
724 filtered if <quote>re_filterfile</quote> specified according to the
725 contents of <quote>re_filterfile</quote>. No sites are blocked. The
726 JunkBuster logo is displayed for filtered ads and other images . The syntax
727 of this file is explained in detail <link
728 linkend="actionsfile">below</link>.
735 <emphasis>actionsfile ijb.action</emphasis>
742 The <quote>re_filterfile</quote> file contains content modification rules.
743 These rules permit powerful changes on the content of Web pages, e.g., you
744 could disable your favorite JavaScript annoyances, rewrite the actual
745 content, or just have some fun replacing <quote>Microsoft</quote> with
746 <quote>MicroSuck</quote> wherever it appears on a Web page. Default: No
747 content modification, or whatever the developers are playing with :-/
751 Filtering requires buffering the page content, which may appear to slow down
752 page rendering since nothing is displayed until all content has passed
753 the filters. (It does not really take longer, but seems that way since
754 the page is not incrementally displayed.) This effect will be more noticeable
755 on slower connections.
763 <emphasis>re_filterfile re_filterfile</emphasis>
770 The logfile is where all logging and error messages are written. The logfile
771 can be useful for tracking down a problem with
772 <application>Junkbuster</application> (e.g., it's not blocking an ad you
773 think it should block) but in most cases you probably will never look at it.
777 Your logfile will grow indefinitely, and you will probably want to
778 periodically remove it. On Unix systems, you can do this with a cron job
779 (see <quote>man cron</quote>). For Redhat, a <command>logrotate</command>
780 script has been included.
784 On SuSE Linux systems, you can place a line like <quote>/var/log/junkbuster.*
785 +1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
786 the effect that cron.daily will automatically archive, gzip, and empty the
787 log, when it exceeds 1M size.
791 Default: Log to the a file named <filename>logfile</filename>.
792 Comment out to disable logging.
799 <emphasis>logfile logfile</emphasis>
806 The <quote>jarfile</quote> defines where
807 <application>Junkbuster</application> stores the cookies it intercepts. Note
808 that if you use a <quote>jarfile</quote>, it may grow quite large. Default:
809 Don't store intercepted cookies.
816 <emphasis>#jarfile jarfile</emphasis>
823 If you specify a <quote>trustfile</quote>,
824 <application>Junkbuster</application> will only allow access to sites that
825 are named in the trustfile. You can also mark sites as trusted referrers,
826 with the effect that access to untrusted sites will be granted, if a link
827 from a trusted referrer was used. The link target will then be added to the
828 <quote>trustfile</quote>. This is a very restrictive feature that typical
829 users most probably want to leave disabled. Default: Disabled, don't use the
837 <emphasis>#trustfile trust</emphasis>
844 If you use the trust mechanism, it is a good idea to write up some on-line
845 documentation about your blocking policy and to specify the URL(s) here. They
846 will appear on the page that your users receive when they try to access
847 untrusted content. Use multiple times for multiple URLs. Default: Don't
848 display links on the <quote>untrusted</quote> info page.
855 <emphasis>trust-info-url http://www.your-site.com/why_we_block.html</emphasis>
856 <emphasis>trust-info-url http://www.your-site.com/what_we_allow.html</emphasis>
864 <!-- ~ End section ~ -->
868 <!-- ~~~~~ New section ~~~~~ -->
871 <title>Other Configuration Options</title>
874 This part of the configuration file contains options that control how
875 <application>Junkbuster</application> operates.
879 <quote>Admin-address</quote> should be set to the email address of the proxy
880 administrator. It is used in many of the proxy-generated pages. Default:
888 <emphasis>#admin-address fill@me.in.please</emphasis>
895 <quote>Proxy-info-url</quote> can be set to a URL that contains more info
896 about this <application>Junkbuster</application> installation, it's
897 configuration and policies. It is used in many of the proxy-generated pages
898 and its use is highly recommended in multi-user installations, since your
899 users will want to know why certain content is blocked or modified. Default:
900 Don't show a link to on-line documentation.
907 <emphasis>proxy-info-url http://www.your-site.com/proxy.html</emphasis>
914 <quote>Listen-address</quote> specifies the address and port where
915 <application>Junkbuster</application> will listen for connections from your
916 Web browser. The default is to listen on the localhost port 8118, and
917 this is suitable for most users. (In your web browser, under proxy
918 configuration, list the proxy server as <quote>localhost</quote> and the
919 port as <quote>8118</quote>).
923 If you already have another service running on port 8118, or if you want to
924 serve requests from other machines (e.g. on your local network) as well, you
925 will need to override the default. The syntax is
926 <quote>listen-address [<ip-address>]:<port></quote>. If you leave
927 out the IP address, <application>junkbuster</application> will bind to all
928 interfaces (addresses) on your machine and may become reachable from the
929 Internet. In that case, consider using access control lists (acl's) (see
930 <quote>aclfile</quote> above), or a firewall.
934 For example, suppose you are running <application>Junkbuster</application> on
935 a machine which has the address 192.168.0.1 on your local private network
936 (192.168.0.0) and has another outside connection with a different address.
937 You want it to serve requests from inside only:
944 <emphasis>listen-address 192.168.0.1:8118</emphasis>
951 If you want it to listen on all addresses (including the outside
959 <emphasis>listen-address :8118</emphasis>
966 If you do this, consider using ACLs (see <quote>aclfile</quote> above). Note:
967 you will need to point your browser(s) to the address and port that you have
968 configured here. Default: localhost:8118 (127.0.0.1:8118).
972 The debug option sets the level of debugging information to log in the
973 logfile (and to the console in the Windows version). A debug level of 1 is
974 informative because it will show you each request as it happens. Higher
975 levels of debug are probably only of interest to developers.
982 debug 1 # GPC = show each GET/POST/CONNECT request
983 debug 2 # CONN = show each connection status
984 debug 4 # IO = show I/O status
985 debug 8 # HDR = show header parsing
986 debug 16 # LOG = log all data into the logfile
987 debug 32 # FRC = debug force feature
988 debug 64 # REF = debug regular expression filter
989 debug 128 # = debug fast redirects
990 debug 256 # = debug GIF de-animation
991 debug 512 # CLF = Common Log Format
992 debug 1024 # = debug kill pop-ups
993 debug 4096 # INFO = Startup banner and warnings.
994 debug 8192 # ERROR = Non-fatal errors
1001 It is <emphasis>highly recommended</emphasis> that you enable ERROR
1002 reporting (debug 8192), at least until the next stable release.
1006 The reporting of FATAL errors (i.e. ones which crash
1007 <application>JunkBuster</application>) is always on and cannot be disabled.
1011 If you want to use CLF (Common Log Format), you should set <quote>debug
1012 512</quote> ONLY, do not enable anything else.
1016 Multiple <quote>debug</quote> directives, are OK - they're logical-OR'd
1024 <emphasis>debug 15 # same as setting the first 4 listed above</emphasis>
1038 <emphasis>debug 1 # URLs</emphasis>
1039 <emphasis>debug 4096 # Info</emphasis>
1040 <emphasis>debug 8192 # Errors - *we highly recommended enabling this*</emphasis>
1047 <application>Junkbuster</application> normally uses
1048 <quote>multi-threading</quote>, a software technique that permits it to
1049 handle many different requests simultaneously. In some cases you may wish to
1050 disable this -- particularly if you're trying to debug a problem. The
1051 <quote>single-threaded</quote> option forces
1052 <application>Junkbuster</application> to handle requests sequentially.
1053 Default: Multi-threaded mode.
1060 <emphasis>#single-threaded</emphasis>
1067 <quote>toggle</quote> allows you to temporarily disable all
1068 <application>Junkbuster's</application> filtering. Just set <quote>toggle
1073 The Windows version of <application>Junkbuster</application> puts an icon in
1074 the system tray, which also allows you to change this option. If you
1075 right-click on that icon (or select the <quote>Options</quote> menu), one
1076 choice is <quote>Enable</quote>. Clicking on enable toggles
1077 <application>Junkbuster</application> on and off. This is useful if you want
1078 to temporarily disable <application>Junkbuster</application>, e.g., to access
1079 a site that requires cookies which you would otherwise have blocked. This can also
1080 be toggled via a web browser at the <application>Junkbuster</application>
1081 internal address of <ulink url="http://i.j.b">http://i.j.b</ulink> on
1086 <quote>toggle 1</quote> means <application>Junkbuster</application> runs
1087 normally, <quote>toggle 0</quote> means that
1088 <application>Junkbuster</application> becomes a non-anonymizing non-blocking
1089 proxy. Default: 1 (on).
1096 <emphasis>toggle 1</emphasis>
1103 For content filtering, i.e. the <quote>+filter</quote> and
1104 <quote>+deanimate-gif</quote> actions, it is necessary that
1105 <application>Junkbuster</application> buffers the entire document body.
1106 This can be potentially dangerous, since a server could just keep sending
1107 data indefinitely and wait for your RAM to exhaust. With nasty consequences.
1111 The <application>buffer-limit</application> option lets you set the maximum
1112 size in Kbytes that each buffer may use. When the documents buffer exceeds
1113 this size, it is flushed to the client unfiltered and no further attempt to
1114 filter the rest of it is made. Remember that there may multiple threads
1115 running, which might require increasing the <quote>buffer-limit</quote>
1116 Kbytes <emphasis>each</emphasis>, unless you have enabled
1117 <quote>single-threaded</quote> above.
1124 <emphasis>buffer-limit 4069</emphasis>
1131 To enable the web-based <filename>ijb.action</filename> file editor set
1132 <application>enable-edit-actions</application> to 1, or 0 to disable. Note
1133 that you must have compiled <application>JunkBuster</application> with
1134 support for this feature, otherwise this option has no effect. This
1135 internal page can be reached at <ulink
1136 url="http://i.j.b">http://i.j.b</ulink>.
1140 Security note: If this is enabled, anyone who can use the proxy
1141 can edit the actions file, and their changes will affect all users.
1142 For shared proxies, you probably want to disable this. Default: enabled.
1149 <emphasis>enable-edit-actions 1</emphasis>
1156 Allow <application>JunkBuster</application> to be toggled on and off
1157 remotely, using your web browser. Set <quote>enable-remote-toggle</quote>to
1158 1 to enable, and 0 to disable. Note that you must have compiled
1159 <application>JunkBuster</application> with support for this feature,
1160 otherwise this option has no effect.
1164 Security note: If this is enabled, anyone who can use the proxy can toggle
1165 it on or off (see <ulink url="http://i.j.b">http://i.j.b</ulink>), and
1166 their changes will affect all users. For shared proxies, you probably want to
1167 disable this. Default: enabled.
1174 <emphasis>enable-remote-toggle 1</emphasis>
1182 <!-- ~ End section ~ -->
1185 <!-- ~~~~~ New section ~~~~~ -->
1188 <title>Access Control List (ACL)</title>
1190 Access controls are included at the request of some ISPs and systems
1191 administrators, and are not usually needed by individual users. Please note
1192 the warnings in the FAQ that this proxy is not intended to be a substitute
1193 for a firewall or to encourage anyone to defer addressing basic security
1198 If no access settings are specified, the proxy talks to anyone that
1199 connects. If any access settings file are specified, then the proxy
1200 talks only to IP addresses permitted somewhere in this file and not
1201 denied later in this file.
1205 Summary -- if using an ACL:
1210 Client must have permission to receive service.
1215 LAST match in ACL wins.
1220 Default behavior is to deny service.
1225 The syntax for an entry in the Access Control List is:
1232 ACTION SRC_ADDR[/SRC_MASKLEN] [ DST_ADDR[/DST_MASKLEN] ]
1239 Where the individual fields are:
1246 <emphasis>ACTION</emphasis> = <quote>permit-access</quote> or <quote>deny-access</quote>
1248 <emphasis>SRC_ADDR</emphasis> = client hostname or dotted IP address
1249 <emphasis>SRC_MASKLEN</emphasis> = number of bits in the subnet mask for the source
1251 <emphasis>DST_ADDR</emphasis> = server or forwarder hostname or dotted IP address
1252 <emphasis>DST_MASKLEN</emphasis> = number of bits in the subnet mask for the target
1260 The field separator (FS) is whitespace (space or tab).
1264 IMPORTANT NOTE: If the <application>junkbuster</application> is using a
1265 forwarder (see below) or a gateway for a particular destination URL, the
1266 <literal>DST_ADDR</literal> that is examined is the address of the forwarder
1267 or the gateway and <emphasis>NOT</emphasis> the address of the ultimate
1268 target. This is necessary because it may be impossible for the local
1269 <application>Junkbuster</application> to determine the address of the
1270 ultimate target (that's often what gateways are used for).
1274 Here are a few examples to show how the ACL features work:
1278 <quote>localhost</quote> is OK -- no DST_ADDR implies that
1279 <emphasis>ALL</emphasis> destination addresses are OK:
1286 <emphasis>permit-access localhost</emphasis>
1293 A silly example to illustrate permitting any host on the class-C subnet with
1294 <application>Junkbuster</application> to go anywhere:
1301 <emphasis>permit-access www.junkbusters.com/24</emphasis>
1308 Except deny one particular IP address from using it at all:
1315 <emphasis>deny-access ident.junkbusters.com</emphasis>
1322 You can also specify an explicit network address and subnet mask.
1323 Explicit addresses do not have to be resolved to be used.
1330 <emphasis>permit-access 207.153.200.0/24</emphasis>
1337 A subnet mask of 0 matches anything, so the next line permits everyone.
1344 <emphasis>permit-access 0.0.0.0/0</emphasis>
1351 Note, you <emphasis>cannot</emphasis> say:
1358 <emphasis>permit-access .org</emphasis>
1365 to allow all *.org domains. Every IP address listed must resolve fully.
1369 An ISP may want to provide a <application>Junkbuster</application> that is
1370 accessible by <quote>the world</quote> and yet restrict use of some of their
1371 private content to hosts on its internal network (i.e. its own subscribers).
1372 Say, for instance the ISP owns the Class-B IP address block 123.124.0.0 (a 16
1373 bit netmask). This is how they could do it:
1380 <emphasis>permit-access 0.0.0.0/0 0.0.0.0/0</emphasis> # other clients can go anywhere
1381 # with the following exceptions:
1383 <emphasis>deny-access</emphasis> 0.0.0.0/0 123.124.0.0/16 # block all external requests for
1384 # sites on the ISP's network
1386 <emphasis>permit 0.0.0.0/0 www.my_isp.com</emphasis> # except for the ISP's main
1389 <emphasis>permit 123.124.0.0/16 0.0.0.0/0</emphasis> # the ISP's clients can go
1397 Note that if some hostnames are listed with multiple IP addresses,
1398 the primary value returned by DNS (via gethostbyname()) is used. Default:
1399 Anyone can access the proxy.
1404 <!-- ~ End section ~ -->
1407 <!-- ~~~~~ New section ~~~~~ -->
1410 <title>Forwarding</title>
1413 This feature allows chaining of HTTP requests via multiple proxies.
1414 It can be used to better protect privacy and confidentiality when
1415 accessing specific domains by routing requests to those domains
1416 to a special purpose filtering proxy such as lpwa.com. Or to use
1417 a caching proxy to speed up browsing.
1421 It can also be used in an environment with multiple networks to route
1422 requests via multiple gateways allowing transparent access to multiple
1423 networks without having to modify browser configurations.
1427 Also specified here are SOCKS proxies. <application>Junkbuster</application>
1428 SOCKS 4 and SOCKS 4A. The difference is that SOCKS 4A will resolve the target
1429 hostname using DNS on the SOCKS server, not our local DNS client.
1433 The syntax of each line is:
1440 <emphasis>forward target_domain[:port] http_proxy_host[:port]</emphasis>
1441 <emphasis>forward-socks4 target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1442 <emphasis>forward-socks4a target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1449 If http_proxy_host is <quote>.</quote>, then requests are not forwarded to a
1450 HTTP proxy but are made directly to the web servers.
1454 Lines are checked in sequence, and the last match wins.
1458 There is an implicit line equivalent to the following, which specifies that
1459 anything not finding a match on the list is to go out without forwarding
1460 or gateway protocol, like so:
1467 <emphasis>forward .* . </emphasis># implicit
1474 In the following common configuration, everything goes to Lucent's LPWA,
1475 except SSL on port 443 (which it doesn't handle):
1482 <emphasis>forward .* lpwa.com:8000</emphasis>
1483 <emphasis>forward :443 .</emphasis>
1490 See the FAQ for instructions on how to automate the login procedure for LPWA.
1491 Some users have reported difficulties related to LPWA's use of
1492 <quote>.</quote> as the last element of the domain, and have said that this
1493 can be fixed with this:
1500 <emphasis>forward lpwa. lpwa.com:8000</emphasis>
1507 (NOTE: the syntax for specifying target_domain has changed since the
1508 previous paragraph was written -- it will not work now. More information
1513 In this fictitious example, everything goes via an ISP's caching proxy,
1514 except requests to that ISP:
1521 <emphasis>forward .* caching.myisp.net:8000</emphasis>
1522 <emphasis>forward myisp.net .</emphasis>
1529 For the @home network, we're told the forwarding configuration is this:
1537 <emphasis>forward .* proxy:8080</emphasis>
1544 Also, we're told they insist on getting cookies and JavaScript, so you should
1545 add home.com to the cookie file. We consider JavaScript a security risk.
1546 Java need not be enabled.
1550 In this example direct connections are made to all <quote>internal</quote>
1551 domains, but everything else goes through Lucent's LPWA by way of the
1552 company's SOCKS gateway to the Internet.
1559 <emphasis>forward-socks4 .* lpwa.com:8000 firewall.my_company.com:1080</emphasis>
1560 <emphasis>forward my_company.com .</emphasis>
1567 This is how you could set up a site that always uses SOCKS but no forwarders:
1574 <emphasis>forward-socks4a .* . firewall.my_company.com:1080</emphasis>
1581 An advanced example for network administrators:
1585 If you have links to multiple ISPs that provide various special content to
1586 their subscribers, you can configure forwarding to pass requests to the
1587 specific host that's connected to that ISP so that everybody can see all
1588 of the content on all of the ISPs.
1592 This is a bit tricky, but here's an example:
1597 host-a has a PPP connection to isp-a.com. And host-b has a PPP connection to
1598 isp-b.com. host-a can run a <application>Junkbuster</application> proxy with
1599 forwarding like this:
1606 <emphasis>forward .* .</emphasis>
1607 <emphasis>forward isp-b.com host-b:8118</emphasis>
1614 host-b can run a <application>Junkbuster</application> proxy with forwarding
1622 <emphasis>forward .* .</emphasis>
1623 <emphasis>forward isp-a.com host-a:8118</emphasis>
1630 Now, <emphasis>anyone</emphasis> on the Internet (including users on host-a
1631 and host-b) can set their browser's proxy to <emphasis>either</emphasis>
1632 host-a or host-b and be able to browse the content on isp-a or isp-b.
1636 Here's another practical example, for University of Kent at
1637 Canterbury students with a network connection in their room, who
1638 need to use the University's Squid web cache.
1645 <emphasis>forward *. ssbcache.ukc.ac.uk:3128</emphasis> # Use the proxy, except for:
1646 <emphasis>forward .ukc.ac.uk . </emphasis> # Anything on the same domain as us
1647 <emphasis>forward * . </emphasis> # Host with no domain specified
1648 <emphasis>forward 129.12.*.* . </emphasis> # A dotted IP on our /16 network.
1649 <emphasis>forward 127.*.*.* . </emphasis> # Loopback address
1650 <emphasis>forward localhost.localdomain . </emphasis> # Loopback address
1651 <emphasis>forward www.ukc.mirror.ac.uk . </emphasis> # Specific host
1658 If you intend to chain <application>Junkbuster</application> and
1659 <application>squid</application> locally, then chain as
1660 <literal>browser -> squid -> junkbuster</literal> is the recommended way.
1664 Your squid configuration could then look like this:
1671 # Define junkbuster as parent cache
1672 <!-- per feedback from user...
1673 cache_peer 127.0.0.1 8118 parent 0 no-query
1675 cache_peer 127.0.0.1 parent 8118 0 no-query
1677 # Define ACL for protocol FTP
1680 # Do not forward ACL FTP to junkbuster
1681 always_direct allow FTP
1683 # Do not forward ACL CONNECT (https) to junkbuster
1684 always_direct allow CONNECT
1686 # Forward the rest to junkbuster
1687 never_direct allow all
1695 <!-- ~ End section ~ -->
1698 <!-- ~~~~~ New section ~~~~~ -->
1701 <title>Windows GUI Options</title>
1703 Removed references to Win32. HB 09/23/01
1706 <application>Junkbuster</application> has a number of options specific to the
1707 Windows GUI interface:
1711 If <quote>activity-animation</quote> is set to 1, the
1712 <application>Junkbuster</application> icon will animate when
1713 <quote>Junkbuster</quote> is active. To turn off, set to 0.
1720 <emphasis>activity-animation 1</emphasis>
1727 If <quote>log-messages</quote> is set to 1,
1728 <application>Junkbuster</application> will log messages to the console
1736 <emphasis>log-messages 1</emphasis>
1743 If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
1744 i.e. the amount of memory used for the log messages displayed in the
1745 console window, will be limited to <quote>log-max-lines</quote> (see below).
1749 Warning: Setting this to 0 will result in the buffer to grow infinitely and
1750 eat up all your memory!
1757 <emphasis>log-buffer-size 1</emphasis>
1764 <application>log-max-lines</application> is the maximum number of lines held
1765 in the log buffer. See above.
1772 <emphasis>log-max-lines 200</emphasis>
1779 If <quote>log-highlight-messages</quote> is set to 1,
1780 <application>Junkbuster</application> will highlight portions of the log
1781 messages with a bold-faced font:
1788 <emphasis>log-highlight-messages 1</emphasis>
1795 The font used in the console window:
1802 <emphasis>log-font-name Comic Sans MS</emphasis>
1809 Font size used in the console window:
1816 <emphasis>log-font-size 8</emphasis>
1823 <quote>show-on-task-bar</quote> controls whether or not
1824 <application>Junkbuster</application> will appear as a button on the Task bar
1832 <emphasis>show-on-task-bar 0</emphasis>
1839 If <quote>close-button-minimizes</quote> is set to 1, the Windows close
1840 button will minimize <application>Junkbuster</application> instead of closing
1841 the program (close with the exit option on the File menu).
1848 <emphasis>close-button-minimizes 1</emphasis>
1855 The <quote>hide-console</quote> option is specific to the MS-Win console
1856 version of <application>JunkBuster</application>. If this option is used,
1857 <application>Junkbuster</application> will disconnect from and hide the
1874 <!-- ~ End section ~ -->
1877 <!-- ~~~~~ New section ~~~~~ -->
1878 <sect2 id="actionsfile">
1879 <title>The Actions File</title>
1882 The <quote>ijb.action</quote> file (formerly
1883 <filename>actionsfile</filename>) is used to define what actions
1884 <application>Junkbuster</application> takes, and thus determines how images,
1885 cookies and various other aspects of HTTP content and transactions are
1886 handled. Images can be anything you want, including ads, banners, or just
1887 some obnoxious image that you would rather not see. Cookies can be accepted
1888 or rejected, or accepted only during the current browser session (i.e.
1889 not written to disk). Changes to <filename>ijb.action</filename> should
1890 be immediately visible to <application>Junkbuster</application> without
1891 the need to restart.
1895 To determine which actions apply to a request, the URL of the request is
1896 compared to all patterns in this file. Every time it matches, the list of
1897 applicable actions for the URL is incrementally updated. You can trace
1898 this process by visiting <ulink
1899 url="http://i.j.b/show-url-info">http://i.j.b/show-url-info</ulink>.
1903 The actions file can be edited with a browser by loading
1904 <ulink url="http://i.j.b/">http://i.j.b/</ulink>, and then select
1905 <quote>Edit Actions</quote>.
1909 There are four types of lines in this file: comments (begin with a
1910 <quote>#</quote> character), actions, aliases and patterns, all of which are
1911 explained below, as well as the configuration file syntax that
1912 <application>Junkbuster</application> understands.
1917 <!-- ~~~~~ New section ~~~~~ -->
1919 <title>URL Domain and Path Syntax</title>
1921 Generally, a pattern has the form <domain>/<path>, where both the
1922 <domain> and <path> part are optional. If you only specify a
1923 domain part, the <quote>/</quote> can be left out:
1927 <emphasis>www.example.com</emphasis> - is a domain only pattern and will match any request to
1928 <quote>www.example.com</quote>.
1932 <emphasis>www.example.com/</emphasis> - means exactly the same.
1936 <emphasis>www.example.com/index.html</emphasis> - matches only the single
1937 document <quote>/index.html</quote> on <quote>www.example.com</quote>.
1941 <emphasis>/index.html</emphasis> - matches the document <quote>/index.html</quote>, regardless of
1946 <emphasis>index.html</emphasis> - matches nothing, since it would be
1947 interpreted as a domain name and there is no top-level domain called
1948 <quote>.html</quote>.
1952 The matching of the domain part offers some flexible options: if the
1953 domain starts or ends with a dot, it becomes unanchored at that end.
1958 <emphasis>.example.com</emphasis> - matches any domain that <emphasis>ENDS</emphasis> in
1959 <quote>.example.com</quote>.
1963 <emphasis>www.</emphasis> - matches any domain that <emphasis>STARTS</emphasis> with
1968 Additionally, there are wild-cards that you can use in the domain names
1969 themselves. They work pretty similar to shell wild-cards: <quote>*</quote>
1970 stands for zero or more arbitrary characters, <quote>?</quote> stands for
1971 any single character. And you can define character classes in square
1972 brackets and they can be freely mixed:
1976 <emphasis>ad*.example.com</emphasis> - matches <quote>adserver.example.com</quote>,
1977 <quote>ads.example.com</quote>, etc but not <quote>sfads.example.com</quote>.
1981 <emphasis>*ad*.example.com</emphasis> - matches all of the above, and then some.
1985 <emphasis>.?pix.com</emphasis> - matches <quote>www.ipix.com</quote>,
1986 <quote>pictures.epix.com</quote>, <quote>a.b.c.d.e.upix.com</quote>, etc.
1990 <emphasis>www[1-9a-ez].example.com</emphasis> - matches <quote>www1.example.com</quote>,
1991 <quote>www4.example.com</quote>, <quote>wwwd.example.com</quote>,
1992 <quote>wwwz.example.com</quote>, etc., but <emphasis>not</emphasis>
1993 <quote>wwww.example.com</quote>.
1997 If <application>Junkbuster</application> was compiled with
1998 <quote>pcre</quote> support (default), Perl compatible regular expressions
1999 can be used. See the <filename>pcre/docs/</filename> directory or <quote>man
2000 perlre</quote> (also available on <ulink
2001 url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>)
2002 for details. A brief discussion of regular expressions is in the
2003 <link linkend="regex">Appendix</link>. For instance:
2007 <emphasis>/.*/advert[0-9]+\.jpe?g</emphasis> - would match a URL from any
2008 domain, with any path that includes <quote>advert</quote> followed
2009 immediately by one or more digits, then a <quote>.</quote> and ending in
2010 either <quote>jpeg</quote> or <quote>jpg</quote>. So we match
2011 <quote>example.com/ads/advert2.jpg</quote>, and
2012 <quote>www.example.com/ads/banners/advert39.jpeg</quote>, but not
2013 <quote>www.example.com/ads/banners/advert39.gif</quote> (no gifs in the
2018 Please note that matching in the path is case
2019 <emphasis>INSENSITIVE</emphasis> by default, but you can switch to case
2020 sensitive at any point in the pattern by using the
2021 <quote>(?-i)</quote> switch:
2025 <emphasis>www.example.com/(?-i)PaTtErN.*</emphasis> - will match only
2026 documents whose path starts with <quote>PaTtErN</quote> in
2027 <emphasis>exactly</emphasis> this capitalization.
2032 <!-- ~ End section ~ -->
2036 <!-- ~~~~~ New section ~~~~~ -->
2039 <title>Actions</title>
2041 Actions are enabled if preceded with a <quote>+</quote>, and disabled if
2042 preceded with a <quote>-</quote>. Actions are invoked by enclosing the
2043 action name in curly braces (e.g. {+some_action}), followed by a list of
2044 URLs to which the action applies. There are three classes of actions:
2052 Boolean (e.g. <quote>+/-block</quote>):
2058 <emphasis>{+name}</emphasis> # enable this action
2059 <emphasis>{-name}</emphasis> # disable this action
2069 parameterized (e.g. <quote>+/-hide-user-agent</quote>):
2075 <emphasis>{+name{param}}</emphasis> # enable action and set parameter to <quote>param</quote>
2076 <emphasis>{-name}</emphasis> # disable action
2085 Multi-value (e.g. <quote>{+/-add-header{Name: value}}</quote>, <quote>{+/-wafer{name=value}}</quote>):
2091 <emphasis>{+name{param}}</emphasis> # enable action and add parameter <quote>param</quote>
2092 <emphasis>{-name{param}}</emphasis> # remove the parameter <quote>param</quote>
2093 <emphasis>{-name}</emphasis> # disable this action totally
2104 If nothing is specified in this file, no <quote>actions</quote> are taken.
2105 So in this case <application>JunkBuster</application> would just be a
2106 normal, non-blocking, non-anonymizing proxy. You must specifically
2107 enable the privacy and blocking features you need (although the
2108 provided default <filename>ijb.action</filename> file will
2109 give a good starting point).
2113 Later defined actions always over-ride earlier ones. For multi-valued
2114 actions, the actions are applied in the order they are specified.
2118 The list of valid <application>Junkbuster</application> <quote>actions</quote> are:
2126 Add the specified HTTP header, which is not checked for validity.
2127 You may specify this many times to specify many different headers:
2133 <emphasis>+add-header{Name: value}</emphasis>
2143 Block this URL totally.
2149 <emphasis>+block</emphasis>
2159 De-animate all animated GIF images, i.e. reduce them to their last frame.
2160 This will also shrink the images considerably (in bytes, not pixels!). If
2161 the option <quote>first</quote> is given, the first frame of the animation
2162 is used as the replacement. If <quote>last</quote> is given, the last frame
2163 of the animation is used instead, which probably makes more sense for most
2164 banner animations, but also has the risk of not showing the entire last
2165 frame (if it is only a delta to an earlier frame).
2171 <emphasis>+deanimate-gifs{last}</emphasis>
2172 <emphasis>+deanimate-gifs{first}</emphasis>
2181 <quote>+downgrade</quote> will downgrade HTTP/1.1 client requests to
2182 HTTP/1.0 and downgrade the responses as well. Use this action for servers
2183 that use HTTP/1.1 protocol features that
2184 <application>Junkbuster</application> doesn't handle well yet. HTTP/1.1
2185 is only partially implemented. Default is not to downgrade requests.
2191 <emphasis>+downgrade</emphasis>
2200 Many sites, like yahoo.com, don't just link to other sites. Instead, they
2201 will link to some script on their own server, giving the destination as a
2202 parameter, which will then redirect you to the final target. URLs resulting
2203 from this scheme typically look like:
2204 http://some.place/some_script?http://some.where-else.
2207 Sometimes, there are even multiple consecutive redirects encoded in the
2208 URL. These redirections via scripts make your web browsing more traceable,
2209 since the server from which you follow such a link can see where you go to.
2210 Apart from that, valuable bandwidth and time is wasted, while your browser
2211 ask the server for one redirect after the other. Plus, it feeds the
2215 The <quote>+fast-redirects</quote> option enables interception of these
2216 requests by <application>Junkbuster</application>, who will cut off all but
2217 the last valid URL in the request and send a local redirect back to your
2218 browser without contacting the remote site.
2224 <emphasis>+fast-redirects</emphasis>
2233 Filter the website through the re_filterfile:
2239 <emphasis>+filter{filename}</emphasis>
2248 Block any existing X-Forwarded-for header, and do not add a new one:
2254 <emphasis>+hide-forwarded</emphasis>
2263 If the browser sends a <quote>From:</quote> header containing your e-mail
2264 address, this either completely removes the header (<quote>block</quote>), or
2265 changes it to the specified e-mail address.
2271 <emphasis>+hide-from{block}</emphasis>
2272 <emphasis>+hide-from{spam@sittingduck.xqq}</emphasis>
2281 Don't send the <quote>Referer:</quote> (sic) header to the web site. You
2282 can block it, forge a URL to the same server as the request (which is
2283 preferred because some sites will not send images otherwise) or set it to a
2284 constant string of your choice.
2290 <emphasis>+hide-referer{block}</emphasis>
2291 <emphasis>+hide-referer{forge}</emphasis>
2292 <emphasis>+hide-referer{http://nowhere.com}</emphasis>
2301 Alternative spelling of <quote>+hide-referer</quote>. It has the same
2302 parameters, and can be freely mixed with, <quote>+hide-referer</quote>.
2303 (<quote>referrer</quote> is the correct English spelling, however the HTTP
2304 specification has a bug - it requires it to be spelled <quote>referer</quote>.)
2310 <emphasis>+hide-referrer{...}</emphasis>
2319 Change the <quote>User-Agent:</quote> header so web servers can't tell your
2320 browser type. Warning! This breaks many web sites. Specify the
2321 user-agent value you want. Example, pretend to be using Netscape on
2328 <emphasis>+hide-user-agent{Mozilla (X11; I; Linux 2.0.32 i586)}</emphasis>
2335 Or to identify yourself explicitly as a <quote>Junkbuster</quote> user:
2341 <emphasis>+hide-user-agent{JunkBuster/1.0}</emphasis>
2346 (Don't change the version number from 1.0 - after all, why tell them?)
2353 <emphasis>+hide-user-agent{browser-type}</emphasis>
2363 Treat this URL as an image. This only matters if it's also <quote>+block</quote>ed,
2364 in which case a <quote>blocked</quote> image can be sent rather than a HTML page.
2365 See <quote>+image-blocker{}</quote> below for the control over what is actually sent.
2371 <emphasis>+image</emphasis>
2380 Decides what to do with URLs that end up tagged with <quote>{+block
2381 +image}</quote>. There are 4 options. <quote>-image-blocker</quote> will
2382 send a HTML <quote>blocked</quote> page, usually resulting in a
2383 <quote>broken image</quote> icon. <quote>+image-blocker{logo}</quote> will
2384 send a <quote>JunkBuster</quote> image.
2385 <quote>+image-blocker{blank}</quote> will send a 1x1 transparent GIF image.
2386 And finally, <quote>+image-blocker{http://xyz.com}</quote> will send a HTTP
2387 temporary redirect to the specified image. This has the advantage of the
2388 icon being being cached by the browser, which will speed up the display.
2394 <emphasis>+image-blocker{logo}</emphasis>
2395 <emphasis>+image-blocker{blank}</emphasis>
2396 <emphasis>+image-blocker{http://i.j.b/send-banner}</emphasis>
2405 By default (i.e. in the absence of a <quote>+limit-connect</quote>
2406 action), <application>Junkbuster</application> will only allow CONNECT
2407 requests to port 443, which is the standard port for https as a
2412 The CONNECT methods exists in HTTP to allow access to secure websites
2413 (https:// URLs) through proxies. It works very simply: the proxy
2414 connects to the server on the specified port, and then short-circuits
2415 its connections to the client <emphasis>and</emphasis> to the remote proxy.
2416 This can be a big security hole, since CONNECT-enabled proxies can
2417 be abused as TCP relays very easily.
2421 If you want to allow CONNECT for more ports than this, or want to forbid
2422 CONNECT altogether, you can specify a comma separated list of ports and
2423 port ranges (the latter using dashes, with the minimum defaulting to 0 and
2431 <emphasis>+limit-connect{443} # This is the default and need no be specified.</emphasis>
2432 <emphasis>+limit-connect{80,443} # Ports 80 and 443 are OK.</emphasis>
2433 <emphasis>+limit-connect{-3, 7, 20-100, 500-} # Port less than 3, 7, 20 to 100</emphasis>
2434 <emphasis> #and above 500 are OK.</emphasis>
2444 <quote>+no-compression</quote> prevents the website from compressing the
2445 data. Some websites do this, which can be a problem for
2446 <application>Junkbuster</application>, since <quote>+filter</quote>,
2447 <quote>+no-popup</quote> and <quote>+gif-deanimate</quote> will not work on
2448 compressed data. This will slow down connections to those websites,
2449 though. Default is <quote>nocompression</quote> is turned on.
2456 <emphasis>+nocompression</emphasis>
2465 If the website sets cookies, <quote>no-cookies-keep</quote> will make sure
2466 they are erased when you exit and restart your web browser. This makes
2467 profiling cookies useless, but won't break sites which require cookies so
2468 that you can log in for transactions. Default: on.
2474 <emphasis>+no-cookies-keep</emphasis>
2483 Prevent the website from reading cookies:
2489 <emphasis>+no-cookies-read</emphasis>
2498 Prevent the website from setting cookies:
2504 <emphasis>+no-cookies-set</emphasis>
2513 Filter the website through a built-in filter to disable those obnoxious
2514 JavaScript pop-up windows via window.open(), etc. The two alternative
2515 spellings are equivalent.
2521 <emphasis>+no-popup</emphasis>
2522 <emphasis>+no-popups</emphasis>
2531 This action only applies if you are using a <filename>jarfile</filename>
2532 for saving cookies. It sends a cookie to every site stating that you do not
2533 accept any copyright on cookies sent to you, and asking them not to track
2534 you. Of course, this is a (relatively) unique header they could use to
2541 <emphasis>+vanilla-wafer</emphasis>
2550 This allows you to add an arbitrary cookie. It can be specified multiple
2551 times in order to add as many cookies as you like.
2557 <emphasis>+wafer{name=value}</emphasis>
2568 The meaning of any of the above is reversed by preceding the action with a
2569 <quote>-</quote>, in place of the <quote>+</quote>.
2577 Turn off cookies by default, then allow a few through for specified sites:
2584 # Turn off all persistent cookies
2585 { +no-cookies-read }
2587 # Allow cookies for this browser session ONLY
2588 { +no-cookies-keep }
2590 # Exceptions to the above, sites that benefit from persistent cookies
2591 { -no-cookies-read }
2593 { -no-cookies-keep }
2600 # Alternative way of saying the same thing
2601 {-no-cookies-set -no-cookies-read -no-cookies-keep}
2610 Now turn off <quote>fast redirects</quote>, and then we allow two exceptions:
2620 # Reverse it for these two sites, which don't work right without it.
2622 www.ukc.ac.uk/cgi-bin/wac\.cgi\?
2630 Turn on page filtering, with one exception for sourceforge:
2637 # Run everything through the default filter file (<filename>re_filterfile</filename>):
2640 # But please don't re_filter code from sourceforge!
2642 .cvs.sourceforge.net
2649 Now some URLs that we want <quote>blocked</quote>, ie we won't see them.
2650 Many of these use regular expressions that will expand to match multiple
2660 /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\.(gif|jpe?g))
2661 /.*/(.*[-_.])?count(er)?(\.cgi|\.dll|\.exe|[?/])
2662 /.*/(ng)?adclient\.cgi
2663 /.*/(plain|live|rotate)[-_.]?ads?/
2664 /.*/(sponsor)s?[0-9]?/
2665 /.*/_?(plain|live)?ads?(-banners)?/
2667 /.*/ad(sdna_image|gifs?)/
2668 /.*/ad(server|stream|juggler)\.(cgi|pl|dll|exe)
2672 /.*/adv((er)?ts?|ertis(ing|ements?))?/
2676 /.*/cgi-bin/centralad/getimage
2677 /.*/images/addver\.gif
2678 /.*/images/marketing/.*\.(gif|jpe?g)
2682 /.*/sponsors?[0-9]?/
2683 /.*/advert[0-9]+\.jpg
2690 /graphics/defaultAd/
2692 /image\.ng/transactionID
2693 /images/.*/.*_anim\.gif # alvin brattli
2694 /ip_img/.*\.(gif|jpe?g)
2698 /cgi-bin/nph-adclick.exe/
2699 /.*/Image/BannerAdvertising/
2701 /.*/adlib/server\.cgi
2710 <!-- ~ End section ~ -->
2713 <!-- ~~~~~ New section ~~~~~ -->
2715 <title>Aliases</title>
2717 Custom <quote>actions</quote>, known to <application>Junkbuster</application>
2718 as <quote>aliases</quote>, can be defined by combining other <quote>actions</quote>.
2719 These can in turn be invoked just like the built-in <quote>actions</quote>.
2720 Currently, an alias can contain any character except space, tab, <quote>=</quote>,
2721 <quote>{</quote> or <quote>}</quote>. But please use only <quote>a</quote>-
2722 <quote>z</quote>, <quote>0</quote>-<quote>9</quote>, <quote>+</quote>, and
2723 <quote>-</quote>. Alias names are not case sensitive, and
2724 <emphasis>must be defined before anything</emphasis> else in the
2725 <filename>ijb.action</filename>file ! And there can only be one set of
2726 <quote>aliases</quote> defined.
2730 Now let's define a few aliases:
2737 # Useful customer aliases we can use later. These must come first!
2739 +no-cookies = +no-cookies-set +no-cookies-read
2740 -no-cookies = -no-cookies-set -no-cookies-read
2741 fragile = -block -no-cookies -filter -fast-redirects -hide-referer -no-popups
2742 shop = -no-cookies -filter -fast-redirects
2743 +imageblock = +block +image
2745 #For people who don't like to type too much: ;-)
2748 c2 = -no-cookies-set +no-cookies-read
2749 c3 = +no-cookies-set -no-cookies-read
2750 #... etc. Customize to your heart's content.
2757 Some examples using our <quote>shop</quote> and <quote>fragile</quote>
2765 # These sites are very complex and require
2766 # minimal interference.
2768 .office.microsoft.com
2769 .windowsupdate.microsoft.com
2772 # Shopping sites - still want to block ads.
2775 .worldpay.com # for quietpc.com
2779 # These shops require pop-ups
2791 <!-- ~ End section ~ -->
2794 <!-- ~~~~~ New section ~~~~~ -->
2795 <sect2 id="filterfile">
2796 <title>The Filter File</title>
2798 The filter file defines what filtering of web pages
2799 <application>Junkbuster</application> does. The default filter file is
2800 <filename>re_filterfile</filename>, located in the config directory. In this
2801 file, <emphasis>any document content</emphasis>, whether viewable text or
2802 embedded non-visible content, can be changed.
2806 This file uses regular expressions to alter or remove any string in the
2807 target page. Some examples from the included default <filename>re_filterfile</filename>:
2811 Stop web pages from displaying annoying messages in the status bar by
2812 deleting such references:
2819 # The status bar is for displaying link targets, not pointless buzzwords.
2820 # Again, check it out on http://www.airport-cgn.de/.
2821 s/status='.*?';*//ig
2828 Just for kicks, replace any occurrence of <quote>Microsoft</quote> with
2829 <quote>MicroSuck</quote>:
2836 s/microsoft(?!.com)/MicroSuck/ig
2843 Kill those auto-refresh tags:
2850 # Kill refresh tags. I like to refresh myself. Manually.
2851 # check it out on http://www.airport-cgn.de/ and go to the arrivals page.
2853 s/<meta[^>]*http-equiv[^>]*refresh.*URL=([^>]*?)"?>/<link rev="x-refresh" href=$1>/i
2854 s/<meta[^>]*http-equiv="?page-enter"?[^>]*content=[^>]*>/<!--no page enter for me-->/i
2862 <!-- ~ End section ~ -->
2866 <!-- ~~~~~ New section ~~~~~ -->
2869 <title>Templates</title>
2871 When <application>Junkbuster</application> displays one of its internal
2872 pages, such as a 404 Not Found error page, it uses the appropriate template.
2873 On Linux, BSD, and Unix, these are locate in
2874 <filename>/etc/junkbuster/templates</filename> by default. These may be
2875 customized, if desired.
2882 <!-- ~ End section ~ -->
2886 <!-- ~~~~~ New section ~~~~~ -->
2887 <sect1 id="quickstart"><title>Quickstart to Using Junkbuster</title>
2889 Install package, then run and enjoy! <application>JunkBuster</application>
2890 accepts only one command line option -- the configuration file to be
2891 used. Example Unix startup command:
2897 # /usr/sbin/junkbuster /etc/junkbuster/config
2903 An init script is provided for SuSE and Redhat.
2907 For for SuSE: /etc/rc.d/junkbuster start
2911 For RedHat: /etc/rc.d/init.d/junkbuster start
2916 If no configuration file is specified on the command line,
2917 <application>Junkbuster</application> will look for a file named
2918 <filename>config</filename> in the current directory. Except on Win32 where
2919 it will try <filename>config.txt</filename>. If no file is specified on the
2920 command line and no default configuration file can be found,
2921 <application>Junkbuster</application> will fail to start.
2925 Be sure your browser is set to use the proxy which is by default at
2926 localhost, port 8118. With <application>Netscape</application> (and
2927 <application>Mozilla</application>), this can be set under <literal>Edit
2928 -> Preferences -> Advanced -> Proxies -> HTTP Proxy</literal>.
2929 For <application>Internet Explorer</application>: <literal>Tools >
2930 Internet Properties -> Connections -> LAN Setting</literal>. Then,
2931 check <quote>Use Proxy</quote> and fill in the appropriate info (Address:
2932 localhost, Port: 8118). Include if HTTPS proxy support too.
2936 The included default configuration files should give a reasonable starting
2937 point, though may be somewhat aggressive in blocking junk. You will probably
2938 want to keep an eye out for sites that require persistent cookies, and add these to
2939 <filename>ijb.action</filename> as needed. By default, most of these will
2940 be accepted only during the current browser session, until you add them to
2941 the configuration. If you want the browser to handle this instead, you will
2942 need to edit <filename>ijb.action</filename> and disable this feature. If you
2943 use more than one browser, it would make more sense to let
2944 <application>Junkbuster</application> handle this. In which case, the
2945 browser(s) should be set to accept all cookies.
2949 If a particular site shows problems loading properly, try adding it
2950 to the <literal>{fragile}</literal> section of
2951 <filename>ijb.action</filename>. This will turn off most actions for
2956 <application>Junkbuster</application> is HTTP/1.1 compliant, but not all 1.1
2957 features are as yet implemented. If browsers that support HTTP/1.1 (like
2958 <application>Mozilla</application> or recent versions of I.E.) experience
2959 problems, you might try to force HTTP/1.0 compatibility. For Mozilla, look
2960 under <literal>Edit -> Preferences -> Debug -> Networking</literal>.
2961 Or set the <quote>+downgrade</quote> config option in
2962 <filename>ijb.action</filename>.
2966 After running <application>Junkbuster</application> for a while, you can
2967 start to fine tune the configuration to suit your personal, or site,
2968 preferences and requirements. There are many, many aspects that can
2969 be customized. <quote>Actions</quote> (as specified in <filename>ijb.action</filename>)
2970 can be adjusted by pointing your browser to
2971 <ulink url="http://i.j.b/">http://i.j.b/</ulink>,
2972 and then follow the link to <quote>edit the actions list</quote>.
2973 (This is an internal page and does not require Internet access.)
2977 In fact, various aspects of <application>Junkbuster</application>
2978 configuration can be viewed from this page, including
2979 current configuration parameters, source code version numbers,
2980 the browser's request headers, and <quote>actions</quote> that apply
2981 to a given URL. In addition to the <filename>ijb.action</filename> file
2982 editor mentioned above, <application>Junkbuster</application> can also
2983 be turned <quote>on</quote> and <quote>off</quote> from this page.
2987 If you encounter problems, please verify it is a
2988 <application>Junkbuster</application> bug, by disabling
2989 <application>Junkbuster</application>, and then trying the same page.
2990 Also, try another browser if possible to eliminate browser or site
2991 problems. Before reporting it as a bug, see if there is not a configuration
2992 option that is enabled that is causing the page not to load. You can
2993 then add an exception for that page or site. If a bug, please report it to
2994 the developers (see below).
3000 <!-- ~~~~~ New section ~~~~~ -->
3001 <sect1 id="contact"><title>Contacting the Developers, Bug Reporting and Feature
3004 We value your feedback. However, to provide you with the best support,
3007 <member>Use the <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=211118">support forum</ulink> to get
3009 <member>Submit bugs only thru our <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=111118">bug
3011 Make sure that the bug has not already been submitted. Please try to
3012 verify that it is a <application>Junkbuster</application> bug, and not
3013 a browser or site bug first. If you are using your own custom configuration,
3014 please try the stock configs to see if the problem is a configuration
3015 related bug. And if not using the latest development snapshot, please
3016 try the latest one. Or even better, CVS sources.
3018 <member>Submit feature requests only thru our <ulink
3019 url="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse">feature request forum</ulink>.</member>
3024 For any other issues, feel free to use the <ulink url="http://sourceforge.net/mail/?group_id=11118">mailing lists</ulink>.
3028 Anyone interested in actively participating in development and related
3029 discussions can join the appropriate mailing list
3030 <ulink url="http://sourceforge.net/mail/?group_id=11118">here</ulink>.
3031 Archives are available here too.
3037 <!-- ~~~~~ New section ~~~~~ -->
3038 <sect1 id="copyright"><title>Copyright and History</title>
3041 <title>License</title>
3043 <application>Internet Junkbuster</application> is free software; you can
3044 redistribute it and/or modify it under the terms of the GNU General Public
3045 License as published by the Free Software Foundation; either version 2 of the
3046 License, or (at your option) any later version.
3050 This program is distributed in the hope that it will be useful, but WITHOUT
3051 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
3052 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
3053 details, which is available from <ulink
3054 url="http://www.gnu.org/copyleft/gpl.html">the Free Software Foundation,
3055 Inc</ulink>, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
3060 <!-- ~ End section ~ -->
3063 <!-- ~~~~~ New section ~~~~~ -->
3066 <title>History</title>
3068 <application>Junkbuster</application> was originally written by Anonymous
3070 url="http://www.junkbusters.com/ht/en/ijbfaq.html">Junkbuster's
3071 Corporation</ulink>, and was released as free open-source software under the
3072 GNU GPL. <ulink url="http://www.waldherr.org/junkbuster/">Stefan
3073 Waldherr</ulink> made many improvements, and started the <ulink
3074 url="http://sourceforge.net/projects/ijbswa/">SourceForge project</ulink> to
3075 rekindle development. There are now several active developers contributing.
3076 The last stable release was v2.0.2, which has now grown whiskers ;-).
3083 <!-- ~~~~~ New section ~~~~~ -->
3084 <sect1 id="seealso"><title>See also</title>
3089 <ulink url="http://sourceforge.net/projects/ijbswa">http://sourceforge.net/projects/ijbswa</ulink>
3094 <ulink url="http://ijbswa.sourceforge.net/">http://ijbswa.sourceforge.net/</ulink>
3099 <ulink url="http://i.j.b/">http://i.j.b/</ulink>
3104 <ulink url="http://www.junkbusters.com/ht/en/cookies.html">http://www.junkbusters.com/ht/en/cookies.html</ulink>
3109 <ulink url="http://www.waldherr.org/junkbuster/">http://www.waldherr.org/junkbuster/</ulink>
3114 <ulink url="http://privacy.net/analyze/">http://privacy.net/analyze/</ulink>
3119 <ulink url="http://www.squid-cache.org/">http://www.squid-cache.org/</ulink>
3128 <!-- ~~~~~ New section ~~~~~ -->
3129 <sect1 id="appendix"><title>Appendix</title>
3132 <!-- ~~~~~ New section ~~~~~ -->
3134 <title>Regular Expressions</title>
3136 <application>Junkbuster</application> can use <quote>regular expressions</quote>
3137 in various config files. Assuming support for <quote>pcre</quote> (Perl
3138 Compatible Regular Expressions) is compiled in, which is the default. Such
3139 configuration directives do not require regular expressions, but they can be
3140 used to increase flexibility by matching a pattern with wild-cards against
3145 If you are reading this, you probably don't understand what <quote>regular
3146 expressions</quote> are, or what they can do. So this will be a very brief
3147 introduction only. A full explanation would require a book ;-)
3151 <quote>Regular expressions</quote> is a way of matching one character
3152 expression against another to see if it matches or not. One of the
3153 <quote>expressions</quote> is a literal string of readable characters
3154 (letter, numbers, etc), and the other is a complex string of literal
3155 characters combined with wild-cards, and other special characters, called
3156 meta-characters. The <quote>meta-characters</quote> have special meanings and
3157 are used to build the complex pattern to be matched against. Perl Compatible
3158 Regular Expressions is an enhanced form of the regular expression language
3159 with backward compatibility.
3163 To make a simple analogy, we do something similar when we use wild-card
3164 characters when listing files with the <command>dir</command> command in DOS.
3165 <literal>*.*</literal> matches all filenames. The <quote>special</quote>
3166 character here is the asterisk which matches any and all characters. We can be
3167 more specific and use <literal>?</literal> to match just individual
3168 characters. So <quote>dir file?.text</quote> would match
3169 <quote>file1.txt</quote>, <quote>file2.txt</quote>, etc. We are pattern
3170 matching, using a similar technique to <quote>regular expressions</quote>!
3174 Regular expressions do essentially the same thing, but are much, much more
3175 powerful. There are many more <quote>special characters</quote> and ways of
3176 building complex patterns however. Let's look at a few of the common ones,
3177 and then some examples:
3182 <emphasis>.</emphasis> - Matches any single character, e.g. <quote>a</quote>,
3183 <quote>A</quote>, <quote>4</quote>, <quote>:</quote>, or <quote>@</quote>.
3189 <emphasis>?</emphasis> - The preceding character or expression is matched ZERO or ONE
3196 <emphasis>+</emphasis> - The preceding character or expression is matched ONE or MORE
3203 <emphasis>*</emphasis> - The preceding character or expression is matched ZERO or MORE
3210 <emphasis>\</emphasis> - The <quote>escape</quote> character denotes that
3211 the following character should be taken literally. This is used where one of the
3212 special characters (e.g. <quote>.</quote>) needs to be taken literally and
3213 not as a special meta-character.
3219 <emphasis>[]</emphasis> - Characters enclosed in brackets will be matched if
3220 any of the enclosed characters are encountered.
3226 <emphasis>()</emphasis> - parentheses are used to group a sub-expression,
3227 or multiple sub-expressions.
3233 <emphasis>|</emphasis> - The <quote>bar</quote> character works like an
3234 <quote>or</quote> conditional statement. A match is successful if the
3235 sub-expression on either side of <quote>|</quote> matches.
3241 <emphasis>s/string1/string2/g</emphasis> - This is used to rewrite strings of text.
3242 <quote>string1</quote> is replaced by <quote>string2</quote> in this
3248 These are just some of the ones you are likely to use when matching URLs with
3249 <application>Junkbuster</application>, and is a long way from a definitive
3250 list. This is enough to get us started with a few simple examples which may
3251 be more illuminating:
3255 <emphasis><literal>/.*/banners/.*</literal></emphasis> - A simple example
3256 that uses the common combination of <quote>.</quote> and <quote>*</quote> to
3257 denote any character, zero or more times. In other words, any string at all.
3258 So we start with a literal forward slash, then our regular expression pattern
3259 (<quote>.*</quote>) another literal forward slash, the string
3260 <quote>banners</quote>, another forward slash, and lastly another
3261 <quote>.*</quote>. We are building
3262 a directory path here. This will match any file with the path that has a
3263 directory named <quote>banners</quote> in it. The <quote>.*</quote> matches
3264 any characters, and this could conceivably be more forward slashes, so it
3265 might expand into a much longer looking path. For example, this could match:
3266 <quote>/eye/hate/spammers/banners/annoy_me_please.gif</quote>, or just
3267 <quote>/banners/annoying.html</quote>, or almost an infinite number of other
3268 possible combinations, just so it has <quote>banners</quote> in the path
3273 A now something a little more complex:
3277 <emphasis><literal>/.*/adv((er)?ts?|ertis(ing|ements?))?/</literal></emphasis> -
3278 We have several literal forward slashes again (<quote>/</quote>), so we are
3279 building another expression that is a file path statement. We have another
3280 <quote>.*</quote>, so we are matching against any conceivable sub-path, just so
3281 it matches our expression. The only true literal that <emphasis>must
3282 match</emphasis> our pattern is <application>adv</application>, together with
3283 the forward slashes. What comes after the <quote>adv</quote> string is the
3288 Remember the <quote>?</quote> means the preceding expression (either a
3289 literal character or anything grouped with <quote>(...)</quote> in this case)
3290 can exist or not, since this means either zero or one match. So
3291 <quote>((er)?ts?|ertis(ing|ements?))</quote> is optional, as are the
3292 individual sub-expressions: <quote>(er)</quote>,
3293 <quote>(ing|ements?)</quote>, and the <quote>s</quote>. The <quote>|</quote>
3294 means <quote>or</quote>. We have two of those. For instance,
3295 <quote>(ing|ements?)</quote>, can expand to match either <quote>ing</quote>
3296 <emphasis>OR</emphasis> <quote>ements?</quote>. What is being done here, is an
3297 attempt at matching as many variations of <quote>advertisement</quote>, and
3298 similar, as possible. So this would expand to match just <quote>adv</quote>,
3299 or <quote>advert</quote>, or <quote>adverts</quote>, or
3300 <quote>advertising</quote>, or <quote>advertisement</quote>, or
3301 <quote>advertisements</quote>. You get the idea. But it would not match
3302 <quote>advertizements</quote> (with a <quote>z</quote>). We could fix that by
3303 changing our regular expression to:
3304 <quote>/.*/adv((er)?ts?|erti(s|z)(ing|ements?))?/</quote>, which would then match
3309 <emphasis><literal>/.*/advert[0-9]+\.(gif|jpe?g)</literal></emphasis> - Again
3310 another path statement with forward slashes. Anything in the square brackets
3311 <quote>[]</quote> can be matched. This is using <quote>0-9</quote> as a
3312 shorthand expression to mean any digit one through nine. It is the same as
3313 saying <quote>0123456789</quote>. So any digit matches. The <quote>+</quote>
3314 means one or more of the preceding expression must be included. The preceding
3315 expression here is what is in the square brackets -- in this case, any digit
3316 one through nine. Then, at the end, we have a grouping: <quote>(gif|jpe?g)</quote>.
3317 This includes a <quote>|</quote>, so this needs to match the expression on
3318 either side of that bar character also. A simple <quote>gif</quote> on one side, and the other
3319 side will in turn match either <quote>jpeg</quote> or <quote>jpg</quote>,
3320 since the <quote>?</quote> means the letter <quote>e</quote> is optional and
3321 can be matched once or not at all. So we are building an expression here to
3322 match image GIF or JPEG type image file. It must include the literal
3323 string <quote>advert</quote>, then one or more digits, and a <quote>.</quote>
3324 (which is now a literal, and not a special character, since it is escaped
3325 with <quote>\</quote>), and lastly either <quote>gif</quote>, or
3326 <quote>jpeg</quote>, or <quote>jpg</quote>. Some possible matches would
3327 include: <quote>//advert1.jpg</quote>,
3328 <quote>/nasty/ads/advert1234.gif</quote>,
3329 <quote>/banners/from/hell/advert99.jpg</quote>. It would not match
3330 <quote>advert1.gif</quote> (no leading slash), or
3331 <quote>/adverts232.jpg</quote> (the expression does not include an
3332 <quote>s</quote>), or <quote>/advert1.jsp</quote> (<quote>jsp</quote> is not
3333 in the expression anywhere).
3337 <emphasis><literal>s/microsoft(?!.com)/MicroSuck/i</literal></emphasis> - This is
3338 a substitution. <quote>MicroSuck</quote> will replace any occurrence of
3339 <quote>microsoft</quote>. The <quote>i</quote> at the end of the expression
3340 means ignore case. The <quote>(?!.com)</quote> means
3341 the match should fail if <quote>microsoft</quote> is followed by
3342 <quote>.com</quote>. In other words, this acts like a <quote>NOT</quote>
3343 modifier. In case this is a hyperlink, we don't want to break it ;-).
3347 We are barely scratching the surface of regular expressions here so that you
3348 can understand the default <application>Junkbuster</application>
3349 configuration files, and maybe use this knowledge to customize your own
3350 installation. There is much, much more that can be done with regular
3351 expressions. Now that you know enough to get started, you can learn more on
3356 More reading on Perl Compatible Regular expressions:
3357 <ulink url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>
3366 This program is free software; you can redistribute it
3367 and/or modify it under the terms of the GNU General
3368 Public License as published by the Free Software
3369 Foundation; either version 2 of the License, or (at
3370 your option) any later version.
3372 This program is distributed in the hope that it will
3373 be useful, but WITHOUT ANY WARRANTY; without even the
3374 implied warranty of MERCHANTABILITY or FITNESS FOR A
3375 PARTICULAR PURPOSE. See the GNU General Public
3376 License for more details.
3378 The GNU General Public License should be included with
3379 this file. If not, you can view it at
3380 http://www.gnu.org/copyleft/gpl.html
3381 or write to the Free Software Foundation, Inc., 59
3382 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
3384 $Log: user-manual.sgml,v $
3385 Revision 1.40 2002/03/07 16:28:39 swa
3386 provide correct feedback channels
3388 Revision 1.39 2002/03/06 16:19:28 hal9
3389 Note on perceived filtering slowdown per FR.
3391 Revision 1.38 2002/03/05 23:55:14 hal9
3392 Stupid I did it again. Double hyphen in comment breaks jade.
3394 Revision 1.37 2002/03/05 23:53:49 hal9
3395 jade barfs on '- -' embedded in comments. - -user option broke it.
3397 Revision 1.36 2002/03/05 22:53:28 hal9
3398 Add new - - user option.
3400 Revision 1.35 2002/03/05 00:17:27 hal9
3401 Added section on command line options.
3403 Revision 1.34 2002/03/04 19:32:07 oes
3404 Changed default port to 8118
3406 Revision 1.33 2002/03/03 19:46:13 hal9
3407 Emphasis on where/how to report bugs, etc
3409 Revision 1.32 2002/03/03 09:26:06 joergs
3410 AmigaOS changes, config is now loaded from PROGDIR: instead of
3411 AmiTCP:db/junkbuster/ if no configuration file is specified on the
3414 Revision 1.31 2002/03/02 22:45:52 david__schmidt
3417 Revision 1.30 2002/03/02 22:00:14 hal9
3418 Updated 'New Features' list. Ran through spell-checker.
3420 Revision 1.29 2002/03/02 20:34:07 david__schmidt
3421 Update OS/2 build section
3423 Revision 1.28 2002/02/24 14:34:24 jongfoster
3424 Formatting changes. Now changing the doctype to DocBook XML 4.1
3425 will work - no other changes are needed.
3427 Revision 1.27 2002/01/11 14:14:32 hal9
3428 Added a very short section on Templates
3430 Revision 1.26 2002/01/09 20:02:50 hal9
3431 Fix bug re: auto-detect config file changes.
3433 Revision 1.25 2002/01/09 18:20:30 hal9
3434 Touch ups for *.action files.
3436 Revision 1.24 2001/12/02 01:13:42 hal9
3439 Revision 1.23 2001/12/02 00:20:41 hal9
3440 Updates for recent changes.
3442 Revision 1.22 2001/11/05 23:57:51 hal9
3443 Minor update for startup now daemon mode.
3445 Revision 1.21 2001/10/31 21:11:03 hal9
3446 Correct 2 minor errors
3448 Revision 1.18 2001/10/24 18:45:26 hal9
3449 *** empty log message ***
3451 Revision 1.17 2001/10/24 17:10:55 hal9
3452 Catching up with Jon's recent work, and a few other things.
3454 Revision 1.16 2001/10/21 17:19:21 swa
3455 wrong url in documentation
3457 Revision 1.15 2001/10/14 23:46:24 hal9
3458 Various minor changes. Fleshed out SEE ALSO section.
3460 Revision 1.13 2001/10/10 17:28:33 hal9
3463 Revision 1.12 2001/09/28 02:57:04 hal9
3466 Revision 1.11 2001/09/28 02:25:20 hal9
3469 Revision 1.9 2001/09/27 23:50:29 hal9
3470 A few changes. A short section on regular expression in appendix.
3472 Revision 1.8 2001/09/25 00:34:59 hal9
3473 Some additions, and re-arranging.
3475 Revision 1.7 2001/09/24 14:31:36 hal9
3478 Revision 1.6 2001/09/24 14:10:32 hal9
3479 Including David's OS/2 installation instructions.
3481 Revision 1.2 2001/09/13 15:27:40 swa
3484 Revision 1.1 2001/09/12 15:36:41 swa
3485 source files for junkbuster documentation
3487 Revision 1.3 2001/09/10 17:43:59 swa
3488 first proposal of a structure.
3490 Revision 1.2 2001/06/13 14:28:31 swa
3491 docs should have an author.
3493 Revision 1.1 2001/06/13 14:20:37 swa
3494 first import of project's documentation for the webserver.
projects / privoxy.git / blob