1 <!DOCTYPE Article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
3 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
4 File : $Source: /cvsroot/ijbswa/current/doc/source/user-manual.sgml,v $
8 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
10 $Id: user-manual.sgml,v 1.2 2001/09/13 15:27:40 swa Exp $
12 Written by and Copyright (C) 2001 the SourceForge
13 IJBSWA team. http://ijbswa.sourceforge.net
15 Based on the Internet Junkbuster originally written
16 by and Copyright (C) 1997 Anonymous Coders and
17 Junkbusters Corporation. http://www.junkbusters.com
21 Sun 09/23/01 08:53:31 PM
23 This is an unfinished, rough draft. Anyone reading this, believe let me
24 know errors!!!!! Stefan, especially you!
26 Hal Burgiss <hal@foobox.net>
31 <title>Junkbuster User Manual</title>
33 <pubdate>$Id: user-manual.sgml,v 1.2 2001/09/13 15:27:40 swa Exp $</pubdate>
38 <orgname>By: Junkbuster Developers</orgname>
45 The user manual gives the users information on how to install and configure
46 <application>Internet Junkbuster</application>. <application>Internet
47 Junkbuster</application> is an application that provides privacy and
48 security to users of the World Wide Web.
51 You can find the latest version of the user manual at <ulink url="http://ijbswa.sourceforge.net/doc/user-manual/">http://ijbswa.sourceforge.net/doc/user-manual/</ulink>.
55 Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>.
62 <!-- ~~~~~ New section ~~~~~ -->
64 <sect1 id="introduction"><title>Introduction</title>
66 <application>Internet Junkbuster</application> is a web proxy with advanced
67 filtering capabilities for protecting privacy, filtering web page content,
68 managing cookies and removing ads, banners, pop-ups and other obnoxious
69 Internet Junk. <application>Junkbuster</application> has a very flexible
70 configuration and can be customized to suit individual needs and tastes.
71 <application>Internet Junkbuster</application> has application for both
72 stand-alone systems and multi-user networks.
76 This documentation is included with the current development version of
77 <application>Internet Junkbuster</application> and is incomplete at this
78 point. The most up to date reference for the time being is still the comments
79 in the source files and in the individual configuration files. Development
80 of version 3.0 is currently underway, and includes significant changes and
81 enhancements over earlier verions.
85 Since this is a development version, there <emphasis>are</emphasis> bugs!
88 <!-- ~~~~~ New section ~~~~~ -->
91 <title>License</title>
93 <application>Internet Junkbuster</application> is free software; you can
94 redistribute it and/or modify it under the terms of the GNU General Public
95 License as published by the Free Software Foundation; either version 2 of the
96 License, or (at your option) any later version.
100 This program is distributed in the hope that it will be useful, but WITHOUT
101 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
102 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
103 details, which is available from <ulink
104 url="http://www.gnu.org/copyleft/gpl.html">the Free Software Foundation,
105 Inc</ulink>, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
110 <!-- ~ End section ~ -->
113 <!-- ~~~~~ New section ~~~~~ -->
116 <title>History</title>
118 <application>Junkbuster</application> was originally written by Anonymouse
120 url="http://www.junkbusters.com/ht/en/ijbfaq.html">JunkBusters
121 Corporation</ulink>, and was released as free open-source software under the
122 GNU GPL. <ulink url="http://www.waldherr.org/junkbuster/">Stefan
123 Waldherr</ulink> made many improvements, and started the <ulink
124 url="http://sourceforge.net/projects/ijbswa/">SourceForge project</ulink> to
125 rekindle development. The last stable release was v2.0.2.
132 <!-- ~ End section ~ -->
135 <!-- ~~~~~ New section ~~~~~ -->
136 <sect1 id="installation"><title>Installation</title>
138 <application>Junkbuster</application> is available as raw source code, or
139 pre-compiled binaries. See the <ulink
140 url="http://sourceforge.net/projects/ijbswa/">Junkbuster Home Page</ulink>
141 for current releases. <application>Junkbuster</application> is also available
143 url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/">CVS</ulink>.
144 This is the recommended approach at this time.
147 <!-- ~~~~~ New section ~~~~~ -->
148 <sect2 id="installation-source"><title>Source</title>
150 For gzipped tar archives, unpack the source:
155 tar zxvf ijb_source_2.9*
161 For retrieving the current CVS sources, you'll need the CVS
162 package installed first. To download CVS source:
167 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
168 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
174 This will create a directory named <filename>current/</filename>, which will
175 contain the source tree.
179 Then, in either case, to build from source:
192 For Redhat and SuSE Linux RPM packages, see below.
198 <!-- ~~~~~ New section ~~~~~ -->
199 <sect2 id="installation-rh"><title>Red Hat</title>
201 To build Redhat RPM packages, install source as above. Then:
212 This will create both binary and src RPMs in the usual places. Example:
216 /usr/src/redhat/RPMS/i686/junkbuster-2.9.8-1.i686.rpm
219 /usr/src/redhat/SRPMS/junkbuster-2.9.8-1.src.rpm
223 To install, of course:
228 rpm -Uvv /usr/src/redhat/RPMS/i686/junkbuster-2.9.8-1.i686.rpm
233 This will place the <application>Junkbuster</application> configuration
234 files in <filename>/etc/junkbuster/</filename>, and log files in
235 <filename>/var/log/junkbuster/</filename>.
240 <!-- ~~~~~ New section ~~~~~ -->
241 <sect2 id="installation-suse"><title>SuSE</title>
243 To build SuSE RPM packages, install source as above. Then:
254 This will create both binary and src RPMs in the usual places. Example:
258 /usr/src/suse/RPMS/i686/junkbuster-2.9.8-1.i686.rpm
261 /usr/src/suse/SRPMS/junkbuster-2.9.8-1.src.rpm
265 To install, of course:
270 rpm -Uvv /usr/src/suse/RPMS/i686/junkbuster-2.9.8-1.i686.rpm
275 This will place the <application>Junkbuster</application> configuration
276 files in <filename>/etc/junkbuster/</filename>, and log files in
277 <filename>/var/log/junkbuster/</filename>.
283 <!-- ~~~~~ New section ~~~~~ -->
284 <sect2 id="installation-os2"><title>OS/2</title>
291 The OS/2 version of <application>Junkbuster</application> requires the EMX
292 runtime library to be installed. The EMX runtime library is available on
293 the hobbes OS/2 archive, among many other locations:
294 <ulink url="http://hobbes.nmsu.edu/cgi-bin/h-search?sh=1&button=Search&key=emxrt.zip&stype=all&sort=type&dir=%2Fpub%2Fos2%2Fdev%2Femx%2Fv0.9d">http://hobbes.nmsu.edu/cgi-bin/h-search?sh=1&button=Search&key=emxrt.zip&stype=all&sort=type&dir=%2Fpub%2Fos2%2Fdev%2Femx%2Fv0.9d</ulink>
298 <application>Junkbuster</application> is packaged in a WarpIN self-
299 installing archive. The self-installing program will be named depending
300 on the release version, something like:
301 <filename>ijbos123.exe</filename>. In order to install it, simply run
302 this executable or double-click on its icon and follow the WarpIN
303 installation panels. A shadow of the <application>Junkbuster</application>
304 executable will be placed in your startup folder so it will start
305 automatically whenever OS/2 starts.
309 The directory you choose to install <application>Junkbuster</application>
310 into will contain all of the configuration files.
314 If you would like to build binary images on OS/2 yourself, you will need
315 a working EMX/GCC environment, plus several Unix-like tools. The Hobbes
316 OS/2 archive is a good place to start when building such an environment.
317 A set of Unix-like tools named gnupack is located here:
318 <ulink url="http://hobbes.nmsu.edu/cgi-bin/h-search?sh=1&key=gnupack&stype=all&sort=type&dir=%2Fpub%2Fos2%2Fapps">http://hobbes.nmsu.edu/cgi-bin/h-search?sh=1&key=gnupack&stype=all&sort=type&dir=%2Fpub%2Fos2%2Fapps</ulink>
321 Once you have the source code unpacked as above, you can build the binaries
322 from the <filename>current/</filename> directory:
336 <!-- ~~~~~ New section ~~~~~ -->
337 <sect2 id="installation-win"><title>Windows</title>
338 <para>I need help on this. Not a clue here. Also for
339 configuration section below.
343 <!-- ~~~~~ New section ~~~~~ -->
344 <sect2 id="installation-other"><title>Other</title>
345 <para>I need help on this too. What others?
351 <!-- ~ End section ~ -->
354 <!-- ~~~~~ New section ~~~~~ -->
355 <sect1 id="configuration"><title>Junkbuster Configuration</title>
357 For Unix and Linux, all configuraton files are located in
358 <filename>/etc/junkbuster/</filename> by default. For MS Windows, these
359 are all in the same directory as the <application>Junkbuster</application>
360 executable. The name and number of configuration files has changed from
361 previous versions, and is subject to change as development progresses.
365 The installed defaults provide a reasonable starting point. For the
366 time being, there are only three default configuration files (this will
375 The main configuration file is named <filename>config</filename>
376 on Linux and Unix, and <filename>junkbustr.txt</filename> on Windows.
382 The <filename>actionsfile</filename> file is used to define various
383 actions relating to images, banners, pop-ups, banners and cookies.
389 The <filename>re_filterfile</filename> file can be used to rewrite the raw
390 page content, including text as well as embedded HTML and JavaScript.
398 <filename>actionsfile</filename> and <filename>re_filterfile</filename>
399 can use Perl style regular expressions for maximum flexibility. All files use
400 the <quote><literal>#</literal></quote> character to denote a comment. Such
401 lines are not processed by <application>Junkbuster</application>. After
402 making any changes, restart <application>Junkbuster</application> in order
403 for the changes to take effect.
407 <!-- ~~~~~ New section ~~~~~ -->
410 <title>The Main Configuration File</title>
412 Again, the main configuration file is named <filename>config</filename> on
413 Linux and Unix, and <filename>junkbustr.txt</filename> on Windows.
414 Configuration lines consist of an initial keyword followed by a list of
415 values, all separated by whitespace (any number of spaces or tabs). For
423 <emphasis>blockfile blocklist.ini</emphasis>
430 Indicates that the blockfile is named <quote>blocklist.ini</quote>.
434 The <quote><literal>#</literal></quote> indicates a comment. Any part of a
435 line following a <quote><literal>#</literal></quote> is ignored, except if
436 the <quote><literal>#</literal></quote> is preceded by a
437 <quote><literal>\</literal></quote>.
441 Thus, by placing a <quote><literal>#</literal></quote> at the start of an
442 existing configuration line, you can make it a comment and it will be treated
443 as if it weren't there. This is called <quote>commenting out</quote> an
444 option and can be useful to turn off features: If you comment out the
445 <quote>logfile</quote> line, <application>junkbuster</application> will not
446 log to a file at all. Watch for the <quote>default:</quote> section in each
447 explanation to see what happens if the option is left unset (or commented
452 Long lines can be continued on the next line by using a
453 <quote><literal>\</literal></quote> as the very last character.
457 There are various aspects of <application>Junkbuster</application> behavior
458 that can be adjusted.
462 <!-- ~~~~~ New section ~~~~~ -->
465 <title>Defining Other Configuration Files</title>
468 <application>Junkbuster</application> can use a number of other files to tell it
469 what ads to block, what cookies to accept, etc. This section of the
470 configuration file tells <application>Junkbuster</application> where to find
471 all those other files.
475 On <application>Windows</application>, <application>Junkbuster</application>
476 looks for these files in the same directory as the executable. On Unix,
477 <application>Junkbuster</application> looks for these files in the current
478 working directory. In either case, an absolute path name can be used to
483 When development goes modular and multiuser, the blocker, filter, and
484 per-user config will be stored in subdirectories of <quote>confdir</quote>.
485 For now, only <filename>confdir/templates</filename> is used for storing HTML
486 templates for CGI results.
490 The location of the configuration files:
497 <emphasis>confdir /etc/junkbuster</emphasis> # No trailing /, please.
504 The directory where all logging (i.e. <filename>logfile</filename> and
505 <filename>jarfile</filename>) takes place. No trailing
506 <quote><literal>/</literal></quote>, please:
513 <emphasis>logdir /var/log/junkbuster</emphasis>
520 Note that all file specifications below are relative to
521 the above two directories!
525 The <quote>actionsfile</quote> contains patterns to specify the actions to
526 apply to requests for each site. Default: Cookies to and from all
527 destinations are filtered. Popups are disabled for all sites. All sites are
528 filtered if re_filterfile specified. No sites are blocked. An empty image is
529 displayed for filtered ads and other images (formerly
530 <quote>tinygif</quote>). The syntax of this file is explained in detail
531 <link linkend="actionsfile">below</link>.
538 <emphasis>actionsfile actionsfile</emphasis>
545 The <quote>re_filterfile</quote> file contains content modification rules.
546 These rules permit powerful changes on the content of Web pages, e.g., you
547 could disable your favourite JavaScript annoyances, rewrite the actual
548 content, or just have some fun replacing <quote>Microsoft</quote> with
549 <quote>MicroSuck</quote> wherever it appears on a Web page. Default: No
550 content modification, or whatever the developers are playing with :-/
557 <emphasis>re_filterfile re_filterfile</emphasis>
564 The logfile is where all logging and error messages are written. The logfile
565 can be useful for tracking down a problem with
566 <application>Junkbuster</application> (e.g., it's not blocking an ad you
567 think it should block) but in most cases you probably will never look at it.
571 Your logfile will grow indefinitely, and you will probably want to
572 periodically remove it. On Unix systems, you can do this with a cron job
573 (see <quote>man cron</quote>). For Redhat, a <command>logrotate</command>
574 script has been included.
578 On SuSE Linux systems, you can place a line like <quote>/var/log/junkbuster.*
579 +1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
580 the effect that cron.daily will automatically archive, gzip, and empty the
581 log, when it exceeds 1M size.
585 Default: Log to the a file named <filename>logfile</filename>.
586 Comment out to disable logging.
593 <emphasis>logfile logfile</emphasis>
600 The <quote>jarfile</quote> defines where
601 <application>Junkbuster</application> stores the cookies it intercepts. Note
602 that if you use a <quote>jarfile</quote>, it may grow quite large. Default:
603 Don't store intercepted cookies.
610 <emphasis>#jarfile jarfile</emphasis>
617 If you specify a <quote>trustfile</quote>,
618 <application>Junkbuster</application> will only allow access to sites that
619 are named in the trustfile. You can also mark sites as trusted referrers,
620 with the effect that access to untrusted sites will be granted, if a link
621 from a trusted referrer was used. The link target will then be added to the
622 <quote>trustfile</quote>. This is a very restrictive feature that typical
623 users most propably want to leave disabled. Default: Disabled, don't use the
631 <emphasis>#trustfile trust</emphasis>
638 If you use the trust mechanism, it is a good idea to write up some online
639 documentation about your blocking policy and to specify the URL(s) here. They
640 will appear on the page that your users receive when they try to access
641 untrusted content. Use multiple times for multiple URLs. Default: Don't
642 display links on the <quote>untrusted</quote> info page.
649 <emphasis>trust-info-url http://www.your-site.com/why_we_block.html</emphasis>
650 <emphasis>trust-info-url http://www.your-site.com/what_we_allow.html</emphasis>
658 <!-- ~ End section ~ -->
662 <!-- ~~~~~ New section ~~~~~ -->
665 <title>Other Configuration Options</title>
668 This part of the configuration file contains options that control how
669 <application>Junkbuster</application> operates.
673 <quote>Admin-address</quote> should be set to the email address of the proxy
674 administrator. It is used in many of the proxy-generated pages. Default:
682 <emphasis>#admin-address fill@me.in.please</emphasis>
689 <quote>Proxy-info-url</quote> can be set to a URL that contains more info
690 about this <application>Junkbuster</application> installation, it's
691 configuration and policies. It is used in many of the proxy-generated pages
692 and its use is highly recommended in multi-user installations, since your
693 users will want to know why certain content is blocked or modified. Default:
694 Don't show a link to online documentation.
701 <emphasis>proxy-info-url http://www.your-site.com/proxy.html</emphasis>
708 <quote>Listen-address</quote> specifies the address and port where
709 <application>Junkbuster</application> will listen for connections from your
710 Web browser. The default is to listen on the localhost port 8000, and
711 this is suitable for most users. (In your web browser, under proxy
712 configuration, list the proxy server as <quote>localhost</quote> and the
713 port as <quote>8000</quote>).
717 If you already have another service running on port 8000, or if you want to
718 serve requests from other machines (e.g. on your local network) as well, you
719 will need to override the default. The syntax is
720 <quote>listen-address [<ip-address>]:<port></quote>. If you leave
721 out the IP adress, <application>junkbuster</application> will bind to all
722 interfaces (addresses) on your machine and may become reachable from the
723 internet. In that case, consider using access control lists (acl's) (see
724 <quote>aclfile</quote> above).
728 For example, suppose you are running <application>Junkbuster</application> on
729 a machine which has the address 192.168.0.1 on your local private network
730 (192.168.0.0) and has another outside connection with a different address.
731 You want it to serve requests from inside only:
738 <emphasis>listen-address 192.168.0.1:8000</emphasis>
745 If you want it to listen on all addresses (including the outside
753 <emphasis>listen-address :8000</emphasis>
760 If you do this, consider using ACLs (see <quote>aclfile</quote> above). Note:
761 you will need to point your browser(s) to the address and port that you have
762 configured here. Default: localhost:8000 (127.0.0.1:8000).
766 The debug option sets the level of debugging information to log in the
767 logfile (and to the console in the Windows version). A debug level of 1 is
768 informative because it will show you each request as it happens. Higher
769 levels of debug are probably only of interest to developers.
776 debug 1 # GPC = show each GET/POST/CONNECT request
777 debug 2 # CONN = show each connection status
778 debug 4 # IO = show I/O status
779 debug 8 # HDR = show header parsing
780 debug 16 # LOG = log all data into the logfile
781 debug 32 # FRC = debug force feature
782 debug 64 # REF = debug regular expression filter
783 debug 128 # = debug fast redirects
784 debug 256 # = debug GIF deanimation
785 debug 512 # CLF = Common Log Format
786 debug 1024 # = debug kill popups
787 debug 4096 # INFO = Startup banner and warnings.
788 debug 8192 # ERROR = Non-fatal errors
795 It is <emphasis>highly recommended</emphasis> that you enable ERROR
796 reporting (debug 8192), at least until the next stable release.
800 The reporting of FATAL errors (i.e. ones which crash
801 <application>JunkBuster</application>) is always on and cannot be disabled.
805 If you want to use CLF (Common Log Format), you should set <quote>debug
806 512</quote> ONLY, do not enable anything else.
810 Multiple <quote>debug</quote> directives, are OK - they're logical-OR'd
818 <emphasis>debug 15 # same as setting the first 4 listed above</emphasis>
832 <emphasis>debug 1 # URLs</emphasis>
833 <emphasis>debug 4096 # Info</emphasis>
834 <emphasis>debug 8192 # Errors - *we highly recommended enabling this*</emphasis>
841 <application>Junkbuster</application> normally uses
842 <quote>multi-threading</quote>, a software technique that permits it to
843 handle many different requests simultaneously. In some cases you may wish to
844 disable this -- particularly if you're trying to debug a problem. The
845 <quote>single-threaded</quote> option forces
846 <application>Junkbuster</application> to handle requests sequentially.
847 Default: Multi-threaded mode.
854 <emphasis>#single-threaded</emphasis>
861 <quote>toggle</quote> allows you to temporarily disable all
862 <application>Junkbuster's</application> filtering. Just set <quote>toggle
867 The Windows version of <application>Junkbuster</application> puts an icon in
868 the system tray, which allows you to change this option without having to
869 edit this file. If you right-click on that icon (or select the
870 <quote>Options</quote> menu), one choice is <quote>Enable</quote>. Clicking
871 on enable toggles <application>Junkbuster</application> on and off. This is
872 useful if you want to temporarily disable
873 <application>Junkbuster</application>, e.g., to access a site that requires
874 cookies which you normally have blocked.
878 <quote>toggle 1</quote> means <application>Junkbuster</application> runs
879 normally, <quote>toggle 0</quote> means that
880 <application>Junkbuster</application> becomes a non-anonymizing non-blocking
888 <emphasis>toggle 1</emphasis>
896 <!-- ~ End section ~ -->
899 <!-- ~~~~~ New section ~~~~~ -->
902 <title>Access Control List (ACL)</title>
904 Access controls are included at the request of some ISPs and systems
905 administrators, and are not usually needed by individual users. Please note
906 the warnings in the FAQ that this proxy is not intended to be a substitute
907 for a firewall or to encourage anyone to defer addressing basic security
912 If no access settings are specified, the proxy talks to anyone that
913 connects. If any access settings file are specified, then the proxy
914 talks only to IP addresses permitted somewhere in this file and not
915 denied later in this file.
919 Summary -- if using an ACL:
924 Client must have permission to receive service.
929 LAST match in ACL wins.
934 Default behavior is to deny service.
939 The syntax for an entry in the Access Control List is:
946 ACTION SRC_ADDR[/SRC_MASKLEN] [ DST_ADDR[/DST_MASKLEN] ]
953 Where the individual fields are:
960 <emphasis>ACTION</emphasis> = <quote>permit-access</quote> or <quote>deny-access</quote>
962 <emphasis>SRC_ADDR</emphasis> = client hostname or dotted IP address
963 <emphasis>SRC_MASKLEN</emphasis> = number of bits in the subnet mask for the source
965 <emphasis>DST_ADDR</emphasis> = server or forwarder hostname or dotted IP address
966 <emphasis>DST_MASKLEN</emphasis> = number of bits in the subnet mask for the target
974 The field separator (FS) is whitespace (space or tab).
978 IMPORTANT NOTE: If the <application>junkbuster</application> is using a
979 forwarder (see below) or a gateway for a particular destination URL, the
980 <literal>DST_ADDR</literal> that is examined is the address of the forwarder
981 or the gateway and <emphasis>NOT</emphasis> the address of the ultimate
982 target. This is necessary because it may be impossible for the local
983 <application>Junkbuster</application> to determine the address of the
984 ultimate target (that's often what gateways are used for).
988 Here are a few examples to show how the ACL features work:
992 <quote>localhost</quote> is OK -- no DST_ADDR implies that
993 <emphasis>ALL</emphasis> destination addresses are OK:
1000 <emphasis>permit-access localhost</emphasis>
1007 A silly example to illustrate permitting any host on the class-C subnet with
1008 <application>Junkbuster</application> to go anywhere:
1015 <emphasis>permit-access www.junkbusters.com/24</emphasis>
1022 Except deny one particular IP address from using it at all:
1029 <emphasis>deny-access ident.junkbusters.com</emphasis>
1036 You can also specify an explicit network address and subnet mask.
1037 Explicit addresses do not have to be resolved to be used.
1044 <emphasis>permit-access 207.153.200.0/24</emphasis>
1051 A subnet mask of 0 matches anything, so the next line permits everyone.
1058 <emphasis>permit-access 0.0.0.0/0</emphasis>
1065 Note, you <emphasis>cannot</emphasis> say:
1072 <emphasis>permit-access .org</emphasis>
1079 to allow all *.org domains. Every IP address listed must resolve fully.
1083 An ISP may want to provide a <application>Junkbuster</application> that is
1084 accessible by <quote>the world</quote> and yet restrict use of some of their
1085 private content to hosts on its internal network (i.e. its own subscribers).
1086 Say, for instance the ISP owns the Class-B IP address block 123.124.0.0 (a 16
1087 bit netmask). This is how they could do it:
1094 <emphasis>permit-access 0.0.0.0/0 0.0.0.0/0</emphasis> # other clients can go anywhere
1095 # with the following exceptions:
1097 <emphasis>deny-access</emphasis> 0.0.0.0/0 123.124.0.0/16 # block all external requests for
1098 # sites on the ISP's network
1100 <emphasis>permit 0.0.0.0/0 www.my_isp.com</emphasis> # except for the ISP's main
1103 <emphasis>permit 123.124.0.0/16 0.0.0.0/0</emphasis> # the ISP's clients can go
1111 Note that if some hostnames are listed with multiple IP addresses,
1112 the primary value returned by DNS (via gethostbyname()) is used. Default:
1113 Anyone can access the proxy.
1118 <!-- ~ End section ~ -->
1121 <!-- ~~~~~ New section ~~~~~ -->
1124 <title>Forwarding</title>
1127 This feature allows routing of HTTP requests via multiple proxies.
1128 It can be used to better protect privacy and confidentiality when
1129 accessing specific domains by routing requests to those domains
1130 to a special purpose filtering proxy such as lpwa.com.
1134 It can also be used in an environment with multiple networks to route
1135 requests via multiple gateways allowing transparent access to multiple
1136 networks without having to modify browser configurations.
1140 Also specified here are SOCKS proxies. <application>Junkbuster</application>
1141 SOCKS 4 and SOCKS 4A. The difference is that SOCKS 4A will resolve the target
1142 hostname using DNS on the SOCKS server, not our local DNS client.
1146 The syntax of each line is:
1153 <emphasis>forward target_domain[:port] http_proxy_host[:port]</emphasis>
1154 <emphasis>forward-socks4 target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1155 <emphasis>forward-socks4a target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1162 If http_proxy_host is <quote>.</quote>, then requests are not forwarded to a
1163 HTTP proxy but are made directly to the web servers.
1167 Lines are checked in sequence, and the last match wins.
1171 There is an implicit line equivalent to the following, which specifies that
1172 anything not finding a match on the list is to go out without forwarding
1173 or gateway protocol, like so:
1180 <emphasis>forward .* . </emphasis># implicit
1187 In the following common configuration, everything goes to Lucent's LPWA,
1188 except SSL on port 443 (which it doesn't handle):
1195 <emphasis>forward .* lpwa.com:8000</emphasis>
1196 <emphasis>forward :443 .</emphasis>
1203 See the FAQ for instructions on how to automate the login procedure for LPWA.
1204 Some users have reported difficulties related to LPWA's use of
1205 <quote>.</quote> as the last element of the domain, and have said that this
1206 can be fixed with this:
1213 <emphasis>forward lpwa. lpwa.com:8000</emphasis>
1220 (NOTE: the syntax for specifiying target_domain has changed since the
1221 previous paragraph was written -- it will not work now. More information
1226 In this fictitious example, everything goes via an ISP's caching proxy,
1227 except requests to that ISP:
1234 <emphasis>forward .* caching.myisp.net:8000</emphasis>
1235 <emphasis>forward myisp.net .</emphasis>
1242 For the @home network, we're told the forwarding configuration is this:
1250 <emphasis>forward .* proxy:8080</emphasis>
1257 Also, we're told they insist on getting cookies and JavaScript, so you need
1258 to add home.com to the cookie file. We consider JavaScript a security risk.
1259 Java need not be enabled.
1263 In this example direct connections are made to all <quote>internal</quote>
1264 domains, but everything else goes through Lucent's LPWA by way of the
1265 company's SOCKS gateway to the Internet.
1272 <emphasis>forward_socks4 .* lpwa.com:8000 firewall.my_company.com:1080</emphasis>
1273 <emphasis>forward my_company.com .</emphasis>
1280 This is how you could set up a site that always uses SOCKS but no forwarders:
1287 <emphasis>forward_socks4a .* . firewall.my_company.com:1080</emphasis>
1294 An advanced example for network administrators:
1298 If you have links to multiple ISPs that provide various special content to
1299 their subscribers, you can configure forwarding to pass requests to the
1300 specific host that's connected to that ISP so that everybody can see all
1301 of the content on all of the ISPs.
1305 This is a bit tricky, but here's an example:
1310 host-a has a PPP connection to isp-a.com. And host-b has a PPP connection to
1311 isp-b.com. host-a can run a <application>Junkbuster</application> proxy with
1312 forwarding like this:
1319 <emphasis>forward .* .</emphasis>
1320 <emphasis>forward isp-b.com host-b:8000</emphasis>
1327 host-b can run a <application>Junkbuster</application> proxy with forwarding
1335 <emphasis>forward .* .</emphasis>
1336 <emphasis>forward isp-a.com host-a:8000</emphasis>
1343 Now, <emphasis>anyone</emphasis> on the Internet (including users on host-a
1344 and host-b) can set their browser's proxy to <emphasis>either</emphasis>
1345 host-a or host-b and be able to browse the content on isp-a or isp-b.
1349 Here's another practical example, for University of Kent at
1350 Canterbury students with a network connection in their room, who
1351 need to use the University's Squid web cache.
1358 <emphasis>forward *. ssbcache.ukc.ac.uk:3128</emphasis> # Use the proxy, except for:
1359 <emphasis>forward .ukc.ac.uk . </emphasis> # Anything on the same domain as us
1360 <emphasis>forward * . </emphasis> # Host with no domain specified
1361 <emphasis>forward 129.12.*.* . </emphasis> # A dotted IP on our /16 network.
1362 <emphasis>forward 127.*.*.* . </emphasis> # Loopback address
1363 <emphasis>forward localhost.localdomain . </emphasis> # Loopback address
1364 <emphasis>forward www.ukc.mirror.ac.uk . </emphasis> # Specific host
1371 If you intend to chain <application>Junkbuster</application> and
1372 <application>squid</application> locally, then chain as
1373 <literal>browser -> squid -> junkbuster</literal> is the recommended way.
1377 Your squid configuration could then look like this:
1384 # Define junkbuster as parent cache
1385 cache_peer 127.0.0.1 8000 parent 0 no-query
1387 # Define ACL for protocol FTP
1390 # Do not forward ACL FTP to junkbuster
1391 always_direct allow FTP
1393 # Do not forward ACL CONNECT (https) to junkbuster
1394 always_direct allow CONNECT
1396 # Forward the rest to junkbuster
1397 never_direct allow all
1405 <!-- ~ End section ~ -->
1408 <!-- ~~~~~ New section ~~~~~ -->
1411 <title>Windows GUI Options</title>
1413 Removed references to Win32. HB 09/23/01
1416 <application>Junkbuster</application> has a number of options specific to the
1417 Windows GUI interface:
1421 If <quote>activity-animation</quote> is set to 1, the
1422 <application>Junkbuster</application> icon will animate when
1423 <quote>Junkbuster</quote> is active. To turn off, set to 0.
1430 <emphasis>activity-animation 1</emphasis>
1437 If <quote>log-messages</quote> is set to 1,
1438 <application>Junkbuster</application> will log messages to the console
1446 <emphasis>log-messages 1</emphasis>
1453 If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
1454 i.e. the amount of memory used for the log messages displayed in the
1455 console window, will be limited to <quote>log-max-lines</quote> (see below).
1459 Warning: Setting this to 0 will result in the buffer to grow infinitely and
1460 eat up all your memory!
1467 <emphasis>log-buffer-size 1</emphasis>
1474 <application>log-max-lines</application> is the maximum number of lines held
1475 in the log buffer. See above.
1482 <emphasis>log-max-lines 200</emphasis>
1489 If <quote>log-highlight-messages</quote> is set to 1,
1490 <application>Junkbuster</application> will highlight portions of the log
1491 messages with a bold-faced font:
1498 <emphasis>log-highlight-messages 1</emphasis>
1505 The font used in the console window:
1512 <emphasis>log-font-name Comic Sans MS</emphasis>
1519 Font size used in the console window:
1526 <emphasis>log-font-size 8</emphasis>
1533 <quote>show-on-task-bar</quote> controls whether or not
1534 <application>Junkbuster</application> will appear as a button on the Task bar
1542 <emphasis>show-on-task-bar 0</emphasis>
1549 If <quote>close-button-minimizes</quote> is set to 1, the Windows close
1550 button will minimize <application>Junkbuster</application> instead of closing
1551 the program (close with the exit option on the File menu).
1558 <emphasis>close-button-minimizes 1</emphasis>
1565 The <quote>hide-console</quote> option is specific to the MS-Win console
1566 version of <application>JunkBuster</application>. If this option is used,
1567 <application>Junkbuster</application> will disconnect from and hide the
1584 <!-- ~ End section ~ -->
1587 <!-- ~~~~~ New section ~~~~~ -->
1588 <sect2 id="actionsfile">
1589 <title>The Actions File</title>
1592 The <quote>actionsfile</quote> is used to define what actions
1593 <application>Junkbuster</application> takes, and thus determines how images,
1594 cookies and various other aspects of HTTP content and transactions are
1595 handled. Images can be anything you want, including ads, banners, or just
1596 some obnoxious image that you would rather not see. Cookies can be accepted
1597 or rejected. The default file is in fact named <filename>actionsfile</filename>.
1601 To determine which actions apply to a request, the URL of the request is
1602 compared to all patterns in this file. Every time it matches, the list of
1603 applicable actions for the URL is incrementally updated. You can trace
1604 this process by visiting <ulink
1605 url="http://i.j.b/show-url-info">http://i.j.b/show-url-info</ulink>.
1609 There are four types of lines in this file: comments (begin with a
1610 <quote>#</quote> character), actions, aliases and patterns, all of which are
1615 <!-- ~~~~~ New section ~~~~~ -->
1617 <title>URL Domain and Path Syntax</title>
1619 Generally, a pattern has the form <domain>/<path>, where both the
1620 <domain> and <path> part are optional. If you only specify a
1621 domain part, the <quote>/</quote> can be left out:
1625 <emphasis>www.example.com</emphasis> - is a domain only pattern and will match any request to
1626 <quote>www.example.com</quote>.
1630 <emphasis>www.example.com/</emphasis> - means exactly the same.
1634 <emphasis>www.example.com/index.html</emphasis> - matches only the single
1635 document <quote>/index.html</quote> on <quote>www.example.com</quote>.
1639 <emphasis>/index.html</emphasis> - matches the document <quote>/index.html</quote>, regardless of
1644 <emphasis>index.html</emphasis> - matches nothing, since it would be
1645 interpreted as a domain name and there is no top-level domain called
1646 <quote>.html</quote>.
1650 The matching of the domain part offers some flexible options: if the
1651 domain starts or ends with a dot, it becomes unanchored at that end.
1656 <emphasis>.example.com</emphasis> - matches any domain that <emphasis>ENDS</emphasis> in
1657 <quote>.example.com</quote>.
1661 <emphasis>www.</emphasis> - matches any domain that <emphasis>STARTS</emphasis> with
1666 Additionally, there are wildcards that you can use in the domain names
1667 themselves. They work pretty similar to shell wildcards: <quote>*</quote>
1668 stands for zero or more arbitrary characters, <quote>?</quote> stands for
1669 any single character. And you can define charachter classes in square
1670 brackets and they can be freely mixed:
1674 <emphasis>ad*.example.com</emphasis> - matches <quote>adserver.example.com</quote>,
1675 <quote>ads.example.com</quote>, etc but not <quote>sfads.example.com</quote>.
1679 <emphasis>*ad*.example.com</emphasis> - matches all of the above, and then some.
1683 <emphasis>.?pix.com</emphasis> - matches <quote>www.ipix.com</quote>,
1684 <quote>pictures.epix.com</quote>, <quote>a.b.c.d.e.upix.com</quote>, etc.
1688 <emphasis>www[1-9a-ez].example.com</emphasis> - matches <quote>www1.example.com</quote>,
1689 <quote>www4.example.com</quote>, <quote>wwwd.example.com</quote>,
1690 <quote>wwwz.example.com</quote>, etc., but <emphasis>not</emphasis>
1691 <quote>wwww.example.com</quote>.
1695 If <application>Junkbuster</application> was compiled with
1696 <quote>pcre</quote> support (default), Perl compatible regular expressions
1697 can be used. See the <filename>pcre/docs/</filename> direcory or <quote>man
1698 perlre</quote> (also available on <ulink
1699 url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>)
1700 for details. A brief discussion of regular expressions is in the
1701 <link linkend="regex">Appendix</link>. For instance:
1705 <emphasis>/.*/advert[0-9]+\.jpe?g</emphasis> - would match a URL from any
1706 domain, with any path that includes <quote>advert</quote> followed
1707 immediately by one or more digits, then a <quote>.</quote> and ending in
1708 either <quote>jpeg</quote> or <quote>jpg</quote>. So we match
1709 <quote>example.com/ads/advert2.jpg</quote>, and
1710 <quote>www.example.com/ads/banners/advert39.jpeg</quote>, but not
1711 <quote>www.example.com/ads/banners/advert39.gif</quote> (no gifs in the
1716 Please note that matching in the path is case
1717 <emphasis>INSENSITIVE</emphasis> by default, but you can switch to case
1718 sensitive at any point in the pattern by using the
1719 <quote>(?-i)</quote> switch:
1723 <emphasis>www.example.com/(?-i)PaTtErN.*</emphasis> - will match only
1724 documents whose path starts with <quote>PaTtErN</quote> in
1725 <emphasis>exactly</emphasis> this capitalization.
1730 <!-- ~ End section ~ -->
1734 <!-- ~~~~~ New section ~~~~~ -->
1737 <title>Actions</title>
1739 Actions are enabled if preceded with a <quote>+</quote>, and disabled if
1740 preceded with a <quote>-</quote>. Actions are invoked by enclosing the
1741 action name in curly braces (e.g. {+some_action}), followed by a list of
1742 URLs to which the action applies. There are three classes of actions:
1750 Boolean (e.g. <quote>+/-block</quote>):
1756 <emphasis>{+name}</emphasis> # enable this action
1757 <emphasis>{-name}</emphasis> # disable this action
1767 Parameterized (e.g. <quote>+/-hide-user-agent</quote>):
1773 <emphasis>{+name{param}}</emphasis> # enable action and set parameter to <quote>param</quote>
1774 <emphasis>{-name}</emphasis> # disable action
1783 Multi-value (e.g. <quote>{+/-add-header{Name: value}}</quote>, <quote>{+/-wafer{name=value}}</quote>):
1789 <emphasis>{+name{param}}</emphasis> # enable action and add parameter <quote>param</quote>
1790 <emphasis>{-name{param}}</emphasis> # remove the parameter <quote>param</quote>
1791 <emphasis>{-name}</emphasis> # disable this action totally
1802 If nothing is specified in this file, no <quote>actions</quote> are taken.
1803 So in this case <application>JunkBuster</application> would just be a
1804 normal, non-blocking, non-anonymizing proxy. You must specifically
1805 enable the privacy and blocking features you need (although the
1806 provided default <filename>actionsfile</filename> file will
1807 give a good starting point).
1811 Later defined actions always over-ride earlier ones. For multi-valued
1812 actions, the actions are applied in the order they are specified.
1816 The list of valid <application>Junkbuster</application> <quote>actions</quote> are:
1824 Add the specified HTTP header, which is not checked for validity.
1825 You may specify this many times to specify many different headers:
1831 <emphasis>+add-header{Name: value}</emphasis>
1841 Block this URL totally.
1847 <emphasis>+block</emphasis>
1857 De-animate all animated GIF images, i.e. reduce them to their last frame.
1858 This will also shrink the images considerably (in bytes, not pixels!). If
1859 the option <quote>first</quote> is given, the first frame of the animation
1860 is used as the replacement. If <quote>last</quote> is given, the last frame
1861 of the animation is used instead, which propably makes more sense for most
1862 banner animations, but also has the risk of not showing the entire last
1863 frame (if it is only a delta to an earlier frame).
1869 <emphasis>+deanimate-gifs{last}</emphasis>
1870 <emphasis>+deanimate-gifs{first}</emphasis>
1879 Many sites, like yahoo.com, don't just link to other sites. Instead, they
1880 will link to some script on their own server, giving the destination as a
1881 parameter, which will then redirect you to the final target. URLs resulting
1882 from this scheme typically look like:
1883 http://some.place/some_script?http://some.where-else.
1886 Sometimes, there are even multiple consecutive redirects encoded in the
1887 URL. These redirections via scripts make your web browing more traceable,
1888 since the server from which you follow such a link can see where you go to.
1889 Apart from that, valuable bandwidth and time is wasted, while your browser
1890 ask the server for one redirect after the other. Plus, it feeds the
1894 The <quote>+fast-redirects</quote> option enables interception of these
1895 requests by <application>Junkbuster</application>, who will cut off all but
1896 the last valid URL in the request and send a local redirect back to your
1897 browser without contacting the remote site.
1903 <emphasis>+fast-redirects</emphasis>
1912 Filter the website through the re_filterfile:
1918 <emphasis>+filter{filename}</emphasis>
1927 Block any existing X-Forwarded-for header, and do not add a new one:
1933 <emphasis>+hide-forwarded</emphasis>
1942 If the browser sends a <quote>From:</quote> header containing your e-mail
1943 address, this either completely removes the header (<quote>block</quote>), or
1944 changes it to the specified e-mail address.
1950 <emphasis>+hide-from{block}</emphasis>
1951 <emphasis>+hide-from{spam@sittingduck.xqq}</emphasis>
1960 Don't send the <quote>Referer:</quote> (sic) header to the web site. You
1961 can block it, forge a URL to the same server as the request (which is
1962 preferred because some sites will not send images otherwise) or set it to a
1963 constant string of your choice.
1969 <emphasis>+hide-referer{block}</emphasis>
1970 <emphasis>+hide-referer{forge}</emphasis>
1971 <emphasis>+hide-referer{http://nowhere.com}</emphasis>
1980 Alternative spelling of <quote>+hide-referer</quote>. It has the same
1981 parameters, and can be freely mixed with, <quote>+hide-referer</quote>.
1982 (<quote>referrer</quote> is the correct English spelling, however the HTTP
1983 specification has a bug - it requires it to be spelled <quote>referer</quote>.)
1989 <emphasis>+hide-referrer{...}</emphasis>
1998 Change the <quote>User-Agent:</quote> header so web servers can't tell your
1999 browser type. Warning! This breaks many web sites. Specify the
2000 user-agent value you want. Example, pretend to be using Netscape on
2007 <emphasis>+hide-user-agent{Mozilla (X11; I; Linux 2.0.32 i586)}</emphasis>
2014 Or to identify yourself explicitly as a <quote>Junkbuster</quote> user:
2020 <emphasis>+hide-user-agent{JunkBuster/1.0}</emphasis>
2025 (Don't change the version number from 1.0 - after all, why tell them?)
2032 <emphasis>+hide-user-agent{browser-type}</emphasis>
2042 Treat this URL as an image. This only matters if it's also <quote>+block</quote>ed,
2043 in which case a <quote>blocked</quote> image can be sent rather than a HTML page.
2044 See <quote>+image-blocker{}</quote> below for the control over what is actually sent.
2050 <emphasis>+image</emphasis>
2059 Decides what to do with URLs that end up tagged with <quote>{+block
2060 +image}</quote>. There are 4 options. <quote>-image-blocker</quote> will
2061 send a HTML <quote>blocked</quote> page, usually resulting in a
2062 <quote>broken image</quote> icon. <quote>+image-blocker{logo}</quote> will
2063 send a <quote>JunkBuster</quote> image.
2064 <quote>+image-blocker{blank}</quote> will send a 1x1 transparent GIF image.
2065 And finally, <quote>+image-blocker{http://xyz.com}</quote> will send a HTTP
2066 temporary redirect to the specified image. This has the advantage of the
2067 icon being being cached by the browser, which will speed up the display.
2073 <emphasis>+image-blocker{logo}</emphasis>
2074 <emphasis>+image-blocker{blank}</emphasis>
2075 <emphasis>+image-blocker{http://i.j.b/send-banner}</emphasis>
2084 Prevent the website from reading cookies:
2090 <emphasis>+no-cookies-read</emphasis>
2099 Prevent the website from setting cookies:
2105 <emphasis>+no-cookies-set</emphasis>
2114 Filter the website through a built-in filter to disable those obnoxious
2115 JavaScript pop-up windows via window.open(), etc. The two alternative
2116 spellings are equivalent.
2122 <emphasis>+no-popup</emphasis>
2123 <emphasis>+no-popups</emphasis>
2132 This action only applies if you are using a <filename>jarfile</filename>
2133 for saving cookies. It sends a cookie to every site stating that you do not
2134 accept any copyright on cookies sent to you, and asking them not to track
2135 you. Of course, this is a (relatively) unique header they could use to
2142 <emphasis>+vanilla-wafer</emphasis>
2151 This allows you to add an arbitrary cookie. It can be specified multiple
2152 times in order to add as many cookies as you like.
2158 <emphasis>+wafer{name=value}</emphasis>
2169 The meaning of any of the above is reversed by preceding the action with a
2170 <quote>-</quote>, in place of the <quote>+</quote>.
2178 Turn off cookies by default, then allow a few through for specified sites:
2185 # Turn off all cookies
2186 { +no-cookies-read }
2189 # Execeptions to the above, sites that need cookies
2190 { -no-cookies-read }
2198 # Alternative way of saying the same thing
2199 {-no-cookies-set -no-cookies-read}
2208 Now turn off <quote>fast redirects</quote>, and then we allow two exceptions:
2218 # Reverse it for these two sites, which don't work right without it.
2220 www.ukc.ac.uk/cgi-bin/wac\.cgi\?
2228 Turn on page filtering, with one exception for sourceforge:
2235 # Run everything through the default filter file (<filename>re_filterfile</filename>):
2238 # But please don't re_filter code from sourceforge!
2240 .cvs.sourceforge.net
2247 Now some URLs that we want <quote>blocked</quote>, ie we won't see them.
2248 Many of these use regular expressions that will expand to match multiple
2258 /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\.(gif|jpe?g))
2259 /.*/(.*[-_.])?count(er)?(\.cgi|\.dll|\.exe|[?/])
2260 /.*/(ng)?adclient\.cgi
2261 /.*/(plain|live|rotate)[-_.]?ads?/
2262 /.*/(sponsor)s?[0-9]?/
2263 /.*/_?(plain|live)?ads?(-banners)?/
2265 /.*/ad(sdna_image|gifs?)/
2266 /.*/ad(server|stream|juggler)\.(cgi|pl|dll|exe)
2270 /.*/adv((er)?ts?|ertis(ing|ements?))?/
2274 /.*/cgi-bin/centralad/getimage
2275 /.*/images/addver\.gif
2276 /.*/images/marketing/.*\.(gif|jpe?g)
2280 /.*/sponsors?[0-9]?/
2281 /.*/advert[0-9]+\.jpg
2288 /graphics/defaultAd/
2290 /image\.ng/transactionID
2291 /images/.*/.*_anim\.gif # alvin brattli
2292 /ip_img/.*\.(gif|jpe?g)
2296 /cgi-bin/nph-adclick.exe/
2297 /.*/Image/BannerAdvertising/
2299 /.*/adlib/server\.cgi
2308 <!-- ~ End section ~ -->
2311 <!-- ~~~~~ New section ~~~~~ -->
2313 <title>Aliases</title>
2315 Custom <quote>actions</quote>, known to <application>Junkbuster</application>
2316 as <quote>aliases</quote>, can be defined by combing other <quote>actions</quote>.
2317 These can in turn be invoked just like the built-in <quote>actions</quote>.
2318 Currently, an alias can contain any character except space, tab, <quote>=</quote>,
2319 <quote>{</quote> or <quote>}</quote>. But please use only <quote>a</quote>-
2320 <quote>z</quote>, <quote>0</quote>-<quote>9</quote>, <quote>+</quote>, and
2321 <quote>-</quote>. Alias names are not case sensitive, and must be defined
2322 before they are used.
2326 Now let's define a few aliases:
2337 +no-cookies = +no-cookies-set +no-cookies-read
2338 -no-cookies = -no-cookies-set -no-cookies-read
2339 fragile = -block -no-cookies -filter -fast-redirects -hide-referer -no-popups
2340 shop = -no-cookies -filter -fast-redirects
2341 +imageblock = +block +image
2343 #For people who don't like to type too much: ;-)
2346 c2 = -no-cookies-set +no-cookies-read
2347 c3 = +no-cookies-set -no-cookies-read
2348 #... etc. Customize to your heart's content.
2355 Some examples using our <quote>shop</quote> and <quote>fragile</quote>
2363 # These sites are very complex and require
2364 # minimal interference.
2366 .office.microsoft.com
2367 .windowsupdate.microsoft.com
2369 # Shopping sites - still want to block ads.
2372 .worldpay.com # for quietpc.com
2376 # These shops require pop-ups
2388 <!-- ~ End section ~ -->
2391 <!-- ~~~~~ New section ~~~~~ -->
2392 <sect2 id="filterfile">
2393 <title>The Filter File</title>
2395 The filter file defines what filtering of web pages
2396 <application>Junkbuster</application> does. The default filter file is
2397 <filename>re_filterfile</filename>, located in the config directory. In this
2398 file, <emphasis>any document content</emphasis>, whether viewable text or
2399 embedded non-visible content, can be changed.
2403 This file uses regular expressions to alter or remove any string in the
2404 target page. Some examples from the included default <filename>re_filterfile</filename>:
2408 Stop web pages from displaying annoying messages in the status bar by
2409 deleting such references:
2416 # The status bar is for displaying link targets, not pointless buzzwords.
2417 # Again, check it out on http://www.airport-cgn.de/.
2418 s/status='.*?';*//ig
2425 Just for kicks, replace any occurrence of <quote>Microsoft</quote> with
2426 <quote>MicroSuck</quote>:
2433 s/microsoft(?!.com)/MicroSuck/ig
2440 Kill those auto-refresh tags:
2447 # Kill refresh tags. I like to refresh myself. Manually.
2448 # check it out on http://www.airport-cgn.de/ and go to the arrivals page.
2450 s/<meta[^>]*http-equiv[^>]*refresh.*URL=([^>]*?)"?>/<link rev="x-refresh" href=$1>/i
2451 s/<meta[^>]*http-equiv="?page-enter"?[^>]*content=[^>]*>/<!--no page enter for me-->/i
2461 <!-- ~~~~~ New section ~~~~~ -->
2462 <sect1 id="quickstart"><title>Quickstart to Using Junkbuster</title>
2468 <!-- ~~~~~ New section ~~~~~ -->
2469 <sect1 id="contact"><title>Contact the developers</title>
2470 <para>To be filled. mention the support forums as the primary channel of
2471 communication (bugs, feature requests, etc.)
2475 <!-- ~~~~~ New section ~~~~~ -->
2476 <sect1 id="copyright"><title>Copyright and History</title>
2481 <!-- ~~~~~ New section ~~~~~ -->
2482 <sect1 id="seealso"><title>See also</title>
2489 <!-- ~~~~~ New section ~~~~~ -->
2490 <sect1 id="appendix"><title>Appendix</title>
2493 <!-- ~~~~~ New section ~~~~~ -->
2495 <title>Regular Expressions</title>
2506 This program is free software; you can redistribute it
2507 and/or modify it under the terms of the GNU General
2508 Public License as published by the Free Software
2509 Foundation; either version 2 of the License, or (at
2510 your option) any later version.
2512 This program is distributed in the hope that it will
2513 be useful, but WITHOUT ANY WARRANTY; without even the
2514 implied warranty of MERCHANTABILITY or FITNESS FOR A
2515 PARTICULAR PURPOSE. See the GNU General Public
2516 License for more details.
2518 The GNU General Public License should be included with
2519 this file. If not, you can view it at
2520 http://www.gnu.org/copyleft/gpl.html
2521 or write to the Free Software Foundation, Inc., 59
2522 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
2524 $Log: user-manual.sgml,v $
2525 Revision 1.2 2001/09/13 15:27:40 swa
2528 Revision 1.1 2001/09/12 15:36:41 swa
2529 source files for junkbuster documentation
2531 Revision 1.3 2001/09/10 17:43:59 swa
2532 first proposal of a structure.
2534 Revision 1.2 2001/06/13 14:28:31 swa
2535 docs should have an author.
2537 Revision 1.1 2001/06/13 14:20:37 swa
2538 first import of project's documentation for the webserver.