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.30 2002/03/02 22:00:14 hal9 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.30 2002/03/02 22:00:14 hal9 Exp $</pubdate>
36 <orgname>By: Junkbuster Developers</orgname>
43 The user manual gives the users information on how to install and configure
44 <application>Internet Junkbuster</application>. <application>Internet
45 Junkbuster</application> is an application that provides privacy and
46 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 web page content,
66 managing cookies, controlling access, and removing ads, banners, pop-ups and
67 other obnoxious Internet Junk. <application>Junkbuster</application> has a
68 very flexible configuration and can be customized to suit individual needs
69 and tastes. <application>Internet Junkbuster</application> has application
70 for both stand-alone systems and multi-user networks.
74 This documentation is included with the current BETA version of
75 <application>Internet Junkbuster</application> and is incomplete at this
76 point. The most up to date reference for the time being is still the comments
77 in the source files and in the individual configuration files. Development
78 of version 3.0 is currently nearing completion, and includes many significant
79 changes and enhancements over earlier versions. The target release date for
84 Since this is a BETA version, not all new features are well tested. This
85 documentation may be slightly out of sync as a result. And there
86 <emphasis>may be</emphasis> bugs, though hopefully not many!
90 <!-- ~~~~~ New section ~~~~~ -->
92 <title>New Features</title>
94 In addition to <application>Junkbuster's</application> traditional features
95 of ad and banner blocking and cookie management, this is a list of new
96 features currently under development:
104 Integrated browser based configuration and control utility (<ulink
105 url="http://i.j.b">http://i.j.b</ulink>). Browser-based tracing of rule
112 Modularized configuration that will allow for system wide settings, and
113 individual user settings. (not implemented yet, probably a 3.1 feature)
119 Blocking of annoying pop-up browser windows.
125 HTTP/1.1 compliant (most, but not all 1.1 features are supported).
131 Support for Perl Compatible Regular Expressions in the configuration files, and
132 generally a more sophisticated and flexible configuration syntax over
145 Web page content filtering (removes banners based on size,
146 invisible <quote>web-bugs</quote>, JavaScript, pop-ups, status bar abuse,
153 Bypass many click-tracking scripts (avoids script redirection).
160 Multi-threaded (POSIX and native threads).
166 Auto-detection and re-reading of config file changes.
172 User-customizable HTML templates (e.g. 404 error page).
178 Improved cookie management features (e.g. session based cookies).
184 Builds from source on most UNIX-like systems. Packages available for: Linux
185 (RedHat, SuSE, or Debian), Windows, Sun Solaris, Mac OSX, OS/2.
192 In addition, the configuration is much more powerful and versatile over-all.
203 <!-- ~ End section ~ -->
206 <!-- ~~~~~ New section ~~~~~ -->
207 <sect1 id="installation"><title>Installation</title>
209 <application>Junkbuster</application> is available as raw source code, or
210 pre-compiled binaries. See the <ulink
211 url="http://sourceforge.net/projects/ijbswa/">Junkbuster Home Page</ulink>
212 for current release info. <application>Junkbuster</application> is also available
214 url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/">CVS</ulink>.
215 This is the recommended approach at this time. But please be aware that CVS
216 is constantly changing, and it may break in mysterious ways.
219 <!-- ~~~~~ New section ~~~~~ -->
220 <sect2 id="installation-source"><title>Source</title>
222 For gzipped tar archives, unpack the source:
227 tar xzvf ijb_source_* [.tgz or .tar.gz]
228 cd ijb_source_2.9.10_beta
233 For retrieving the current CVS sources, you'll need the CVS
234 package installed first. To download CVS source:
239 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
240 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
246 This will create a directory named <filename>current/</filename>, which will
247 contain the source tree.
251 Then, in either case, to build from tarball/CVS source:
256 ./configure (--help to see options)
257 make (the make from gnu, gmake for *BSD)
259 make -n install (to see where all the files will go)
260 make install (to really install)
265 For Redhat and SuSE Linux RPM packages, see below.
271 <!-- ~~~~~ New section ~~~~~ -->
272 <sect2 id="installation-rh"><title>Red Hat</title>
274 To build Redhat RPM packages, install source as above. Then:
279 autoheader [suggested for CVS source]
280 autoconf [suggested for CVS source]
287 This will create both binary and src RPMs in the usual places. Example:
291 /usr/src/redhat/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
294 /usr/src/redhat/SRPMS/junkbuster-2.9.10-1.src.rpm
298 To install, of course:
303 rpm -Uvv /usr/src/redhat/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
308 This will place the <application>Junkbuster</application> configuration
309 files in <filename>/etc/junkbuster/</filename>, and log files in
310 <filename>/var/log/junkbuster/</filename>.
315 <!-- ~~~~~ New section ~~~~~ -->
316 <sect2 id="installation-suse"><title>SuSE</title>
318 To build SuSE RPM packages, install source as above. Then:
323 autoheader [suggested for CVS source]
324 autoconf [suggested for CVS source]
331 This will create both binary and src RPMs in the usual places. Example:
335 /usr/src/packages/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
338 /usr/src/packages/SRPMS/junkbuster-2.9.10-1.src.rpm
342 To install, of course:
347 rpm -Uvv /usr/src/packages/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
352 This will place the <application>Junkbuster</application> configuration
353 files in <filename>/etc/junkbuster/</filename>, and log files in
354 <filename>/var/log/junkbuster/</filename>.
360 <!-- ~~~~~ New section ~~~~~ -->
361 <sect2 id="installation-os2"><title>OS/2</title>
368 <application>Junkbuster</application> is packaged in a WarpIN self-
369 installing archive. The self-installing program will be named depending
370 on the release version, something like:
371 <filename>ijbos2_setup_1.2.3.exe</filename>. In order to install it, simply
372 run this executable or double-click on its icon and follow the WarpIN
373 installation panels. A shadow of the <application>Junkbuster</application>
374 executable will be placed in your startup folder so it will start
375 automatically whenever OS/2 starts.
379 The directory you choose to install <application>Junkbuster</application>
380 into will contain all of the configuration files.
384 If you would like to build binary images on OS/2 yourself, you will need
385 a few Unix-like tools: autoconf, autoheader and sh. These tools will be
386 used to create the required config.h file, which is not part of the
387 source distribution because it differs based on platform. You will also
389 The distribution has been created using IBM VisualAge compilers, but you
390 can use any compiler you like. GCC/EMX has the disadvantage of needing
391 to be single-threaded due to a limitation of EMX's implementation of the
392 select() socket call.
396 In addition to needing the source code distribution as outlined earlier,
397 you will want to extract the <filename>os2seutp</filename> directory from CVS:
399 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
400 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
402 This will create a directory named os2setup/, which will contain the
403 <filename>Makefile.vac</filename> makefile and <filename>os2build.cmd</filename>
404 which is used to completely create the binary distribution. The sequence
405 of events for building the executable for yourself goes something like this:
412 nmake -f Makefile.vac
414 You will see this sequence laid out in <filename>os2build.cmd</filename>.
420 <!-- ~~~~~ New section ~~~~~ -->
421 <sect2 id="installation-win"><title>Windows</title>
422 <para>Click-click. (I need help on this. Not a clue here. Also for
423 configuration section below. HB.)
427 <!-- ~~~~~ New section ~~~~~ -->
428 <sect2 id="installation-other"><title>Other</title>
430 Some quick notes on other Operating Systems.
434 For FreeBSD (and other *BSDs?), the build will require <command>gmake</command>
435 instead of the included <command>make</command>. <command>gmake</command> is
436 available from <ulink url="http://www.gnu.org">http://www.gnu.org</ulink>.
437 The rest should be the same as above for Linux/Unix.
444 <!-- ~ End section ~ -->
447 <!-- ~~~~~ New section ~~~~~ -->
448 <sect1 id="configuration"><title>Junkbuster Configuration</title>
450 For Unix, *BSD and Linux, all configuration files are located in
451 <filename>/etc/junkbuster/</filename> by default. For MS Windows and OS/2,
452 these are all in the same directory as the
453 <application>Junkbuster</application> executable. The name and number of
454 configuration files has changed from previous versions, and is subject to
455 change as development progresses.
459 The installed defaults provide a reasonable starting point, though possibly
460 aggressive by some standards. For the time being, there are only three
461 default configuration files (this will change in time):
469 The main configuration file is named <filename>config</filename>
470 on Linux, Unix, BSD, and OS/2, and <filename>config.txt</filename> on
471 Windows. On Amiga, it is
472 <filename>AmiTCP:db/junkbuster/config</filename>.
478 The <filename>ijb.action</filename> file is used to define various
479 <quote>actions</quote> relating to images, banners, pop-ups, access
480 restrictions, banners and cookies. There is a CGI based editor for this
481 file that can be accessed via <ulink
482 url="http://i.j.b">http://i.j.b</ulink>. This is the easiest method of
483 configuring actions. (Other actions
484 files are included as well with differing levels of filtering
485 and blocking, e.g. <filename>ijb-basic.action</filename>.)
491 The <filename>re_filterfile</filename> file can be used to rewrite the raw
492 page content, including text as well as embedded HTML and JavaScript.
500 <filename>ijb.action</filename> and <filename>re_filterfile</filename>
501 can use Perl style regular expressions for maximum flexibility. All files use
502 the <quote><literal>#</literal></quote> character to denote a comment. Such
503 lines are not processed by <application>Junkbuster</application>. After
504 making any changes, there is no need to restart
505 <application>Junkbuster</application> in order for the changes to take
506 effect. <application>Junkbuster</application> should detect such changes
511 While under development, the configuration content is subject to change.
512 The below documentation may not be accurate by the time you read this.
513 Also, what constitutes a <quote>default</quote> setting, may change, so
514 please check all your configuration files on important issues.
517 <!-- ~~~~~ New section ~~~~~ -->
520 <title>The Main Configuration File</title>
522 Again, the main configuration file is named <filename>config</filename> on
523 Linux/Unix/BSD and OS/2, and <filename>config.txt</filename> on Windows.
524 Configuration lines consist of an initial keyword followed by a list of
525 values, all separated by whitespace (any number of spaces or tabs). For
533 <emphasis>blockfile blocklist.ini</emphasis>
540 Indicates that the blockfile is named <quote>blocklist.ini</quote>.
544 A <quote><literal>#</literal></quote> indicates a comment. Any part of a
545 line following a <quote><literal>#</literal></quote> is ignored, except if
546 the <quote><literal>#</literal></quote> is preceded by a
547 <quote><literal>\</literal></quote>.
551 Thus, by placing a <quote><literal>#</literal></quote> at the start of an
552 existing configuration line, you can make it a comment and it will be treated
553 as if it weren't there. This is called <quote>commenting out</quote> an
554 option and can be useful to turn off features: If you comment out the
555 <quote>logfile</quote> line, <application>junkbuster</application> will not
556 log to a file at all. Watch for the <quote>default:</quote> section in each
557 explanation to see what happens if the option is left unset (or commented
562 Long lines can be continued on the next line by using a
563 <quote><literal>\</literal></quote> as the very last character.
567 There are various aspects of <application>Junkbuster</application> behavior
572 <!-- ~~~~~ New section ~~~~~ -->
575 <title>Defining Other Configuration Files</title>
578 <application>Junkbuster</application> can use a number of other files to tell it
579 what ads to block, what cookies to accept, etc. This section of the
580 configuration file tells <application>Junkbuster</application> where to find
581 all those other files.
585 On <application>Windows</application>, <application>Junkbuster</application>
586 looks for these files in the same directory as the executable. On Unix and
587 OS/2, <application>Junkbuster</application> looks for these files in the current
588 working directory. In either case, an absolute path name can be used to
593 When development goes modular and multi-user, the blocker, filter, and
594 per-user config will be stored in subdirectories of <quote>confdir</quote>.
595 For now, only <filename>confdir/templates</filename> is used for storing HTML
596 templates for CGI results.
600 The location of the configuration files:
607 <emphasis>confdir /etc/junkbuster</emphasis> # No trailing /, please.
614 The directory where all logging (i.e. <filename>logfile</filename> and
615 <filename>jarfile</filename>) takes place. No trailing
616 <quote><literal>/</literal></quote>, please:
623 <emphasis>logdir /var/log/junkbuster</emphasis>
630 Note that all file specifications below are relative to
631 the above two directories!
635 The <quote>ijb.action</quote> file contains patterns to specify the actions to
636 apply to requests for each site. Default: Cookies to and from all
637 destinations are kept only during the current browser session (i.e. they
638 are not saved to disk). Pop-ups are disabled for all sites. All sites are
639 filtered if <quote>re_filterfile</quote> specified. No sites are blocked. An
640 empty image is displayed for filtered ads and other images (formerly
641 <quote>tinygif</quote>). The syntax of this file is explained in detail <link
642 linkend="actionsfile">below</link>.
649 <emphasis>actionsfile ijb.action</emphasis>
656 The <quote>re_filterfile</quote> file contains content modification rules.
657 These rules permit powerful changes on the content of Web pages, e.g., you
658 could disable your favorite JavaScript annoyances, rewrite the actual
659 content, or just have some fun replacing <quote>Microsoft</quote> with
660 <quote>MicroSuck</quote> wherever it appears on a Web page. Default: No
661 content modification, or whatever the developers are playing with :-/
668 <emphasis>re_filterfile re_filterfile</emphasis>
675 The logfile is where all logging and error messages are written. The logfile
676 can be useful for tracking down a problem with
677 <application>Junkbuster</application> (e.g., it's not blocking an ad you
678 think it should block) but in most cases you probably will never look at it.
682 Your logfile will grow indefinitely, and you will probably want to
683 periodically remove it. On Unix systems, you can do this with a cron job
684 (see <quote>man cron</quote>). For Redhat, a <command>logrotate</command>
685 script has been included.
689 On SuSE Linux systems, you can place a line like <quote>/var/log/junkbuster.*
690 +1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
691 the effect that cron.daily will automatically archive, gzip, and empty the
692 log, when it exceeds 1M size.
696 Default: Log to the a file named <filename>logfile</filename>.
697 Comment out to disable logging.
704 <emphasis>logfile logfile</emphasis>
711 The <quote>jarfile</quote> defines where
712 <application>Junkbuster</application> stores the cookies it intercepts. Note
713 that if you use a <quote>jarfile</quote>, it may grow quite large. Default:
714 Don't store intercepted cookies.
721 <emphasis>#jarfile jarfile</emphasis>
728 If you specify a <quote>trustfile</quote>,
729 <application>Junkbuster</application> will only allow access to sites that
730 are named in the trustfile. You can also mark sites as trusted referrers,
731 with the effect that access to untrusted sites will be granted, if a link
732 from a trusted referrer was used. The link target will then be added to the
733 <quote>trustfile</quote>. This is a very restrictive feature that typical
734 users most probably want to leave disabled. Default: Disabled, don't use the
742 <emphasis>#trustfile trust</emphasis>
749 If you use the trust mechanism, it is a good idea to write up some on-line
750 documentation about your blocking policy and to specify the URL(s) here. They
751 will appear on the page that your users receive when they try to access
752 untrusted content. Use multiple times for multiple URLs. Default: Don't
753 display links on the <quote>untrusted</quote> info page.
760 <emphasis>trust-info-url http://www.your-site.com/why_we_block.html</emphasis>
761 <emphasis>trust-info-url http://www.your-site.com/what_we_allow.html</emphasis>
769 <!-- ~ End section ~ -->
773 <!-- ~~~~~ New section ~~~~~ -->
776 <title>Other Configuration Options</title>
779 This part of the configuration file contains options that control how
780 <application>Junkbuster</application> operates.
784 <quote>Admin-address</quote> should be set to the email address of the proxy
785 administrator. It is used in many of the proxy-generated pages. Default:
793 <emphasis>#admin-address fill@me.in.please</emphasis>
800 <quote>Proxy-info-url</quote> can be set to a URL that contains more info
801 about this <application>Junkbuster</application> installation, it's
802 configuration and policies. It is used in many of the proxy-generated pages
803 and its use is highly recommended in multi-user installations, since your
804 users will want to know why certain content is blocked or modified. Default:
805 Don't show a link to on-line documentation.
812 <emphasis>proxy-info-url http://www.your-site.com/proxy.html</emphasis>
819 <quote>Listen-address</quote> specifies the address and port where
820 <application>Junkbuster</application> will listen for connections from your
821 Web browser. The default is to listen on the localhost port 8000, and
822 this is suitable for most users. (In your web browser, under proxy
823 configuration, list the proxy server as <quote>localhost</quote> and the
824 port as <quote>8000</quote>).
828 If you already have another service running on port 8000, or if you want to
829 serve requests from other machines (e.g. on your local network) as well, you
830 will need to override the default. The syntax is
831 <quote>listen-address [<ip-address>]:<port></quote>. If you leave
832 out the IP address, <application>junkbuster</application> will bind to all
833 interfaces (addresses) on your machine and may become reachable from the
834 Internet. In that case, consider using access control lists (acl's) (see
835 <quote>aclfile</quote> above), or a firewall.
839 For example, suppose you are running <application>Junkbuster</application> on
840 a machine which has the address 192.168.0.1 on your local private network
841 (192.168.0.0) and has another outside connection with a different address.
842 You want it to serve requests from inside only:
849 <emphasis>listen-address 192.168.0.1:8000</emphasis>
856 If you want it to listen on all addresses (including the outside
864 <emphasis>listen-address :8000</emphasis>
871 If you do this, consider using ACLs (see <quote>aclfile</quote> above). Note:
872 you will need to point your browser(s) to the address and port that you have
873 configured here. Default: localhost:8000 (127.0.0.1:8000).
877 The debug option sets the level of debugging information to log in the
878 logfile (and to the console in the Windows version). A debug level of 1 is
879 informative because it will show you each request as it happens. Higher
880 levels of debug are probably only of interest to developers.
887 debug 1 # GPC = show each GET/POST/CONNECT request
888 debug 2 # CONN = show each connection status
889 debug 4 # IO = show I/O status
890 debug 8 # HDR = show header parsing
891 debug 16 # LOG = log all data into the logfile
892 debug 32 # FRC = debug force feature
893 debug 64 # REF = debug regular expression filter
894 debug 128 # = debug fast redirects
895 debug 256 # = debug GIF de-animation
896 debug 512 # CLF = Common Log Format
897 debug 1024 # = debug kill pop-ups
898 debug 4096 # INFO = Startup banner and warnings.
899 debug 8192 # ERROR = Non-fatal errors
906 It is <emphasis>highly recommended</emphasis> that you enable ERROR
907 reporting (debug 8192), at least until the next stable release.
911 The reporting of FATAL errors (i.e. ones which crash
912 <application>JunkBuster</application>) is always on and cannot be disabled.
916 If you want to use CLF (Common Log Format), you should set <quote>debug
917 512</quote> ONLY, do not enable anything else.
921 Multiple <quote>debug</quote> directives, are OK - they're logical-OR'd
929 <emphasis>debug 15 # same as setting the first 4 listed above</emphasis>
943 <emphasis>debug 1 # URLs</emphasis>
944 <emphasis>debug 4096 # Info</emphasis>
945 <emphasis>debug 8192 # Errors - *we highly recommended enabling this*</emphasis>
952 <application>Junkbuster</application> normally uses
953 <quote>multi-threading</quote>, a software technique that permits it to
954 handle many different requests simultaneously. In some cases you may wish to
955 disable this -- particularly if you're trying to debug a problem. The
956 <quote>single-threaded</quote> option forces
957 <application>Junkbuster</application> to handle requests sequentially.
958 Default: Multi-threaded mode.
965 <emphasis>#single-threaded</emphasis>
972 <quote>toggle</quote> allows you to temporarily disable all
973 <application>Junkbuster's</application> filtering. Just set <quote>toggle
978 The Windows version of <application>Junkbuster</application> puts an icon in
979 the system tray, which also allows you to change this option. If you
980 right-click on that icon (or select the <quote>Options</quote> menu), one
981 choice is <quote>Enable</quote>. Clicking on enable toggles
982 <application>Junkbuster</application> on and off. This is useful if you want
983 to temporarily disable <application>Junkbuster</application>, e.g., to access
984 a site that requires cookies which you would otherwise have blocked. This can also
985 be toggled via a web browser at the <application>Junkbuster</application>
986 internal address of <ulink url="http://i.j.b">http://i.j.b</ulink> on
991 <quote>toggle 1</quote> means <application>Junkbuster</application> runs
992 normally, <quote>toggle 0</quote> means that
993 <application>Junkbuster</application> becomes a non-anonymizing non-blocking
994 proxy. Default: 1 (on).
1001 <emphasis>toggle 1</emphasis>
1008 For content filtering, i.e. the <quote>+filter</quote> and
1009 <quote>+deanimate-gif</quote> actions, it is necessary that
1010 <application>Junkbuster</application> buffers the entire document body.
1011 This can be potentially dangerous, since a server could just keep sending
1012 data indefinitely and wait for your RAM to exhaust. With nasty consequences.
1016 The <application>buffer-limit</application> option lets you set the maximum
1017 size in Kbytes that each buffer may use. When the documents buffer exceeds
1018 this size, it is flushed to the client unfiltered and no further attempt to
1019 filter the rest of it is made. Remember that there may multiple threads
1020 running, which might require increasing the <quote>buffer-limit</quote>
1021 Kbytes <emphasis>each</emphasis>, unless you have enabled
1022 <quote>single-threaded</quote> above.
1029 <emphasis>buffer-limit 4069</emphasis>
1036 To enable the web-based <filename>ijb.action</filename> file editor set
1037 <application>enable-edit-actions</application> to 1, or 0 to disable. Note
1038 that you must have compiled <application>JunkBuster</application> with
1039 support for this feature, otherwise this option has no effect. This
1040 internal page can be reached at <ulink
1041 url="http://i.j.b">http://i.j.b</ulink>.
1045 Security note: If this is enabled, anyone who can use the proxy
1046 can edit the actions file, and their changes will affect all users.
1047 For shared proxies, you probably want to disable this. Default: enabled.
1054 <emphasis>enable-edit-actions 1</emphasis>
1061 Allow <application>JunkBuster</application> to be toggled on and off
1062 remotely, using your web browser. Set <quote>enable-remote-toggle</quote>to
1063 1 to enable, and 0 to disable. Note that you must have compiled
1064 <application>JunkBuster</application> with support for this feature,
1065 otherwise this option has no effect.
1069 Security note: If this is enabled, anyone who can use the proxy can toggle
1070 it on or off (see <ulink url="http://i.j.b">http://i.j.b</ulink>), and
1071 their changes will affect all users. For shared proxies, you probably want to
1072 disable this. Default: enabled.
1079 <emphasis>enable-remote-toggle 1</emphasis>
1087 <!-- ~ End section ~ -->
1090 <!-- ~~~~~ New section ~~~~~ -->
1093 <title>Access Control List (ACL)</title>
1095 Access controls are included at the request of some ISPs and systems
1096 administrators, and are not usually needed by individual users. Please note
1097 the warnings in the FAQ that this proxy is not intended to be a substitute
1098 for a firewall or to encourage anyone to defer addressing basic security
1103 If no access settings are specified, the proxy talks to anyone that
1104 connects. If any access settings file are specified, then the proxy
1105 talks only to IP addresses permitted somewhere in this file and not
1106 denied later in this file.
1110 Summary -- if using an ACL:
1115 Client must have permission to receive service.
1120 LAST match in ACL wins.
1125 Default behavior is to deny service.
1130 The syntax for an entry in the Access Control List is:
1137 ACTION SRC_ADDR[/SRC_MASKLEN] [ DST_ADDR[/DST_MASKLEN] ]
1144 Where the individual fields are:
1151 <emphasis>ACTION</emphasis> = <quote>permit-access</quote> or <quote>deny-access</quote>
1153 <emphasis>SRC_ADDR</emphasis> = client hostname or dotted IP address
1154 <emphasis>SRC_MASKLEN</emphasis> = number of bits in the subnet mask for the source
1156 <emphasis>DST_ADDR</emphasis> = server or forwarder hostname or dotted IP address
1157 <emphasis>DST_MASKLEN</emphasis> = number of bits in the subnet mask for the target
1165 The field separator (FS) is whitespace (space or tab).
1169 IMPORTANT NOTE: If the <application>junkbuster</application> is using a
1170 forwarder (see below) or a gateway for a particular destination URL, the
1171 <literal>DST_ADDR</literal> that is examined is the address of the forwarder
1172 or the gateway and <emphasis>NOT</emphasis> the address of the ultimate
1173 target. This is necessary because it may be impossible for the local
1174 <application>Junkbuster</application> to determine the address of the
1175 ultimate target (that's often what gateways are used for).
1179 Here are a few examples to show how the ACL features work:
1183 <quote>localhost</quote> is OK -- no DST_ADDR implies that
1184 <emphasis>ALL</emphasis> destination addresses are OK:
1191 <emphasis>permit-access localhost</emphasis>
1198 A silly example to illustrate permitting any host on the class-C subnet with
1199 <application>Junkbuster</application> to go anywhere:
1206 <emphasis>permit-access www.junkbusters.com/24</emphasis>
1213 Except deny one particular IP address from using it at all:
1220 <emphasis>deny-access ident.junkbusters.com</emphasis>
1227 You can also specify an explicit network address and subnet mask.
1228 Explicit addresses do not have to be resolved to be used.
1235 <emphasis>permit-access 207.153.200.0/24</emphasis>
1242 A subnet mask of 0 matches anything, so the next line permits everyone.
1249 <emphasis>permit-access 0.0.0.0/0</emphasis>
1256 Note, you <emphasis>cannot</emphasis> say:
1263 <emphasis>permit-access .org</emphasis>
1270 to allow all *.org domains. Every IP address listed must resolve fully.
1274 An ISP may want to provide a <application>Junkbuster</application> that is
1275 accessible by <quote>the world</quote> and yet restrict use of some of their
1276 private content to hosts on its internal network (i.e. its own subscribers).
1277 Say, for instance the ISP owns the Class-B IP address block 123.124.0.0 (a 16
1278 bit netmask). This is how they could do it:
1285 <emphasis>permit-access 0.0.0.0/0 0.0.0.0/0</emphasis> # other clients can go anywhere
1286 # with the following exceptions:
1288 <emphasis>deny-access</emphasis> 0.0.0.0/0 123.124.0.0/16 # block all external requests for
1289 # sites on the ISP's network
1291 <emphasis>permit 0.0.0.0/0 www.my_isp.com</emphasis> # except for the ISP's main
1294 <emphasis>permit 123.124.0.0/16 0.0.0.0/0</emphasis> # the ISP's clients can go
1302 Note that if some hostnames are listed with multiple IP addresses,
1303 the primary value returned by DNS (via gethostbyname()) is used. Default:
1304 Anyone can access the proxy.
1309 <!-- ~ End section ~ -->
1312 <!-- ~~~~~ New section ~~~~~ -->
1315 <title>Forwarding</title>
1318 This feature allows chaining of HTTP requests via multiple proxies.
1319 It can be used to better protect privacy and confidentiality when
1320 accessing specific domains by routing requests to those domains
1321 to a special purpose filtering proxy such as lpwa.com. Or to use
1322 a caching proxy to speed up browsing.
1326 It can also be used in an environment with multiple networks to route
1327 requests via multiple gateways allowing transparent access to multiple
1328 networks without having to modify browser configurations.
1332 Also specified here are SOCKS proxies. <application>Junkbuster</application>
1333 SOCKS 4 and SOCKS 4A. The difference is that SOCKS 4A will resolve the target
1334 hostname using DNS on the SOCKS server, not our local DNS client.
1338 The syntax of each line is:
1345 <emphasis>forward target_domain[:port] http_proxy_host[:port]</emphasis>
1346 <emphasis>forward-socks4 target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1347 <emphasis>forward-socks4a target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1354 If http_proxy_host is <quote>.</quote>, then requests are not forwarded to a
1355 HTTP proxy but are made directly to the web servers.
1359 Lines are checked in sequence, and the last match wins.
1363 There is an implicit line equivalent to the following, which specifies that
1364 anything not finding a match on the list is to go out without forwarding
1365 or gateway protocol, like so:
1372 <emphasis>forward .* . </emphasis># implicit
1379 In the following common configuration, everything goes to Lucent's LPWA,
1380 except SSL on port 443 (which it doesn't handle):
1387 <emphasis>forward .* lpwa.com:8000</emphasis>
1388 <emphasis>forward :443 .</emphasis>
1395 See the FAQ for instructions on how to automate the login procedure for LPWA.
1396 Some users have reported difficulties related to LPWA's use of
1397 <quote>.</quote> as the last element of the domain, and have said that this
1398 can be fixed with this:
1405 <emphasis>forward lpwa. lpwa.com:8000</emphasis>
1412 (NOTE: the syntax for specifying target_domain has changed since the
1413 previous paragraph was written -- it will not work now. More information
1418 In this fictitious example, everything goes via an ISP's caching proxy,
1419 except requests to that ISP:
1426 <emphasis>forward .* caching.myisp.net:8000</emphasis>
1427 <emphasis>forward myisp.net .</emphasis>
1434 For the @home network, we're told the forwarding configuration is this:
1442 <emphasis>forward .* proxy:8080</emphasis>
1449 Also, we're told they insist on getting cookies and JavaScript, so you should
1450 add home.com to the cookie file. We consider JavaScript a security risk.
1451 Java need not be enabled.
1455 In this example direct connections are made to all <quote>internal</quote>
1456 domains, but everything else goes through Lucent's LPWA by way of the
1457 company's SOCKS gateway to the Internet.
1464 <emphasis>forward-socks4 .* lpwa.com:8000 firewall.my_company.com:1080</emphasis>
1465 <emphasis>forward my_company.com .</emphasis>
1472 This is how you could set up a site that always uses SOCKS but no forwarders:
1479 <emphasis>forward-socks4a .* . firewall.my_company.com:1080</emphasis>
1486 An advanced example for network administrators:
1490 If you have links to multiple ISPs that provide various special content to
1491 their subscribers, you can configure forwarding to pass requests to the
1492 specific host that's connected to that ISP so that everybody can see all
1493 of the content on all of the ISPs.
1497 This is a bit tricky, but here's an example:
1502 host-a has a PPP connection to isp-a.com. And host-b has a PPP connection to
1503 isp-b.com. host-a can run a <application>Junkbuster</application> proxy with
1504 forwarding like this:
1511 <emphasis>forward .* .</emphasis>
1512 <emphasis>forward isp-b.com host-b:8000</emphasis>
1519 host-b can run a <application>Junkbuster</application> proxy with forwarding
1527 <emphasis>forward .* .</emphasis>
1528 <emphasis>forward isp-a.com host-a:8000</emphasis>
1535 Now, <emphasis>anyone</emphasis> on the Internet (including users on host-a
1536 and host-b) can set their browser's proxy to <emphasis>either</emphasis>
1537 host-a or host-b and be able to browse the content on isp-a or isp-b.
1541 Here's another practical example, for University of Kent at
1542 Canterbury students with a network connection in their room, who
1543 need to use the University's Squid web cache.
1550 <emphasis>forward *. ssbcache.ukc.ac.uk:3128</emphasis> # Use the proxy, except for:
1551 <emphasis>forward .ukc.ac.uk . </emphasis> # Anything on the same domain as us
1552 <emphasis>forward * . </emphasis> # Host with no domain specified
1553 <emphasis>forward 129.12.*.* . </emphasis> # A dotted IP on our /16 network.
1554 <emphasis>forward 127.*.*.* . </emphasis> # Loopback address
1555 <emphasis>forward localhost.localdomain . </emphasis> # Loopback address
1556 <emphasis>forward www.ukc.mirror.ac.uk . </emphasis> # Specific host
1563 If you intend to chain <application>Junkbuster</application> and
1564 <application>squid</application> locally, then chain as
1565 <literal>browser -> squid -> junkbuster</literal> is the recommended way.
1569 Your squid configuration could then look like this:
1576 # Define junkbuster as parent cache
1577 <!-- per feedback from user...
1578 cache_peer 127.0.0.1 8000 parent 0 no-query
1580 cache_peer 127.0.0.1 parent 8000 0 no-query
1582 # Define ACL for protocol FTP
1585 # Do not forward ACL FTP to junkbuster
1586 always_direct allow FTP
1588 # Do not forward ACL CONNECT (https) to junkbuster
1589 always_direct allow CONNECT
1591 # Forward the rest to junkbuster
1592 never_direct allow all
1600 <!-- ~ End section ~ -->
1603 <!-- ~~~~~ New section ~~~~~ -->
1606 <title>Windows GUI Options</title>
1608 Removed references to Win32. HB 09/23/01
1611 <application>Junkbuster</application> has a number of options specific to the
1612 Windows GUI interface:
1616 If <quote>activity-animation</quote> is set to 1, the
1617 <application>Junkbuster</application> icon will animate when
1618 <quote>Junkbuster</quote> is active. To turn off, set to 0.
1625 <emphasis>activity-animation 1</emphasis>
1632 If <quote>log-messages</quote> is set to 1,
1633 <application>Junkbuster</application> will log messages to the console
1641 <emphasis>log-messages 1</emphasis>
1648 If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
1649 i.e. the amount of memory used for the log messages displayed in the
1650 console window, will be limited to <quote>log-max-lines</quote> (see below).
1654 Warning: Setting this to 0 will result in the buffer to grow infinitely and
1655 eat up all your memory!
1662 <emphasis>log-buffer-size 1</emphasis>
1669 <application>log-max-lines</application> is the maximum number of lines held
1670 in the log buffer. See above.
1677 <emphasis>log-max-lines 200</emphasis>
1684 If <quote>log-highlight-messages</quote> is set to 1,
1685 <application>Junkbuster</application> will highlight portions of the log
1686 messages with a bold-faced font:
1693 <emphasis>log-highlight-messages 1</emphasis>
1700 The font used in the console window:
1707 <emphasis>log-font-name Comic Sans MS</emphasis>
1714 Font size used in the console window:
1721 <emphasis>log-font-size 8</emphasis>
1728 <quote>show-on-task-bar</quote> controls whether or not
1729 <application>Junkbuster</application> will appear as a button on the Task bar
1737 <emphasis>show-on-task-bar 0</emphasis>
1744 If <quote>close-button-minimizes</quote> is set to 1, the Windows close
1745 button will minimize <application>Junkbuster</application> instead of closing
1746 the program (close with the exit option on the File menu).
1753 <emphasis>close-button-minimizes 1</emphasis>
1760 The <quote>hide-console</quote> option is specific to the MS-Win console
1761 version of <application>JunkBuster</application>. If this option is used,
1762 <application>Junkbuster</application> will disconnect from and hide the
1779 <!-- ~ End section ~ -->
1782 <!-- ~~~~~ New section ~~~~~ -->
1783 <sect2 id="actionsfile">
1784 <title>The Actions File</title>
1787 The <quote>ijb.action</quote> file (formerly
1788 <filename>actionsfile</filename>) is used to define what actions
1789 <application>Junkbuster</application> takes, and thus determines how images,
1790 cookies and various other aspects of HTTP content and transactions are
1791 handled. Images can be anything you want, including ads, banners, or just
1792 some obnoxious image that you would rather not see. Cookies can be accepted
1793 or rejected, or accepted only during the current browser session (i.e.
1794 not written to disk). Changes to <filename>ijb.action</filename> should
1795 be immediately visible to <application>Junkbuster</application> without
1796 the need to restart.
1800 To determine which actions apply to a request, the URL of the request is
1801 compared to all patterns in this file. Every time it matches, the list of
1802 applicable actions for the URL is incrementally updated. You can trace
1803 this process by visiting <ulink
1804 url="http://i.j.b/show-url-info">http://i.j.b/show-url-info</ulink>.
1808 The actions file can be edited with a browser by loading
1809 <ulink url="http://i.j.b/">http://i.j.b/</ulink>, and then select
1810 <quote>Edit Actions</quote>.
1814 There are four types of lines in this file: comments (begin with a
1815 <quote>#</quote> character), actions, aliases and patterns, all of which are
1816 explained below, as well as the configuration file syntax that
1817 <application>Junkbuster</application> understands.
1822 <!-- ~~~~~ New section ~~~~~ -->
1824 <title>URL Domain and Path Syntax</title>
1826 Generally, a pattern has the form <domain>/<path>, where both the
1827 <domain> and <path> part are optional. If you only specify a
1828 domain part, the <quote>/</quote> can be left out:
1832 <emphasis>www.example.com</emphasis> - is a domain only pattern and will match any request to
1833 <quote>www.example.com</quote>.
1837 <emphasis>www.example.com/</emphasis> - means exactly the same.
1841 <emphasis>www.example.com/index.html</emphasis> - matches only the single
1842 document <quote>/index.html</quote> on <quote>www.example.com</quote>.
1846 <emphasis>/index.html</emphasis> - matches the document <quote>/index.html</quote>, regardless of
1851 <emphasis>index.html</emphasis> - matches nothing, since it would be
1852 interpreted as a domain name and there is no top-level domain called
1853 <quote>.html</quote>.
1857 The matching of the domain part offers some flexible options: if the
1858 domain starts or ends with a dot, it becomes unanchored at that end.
1863 <emphasis>.example.com</emphasis> - matches any domain that <emphasis>ENDS</emphasis> in
1864 <quote>.example.com</quote>.
1868 <emphasis>www.</emphasis> - matches any domain that <emphasis>STARTS</emphasis> with
1873 Additionally, there are wild-cards that you can use in the domain names
1874 themselves. They work pretty similar to shell wild-cards: <quote>*</quote>
1875 stands for zero or more arbitrary characters, <quote>?</quote> stands for
1876 any single character. And you can define character classes in square
1877 brackets and they can be freely mixed:
1881 <emphasis>ad*.example.com</emphasis> - matches <quote>adserver.example.com</quote>,
1882 <quote>ads.example.com</quote>, etc but not <quote>sfads.example.com</quote>.
1886 <emphasis>*ad*.example.com</emphasis> - matches all of the above, and then some.
1890 <emphasis>.?pix.com</emphasis> - matches <quote>www.ipix.com</quote>,
1891 <quote>pictures.epix.com</quote>, <quote>a.b.c.d.e.upix.com</quote>, etc.
1895 <emphasis>www[1-9a-ez].example.com</emphasis> - matches <quote>www1.example.com</quote>,
1896 <quote>www4.example.com</quote>, <quote>wwwd.example.com</quote>,
1897 <quote>wwwz.example.com</quote>, etc., but <emphasis>not</emphasis>
1898 <quote>wwww.example.com</quote>.
1902 If <application>Junkbuster</application> was compiled with
1903 <quote>pcre</quote> support (default), Perl compatible regular expressions
1904 can be used. See the <filename>pcre/docs/</filename> directory or <quote>man
1905 perlre</quote> (also available on <ulink
1906 url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>)
1907 for details. A brief discussion of regular expressions is in the
1908 <link linkend="regex">Appendix</link>. For instance:
1912 <emphasis>/.*/advert[0-9]+\.jpe?g</emphasis> - would match a URL from any
1913 domain, with any path that includes <quote>advert</quote> followed
1914 immediately by one or more digits, then a <quote>.</quote> and ending in
1915 either <quote>jpeg</quote> or <quote>jpg</quote>. So we match
1916 <quote>example.com/ads/advert2.jpg</quote>, and
1917 <quote>www.example.com/ads/banners/advert39.jpeg</quote>, but not
1918 <quote>www.example.com/ads/banners/advert39.gif</quote> (no gifs in the
1923 Please note that matching in the path is case
1924 <emphasis>INSENSITIVE</emphasis> by default, but you can switch to case
1925 sensitive at any point in the pattern by using the
1926 <quote>(?-i)</quote> switch:
1930 <emphasis>www.example.com/(?-i)PaTtErN.*</emphasis> - will match only
1931 documents whose path starts with <quote>PaTtErN</quote> in
1932 <emphasis>exactly</emphasis> this capitalization.
1937 <!-- ~ End section ~ -->
1941 <!-- ~~~~~ New section ~~~~~ -->
1944 <title>Actions</title>
1946 Actions are enabled if preceded with a <quote>+</quote>, and disabled if
1947 preceded with a <quote>-</quote>. Actions are invoked by enclosing the
1948 action name in curly braces (e.g. {+some_action}), followed by a list of
1949 URLs to which the action applies. There are three classes of actions:
1957 Boolean (e.g. <quote>+/-block</quote>):
1963 <emphasis>{+name}</emphasis> # enable this action
1964 <emphasis>{-name}</emphasis> # disable this action
1974 parameterized (e.g. <quote>+/-hide-user-agent</quote>):
1980 <emphasis>{+name{param}}</emphasis> # enable action and set parameter to <quote>param</quote>
1981 <emphasis>{-name}</emphasis> # disable action
1990 Multi-value (e.g. <quote>{+/-add-header{Name: value}}</quote>, <quote>{+/-wafer{name=value}}</quote>):
1996 <emphasis>{+name{param}}</emphasis> # enable action and add parameter <quote>param</quote>
1997 <emphasis>{-name{param}}</emphasis> # remove the parameter <quote>param</quote>
1998 <emphasis>{-name}</emphasis> # disable this action totally
2009 If nothing is specified in this file, no <quote>actions</quote> are taken.
2010 So in this case <application>JunkBuster</application> would just be a
2011 normal, non-blocking, non-anonymizing proxy. You must specifically
2012 enable the privacy and blocking features you need (although the
2013 provided default <filename>ijb.action</filename> file will
2014 give a good starting point).
2018 Later defined actions always over-ride earlier ones. For multi-valued
2019 actions, the actions are applied in the order they are specified.
2023 The list of valid <application>Junkbuster</application> <quote>actions</quote> are:
2031 Add the specified HTTP header, which is not checked for validity.
2032 You may specify this many times to specify many different headers:
2038 <emphasis>+add-header{Name: value}</emphasis>
2048 Block this URL totally.
2054 <emphasis>+block</emphasis>
2064 De-animate all animated GIF images, i.e. reduce them to their last frame.
2065 This will also shrink the images considerably (in bytes, not pixels!). If
2066 the option <quote>first</quote> is given, the first frame of the animation
2067 is used as the replacement. If <quote>last</quote> is given, the last frame
2068 of the animation is used instead, which probably makes more sense for most
2069 banner animations, but also has the risk of not showing the entire last
2070 frame (if it is only a delta to an earlier frame).
2076 <emphasis>+deanimate-gifs{last}</emphasis>
2077 <emphasis>+deanimate-gifs{first}</emphasis>
2086 <quote>+downgrade</quote> will downgrade HTTP/1.1 client requests to
2087 HTTP/1.0 and downgrade the responses as well. Use this action for servers
2088 that use HTTP/1.1 protocol features that
2089 <application>Junkbuster</application> doesn't handle well yet. HTTP/1.1
2090 is only partially implemented. Default is not to downgrade requests.
2096 <emphasis>+downgrade</emphasis>
2105 Many sites, like yahoo.com, don't just link to other sites. Instead, they
2106 will link to some script on their own server, giving the destination as a
2107 parameter, which will then redirect you to the final target. URLs resulting
2108 from this scheme typically look like:
2109 http://some.place/some_script?http://some.where-else.
2112 Sometimes, there are even multiple consecutive redirects encoded in the
2113 URL. These redirections via scripts make your web browsing more traceable,
2114 since the server from which you follow such a link can see where you go to.
2115 Apart from that, valuable bandwidth and time is wasted, while your browser
2116 ask the server for one redirect after the other. Plus, it feeds the
2120 The <quote>+fast-redirects</quote> option enables interception of these
2121 requests by <application>Junkbuster</application>, who will cut off all but
2122 the last valid URL in the request and send a local redirect back to your
2123 browser without contacting the remote site.
2129 <emphasis>+fast-redirects</emphasis>
2138 Filter the website through the re_filterfile:
2144 <emphasis>+filter{filename}</emphasis>
2153 Block any existing X-Forwarded-for header, and do not add a new one:
2159 <emphasis>+hide-forwarded</emphasis>
2168 If the browser sends a <quote>From:</quote> header containing your e-mail
2169 address, this either completely removes the header (<quote>block</quote>), or
2170 changes it to the specified e-mail address.
2176 <emphasis>+hide-from{block}</emphasis>
2177 <emphasis>+hide-from{spam@sittingduck.xqq}</emphasis>
2186 Don't send the <quote>Referer:</quote> (sic) header to the web site. You
2187 can block it, forge a URL to the same server as the request (which is
2188 preferred because some sites will not send images otherwise) or set it to a
2189 constant string of your choice.
2195 <emphasis>+hide-referer{block}</emphasis>
2196 <emphasis>+hide-referer{forge}</emphasis>
2197 <emphasis>+hide-referer{http://nowhere.com}</emphasis>
2206 Alternative spelling of <quote>+hide-referer</quote>. It has the same
2207 parameters, and can be freely mixed with, <quote>+hide-referer</quote>.
2208 (<quote>referrer</quote> is the correct English spelling, however the HTTP
2209 specification has a bug - it requires it to be spelled <quote>referer</quote>.)
2215 <emphasis>+hide-referrer{...}</emphasis>
2224 Change the <quote>User-Agent:</quote> header so web servers can't tell your
2225 browser type. Warning! This breaks many web sites. Specify the
2226 user-agent value you want. Example, pretend to be using Netscape on
2233 <emphasis>+hide-user-agent{Mozilla (X11; I; Linux 2.0.32 i586)}</emphasis>
2240 Or to identify yourself explicitly as a <quote>Junkbuster</quote> user:
2246 <emphasis>+hide-user-agent{JunkBuster/1.0}</emphasis>
2251 (Don't change the version number from 1.0 - after all, why tell them?)
2258 <emphasis>+hide-user-agent{browser-type}</emphasis>
2268 Treat this URL as an image. This only matters if it's also <quote>+block</quote>ed,
2269 in which case a <quote>blocked</quote> image can be sent rather than a HTML page.
2270 See <quote>+image-blocker{}</quote> below for the control over what is actually sent.
2276 <emphasis>+image</emphasis>
2285 Decides what to do with URLs that end up tagged with <quote>{+block
2286 +image}</quote>. There are 4 options. <quote>-image-blocker</quote> will
2287 send a HTML <quote>blocked</quote> page, usually resulting in a
2288 <quote>broken image</quote> icon. <quote>+image-blocker{logo}</quote> will
2289 send a <quote>JunkBuster</quote> image.
2290 <quote>+image-blocker{blank}</quote> will send a 1x1 transparent GIF image.
2291 And finally, <quote>+image-blocker{http://xyz.com}</quote> will send a HTTP
2292 temporary redirect to the specified image. This has the advantage of the
2293 icon being being cached by the browser, which will speed up the display.
2299 <emphasis>+image-blocker{logo}</emphasis>
2300 <emphasis>+image-blocker{blank}</emphasis>
2301 <emphasis>+image-blocker{http://i.j.b/send-banner}</emphasis>
2310 By default (i.e. in the absence of a <quote>+limit-connect</quote>
2311 action), <application>Junkbuster</application> will only allow CONNECT
2312 requests to port 443, which is the standard port for https as a
2317 The CONNECT methods exists in HTTP to allow access to secure websites
2318 (https:// URLs) through proxies. It works very simply: the proxy
2319 connects to the server on the specified port, and then short-circuits
2320 its connections to the client <emphasis>and</emphasis> to the remote proxy.
2321 This can be a big security hole, since CONNECT-enabled proxies can
2322 be abused as TCP relays very easily.
2326 If you want to allow CONNECT for more ports than this, or want to forbid
2327 CONNECT altogether, you can specify a comma separated list of ports and
2328 port ranges (the latter using dashes, with the minimum defaulting to 0 and
2336 <emphasis>+limit-connect{443} # This is the default and need no be specified.</emphasis>
2337 <emphasis>+limit-connect{80,443} # Ports 80 and 443 are OK.</emphasis>
2338 <emphasis>+limit-connect{-3, 7, 20-100, 500-} # Port less than 3, 7, 20 to 100</emphasis>
2339 <emphasis> #and above 500 are OK.</emphasis>
2349 <quote>+no-compression</quote> prevents the website from compressing the
2350 data. Some websites do this, which can be a problem for
2351 <application>Junkbuster</application>, since <quote>+filter</quote>,
2352 <quote>+no-popup</quote> and <quote>+gif-deanimate</quote> will not work on
2353 compressed data. This will slow down connections to those websites,
2354 though. Default is <quote>nocompression</quote> is turned on.
2361 <emphasis>+nocompression</emphasis>
2370 If the website sets cookies, <quote>no-cookies-keep</quote> will make sure
2371 they are erased when you exit and restart your web browser. This makes
2372 profiling cookies useless, but won't break sites which require cookies so
2373 that you can log in for transactions. Default: on.
2379 <emphasis>+no-cookies-keep</emphasis>
2388 Prevent the website from reading cookies:
2394 <emphasis>+no-cookies-read</emphasis>
2403 Prevent the website from setting cookies:
2409 <emphasis>+no-cookies-set</emphasis>
2418 Filter the website through a built-in filter to disable those obnoxious
2419 JavaScript pop-up windows via window.open(), etc. The two alternative
2420 spellings are equivalent.
2426 <emphasis>+no-popup</emphasis>
2427 <emphasis>+no-popups</emphasis>
2436 This action only applies if you are using a <filename>jarfile</filename>
2437 for saving cookies. It sends a cookie to every site stating that you do not
2438 accept any copyright on cookies sent to you, and asking them not to track
2439 you. Of course, this is a (relatively) unique header they could use to
2446 <emphasis>+vanilla-wafer</emphasis>
2455 This allows you to add an arbitrary cookie. It can be specified multiple
2456 times in order to add as many cookies as you like.
2462 <emphasis>+wafer{name=value}</emphasis>
2473 The meaning of any of the above is reversed by preceding the action with a
2474 <quote>-</quote>, in place of the <quote>+</quote>.
2482 Turn off cookies by default, then allow a few through for specified sites:
2489 # Turn off all persistent cookies
2490 { +no-cookies-read }
2492 # Allow cookies for this browser session ONLY
2493 { +no-cookies-keep }
2495 # Exceptions to the above, sites that benefit from persistent cookies
2496 { -no-cookies-read }
2498 { -no-cookies-keep }
2505 # Alternative way of saying the same thing
2506 {-no-cookies-set -no-cookies-read -no-cookies-keep}
2515 Now turn off <quote>fast redirects</quote>, and then we allow two exceptions:
2525 # Reverse it for these two sites, which don't work right without it.
2527 www.ukc.ac.uk/cgi-bin/wac\.cgi\?
2535 Turn on page filtering, with one exception for sourceforge:
2542 # Run everything through the default filter file (<filename>re_filterfile</filename>):
2545 # But please don't re_filter code from sourceforge!
2547 .cvs.sourceforge.net
2554 Now some URLs that we want <quote>blocked</quote>, ie we won't see them.
2555 Many of these use regular expressions that will expand to match multiple
2565 /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\.(gif|jpe?g))
2566 /.*/(.*[-_.])?count(er)?(\.cgi|\.dll|\.exe|[?/])
2567 /.*/(ng)?adclient\.cgi
2568 /.*/(plain|live|rotate)[-_.]?ads?/
2569 /.*/(sponsor)s?[0-9]?/
2570 /.*/_?(plain|live)?ads?(-banners)?/
2572 /.*/ad(sdna_image|gifs?)/
2573 /.*/ad(server|stream|juggler)\.(cgi|pl|dll|exe)
2577 /.*/adv((er)?ts?|ertis(ing|ements?))?/
2581 /.*/cgi-bin/centralad/getimage
2582 /.*/images/addver\.gif
2583 /.*/images/marketing/.*\.(gif|jpe?g)
2587 /.*/sponsors?[0-9]?/
2588 /.*/advert[0-9]+\.jpg
2595 /graphics/defaultAd/
2597 /image\.ng/transactionID
2598 /images/.*/.*_anim\.gif # alvin brattli
2599 /ip_img/.*\.(gif|jpe?g)
2603 /cgi-bin/nph-adclick.exe/
2604 /.*/Image/BannerAdvertising/
2606 /.*/adlib/server\.cgi
2615 <!-- ~ End section ~ -->
2618 <!-- ~~~~~ New section ~~~~~ -->
2620 <title>Aliases</title>
2622 Custom <quote>actions</quote>, known to <application>Junkbuster</application>
2623 as <quote>aliases</quote>, can be defined by combining other <quote>actions</quote>.
2624 These can in turn be invoked just like the built-in <quote>actions</quote>.
2625 Currently, an alias can contain any character except space, tab, <quote>=</quote>,
2626 <quote>{</quote> or <quote>}</quote>. But please use only <quote>a</quote>-
2627 <quote>z</quote>, <quote>0</quote>-<quote>9</quote>, <quote>+</quote>, and
2628 <quote>-</quote>. Alias names are not case sensitive, and
2629 <emphasis>must be defined before anything</emphasis> else in the
2630 <filename>ijb.action</filename>file ! And there can only be one set of
2631 <quote>aliases</quote> defined.
2635 Now let's define a few aliases:
2642 # Useful customer aliases we can use later. These must come first!
2644 +no-cookies = +no-cookies-set +no-cookies-read
2645 -no-cookies = -no-cookies-set -no-cookies-read
2646 fragile = -block -no-cookies -filter -fast-redirects -hide-referer -no-popups
2647 shop = -no-cookies -filter -fast-redirects
2648 +imageblock = +block +image
2650 #For people who don't like to type too much: ;-)
2653 c2 = -no-cookies-set +no-cookies-read
2654 c3 = +no-cookies-set -no-cookies-read
2655 #... etc. Customize to your heart's content.
2662 Some examples using our <quote>shop</quote> and <quote>fragile</quote>
2670 # These sites are very complex and require
2671 # minimal interference.
2673 .office.microsoft.com
2674 .windowsupdate.microsoft.com
2677 # Shopping sites - still want to block ads.
2680 .worldpay.com # for quietpc.com
2684 # These shops require pop-ups
2696 <!-- ~ End section ~ -->
2699 <!-- ~~~~~ New section ~~~~~ -->
2700 <sect2 id="filterfile">
2701 <title>The Filter File</title>
2703 The filter file defines what filtering of web pages
2704 <application>Junkbuster</application> does. The default filter file is
2705 <filename>re_filterfile</filename>, located in the config directory. In this
2706 file, <emphasis>any document content</emphasis>, whether viewable text or
2707 embedded non-visible content, can be changed.
2711 This file uses regular expressions to alter or remove any string in the
2712 target page. Some examples from the included default <filename>re_filterfile</filename>:
2716 Stop web pages from displaying annoying messages in the status bar by
2717 deleting such references:
2724 # The status bar is for displaying link targets, not pointless buzzwords.
2725 # Again, check it out on http://www.airport-cgn.de/.
2726 s/status='.*?';*//ig
2733 Just for kicks, replace any occurrence of <quote>Microsoft</quote> with
2734 <quote>MicroSuck</quote>:
2741 s/microsoft(?!.com)/MicroSuck/ig
2748 Kill those auto-refresh tags:
2755 # Kill refresh tags. I like to refresh myself. Manually.
2756 # check it out on http://www.airport-cgn.de/ and go to the arrivals page.
2758 s/<meta[^>]*http-equiv[^>]*refresh.*URL=([^>]*?)"?>/<link rev="x-refresh" href=$1>/i
2759 s/<meta[^>]*http-equiv="?page-enter"?[^>]*content=[^>]*>/<!--no page enter for me-->/i
2767 <!-- ~ End section ~ -->
2771 <!-- ~~~~~ New section ~~~~~ -->
2774 <title>Templates</title>
2776 When <application>Junkbuster</application> displays one of its internal
2777 pages, such as a 404 Not Found error page, it uses the appropriate template.
2778 On Linux, BSD, and Unix, these are locate in
2779 <filename>/etc/junkbuster/templates</filename> by default. These may be
2780 customized, if desired.
2787 <!-- ~ End section ~ -->
2791 <!-- ~~~~~ New section ~~~~~ -->
2792 <sect1 id="quickstart"><title>Quickstart to Using Junkbuster</title>
2794 Install package, then run and enjoy! <application>JunkBuster</application>
2795 accepts only one command line option -- the configuration file to be
2796 used. Example Unix startup command:
2802 # /usr/sbin/junkbuster /etc/junkbuster/config
2808 An init script is provided for SuSE and Redhat.
2812 For for SuSE: /etc/rc.d/junkbuster start
2816 For RedHat: /etc/rc.d/init.d/junkbuster start
2821 If no configuration file is specified on the command line,
2822 <application>Junkbuster</application> will look for a file named
2823 <filename>config</filename> in the current directory. Except on Amiga where
2824 it will look for <filename>AmiTCP:db/junkbuster/config</filename> and Win32
2825 where it will try <filename>config.txt</filename>. If no file is specified
2826 on the command line and no default configuration file can be found,
2827 <application>Junkbuster</application> will fail to start.
2831 Be sure your browser is set to use the proxy which is by default at
2832 localhost, port 8000. With <application>Netscape</application> (and
2833 <application>Mozilla</application>), this can be set under <literal>Edit
2834 -> Preferences -> Advanced -> Proxies -> HTTP Proxy</literal>.
2835 For <application>Internet Explorer</application>: <literal>Tools >
2836 Internet Properties -> Connections -> LAN Setting</literal>. Then,
2837 check <quote>Use Proxy</quote> and fill in the appropriate info (Address:
2838 localhost, Port: 8000). Include if HTTPS proxy support too.
2842 The included default configuration files should give a reasonable starting
2843 point, though may be somewhat aggressive in blocking junk. You will probably
2844 want to keep an eye out for sites that require persistent cookies, and add these to
2845 <filename>ijb.action</filename> as needed. By default, most of these will
2846 be accepted only during the current browser session, until you add them to
2847 the configuration. If you want the browser to handle this instead, you will
2848 need to edit <filename>ijb.action</filename> and disable this feature. If you
2849 use more than one browser, it would make more sense to let
2850 <application>Junkbuster</application> handle this. In which case, the
2851 browser(s) should be set to accept all cookies.
2855 If a particular site shows problems loading properly, try adding it
2856 to the <literal>{fragile}</literal> section of
2857 <filename>ijb.action</filename>. This will turn off most actions for
2862 HTTP/1.1 support is not fully implemented. If browsers that
2863 support HTTP/1.1 (like <application>Mozilla</application> or recent versions
2864 of I.E.) experience problems, you might try to force HTTP/1.0 compatibility.
2865 For Mozilla, look under <literal>Edit -> Preferences -> Debug ->
2866 Networking</literal>. Or set the <quote>+downgrade</quote> config option in
2867 <filename>ijb.action</filename>.
2871 After running <application>Junkbuster</application> for a while, you can
2872 start to fine tune the configuration to suit your personal, or site,
2873 preferences and requirements. There are many, many aspects that can
2874 be customized. <quote>Actions</quote> (as specified in <filename>ijb.action</filename>)
2875 can be adjusted by pointing your browser to
2876 <ulink url="http://i.j.b/">http://i.j.b/</ulink>,
2877 and then follow the link to <quote>edit the actions list</quote>.
2878 (This is an internal page and does not require Internet access.)
2882 In fact, various aspects of <application>Junkbuster</application>
2883 configuration can be viewed from this page, including
2884 current configuration parameters, source code version numbers,
2885 the browser's request headers, and <quote>actions</quote> that apply
2886 to a given URL. In addition to the <filename>ijb.action</filename> file
2887 editor mentioned above, <application>Junkbuster</application> can also
2888 be turned <quote>on</quote> and <quote>off</quote> from this page.
2892 If you encounter problems, please verify it is a
2893 <application>Junkbuster</application> bug, by disabling
2894 <application>Junkbuster</application>, and then trying the same page.
2895 Also, try another browser if possible to eliminate browser or site
2896 problems. Before reporting it as a bug, see if there is not a configuration
2897 option that is enabled that is causing the page not to load. You can
2898 then add an exception for that page or site. If a bug, please report it to
2899 the developers (see below).
2905 <!-- ~~~~~ New section ~~~~~ -->
2906 <sect1 id="contact"><title>Contact the Developers</title>
2909 To be filled. mention the support forums as the primary channel of
2910 communication (bugs, feature requests, etc.)
2912 Feature requests and other questions should be posted to the <ulink
2913 url="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse">Feature
2914 request page</ulink> at SourceForge. There is also an archive there.
2918 Anyone interested in actively participating in development and related
2919 discussions can join the appropriate mailing list
2920 <ulink url="http://sourceforge.net/mail/?group_id=11118">here</ulink>.
2921 Archives are available here too.
2925 Please report bugs, using the form at
2926 <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=111118">Sourceforge</ulink>.
2927 Please try to verify that it is a <application>Junkbuster</application> bug,
2928 and not a browser or site bug first. Also, check to make sure this is not
2929 already a known bug.
2935 <!-- ~~~~~ New section ~~~~~ -->
2936 <sect1 id="copyright"><title>Copyright and History</title>
2939 <title>License</title>
2941 <application>Internet Junkbuster</application> is free software; you can
2942 redistribute it and/or modify it under the terms of the GNU General Public
2943 License as published by the Free Software Foundation; either version 2 of the
2944 License, or (at your option) any later version.
2948 This program is distributed in the hope that it will be useful, but WITHOUT
2949 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
2950 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
2951 details, which is available from <ulink
2952 url="http://www.gnu.org/copyleft/gpl.html">the Free Software Foundation,
2953 Inc</ulink>, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
2958 <!-- ~ End section ~ -->
2961 <!-- ~~~~~ New section ~~~~~ -->
2964 <title>History</title>
2966 <application>Junkbuster</application> was originally written by Anonymous
2968 url="http://www.junkbusters.com/ht/en/ijbfaq.html">Junkbuster's
2969 Corporation</ulink>, and was released as free open-source software under the
2970 GNU GPL. <ulink url="http://www.waldherr.org/junkbuster/">Stefan
2971 Waldherr</ulink> made many improvements, and started the <ulink
2972 url="http://sourceforge.net/projects/ijbswa/">SourceForge project</ulink> to
2973 rekindle development. The last stable release was v2.0.2, which has now
2981 <!-- ~~~~~ New section ~~~~~ -->
2982 <sect1 id="seealso"><title>See also</title>
2987 <ulink url="http://sourceforge.net/projects/ijbswa">http://sourceforge.net/projects/ijbswa</ulink>
2992 <ulink url="http://ijbswa.sourceforge.net/">http://ijbswa.sourceforge.net/</ulink>
2997 <ulink url="http://i.j.b/">http://i.j.b/</ulink>
3002 <ulink url="http://www.junkbusters.com/ht/en/cookies.html">http://www.junkbusters.com/ht/en/cookies.html</ulink>
3007 <ulink url="http://www.waldherr.org/junkbuster/">http://www.waldherr.org/junkbuster/</ulink>
3012 <ulink url="http://privacy.net/analyze/">http://privacy.net/analyze/</ulink>
3017 <ulink url="http://www.squid-cache.org/">http://www.squid-cache.org/</ulink>
3026 <!-- ~~~~~ New section ~~~~~ -->
3027 <sect1 id="appendix"><title>Appendix</title>
3030 <!-- ~~~~~ New section ~~~~~ -->
3032 <title>Regular Expressions</title>
3034 <application>Junkbuster</application> can use <quote>regular expressions</quote>
3035 in various config files. Assuming support for <quote>pcre</quote> (Perl
3036 Compatible Regular Expressions) is compiled in, which is the default. Such
3037 configuration directives do not require regular expressions, but they can be
3038 used to increase flexibility by matching a pattern with wild-cards against
3043 If you are reading this, you probably don't understand what <quote>regular
3044 expressions</quote> are, or what they can do. So this will be a very brief
3045 introduction only. A full explanation would require a book ;-)
3049 <quote>Regular expressions</quote> is a way of matching one character
3050 expression against another to see if it matches or not. One of the
3051 <quote>expressions</quote> is a literal string of readable characters
3052 (letter, numbers, etc), and the other is a complex string of literal
3053 characters combined with wild-cards, and other special characters, called
3054 meta-characters. The <quote>meta-characters</quote> have special meanings and
3055 are used to build the complex pattern to be matched against. Perl Compatible
3056 Regular Expressions is an enhanced form of the regular expression language
3057 with backward compatibility.
3061 To make a simple analogy, we do something similar when we use wild-card
3062 characters when listing files with the <command>dir</command> command in DOS.
3063 <literal>*.*</literal> matches all filenames. The <quote>special</quote>
3064 character here is the asterisk which matches any and all characters. We can be
3065 more specific and use <literal>?</literal> to match just individual
3066 characters. So <quote>dir file?.text</quote> would match
3067 <quote>file1.txt</quote>, <quote>file2.txt</quote>, etc. We are pattern
3068 matching, using a similar technique to <quote>regular expressions</quote>!
3072 Regular expressions do essentially the same thing, but are much, much more
3073 powerful. There are many more <quote>special characters</quote> and ways of
3074 building complex patterns however. Let's look at a few of the common ones,
3075 and then some examples:
3080 <emphasis>.</emphasis> - Matches any single character, e.g. <quote>a</quote>,
3081 <quote>A</quote>, <quote>4</quote>, <quote>:</quote>, or <quote>@</quote>.
3087 <emphasis>?</emphasis> - The preceding character or expression is matched ZERO or ONE
3094 <emphasis>+</emphasis> - The preceding character or expression is matched ONE or MORE
3101 <emphasis>*</emphasis> - The preceding character or expression is matched ZERO or MORE
3108 <emphasis>\</emphasis> - The <quote>escape</quote> character denotes that
3109 the following character should be taken literally. This is used where one of the
3110 special characters (e.g. <quote>.</quote>) needs to be taken literally and
3111 not as a special meta-character.
3117 <emphasis>[]</emphasis> - Characters enclosed in brackets will be matched if
3118 any of the enclosed characters are encountered.
3124 <emphasis>()</emphasis> - parentheses are used to group a sub-expression,
3125 or multiple sub-expressions.
3131 <emphasis>|</emphasis> - The <quote>bar</quote> character works like an
3132 <quote>or</quote> conditional statement. A match is successful if the
3133 sub-expression on either side of <quote>|</quote> matches.
3139 <emphasis>s/string1/string2/g</emphasis> - This is used to rewrite strings of text.
3140 <quote>string1</quote> is replaced by <quote>string2</quote> in this
3146 These are just some of the ones you are likely to use when matching URLs with
3147 <application>Junkbuster</application>, and is a long way from a definitive
3148 list. This is enough to get us started with a few simple examples which may
3149 be more illuminating:
3153 <emphasis><literal>/.*/banners/.*</literal></emphasis> - A simple example
3154 that uses the common combination of <quote>.</quote> and <quote>*</quote> to
3155 denote any character, zero or more times. In other words, any string at all.
3156 So we start with a literal forward slash, then our regular expression pattern
3157 (<quote>.*</quote>) another literal forward slash, the string
3158 <quote>banners</quote>, another forward slash, and lastly another
3159 <quote>.*</quote>. We are building
3160 a directory path here. This will match any file with the path that has a
3161 directory named <quote>banners</quote> in it. The <quote>.*</quote> matches
3162 any characters, and this could conceivably be more forward slashes, so it
3163 might expand into a much longer looking path. For example, this could match:
3164 <quote>/eye/hate/spammers/banners/annoy_me_please.gif</quote>, or just
3165 <quote>/banners/annoying.html</quote>, or almost an infinite number of other
3166 possible combinations, just so it has <quote>banners</quote> in the path
3171 A now something a little more complex:
3175 <emphasis><literal>/.*/adv((er)?ts?|ertis(ing|ements?))?/</literal></emphasis> -
3176 We have several literal forward slashes again (<quote>/</quote>), so we are
3177 building another expression that is a file path statement. We have another
3178 <quote>.*</quote>, so we are matching against any conceivable sub-path, just so
3179 it matches our expression. The only true literal that <emphasis>must
3180 match</emphasis> our pattern is <application>adv</application>, together with
3181 the forward slashes. What comes after the <quote>adv</quote> string is the
3186 Remember the <quote>?</quote> means the preceding expression (either a
3187 literal character or anything grouped with <quote>(...)</quote> in this case)
3188 can exist or not, since this means either zero or one match. So
3189 <quote>((er)?ts?|ertis(ing|ements?))</quote> is optional, as are the
3190 individual sub-expressions: <quote>(er)</quote>,
3191 <quote>(ing|ements?)</quote>, and the <quote>s</quote>. The <quote>|</quote>
3192 means <quote>or</quote>. We have two of those. For instance,
3193 <quote>(ing|ements?)</quote>, can expand to match either <quote>ing</quote>
3194 <emphasis>OR</emphasis> <quote>ements?</quote>. What is being done here, is an
3195 attempt at matching as many variations of <quote>advertisement</quote>, and
3196 similar, as possible. So this would expand to match just <quote>adv</quote>,
3197 or <quote>advert</quote>, or <quote>adverts</quote>, or
3198 <quote>advertising</quote>, or <quote>advertisement</quote>, or
3199 <quote>advertisements</quote>. You get the idea. But it would not match
3200 <quote>advertizements</quote> (with a <quote>z</quote>). We could fix that by
3201 changing our regular expression to:
3202 <quote>/.*/adv((er)?ts?|erti(s|z)(ing|ements?))?/</quote>, which would then match
3207 <emphasis><literal>/.*/advert[0-9]+\.(gif|jpe?g)</literal></emphasis> - Again
3208 another path statement with forward slashes. Anything in the square brackets
3209 <quote>[]</quote> can be matched. This is using <quote>0-9</quote> as a
3210 shorthand expression to mean any digit one through nine. It is the same as
3211 saying <quote>0123456789</quote>. So any digit matches. The <quote>+</quote>
3212 means one or more of the preceding expression must be included. The preceding
3213 expression here is what is in the square brackets -- in this case, any digit
3214 one through nine. Then, at the end, we have a grouping: <quote>(gif|jpe?g)</quote>.
3215 This includes a <quote>|</quote>, so this needs to match the expression on
3216 either side of that bar character also. A simple <quote>gif</quote> on one side, and the other
3217 side will in turn match either <quote>jpeg</quote> or <quote>jpg</quote>,
3218 since the <quote>?</quote> means the letter <quote>e</quote> is optional and
3219 can be matched once or not at all. So we are building an expression here to
3220 match image GIF or JPEG type image file. It must include the literal
3221 string <quote>advert</quote>, then one or more digits, and a <quote>.</quote>
3222 (which is now a literal, and not a special character, since it is escaped
3223 with <quote>\</quote>), and lastly either <quote>gif</quote>, or
3224 <quote>jpeg</quote>, or <quote>jpg</quote>. Some possible matches would
3225 include: <quote>//advert1.jpg</quote>,
3226 <quote>/nasty/ads/advert1234.gif</quote>,
3227 <quote>/banners/from/hell/advert99.jpg</quote>. It would not match
3228 <quote>advert1.gif</quote> (no leading slash), or
3229 <quote>/adverts232.jpg</quote> (the expression does not include an
3230 <quote>s</quote>), or <quote>/advert1.jsp</quote> (<quote>jsp</quote> is not
3231 in the expression anywhere).
3235 <emphasis><literal>s/microsoft(?!.com)/MicroSuck/i</literal></emphasis> - This is
3236 a substitution. <quote>MicroSuck</quote> will replace any occurrence of
3237 <quote>microsoft</quote>. The <quote>i</quote> at the end of the expression
3238 means ignore case. The <quote>(?!.com)</quote> means
3239 the match should fail if <quote>microsoft</quote> is followed by
3240 <quote>.com</quote>. In other words, this acts like a <quote>NOT</quote>
3241 modifier. In case this is a hyperlink, we don't want to break it ;-).
3245 We are barely scratching the surface of regular expressions here so that you
3246 can understand the default <application>Junkbuster</application>
3247 configuration files, and maybe use this knowledge to customize your own
3248 installation. There is much, much more that can be done with regular
3249 expressions. Now that you know enough to get started, you can learn more on
3254 More reading on Perl Compatible Regular expressions:
3255 <ulink url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>
3264 This program is free software; you can redistribute it
3265 and/or modify it under the terms of the GNU General
3266 Public License as published by the Free Software
3267 Foundation; either version 2 of the License, or (at
3268 your option) any later version.
3270 This program is distributed in the hope that it will
3271 be useful, but WITHOUT ANY WARRANTY; without even the
3272 implied warranty of MERCHANTABILITY or FITNESS FOR A
3273 PARTICULAR PURPOSE. See the GNU General Public
3274 License for more details.
3276 The GNU General Public License should be included with
3277 this file. If not, you can view it at
3278 http://www.gnu.org/copyleft/gpl.html
3279 or write to the Free Software Foundation, Inc., 59
3280 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
3282 $Log: user-manual.sgml,v $
3283 Revision 1.30 2002/03/02 22:00:14 hal9
3284 Updated 'New Features' list. Ran through spell-checker.
3286 Revision 1.29 2002/03/02 20:34:07 david__schmidt
3287 Update OS/2 build section
3289 Revision 1.28 2002/02/24 14:34:24 jongfoster
3290 Formatting changes. Now changing the doctype to DocBook XML 4.1
3291 will work - no other changes are needed.
3293 Revision 1.27 2002/01/11 14:14:32 hal9
3294 Added a very short section on Templates
3296 Revision 1.26 2002/01/09 20:02:50 hal9
3297 Fix bug re: auto-detect config file changes.
3299 Revision 1.25 2002/01/09 18:20:30 hal9
3300 Touch ups for *.action files.
3302 Revision 1.24 2001/12/02 01:13:42 hal9
3305 Revision 1.23 2001/12/02 00:20:41 hal9
3306 Updates for recent changes.
3308 Revision 1.22 2001/11/05 23:57:51 hal9
3309 Minor update for startup now daemon mode.
3311 Revision 1.21 2001/10/31 21:11:03 hal9
3312 Correct 2 minor errors
3314 Revision 1.18 2001/10/24 18:45:26 hal9
3315 *** empty log message ***
3317 Revision 1.17 2001/10/24 17:10:55 hal9
3318 Catching up with Jon's recent work, and a few other things.
3320 Revision 1.16 2001/10/21 17:19:21 swa
3321 wrong url in documentation
3323 Revision 1.15 2001/10/14 23:46:24 hal9
3324 Various minor changes. Fleshed out SEE ALSO section.
3326 Revision 1.13 2001/10/10 17:28:33 hal9
3329 Revision 1.12 2001/09/28 02:57:04 hal9
3332 Revision 1.11 2001/09/28 02:25:20 hal9
3335 Revision 1.9 2001/09/27 23:50:29 hal9
3336 A few changes. A short section on regular expression in appendix.
3338 Revision 1.8 2001/09/25 00:34:59 hal9
3339 Some additions, and re-arranging.
3341 Revision 1.7 2001/09/24 14:31:36 hal9
3344 Revision 1.6 2001/09/24 14:10:32 hal9
3345 Including David's OS/2 installation instructions.
3347 Revision 1.2 2001/09/13 15:27:40 swa
3350 Revision 1.1 2001/09/12 15:36:41 swa
3351 source files for junkbuster documentation
3353 Revision 1.3 2001/09/10 17:43:59 swa
3354 first proposal of a structure.
3356 Revision 1.2 2001/06/13 14:28:31 swa
3357 docs should have an author.
3359 Revision 1.1 2001/06/13 14:20:37 swa
3360 first import of project's documentation for the webserver.