Ignoring a very common warning.
[privoxy.git] / doc / source / user-manual.sgml
1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
2 <!--
3  File        :  $Source: /cvsroot/ijbswa/current/doc/source/user-manual.sgml,v $
4
5  Purpose     :  user manual
6                 This file belongs into
7                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
8                 
9  $Id: user-manual.sgml,v 1.47 2002/03/11 13:13:27 swa Exp $
10
11  Written by and Copyright (C) 2001 the SourceForge
12  IJBSWA team.  http://ijbswa.sourceforge.net
13
14  Based on the Internet Junkbuster originally written
15  by and Copyright (C) 1997 Anonymous Coders and 
16  Junkbusters Corporation.  http://www.junkbusters.com
17 -->
18
19 <!--
20 Sat 03/02/02 04:53:47 PM
21
22 This should be ready for BETA release.
23
24 Hal Burgiss <hal@foobox.net>
25 -->
26
27 <article id="index">
28 <artheader>
29 <title>Junkbuster User Manual</title>
30
31 <pubdate>$Id: user-manual.sgml,v 1.47 2002/03/11 13:13:27 swa Exp $</pubdate>
32
33 <authorgroup>
34  <author>
35   <affiliation>
36    <orgname>By: Junkbuster Developers</orgname>
37    </affiliation>
38  </author>
39 </authorgroup>
40
41 <abstract>
42  <para>
43   The user manual gives users information on how to install, configure and use
44   <application>Internet Junkbuster</application>. <application>Internet
45   Junkbuster</application> is a web proxy with advanced filtering capabilities
46   for protecting privacy, filtering web page content, managing cookies,
47   controlling access, and removing ads, banners, pop-ups and other obnoxious
48   Internet Junk. Junkbuster has a very flexible configuration and can be
49   customized to suit individual needs and tastes. <application>Internet
50   Junkbuster</application> has application for both stand-alone systems and
51   multi-user networks.
52  </para>
53  <para>
54 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>.
55  </para>
56
57 <!--   <para> -->
58 <!--    Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
59 <!--   </para> -->
60 </abstract>
61
62 </artheader>
63
64
65 <!--   ~~~~~       New section      ~~~~~     -->
66
67 <sect1 id="introduction"><title>Introduction</title>
68 <para>
69  <application>Internet Junkbuster</application> is a web proxy with advanced
70  filtering capabilities for protecting privacy, filtering and modifying web
71  page content, managing cookies, controlling access, and removing ads,
72  banners, pop-ups and other obnoxious Internet Junk.
73  <application>Junkbuster</application> has a very flexible configuration and
74  can be customized to suit individual needs and tastes. <application>Internet
75  Junkbuster</application> has application for both stand-alone systems and
76  multi-user networks.
77 </para>
78
79 <para>
80  This documentation is included with the current BETA version of
81  <application>Internet Junkbuster</application> and is mostly complete at this
82  point. The most up to date reference for the time being is still the comments
83  in the source files and in the individual configuration files. Development
84  of version 3.0 is currently nearing completion, and includes many significant
85  changes and enhancements over earlier versions. The target release date for
86  stable v3.0 is <quote>soon</quote> ;-)
87 </para>
88
89 <para>
90  Since this is a BETA version, not all new features are well tested. This
91  documentation may be slightly out of sync as a result (especially with 
92  CVS sources). And there <emphasis>may be</emphasis> bugs, though hopefully
93  not many! 
94 </para>
95
96
97 <!--   ~~~~~       New section      ~~~~~     -->
98 <sect2>
99 <title>New Features</title>
100 <para>
101  In addition to <application>Junkbuster's</application> traditional features
102  of ad and banner blocking and cookie management, this is a list of new
103  features currently under development:
104 </para>
105
106 <para>
107  <itemizedlist>
108
109  <listitem>
110   <para>
111    Integrated browser based configuration and control utility (<ulink
112    url="http://i.j.b">http://i.j.b</ulink>). Browser-based tracing of rule
113    and filter effects.
114   </para>
115  </listitem> 
116
117  <listitem>
118   <para>
119    Modularized configuration that will allow for system wide settings, and
120    individual user settings. (not implemented yet, probably a 3.1 feature)
121   </para>
122  </listitem> 
123
124  <listitem>
125   <para>
126     Blocking of annoying pop-up browser windows.
127   </para>
128  </listitem> 
129
130  <listitem>
131   <para>
132    HTTP/1.1 compliant (most, but not all 1.1 features are supported).
133   </para>
134  </listitem> 
135
136  <listitem>
137   <para>
138    Support for Perl Compatible Regular Expressions in the configuration files, and 
139    generally a more sophisticated and flexible configuration syntax over
140    previous versions. 
141   </para>
142  </listitem> 
143
144  <listitem>
145   <para>
146    GIF de-animation. 
147   </para>
148  </listitem> 
149  
150  <listitem>
151   <para>
152    Web page content filtering (removes banners based on size,
153    invisible <quote>web-bugs</quote>, JavaScript, pop-ups, status bar abuse,
154    etc.)
155   </para>
156  </listitem> 
157  
158  <listitem>
159   <para>
160    Bypass many click-tracking scripts (avoids script redirection).
161  
162   </para>
163  </listitem> 
164  
165  <listitem>
166   <para>
167    Multi-threaded (POSIX and native threads).
168   </para>
169  </listitem> 
170
171  <listitem>
172   <para>
173    Auto-detection and re-reading of config file changes.
174   </para>
175  </listitem> 
176
177  <listitem>
178   <para>
179    User-customizable HTML templates (e.g. 404 error page).
180   </para>
181  </listitem> 
182
183  <listitem>
184   <para>
185    Improved cookie management features (e.g. session based cookies).
186   </para>
187 </listitem> 
188
189  <listitem>
190   <para>
191    Builds from source on most UNIX-like systems. Packages available for: Linux
192    (RedHat, SuSE, or Debian), Windows, Sun Solaris, Mac OSX, OS/2, HP-UX 11 and AmigaOS.
193  
194   </para>
195  </listitem> 
196
197  <listitem>
198   <para>
199    In addition, the configuration is much more powerful and versatile over-all.
200   </para>
201 </listitem> 
202
203  </itemizedlist>
204 </para>
205
206 </sect2>
207
208 </sect1>
209
210 <!--  ~  End section  ~  -->
211
212
213 <!--   ~~~~~       New section      ~~~~~     -->
214 <sect1 id="installation"><title>Installation</title>
215 <para>
216  <application>Junkbuster</application> is available as raw source code, or
217  pre-compiled binaries. See the <ulink
218  url="http://sourceforge.net/projects/ijbswa/">Junkbuster Home Page</ulink>
219  for binaries and current release info. <application>Junkbuster</application>
220  is also available via <ulink
221  url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/">CVS</ulink>.
222  This is the recommended approach at this time. But please be aware that CVS 
223  is constantly changing, and it may break in mysterious ways.
224 </para>
225
226 <!--   ~~~~~       New section      ~~~~~     -->
227 <sect2 id="installation-source"><title>Source</title>
228 <para>
229  For gzipped tar archives, unpack the source:
230 </para>
231
232 <para>
233  <screen>
234  tar xzvf ijb_source_* [.tgz or .tar.gz]
235  cd ijb_source_2.9.11_beta
236  </screen>
237 </para>
238
239 <para>
240  For retrieving the current CVS sources, you'll need the CVS 
241  package installed first. To download CVS source:
242 </para>
243
244 <para>
245  <screen>
246   cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
247   cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
248   cd current
249  </screen>
250 </para>
251
252 <para>
253  This will create a directory named <filename>current/</filename>, which will 
254  contain the source tree.
255 </para>
256
257 <para>
258  Then, in either case, to build from tarball/CVS source:
259 </para>
260
261 <para>
262  <screen>
263  ./configure      (--help to see options)
264  make             (the make from gnu, gmake for *BSD) 
265  su 
266  make -n install  (to see where all the files will go)
267  make install     (to really install)
268  </screen>
269 </para>
270
271 <para>
272  For Redhat and SuSE Linux RPM packages, see below.
273 </para>
274
275 </sect2>
276
277
278 <!--   ~~~~~       New section      ~~~~~     -->
279 <sect2 id="installation-rh"><title>Red Hat</title>
280 <para>
281  To build Redhat RPM packages, install source as above. Then:
282 </para>
283
284 <para>
285  <screen>
286  autoheader   [suggested for CVS source]
287  autoconf     [suggested for CVS source]
288  ./configure
289  make redhat-dist
290  </screen>
291 </para>
292
293 <para>
294  This will create both binary and src RPMs in the usual places. Example:
295 </para>
296
297 <para>
298  &nbsp;&nbsp;&nbsp;/usr/src/redhat/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
299 </para>
300 <para>
301  &nbsp;&nbsp;&nbsp;/usr/src/redhat/SRPMS/junkbuster-2.9.11-1.src.rpm
302 </para>
303
304 <para>
305  To install, of course:
306 </para>
307
308 <para>
309  <screen>
310  rpm -Uvv /usr/src/redhat/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
311  </screen>
312 </para>
313
314 <para>
315  This will place the <application>Junkbuster</application> configuration 
316  files in <filename>/etc/junkbuster/</filename>, and log files in 
317  <filename>/var/log/junkbuster/</filename>.
318 </para>
319
320 </sect2>
321
322 <!--   ~~~~~       New section      ~~~~~     -->
323 <sect2 id="installation-suse"><title>SuSE</title>
324 <para>
325  To build SuSE RPM packages, install source as above. Then:
326 </para>
327
328 <para>
329  <screen>
330  autoheader   [suggested for CVS source]
331  autoconf     [suggested for CVS source]
332  ./configure
333  make suse-dist
334  </screen>
335 </para>
336
337 <para>
338  This will create both binary and src RPMs in the usual places. Example:
339 </para>
340
341 <para>
342  &nbsp;&nbsp;&nbsp;/usr/src/packages/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
343 </para>
344 <para>
345  &nbsp;&nbsp;&nbsp;/usr/src/packages/SRPMS/junkbuster-2.9.11-1.src.rpm
346 </para>
347
348 <para>
349  To install, of course:
350 </para>
351
352 <para>
353  <screen>
354  rpm -Uvv /usr/src/packages/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
355  </screen>
356 </para>
357
358 <para>
359  This will place the <application>Junkbuster</application> configuration 
360  files in <filename>/etc/junkbuster/</filename>, and log files in 
361  <filename>/var/log/junkbuster/</filename>.
362 </para>
363
364 </sect2>
365
366
367 <!--   ~~~~~       New section      ~~~~~     -->
368 <sect2 id="installation-os2"><title>OS/2</title>
369
370 <!--
371 Thanx David Schmidt!
372 -->
373
374 <para>
375  <application>Junkbuster</application> is packaged in a WarpIN self-
376  installing archive.  The self-installing program will be named depending
377  on the release version, something like:
378  <filename>ijbos2_setup_1.2.3.exe</filename>.  In order to install it, simply
379  run this executable or double-click on its icon and follow the WarpIN
380  installation panels.  A shadow of the <application>Junkbuster</application>
381  executable will be placed in your startup folder so it will start 
382  automatically whenever OS/2 starts.
383 </para>
384
385 <para>
386  The directory you choose to install <application>Junkbuster</application>
387  into will contain all of the configuration files.
388 </para>
389
390 <para>
391  If you would like to build binary images on OS/2 yourself, you will need
392  a few Unix-like tools: autoconf, autoheader and sh.  These tools will be
393  used to create the required config.h file, which is not part of the 
394  source distribution because it differs based on platform.  You will also
395  need a compiler.
396  The distribution has been created using IBM VisualAge compilers, but you
397  can use any compiler you like.  GCC/EMX has the disadvantage of needing 
398  to be single-threaded due to a limitation of EMX's implementation of the
399  select() socket call.
400 </para>
401
402 <para>
403  In addition to needing the source code distribution as outlined earlier,
404  you will want to extract the <filename>os2seutp</filename> directory from CVS:
405  <screen>
406  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login          
407  cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
408  </screen>
409  This will create a directory named os2setup/, which will contain the
410  <filename>Makefile.vac</filename> makefile and <filename>os2build.cmd</filename>
411  which is used to completely create the binary distribution.  The sequence
412  of events for building the executable for yourself goes something like this:
413  <screen>
414  cd current
415  autoheader
416  autoconf
417  sh configure
418  cd ..\os2setup
419  nmake -f Makefile.vac
420  </screen>
421  You will see this sequence laid out in <filename>os2build.cmd</filename>.
422 </para>
423
424 </sect2>
425
426
427 <!--   ~~~~~       New section      ~~~~~     -->
428 <sect2 id="installation-win"><title>Windows</title>
429 <para>Click-click. (I need help on this. Not a clue here. Also for 
430 configuration section below. HB.)
431 </para>
432 </sect2>
433
434 <!--   ~~~~~       New section      ~~~~~     -->
435 <sect2 id="installation-other"><title>Other</title>
436 <para>
437  Some quick notes on other Operating Systems.
438 </para>
439
440 <para>
441  For FreeBSD (and other *BSDs?), the build will require <command>gmake</command> 
442  instead of the included <command>make</command>. <command>gmake</command> is
443  available from <ulink url="http://www.gnu.org">http://www.gnu.org</ulink>.
444  The rest should be the same as above for Linux/Unix.
445 </para>
446
447 </sect2>
448
449 </sect1>
450
451 <!--  ~  End section  ~  -->
452
453
454 <!--   ~~~~~       New section      ~~~~~     -->
455 <sect1 id="configuration"><title>JunkBuster Configuration</title>
456  <para>
457   All <application>JunkBuster</application> configuration is kept 
458   in text files. These files can be edited with a text editor.
459   Many important aspects of <application>JunkBuster</application> can 
460   also be controlled easily with a web browser.
461
462  </para>
463
464
465 <!--   ~~~~~       New section      ~~~~~     -->
466
467 <sect2>
468 <title>Controlling Junkbuster with Your Web Browser</title>
469 <para>
470  <application>JunkBuster</application> can be reached by the special 
471  URL <ulink url="http://i.j.b/">http://i.j.b/</ulink> (or alternately
472  <ulink url="http://ijbswa.sourceforge.net/config/">http://ijbswa.sourceforge.net/config/</ulink>, 
473  which is an internal page. You will see the following section:
474
475 </para>
476
477 <para>
478  <screen>
479
480 Please choose from the following options:
481
482     * Show information about the current configuration
483     * Show the source code version numbers
484     * Show the client's request headers.
485     * Show which actions apply to a URL and why
486     * Toggle JunkBuster on or off
487     * Edit the actions list
488
489  </screen>
490 </para>
491
492 <para>
493  This should be self-explanatory. Note the last item is an editor for the
494  <quote>actions list</quote>, which is where much of the ad, banner, cookie,
495  and URL blocking magic is configured as well as other advanced features of
496  <application>Junkbuster</application>. This is an easy way to adjust various
497  aspects of <application>Junkbuster</application> configuration. The actions
498  file, and other configuration files, are explained in detail below. 
499  <application>Junkbuster</application> will automatically detect any changes 
500  to these files.
501 </para>
502
503 <para>
504  <quote>Toggle JunkBuster On or Off</quote> is handy for sites that might 
505  have problems with your current actions and filters, or just to test if 
506  a site misbehaves, whether it is <application>JunkBuster</application> 
507  causing the problem or not. <application>Junkbuster</application> continues 
508  to run as a proxy in this case, but all filtering is disabled.
509
510 </para>
511
512 </sect2>
513
514 <!--  ~  End section  ~  -->
515
516
517
518
519 <!--   ~~~~~       New section      ~~~~~     -->
520
521 <sect2>
522 <title>Configuration Files Overview</title>
523 <para>
524  For Unix, *BSD and Linux, all configuration files are located in
525  <filename>/etc/junkbuster/</filename> by default. For MS Windows, OS/2, and
526  AmigaOS these are all in the same directory as the 
527  <application>Junkbuster</application> executable. The name and number of
528  configuration files has changed from previous versions, and is subject to
529  change as development progresses.
530 </para>
531
532 <para>
533  The installed defaults provide a reasonable starting point, though possibly
534  aggressive by some standards. For the time being, there are only three
535  default configuration files (this will change in time):
536 </para>
537
538 <para>
539  <itemizedlist>
540
541   <listitem>
542    <para>
543      The main configuration file is named <filename>config</filename>
544      on Linux, Unix, BSD, OS/2, and AmigaOS and <filename>config.txt</filename>
545      on Windows.
546    </para>
547   </listitem> 
548
549   <listitem>
550    <para>
551     The <filename>ijb.action</filename> file is used  to define various 
552     <quote>actions</quote> relating to images, banners, pop-ups, access
553     restrictions, banners and cookies. There is a CGI based editor for this
554     file that can be accessed via <ulink
555     url="http://i.j.b">http://i.j.b</ulink>. (Other actions 
556     files are included as well with differing levels of filtering 
557     and blocking, e.g. <filename>ijb-basic.action</filename>.)
558    </para>
559   </listitem> 
560
561   <listitem>
562    <para>
563     The <filename>re_filterfile</filename> file can be used to re-write the raw
564     page content, including viewable text as well as embedded HTML and JavaScript,
565     and whatever else lurks on any given web page.
566    </para>
567   </listitem> 
568
569  </itemizedlist>
570 </para>
571
572 <para>
573  <filename>ijb.action</filename> and <filename>re_filterfile</filename> 
574  can use Perl style regular expressions for maximum flexibility. All files use
575  the <quote><literal>#</literal></quote> character to denote a comment. Such
576  lines are not processed by <application>Junkbuster</application>. After
577  making any changes, there is no need to restart
578  <application>Junkbuster</application> in order for the changes to take
579  effect. <application>Junkbuster</application> should detect such changes 
580  automatically.
581 </para>
582
583 <para>
584  While under development, the configuration content is subject to change. 
585  The below documentation may not be accurate by the time you read this. 
586  Also, what constitutes a <quote>default</quote> setting, may change, so 
587  please check all your configuration files on important issues.
588 </para>
589 </sect2>
590
591
592 <!--   ~~~~~       New section      ~~~~~     -->
593
594 <sect2>
595 <title>The Main Configuration File</title>
596 <para>
597  Again, the main configuration file is named <filename>config</filename> on
598  Linux/Unix/BSD and OS/2, and <filename>config.txt</filename> on Windows.
599  Configuration lines consist of an initial keyword followed by a list of
600  values, all separated by whitespace (any number of spaces or tabs). For
601  example:
602 </para>
603
604 <para>
605  <literal>
606   <msgtext> 
607    <literallayout>
608   <emphasis>blockfile blocklist.ini</emphasis>
609    </literallayout>
610   </msgtext> 
611  </literal>
612 </para>
613
614 <para>
615  Indicates that the blockfile is named <quote>blocklist.ini</quote>.
616 </para>
617
618 <para>
619  A <quote><literal>#</literal></quote> indicates a comment.  Any part of a
620  line following a <quote><literal>#</literal></quote> is ignored, except if
621  the <quote><literal>#</literal></quote> is preceded by a
622  <quote><literal>\</literal></quote>.
623 </para>
624
625 <para>
626  Thus, by placing a <quote><literal>#</literal></quote> at the start of an
627  existing configuration line, you can make it a comment and it will be treated
628  as if it weren't there. This is called <quote>commenting out</quote> an
629  option and can be useful to turn off features: If you comment out the
630  <quote>logfile</quote> line, <application>junkbuster</application> will not
631  log to a file at all. Watch for the <quote>default:</quote> section in each
632  explanation to see what happens if the option is left unset (or commented
633  out). 
634 </para>
635
636 <para>
637  Long lines can be continued on the next line by using a
638  <quote><literal>\</literal></quote> as the very last character.
639 </para>
640
641 <para>
642  There are various aspects of <application>Junkbuster</application> behavior 
643  that can be tuned.
644 </para>
645
646
647 <!--   ~~~~~       New section      ~~~~~     -->
648
649 <sect3>
650 <title>Defining Other Configuration Files</title>
651
652 <para>
653  <application>Junkbuster</application> can use a number of other files to tell it
654  what ads to block, what cookies to accept, etc.  This section of the
655  configuration file tells <application>Junkbuster</application> where to find
656  all those other files. 
657 </para>
658
659 <para>
660  On <application>Windows</application> and <application>AmigaOS</application>,
661  <application>Junkbuster</application> looks for these files in the same
662  directory as the executable.  On Unix and  OS/2,
663  <application>Junkbuster</application> looks for these files in the current
664  working directory. In either case, an absolute path name can be used to
665  avoid problems.
666 </para>
667
668 <para>
669  When development goes modular and multi-user, the blocker, filter, and
670  per-user config will be stored in subdirectories of <quote>confdir</quote>.
671  For now, only <filename>confdir/templates</filename> is used for storing HTML
672  templates for CGI results. 
673 </para>
674
675 <para>
676  The location of the configuration files:
677 </para>
678
679 <para>
680  <literal>
681   <msgtext> 
682    <literallayout>
683   <emphasis>confdir  /etc/junkbuster</emphasis>       # No trailing /, please.
684    </literallayout>
685   </msgtext> 
686  </literal>
687 </para>
688
689 <para>
690  The directory where all logging (i.e. <filename>logfile</filename> and 
691  <filename>jarfile</filename>) takes place. No trailing
692  <quote><literal>/</literal></quote>, please: 
693 </para>
694
695 <para>
696  <literal>
697   <msgtext> 
698    <literallayout>
699   <emphasis>logdir  /var/log/junkbuster</emphasis>
700    </literallayout>
701   </msgtext> 
702  </literal>
703 </para>
704
705 <para>
706  Note that all file specifications below are relative to 
707  the above two directories!
708 </para>
709
710 <para>
711  The <quote>ijb.action</quote> file contains patterns to specify the actions to
712  apply to requests for each site. Default: Cookies to and from all
713  destinations are kept only during the current browser session (i.e. they 
714  are not saved to disk). Pop-ups are disabled for all sites. All sites are
715  filtered through selected sections of <quote>re_filterfile</quote>. No sites
716  are blocked. The JunkBuster logo is displayed for filtered ads and other
717  images . The syntax of this file is explained in detail <link
718  linkend="actionsfile">below</link>. 
719 </para>
720
721 <para>
722  <literal>
723   <msgtext> 
724    <literallayout>
725   <emphasis>actionsfile  ijb.action</emphasis>
726    </literallayout>
727   </msgtext> 
728  </literal>
729 </para>
730
731 <para>
732  The <quote>re_filterfile</quote> file contains content modification rules 
733  that use <quote>regular expressions</quote>. These rules permit powerful
734  changes on the content of Web pages, e.g., you could disable your favorite
735  JavaScript annoyances, re-write the actual displayed text, or just have some
736  fun replacing <quote>Microsoft</quote> with <quote>MicroSuck</quote> wherever
737  it appears on a Web page. Default: whatever the developers are playing with
738  :-/
739 </para>
740
741 <para>
742  Filtering requires buffering the page content, which may appear to slow down
743  page rendering since nothing is displayed until all content has passed 
744  the filters. (It does not really take longer, but seems that way since 
745  the page is not incrementally displayed.) This effect will be more noticeable
746  on slower connections.
747
748 </para>
749
750 <para>
751  <literal>
752   <msgtext> 
753    <literallayout>
754   <emphasis>re_filterfile  re_filterfile</emphasis>
755    </literallayout>
756   </msgtext> 
757  </literal>
758 </para>
759
760 <para>
761  The logfile is where all logging and error messages are written. The logfile
762  can be useful for tracking down a problem with
763  <application>Junkbuster</application> (e.g., it's not blocking an ad you
764  think it should block) but in most cases you probably will never look at it.
765 </para>
766
767 <para>
768  Your logfile will grow indefinitely, and you will probably want to
769  periodically remove it.  On Unix systems, you can do this with a cron job
770  (see <quote>man cron</quote>). For Redhat, a <command>logrotate</command> 
771  script has been included.
772 </para>
773
774 <para>
775  On SuSE Linux systems, you can place a line like <quote>/var/log/junkbuster.*
776  +1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
777  the effect that cron.daily will automatically archive, gzip, and empty the
778  log, when it exceeds 1M size.
779 </para>
780
781 <para>
782  Default: Log to the a file named <filename>logfile</filename>. 
783  Comment out to disable logging.
784 </para>
785
786 <para>
787  <literal>
788   <msgtext> 
789    <literallayout>
790   <emphasis>logfile  logfile</emphasis>
791    </literallayout>
792   </msgtext> 
793  </literal>
794 </para>
795
796 <para>
797  The <quote>jarfile</quote> defines where
798  <application>Junkbuster</application> stores the cookies it intercepts.  Note
799  that if you use a <quote>jarfile</quote>, it may grow quite large. Default:
800  Don't store intercepted cookies.
801 </para>
802
803 <para>
804  <literal>
805   <msgtext> 
806    <literallayout>
807   <emphasis>#jarfile  jarfile</emphasis>
808    </literallayout>
809   </msgtext> 
810  </literal>
811 </para>
812
813 <para>
814  If you specify a <quote>trustfile</quote>,
815  <application>Junkbuster</application> will only allow access to sites that
816  are named in the trustfile. You can also mark sites as trusted referrers,
817  with the effect that access to untrusted sites will be granted, if a link
818  from a trusted referrer was used. The link target will then be added to the
819  <quote>trustfile</quote>. This is a very restrictive feature that typical
820  users most probably want to leave disabled. Default: Disabled, don't use the
821  trust mechanism.
822 </para>
823
824 <para>
825  <literal>
826   <msgtext> 
827    <literallayout>
828   <emphasis>#trustfile  trust</emphasis>
829    </literallayout>
830   </msgtext> 
831  </literal>
832 </para>
833  
834 <para>
835  If you use the trust mechanism, it is a good idea to write up some on-line
836  documentation about your blocking policy and to specify the URL(s) here. They
837  will appear on the page that your users receive when they try to access
838  untrusted content. Use multiple times for multiple URLs. Default: Don't
839  display links on the <quote>untrusted</quote> info page.
840 </para>
841
842 <para>
843  <literal>
844   <msgtext> 
845    <literallayout>
846   <emphasis>trust-info-url http://www.your-site.com/why_we_block.html</emphasis>
847   <emphasis>trust-info-url http://www.your-site.com/what_we_allow.html</emphasis>
848    </literallayout>
849   </msgtext> 
850  </literal>
851 </para>
852
853 </sect3>
854
855 <!--  ~  End section  ~  -->
856
857
858
859 <!--   ~~~~~       New section      ~~~~~     -->
860
861 <sect3>
862 <title>Other Configuration Options</title>
863
864 <para>
865  This part of the configuration file contains options that control how
866  <application>Junkbuster</application> operates.
867 </para>
868
869 <para>
870  <quote>Admin-address</quote> should be set to the email address of the proxy
871  administrator. It is used in many of the proxy-generated pages. Default:
872  fill@me.in.please.
873 </para>
874
875 <para>
876  <literal>
877   <msgtext> 
878    <literallayout>
879   <emphasis>#admin-address  fill@me.in.please</emphasis>
880    </literallayout>
881   </msgtext> 
882  </literal>
883 </para>
884
885 <para>
886  <quote>Proxy-info-url</quote> can be set to a URL that contains more info
887  about this <application>Junkbuster</application> installation, it's
888  configuration and policies. It is used in many of the proxy-generated pages
889  and its use is highly recommended in multi-user installations, since your
890  users will want to know why certain content is blocked or modified. Default:
891  Don't show a link to on-line documentation.
892 </para>
893
894 <para>
895  <literal>
896   <msgtext> 
897    <literallayout>
898   <emphasis>proxy-info-url  http://www.your-site.com/proxy.html</emphasis>
899    </literallayout>
900   </msgtext> 
901  </literal>
902 </para>
903
904 <para>
905  <quote>Listen-address</quote> specifies the address and port where
906  <application>Junkbuster</application> will listen for connections from your
907  Web browser.  The default is to listen on the localhost port 8118, and
908  this is suitable for most users.  (In your web browser, under proxy
909  configuration, list the proxy server as <quote>localhost</quote> and the
910  port as <quote>8118</quote>).
911 </para>
912
913 <para>
914  If you already have another service running on port 8118, or if you want to
915  serve requests from other machines (e.g. on your local network) as well, you
916  will need to override the default. The syntax is 
917  <quote>listen-address [&lt;ip-address&gt;]:&lt;port&gt;</quote>. If you leave
918  out the IP address, <application>junkbuster</application> will bind to all
919  interfaces (addresses) on your machine and may become reachable from the
920  Internet. In that case, consider using access control lists (acl's) (see
921  <quote>aclfile</quote> above), or a firewall.
922 </para>
923
924 <para>
925  For example, suppose you are running <application>Junkbuster</application> on
926  a machine which has the address 192.168.0.1 on your local private network
927  (192.168.0.0) and has another outside connection with a different address.
928  You want it to serve requests from inside only:
929 </para>
930
931 <para>
932  <literal>
933   <msgtext> 
934    <literallayout>
935   <emphasis>listen-address  192.168.0.1:8118</emphasis>
936    </literallayout>
937   </msgtext> 
938  </literal>
939 </para>
940
941 <para>
942  If you want it to listen on all addresses (including the outside
943  connection):
944 </para>
945
946 <para>
947  <literal>
948   <msgtext> 
949    <literallayout>
950   <emphasis>listen-address  :8118</emphasis>
951    </literallayout>
952   </msgtext> 
953  </literal>
954 </para>
955
956 <para>
957  If you do this, consider using ACLs (see <quote>aclfile</quote> above). Note:
958  you will need to point your browser(s) to the address and port that you have
959  configured here. Default: localhost:8118 (127.0.0.1:8118).
960 </para>
961
962 <para>
963  The debug option sets the level of debugging information to log in the
964  logfile (and to the console in the Windows version).  A debug level of 1 is
965  informative because it will show you each request as it happens.  Higher
966  levels of debug are probably only of interest to developers.
967 </para>
968
969 <para>
970  <literal>
971   <msgtext> 
972    <literallayout>
973   debug         1 # GPC   = show each GET/POST/CONNECT request
974   debug         2 # CONN  = show each connection status
975   debug         4 # IO    = show I/O status
976   debug         8 # HDR   = show header parsing
977   debug        16 # LOG   = log all data into the logfile
978   debug        32 # FRC   = debug force feature
979   debug        64 # REF   = debug regular expression filter 
980   debug       128 #       = debug fast redirects
981   debug       256 #       = debug GIF de-animation
982   debug       512 # CLF   = Common Log Format
983   debug      1024 #       = debug kill pop-ups
984   debug      4096 # INFO  = Startup banner and warnings.
985   debug      8192 # ERROR = Non-fatal errors
986     </literallayout>
987   </msgtext>
988  </literal>
989 </para>
990
991 <para>
992  It is <emphasis>highly recommended</emphasis> that you enable ERROR
993  reporting (debug 8192), at least until the next stable release.
994 </para>
995
996 <para>
997  The reporting of FATAL errors (i.e. ones which crash 
998  <application>JunkBuster</application>) is always on and cannot be disabled.
999 </para>
1000
1001 <para>
1002  If you want to use CLF (Common Log Format), you should set <quote>debug
1003  512</quote> ONLY, do not enable anything else.
1004 </para>
1005
1006 <para>
1007  Multiple <quote>debug</quote> directives, are OK - they're logical-OR'd
1008  together. 
1009 </para>
1010
1011 <para>
1012  <literal>
1013   <msgtext> 
1014    <literallayout>
1015   <emphasis>debug    15     # same as setting the first 4 listed above</emphasis>
1016    </literallayout>
1017   </msgtext> 
1018  </literal>
1019 </para>
1020
1021 <para>
1022  Default:
1023 </para>
1024
1025 <para>
1026  <literal>
1027   <msgtext> 
1028    <literallayout>
1029   <emphasis>debug   1     # URLs</emphasis>
1030   <emphasis>debug   4096  # Info</emphasis>
1031   <emphasis>debug   8192  # Errors - *we highly recommended enabling this*</emphasis>
1032    </literallayout>
1033   </msgtext> 
1034  </literal>
1035 </para>
1036
1037 <para>
1038  <application>Junkbuster</application> normally uses
1039  <quote>multi-threading</quote>, a software technique that permits it to
1040  handle many different requests simultaneously. In some cases you may wish to
1041  disable this -- particularly if you're trying to debug a problem.  The
1042  <quote>single-threaded</quote> option forces
1043  <application>Junkbuster</application> to handle requests sequentially.
1044  Default: Multi-threaded mode.
1045 </para>
1046
1047 <para>
1048  <literal>
1049   <msgtext> 
1050    <literallayout>
1051   <emphasis>#single-threaded</emphasis>
1052    </literallayout>
1053   </msgtext> 
1054  </literal>
1055 </para>
1056
1057 <para>
1058  <quote>toggle</quote> allows you to temporarily disable all
1059  <application>Junkbuster's</application>  filtering. Just set <quote>toggle
1060  0</quote>.
1061 </para>
1062
1063 <para>
1064  The Windows version of <application>Junkbuster</application> puts an icon in
1065  the system tray, which also allows you to change this option.  If you
1066  right-click on that icon (or select the <quote>Options</quote> menu), one
1067  choice is <quote>Enable</quote>. Clicking on enable toggles
1068  <application>Junkbuster</application> on and off. This is useful if you want
1069  to temporarily disable <application>Junkbuster</application>, e.g., to access
1070  a site that requires cookies which you would otherwise have blocked. This can also
1071  be toggled via a web browser at the <application>Junkbuster</application>
1072  internal address of <ulink url="http://i.j.b">http://i.j.b</ulink> on 
1073  any platform.
1074 </para>
1075
1076 <para>
1077  <quote>toggle 1</quote> means <application>Junkbuster</application> runs
1078  normally, <quote>toggle 0</quote> means that
1079  <application>Junkbuster</application> becomes a non-anonymizing non-blocking
1080  proxy. Default: 1 (on). 
1081 </para>
1082
1083 <para>
1084  <literal>
1085   <msgtext> 
1086    <literallayout>
1087   <emphasis>toggle    1</emphasis>
1088    </literallayout>
1089   </msgtext> 
1090  </literal>
1091 </para>
1092
1093 <para>
1094  For content filtering, i.e. the <quote>+filter</quote> and
1095  <quote>+deanimate-gif</quote> actions, it is necessary that 
1096  <application>Junkbuster</application> buffers the entire document body.
1097  This can be potentially dangerous, since a server could just keep sending
1098  data indefinitely and wait for your RAM to exhaust. With nasty consequences.
1099 </para>
1100
1101 <para>
1102  The <application>buffer-limit</application> option lets you set the maximum
1103  size in Kbytes that each buffer may use. When the documents buffer exceeds
1104  this size, it is flushed to the client unfiltered and no further attempt to
1105  filter the rest of it is made. Remember that there may multiple threads
1106  running, which might require increasing the <quote>buffer-limit</quote>
1107  Kbytes <emphasis>each</emphasis>, unless you have enabled 
1108  <quote>single-threaded</quote> above.
1109 </para>
1110
1111 <para>
1112  <literal>
1113   <msgtext> 
1114    <literallayout>
1115   <emphasis>buffer-limit    4069</emphasis>
1116    </literallayout>
1117   </msgtext> 
1118  </literal>
1119 </para>
1120
1121 <para>
1122  To enable the web-based <filename>ijb.action</filename> file editor set
1123  <application>enable-edit-actions</application> to 1, or 0 to disable.  Note
1124  that you must have compiled <application>JunkBuster</application> with
1125  support for this feature, otherwise this option has no effect. This 
1126  internal page can be reached at <ulink
1127  url="http://i.j.b">http://i.j.b</ulink>.
1128  </para>
1129
1130 <para>
1131  Security note: If this is enabled, anyone who can use the proxy
1132  can edit the actions file, and their changes will affect all users.
1133  For shared proxies, you probably want to disable this. Default: enabled.
1134 </para>
1135
1136 <para>
1137  <literal>
1138   <msgtext> 
1139    <literallayout>
1140   <emphasis>enable-edit-actions    1</emphasis>
1141    </literallayout>
1142   </msgtext> 
1143  </literal>
1144 </para>
1145
1146 <para>
1147  Allow <application>JunkBuster</application> to be toggled on and off
1148  remotely, using your web browser.  Set <quote>enable-remote-toggle</quote>to
1149  1 to enable, and 0 to disable.  Note that you must have compiled 
1150  <application>JunkBuster</application> with support for this feature,
1151  otherwise this option has no effect.
1152 </para>
1153
1154 <para>
1155  Security note:  If this is enabled, anyone who can use the proxy can toggle
1156  it on or off (see <ulink url="http://i.j.b">http://i.j.b</ulink>), and
1157  their changes will affect all users. For shared proxies, you probably want to
1158  disable this. Default: enabled.
1159 </para>
1160
1161 <para>
1162  <literal>
1163   <msgtext> 
1164    <literallayout>
1165   <emphasis>enable-remote-toggle    1</emphasis>
1166    </literallayout>
1167   </msgtext> 
1168  </literal>
1169 </para>
1170
1171 </sect3>
1172
1173 <!--  ~  End section  ~  -->
1174
1175
1176 <!--   ~~~~~       New section      ~~~~~     -->
1177
1178 <sect3>
1179 <title>Access Control List (ACL)</title>
1180 <para>
1181  Access controls are included at the request of some ISPs and systems
1182  administrators, and are not usually needed by individual users. Please note
1183  the warnings in the FAQ that this proxy is not intended to be a substitute
1184  for a firewall or to encourage anyone to defer addressing basic security
1185  weaknesses.
1186 </para>
1187
1188 <para>
1189  If no access settings are specified, the proxy talks to anyone that
1190  connects. If any access settings file are specified, then the proxy
1191  talks only to IP addresses permitted somewhere in this file and not
1192  denied later in this file.
1193 </para>
1194
1195 <para>
1196  Summary -- if using an ACL:
1197 </para>
1198
1199  <simplelist>
1200   <member>
1201    Client must have permission to receive service.
1202   </member>
1203  </simplelist>
1204  <simplelist>
1205   <member>
1206    LAST match in ACL wins.
1207   </member>
1208  </simplelist>
1209  <simplelist>
1210   <member>
1211    Default behavior is to deny service.
1212   </member>
1213  </simplelist>
1214
1215 <para>
1216  The syntax for an entry in the Access Control List is:
1217 </para>
1218
1219 <para>
1220  <literal>
1221   <msgtext> 
1222    <literallayout>
1223   ACTION    SRC_ADDR[/SRC_MASKLEN]    [ DST_ADDR[/DST_MASKLEN] ]
1224    </literallayout>
1225   </msgtext> 
1226  </literal>
1227 </para>
1228
1229 <para>
1230  Where the individual fields are:
1231 </para>
1232
1233 <para>
1234  <literal>
1235   <msgtext> 
1236    <literallayout>
1237  <emphasis>ACTION</emphasis>      = <quote>permit-access</quote> or <quote>deny-access</quote>
1238
1239  <emphasis>SRC_ADDR</emphasis>    = client hostname or dotted IP address
1240  <emphasis>SRC_MASKLEN</emphasis> = number of bits in the subnet mask for the source
1241
1242  <emphasis>DST_ADDR</emphasis>    = server or forwarder hostname or dotted IP address
1243  <emphasis>DST_MASKLEN</emphasis> = number of bits in the subnet mask for the target
1244    </literallayout>
1245   </msgtext> 
1246  </literal>
1247 </para>
1248
1249
1250 <para> 
1251  The field separator (FS) is whitespace (space or tab).
1252 </para>
1253
1254 <para>
1255  IMPORTANT NOTE: If the <application>junkbuster</application> is using a
1256  forwarder (see below) or a gateway for a particular destination URL, the
1257  <literal>DST_ADDR</literal> that is examined is the address of the forwarder
1258  or the gateway and <emphasis>NOT</emphasis> the address of the ultimate
1259  target. This is necessary because it may be impossible for the local
1260  <application>Junkbuster</application> to determine the address of the
1261  ultimate target (that's often what gateways are used for).
1262 </para>
1263
1264 <para>
1265  Here are a few examples to show how the ACL features work:
1266 </para>
1267
1268 <para>
1269  <quote>localhost</quote> is OK -- no DST_ADDR implies that
1270  <emphasis>ALL</emphasis> destination addresses are OK:
1271 </para>
1272
1273 <para>
1274  <literal>
1275   <msgtext> 
1276    <literallayout>
1277   <emphasis>permit-access  localhost</emphasis>
1278    </literallayout>
1279   </msgtext> 
1280  </literal>
1281 </para>
1282
1283 <para>
1284  A silly example to illustrate permitting any host on the class-C subnet with
1285  <application>Junkbuster</application> to go anywhere:
1286 </para>
1287
1288 <para>
1289  <literal>
1290   <msgtext> 
1291    <literallayout>
1292   <emphasis>permit-access    www.junkbusters.com/24</emphasis>
1293    </literallayout>
1294   </msgtext> 
1295  </literal>
1296 </para>
1297
1298 <para>
1299  Except deny one particular IP address from using it at all:
1300 </para>
1301
1302 <para>
1303  <literal>
1304   <msgtext> 
1305    <literallayout>
1306   <emphasis>deny-access      ident.junkbusters.com</emphasis>
1307    </literallayout>
1308   </msgtext> 
1309  </literal>
1310 </para>
1311
1312 <para>
1313  You can also specify an explicit network address and subnet mask.
1314  Explicit addresses do not have to be resolved to be used.
1315 </para>
1316
1317 <para>
1318  <literal>
1319   <msgtext> 
1320    <literallayout>
1321   <emphasis>permit-access    207.153.200.0/24</emphasis>
1322    </literallayout>
1323   </msgtext> 
1324  </literal>
1325 </para>
1326
1327 <para>
1328  A subnet mask of 0 matches anything, so the next line permits everyone.
1329 </para>
1330
1331 <para>
1332  <literal>
1333   <msgtext> 
1334    <literallayout>
1335   <emphasis>permit-access    0.0.0.0/0</emphasis>
1336    </literallayout>
1337   </msgtext> 
1338  </literal>
1339 </para>
1340
1341 <para>
1342  Note, you <emphasis>cannot</emphasis> say:
1343 </para>
1344
1345 <para>
1346  <literal>
1347   <msgtext> 
1348    <literallayout>
1349   <emphasis>permit-access    .org</emphasis>
1350    </literallayout>
1351   </msgtext> 
1352  </literal>
1353 </para>
1354
1355 <para>
1356  to allow all *.org domains. Every IP address listed must resolve fully.
1357 </para>
1358
1359 <para>
1360  An ISP may want to provide a <application>Junkbuster</application> that is
1361  accessible by <quote>the world</quote> and yet restrict use of some of their
1362  private content to hosts on its internal network (i.e. its own subscribers).
1363  Say, for instance the ISP owns the Class-B IP address block 123.124.0.0 (a 16
1364  bit netmask). This is how they could do it:
1365 </para>
1366
1367 <para>
1368  <literal>
1369   <msgtext> 
1370    <literallayout>
1371  <emphasis>permit-access 0.0.0.0/0   0.0.0.0/0</emphasis>   # other clients can go anywhere 
1372                                        # with the following exceptions:
1373  
1374  <emphasis>deny-access</emphasis>   0.0.0.0/0   123.124.0.0/16 # block all external requests for
1375                                           # sites on the ISP's network
1376
1377  <emphasis>permit 0.0.0.0/0   www.my_isp.com</emphasis>        # except for the ISP's main 
1378                                           # web site
1379
1380  <emphasis>permit 123.124.0.0/16 0.0.0.0/0</emphasis>          # the ISP's clients can go 
1381                                           # anywhere
1382    </literallayout>
1383   </msgtext> 
1384  </literal>
1385 </para>
1386
1387 <para>
1388  Note that if some hostnames are listed with multiple IP addresses, 
1389  the primary value returned by DNS (via gethostbyname()) is used. Default:
1390  Anyone can access the proxy.
1391 </para>
1392
1393 </sect3>
1394
1395 <!--  ~  End section  ~  -->
1396
1397
1398 <!--   ~~~~~       New section      ~~~~~     -->
1399
1400 <sect3>
1401 <title>Forwarding</title>
1402
1403 <para>
1404  This feature allows chaining of HTTP requests via multiple proxies.
1405  It can be used to better protect privacy and confidentiality when
1406  accessing specific domains by routing requests to those domains
1407  to a special purpose filtering proxy such as lpwa.com. Or to use 
1408  a caching proxy to speed up browsing.
1409 </para>
1410
1411 <para>
1412  It can also be used in an environment with multiple networks to route
1413  requests via multiple gateways allowing transparent access to multiple
1414  networks without having to modify browser configurations.
1415 </para>
1416
1417 <para>
1418  Also specified here are SOCKS proxies. <application>Junkbuster</application>
1419  SOCKS 4 and SOCKS 4A. The difference is that SOCKS 4A will resolve the target
1420  hostname using DNS on the SOCKS server, not our local DNS client.
1421 </para>
1422
1423 <para>
1424  The syntax of each line is:
1425 </para>
1426
1427 <para>
1428  <literal>
1429   <msgtext> 
1430    <literallayout>
1431  <emphasis>forward target_domain[:port] http_proxy_host[:port]</emphasis>
1432  <emphasis>forward-socks4  target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1433  <emphasis>forward-socks4a target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1434    </literallayout>
1435   </msgtext> 
1436  </literal>
1437 </para>
1438
1439 <para>
1440  If http_proxy_host is <quote>.</quote>, then requests are not forwarded to a
1441  HTTP proxy but are made directly to the web servers.
1442 </para>
1443
1444 <para>
1445  Lines are checked in sequence, and the last match wins.
1446 </para>
1447
1448 <para>
1449  There is an implicit line equivalent to the following, which specifies that
1450  anything not finding a match on the list is to go out without forwarding
1451  or gateway protocol, like so:
1452 </para>
1453
1454 <para>
1455  <literal>
1456   <msgtext> 
1457    <literallayout>
1458   <emphasis>forward   .*   .       </emphasis># implicit
1459    </literallayout>
1460   </msgtext> 
1461  </literal>
1462 </para>
1463
1464 <para>
1465  In the following common configuration, everything goes to Lucent's LPWA,
1466  except SSL on port 443 (which it doesn't handle):
1467 </para>
1468
1469 <para>
1470  <literal>
1471   <msgtext> 
1472    <literallayout>
1473  <emphasis>forward   .*     lpwa.com:8000</emphasis>
1474  <emphasis>forward   :443   .</emphasis>
1475    </literallayout>
1476   </msgtext> 
1477  </literal>
1478 </para>
1479
1480 <para>
1481  See the FAQ for instructions on how to automate the login procedure for LPWA.
1482  Some users have reported difficulties related to LPWA's use of
1483  <quote>.</quote> as the last element of the domain, and have said that this
1484  can be fixed with this:
1485 </para>
1486    
1487 <para>
1488  <literal>
1489   <msgtext> 
1490    <literallayout>
1491   <emphasis>forward   lpwa.  lpwa.com:8000</emphasis>
1492    </literallayout>
1493   </msgtext> 
1494  </literal>
1495 </para>
1496  
1497 <para>
1498  (NOTE: the syntax for specifying target_domain has changed since the
1499  previous paragraph was written -- it will not work now.  More information
1500  is welcome.)
1501 </para>
1502
1503 <para>
1504  In this fictitious example, everything goes via an ISP's caching proxy,
1505  except requests to that ISP:
1506 </para>
1507
1508 <para>
1509  <literal>
1510   <msgtext> 
1511    <literallayout>
1512  <emphasis>forward    .*         caching.myisp.net:8000</emphasis>
1513  <emphasis>forward    myisp.net  .</emphasis>
1514    </literallayout>
1515   </msgtext> 
1516  </literal>
1517 </para>
1518
1519 <para>
1520  For the @home network, we're told the forwarding configuration is this:
1521 </para>
1522
1523
1524 <para>
1525  <literal>
1526   <msgtext> 
1527    <literallayout>
1528   <emphasis>forward    .*    proxy:8080</emphasis>
1529    </literallayout>
1530   </msgtext> 
1531  </literal>
1532 </para>
1533
1534 <para>
1535  Also, we're told they insist on getting cookies and JavaScript, so you should 
1536  add home.com to the cookie file. We consider JavaScript a security risk.
1537  Java need not be enabled.
1538 </para>
1539
1540 <para>
1541  In this example direct connections are made to all <quote>internal</quote>
1542  domains, but everything else goes through Lucent's LPWA by way of the
1543  company's SOCKS gateway to the Internet.
1544 </para>
1545
1546 <para>
1547  <literal>
1548   <msgtext> 
1549    <literallayout>
1550  <emphasis>forward-socks4  .*  lpwa.com:8000  firewall.my_company.com:1080</emphasis>
1551  <emphasis>forward    my_company.com  .</emphasis>
1552    </literallayout>
1553   </msgtext> 
1554  </literal>
1555 </para>
1556
1557 <para>
1558  This is how you could set up a site that always uses SOCKS but no forwarders:
1559 </para>
1560
1561 <para>
1562  <literal>
1563   <msgtext> 
1564    <literallayout>
1565   <emphasis>forward-socks4a   .*  .  firewall.my_company.com:1080</emphasis>
1566    </literallayout>
1567   </msgtext> 
1568  </literal>
1569 </para>
1570
1571 <para>
1572  An advanced example for network administrators:
1573 </para>
1574
1575 <para>
1576  If you have links to multiple ISPs that provide various special content to
1577  their subscribers, you can configure forwarding to pass requests to the
1578  specific host that's connected to that ISP so that everybody can see all
1579  of the content on all of the ISPs.
1580 </para>
1581
1582 <para>
1583  This is a bit tricky, but here's an example:
1584 </para>
1585
1586
1587 <para>
1588  host-a has a PPP connection to isp-a.com. And host-b has a PPP connection to
1589  isp-b.com. host-a can run a <application>Junkbuster</application> proxy with
1590  forwarding like this: 
1591 </para>
1592
1593 <para>
1594  <literal>
1595   <msgtext> 
1596    <literallayout>
1597  <emphasis>forward    .*         .</emphasis>
1598  <emphasis>forward    isp-b.com  host-b:8118</emphasis>
1599    </literallayout>
1600   </msgtext> 
1601  </literal>
1602 </para>
1603
1604 <para>
1605  host-b can run a <application>Junkbuster</application> proxy with forwarding
1606  like this: 
1607 </para>
1608
1609 <para>
1610  <literal>
1611   <msgtext> 
1612    <literallayout>
1613  <emphasis>forward    .*          .</emphasis>
1614  <emphasis>forward    isp-a.com   host-a:8118</emphasis>
1615    </literallayout>
1616   </msgtext> 
1617  </literal>
1618 </para>
1619
1620 <para>
1621  Now, <emphasis>anyone</emphasis> on the Internet (including users on host-a
1622  and host-b) can set their browser's proxy to <emphasis>either</emphasis>
1623  host-a or host-b and be able to browse the content on isp-a or isp-b.
1624 </para>
1625
1626 <para>
1627  Here's another practical example, for University of Kent at
1628  Canterbury students with a network connection in their room, who
1629  need to use the University's Squid web cache.
1630 </para>
1631
1632 <para>
1633  <literal>
1634   <msgtext> 
1635    <literallayout>
1636  <emphasis>forward  *. ssbcache.ukc.ac.uk:3128</emphasis>  # Use the proxy, except for:
1637  <emphasis>forward  .ukc.ac.uk            .    </emphasis> # Anything on the same domain as us
1638  <emphasis>forward  *                     .    </emphasis> # Host with no domain specified
1639  <emphasis>forward  129.12.*.*            .    </emphasis> # A dotted IP on our /16 network.
1640  <emphasis>forward  127.*.*.*             .    </emphasis> # Loopback address
1641  <emphasis>forward  localhost.localdomain .    </emphasis> # Loopback address
1642  <emphasis>forward  www.ukc.mirror.ac.uk  .    </emphasis> # Specific host
1643    </literallayout>
1644   </msgtext> 
1645  </literal>
1646 </para>
1647
1648 <para>
1649  If you intend to chain <application>Junkbuster</application> and 
1650  <application>squid</application> locally, then chain as 
1651  <literal>browser -> squid -> junkbuster</literal> is the recommended way. 
1652 </para>
1653
1654 <para>
1655  Your squid configuration could then look like this:
1656 </para>
1657
1658 <para>
1659  <literal>
1660   <msgtext> 
1661    <literallayout>
1662   # Define junkbuster as parent cache 
1663  <!-- per feedback from user...
1664   cache_peer 127.0.0.1 8118 parent 0 no-query 
1665  --> 
1666   cache_peer 127.0.0.1 parent 8118 0 no-query
1667   
1668   # Define ACL for protocol FTP 
1669   acl FTP proto FTP 
1670
1671   # Do not forward ACL FTP to junkbuster 
1672   always_direct allow FTP 
1673
1674   # Do not forward ACL CONNECT (https) to junkbuster 
1675   always_direct allow CONNECT 
1676
1677   # Forward the rest to junkbuster 
1678   never_direct allow all 
1679    </literallayout>
1680   </msgtext> 
1681  </literal>
1682 </para>
1683
1684 </sect3>
1685
1686 <!--  ~  End section  ~  -->
1687
1688
1689 <!--   ~~~~~       New section      ~~~~~     -->
1690
1691 <sect3>
1692 <title>Windows GUI Options</title>
1693 <!--
1694 Removed references to Win32. HB 09/23/01
1695 -->
1696 <para>
1697  <application>Junkbuster</application> has a number of options specific to the
1698  Windows GUI interface:
1699 </para>
1700
1701 <para>
1702  If <quote>activity-animation</quote> is set to 1, the
1703  <application>Junkbuster</application> icon will animate when
1704  <quote>Junkbuster</quote> is active. To turn off, set to 0.
1705 </para>
1706
1707 <para>
1708  <literal>
1709   <msgtext> 
1710    <literallayout>
1711   <emphasis>activity-animation   1</emphasis>
1712    </literallayout>
1713   </msgtext> 
1714  </literal>
1715 </para>
1716
1717 <para>
1718  If <quote>log-messages</quote> is set to 1,
1719  <application>Junkbuster</application> will log messages to the console
1720  window:
1721 </para>
1722
1723 <para>
1724  <literal>
1725   <msgtext> 
1726    <literallayout>
1727   <emphasis>log-messages       1</emphasis>
1728    </literallayout>
1729   </msgtext> 
1730  </literal>
1731 </para>
1732
1733 <para> 
1734  If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
1735  i.e. the amount of memory used for the log messages displayed in the
1736  console window, will be limited to <quote>log-max-lines</quote> (see below).
1737 </para>
1738
1739 <para>
1740  Warning: Setting this to 0 will result in the buffer to grow infinitely and
1741  eat up all your memory!
1742 </para>
1743
1744 <para>
1745  <literal>
1746   <msgtext> 
1747    <literallayout>
1748   <emphasis>log-buffer-size      1</emphasis>
1749    </literallayout>
1750   </msgtext> 
1751  </literal>
1752 </para>
1753
1754 <para>
1755  <application>log-max-lines</application> is the maximum number of lines held
1756  in the log buffer. See above.
1757 </para>
1758
1759 <para>
1760  <literal>
1761   <msgtext> 
1762    <literallayout>
1763   <emphasis>log-max-lines      200</emphasis>
1764    </literallayout>
1765   </msgtext> 
1766  </literal>
1767 </para>
1768
1769 <para>
1770  If <quote>log-highlight-messages</quote> is set to 1,
1771  <application>Junkbuster</application> will highlight portions of the log
1772  messages with a bold-faced font:
1773 </para>
1774
1775 <para>
1776  <literal>
1777   <msgtext> 
1778    <literallayout>
1779   <emphasis>log-highlight-messages   1</emphasis>
1780    </literallayout>
1781   </msgtext> 
1782  </literal>
1783 </para>
1784
1785 <para>
1786  The font used in the console window:
1787 </para>
1788
1789 <para>
1790  <literal>
1791   <msgtext> 
1792    <literallayout>
1793   <emphasis>log-font-name        Comic Sans MS</emphasis>
1794    </literallayout>
1795   </msgtext> 
1796  </literal>
1797 </para>
1798
1799 <para>
1800  Font size used in the console window:
1801 </para>
1802
1803 <para>
1804  <literal>
1805   <msgtext> 
1806    <literallayout>
1807   <emphasis>log-font-size        8</emphasis>
1808    </literallayout>
1809   </msgtext> 
1810  </literal>
1811 </para>
1812
1813 <para>  
1814  <quote>show-on-task-bar</quote> controls whether or not
1815  <application>Junkbuster</application> will appear as a button on the Task bar
1816  when minimized:
1817 </para>
1818
1819 <para>
1820  <literal>
1821   <msgtext> 
1822    <literallayout>
1823   <emphasis>show-on-task-bar     0</emphasis>
1824    </literallayout>
1825   </msgtext> 
1826  </literal>
1827 </para>
1828
1829 <para>
1830  If <quote>close-button-minimizes</quote> is set to 1, the Windows close
1831  button will minimize <application>Junkbuster</application> instead of closing
1832  the program (close with the exit option on the File menu).
1833 </para>
1834
1835 <para>
1836  <literal>
1837   <msgtext> 
1838    <literallayout>
1839   <emphasis>close-button-minimizes  1</emphasis>
1840    </literallayout>
1841   </msgtext> 
1842  </literal>
1843 </para>
1844
1845 <para>
1846  The <quote>hide-console</quote> option is specific to the MS-Win console
1847  version of <application>JunkBuster</application>. If this option is used,
1848  <application>Junkbuster</application> will disconnect from and hide  the
1849  command console.
1850 </para>
1851
1852 <para>
1853  <literal>
1854   <msgtext> 
1855    <literallayout>
1856   #hide-console
1857    </literallayout>
1858   </msgtext> 
1859  </literal>
1860 </para>
1861
1862 </sect3>
1863 </sect2>
1864
1865 <!--  ~  End section  ~  -->
1866
1867
1868 <!--   ~~~~~       New section      ~~~~~     -->
1869 <sect2 id="actionsfile">
1870 <title>The Actions File</title>
1871
1872 <para>
1873  The <quote>ijb.action</quote> file (formerly
1874  <filename>actionsfile</filename>) is used to define what actions
1875  <application>Junkbuster</application> takes, and thus determines how images,
1876  cookies and various other aspects of HTTP content and transactions are
1877  handled. Images can be anything you want, including ads, banners, or just
1878  some obnoxious image that you would rather not see. Cookies can be accepted
1879  or rejected, or accepted only during the current browser session (i.e. 
1880  not written to disk). Changes to <filename>ijb.action</filename> should 
1881  be immediately visible to <application>Junkbuster</application> without 
1882  the need to restart.
1883 </para>
1884
1885 <para>
1886  To determine which actions apply to a request, the URL of the request is
1887  compared to all patterns in this file. Every time it matches, the list of
1888  applicable actions for the URL is incrementally updated. You can trace
1889  this process by visiting <ulink
1890  url="http://i.j.b/show-url-info">http://i.j.b/show-url-info</ulink>. 
1891 </para>
1892
1893 <para>
1894  The actions file can be edited with a browser by loading 
1895  <ulink url="http://i.j.b/">http://i.j.b/</ulink>, and then select 
1896  <quote>Edit Actions</quote>.
1897 </para>
1898
1899 <para>
1900  There are four types of lines in this file: comments (begin with a 
1901  <quote>#</quote> character), actions, aliases and patterns, all of which are
1902  explained below, as well as the configuration file syntax that 
1903  <application>Junkbuster</application> understands.
1904
1905 </para>
1906
1907
1908 <!--   ~~~~~       New section      ~~~~~     -->
1909 <sect3>
1910 <title>URL Domain and Path Syntax</title>
1911 <para>
1912  Generally, a pattern has the form &lt;domain&gt;/&lt;path&gt;, where both the
1913  &lt;domain&gt; and &lt;path&gt; part are optional. If you only specify a
1914  domain part, the <quote>/</quote> can be left out:
1915 </para>
1916
1917 <para>
1918  <emphasis>www.example.com</emphasis> - is a domain only pattern and will match any request to
1919  <quote>www.example.com</quote>.
1920 </para>
1921
1922 <para>
1923  <emphasis>www.example.com/</emphasis> - means exactly the same.
1924 </para>
1925
1926 <para>
1927  <emphasis>www.example.com/index.html</emphasis> - matches only the single
1928  document <quote>/index.html</quote> on <quote>www.example.com</quote>.
1929 </para>
1930
1931 <para>
1932  <emphasis>/index.html</emphasis> - matches the document <quote>/index.html</quote>, regardless of
1933  the domain.
1934 </para>
1935
1936 <para>
1937  <emphasis>index.html</emphasis> - matches nothing, since it would be
1938  interpreted as a domain name and there is no top-level domain called
1939  <quote>.html</quote>.
1940 </para>
1941
1942 <para>
1943  The matching of the domain part offers some flexible options: if the
1944  domain starts or ends with a dot, it becomes unanchored at that end. 
1945  For example:
1946 </para>
1947
1948 <para>
1949  <emphasis>.example.com</emphasis> - matches any domain that <emphasis>ENDS</emphasis> in 
1950  <quote>.example.com</quote>.
1951 </para>
1952
1953 <para>
1954  <emphasis>www.</emphasis> - matches any domain that <emphasis>STARTS</emphasis> with
1955  <quote>www</quote>.
1956 </para>
1957
1958 <para>
1959  Additionally, there are wild-cards that you can use in the domain names
1960  themselves. They work pretty similar to shell wild-cards: <quote>*</quote>
1961  stands for zero or more arbitrary characters, <quote>?</quote> stands for
1962  any single character. And you can define character classes in square
1963  brackets and they can be freely mixed:
1964 </para>
1965
1966 <para>
1967  <emphasis>ad*.example.com</emphasis> - matches <quote>adserver.example.com</quote>, 
1968  <quote>ads.example.com</quote>, etc but not <quote>sfads.example.com</quote>.
1969 </para>
1970
1971 <para>
1972  <emphasis>*ad*.example.com</emphasis> - matches all of the above, and then some.
1973 </para>
1974
1975 <para>
1976  <emphasis>.?pix.com</emphasis> - matches <quote>www.ipix.com</quote>,
1977  <quote>pictures.epix.com</quote>, <quote>a.b.c.d.e.upix.com</quote>, etc. 
1978 </para>
1979
1980 <para>
1981  <emphasis>www[1-9a-ez].example.com</emphasis> - matches <quote>www1.example.com</quote>, 
1982  <quote>www4.example.com</quote>, <quote>wwwd.example.com</quote>, 
1983  <quote>wwwz.example.com</quote>, etc., but <emphasis>not</emphasis> 
1984  <quote>wwww.example.com</quote>.
1985 </para>
1986
1987 <para>
1988  If <application>Junkbuster</application> was compiled with
1989  <quote>pcre</quote> support (default), Perl compatible regular expressions
1990  can be used. See the <filename>pcre/docs/</filename> directory or <quote>man
1991  perlre</quote> (also available on  <ulink
1992  url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>)
1993  for details. A brief discussion of regular expressions is in the 
1994  <link linkend="regex">Appendix</link>. For instance:
1995 </para>
1996
1997 <para>
1998  <emphasis>/.*/advert[0-9]+\.jpe?g</emphasis>  - would match a URL from any
1999  domain, with any path that includes <quote>advert</quote> followed
2000  immediately by one or more digits, then a <quote>.</quote> and ending in
2001  either <quote>jpeg</quote> or <quote>jpg</quote>. So we match
2002  <quote>example.com/ads/advert2.jpg</quote>, and
2003  <quote>www.example.com/ads/banners/advert39.jpeg</quote>, but not
2004  <quote>www.example.com/ads/banners/advert39.gif</quote> (no gifs in the
2005  example pattern).
2006 </para>
2007
2008 <para>
2009  Please note that matching in the path is case
2010  <emphasis>INSENSITIVE</emphasis> by default, but you can switch to case
2011  sensitive at any point in the pattern by using the 
2012  <quote>(?-i)</quote> switch:
2013 </para>
2014
2015 <para>
2016  <emphasis>www.example.com/(?-i)PaTtErN.*</emphasis> - will match only
2017  documents whose path starts with <quote>PaTtErN</quote> in
2018  <emphasis>exactly</emphasis> this capitalization.
2019 </para>
2020
2021 </sect3>
2022
2023 <!--  ~  End section  ~  -->
2024
2025
2026
2027 <!--   ~~~~~       New section      ~~~~~     -->
2028
2029 <sect3>
2030 <title>Actions</title>
2031 <para>
2032  Actions are enabled if preceded with a <quote>+</quote>, and disabled if 
2033  preceded with a <quote>-</quote>. Actions are invoked by enclosing the 
2034  action name in curly braces (e.g. {+some_action}), followed by a list of 
2035  URLs to which the action applies. There are three classes of actions:
2036 </para>
2037
2038 <para>
2039  <itemizedlist>
2040
2041  <listitem>
2042   <para>  
2043    Boolean (e.g. <quote>+/-block</quote>):
2044   </para>
2045   <para>
2046    <literal>
2047     <msgtext> 
2048      <literallayout>
2049   <emphasis>{+name}</emphasis>        # enable this action
2050   <emphasis>{-name}</emphasis>        # disable this action
2051      </literallayout>
2052     </msgtext> 
2053    </literal>
2054   </para>
2055  </listitem>
2056
2057
2058  <listitem>
2059   <para>  
2060    parameterized (e.g. <quote>+/-hide-user-agent</quote>):
2061   </para>
2062   <para>
2063    <literal>
2064     <msgtext> 
2065      <literallayout>
2066   <emphasis>{+name{param}}</emphasis>  # enable action and set parameter to <quote>param</quote>
2067   <emphasis>{-name}</emphasis>         # disable action
2068      </literallayout>
2069     </msgtext> 
2070    </literal>
2071   </para>
2072  </listitem>
2073  
2074  <listitem>
2075   <para>  
2076    Multi-value (e.g. <quote>{+/-add-header{Name: value}}</quote>, <quote>{+/-wafer{name=value}}</quote>):
2077   </para>
2078   <para>
2079    <literal>
2080     <msgtext> 
2081      <literallayout>
2082   <emphasis>{+name{param}}</emphasis>   # enable action and add parameter <quote>param</quote>
2083   <emphasis>{-name{param}}</emphasis>   # remove the parameter <quote>param</quote>
2084   <emphasis>{-name}</emphasis>          # disable this action totally
2085      </literallayout>
2086     </msgtext> 
2087    </literal>
2088   </para>
2089  </listitem>
2090
2091  </itemizedlist>
2092 </para>
2093
2094 <para>
2095  If nothing is specified in this file, no <quote>actions</quote> are taken.
2096  So in this case <application>JunkBuster</application> would just be a
2097  normal, non-blocking, non-anonymizing proxy. You must specifically
2098  enable the privacy and blocking features you need (although the 
2099  provided default <filename>ijb.action</filename> file will 
2100  give a good starting point).
2101 </para>
2102
2103 <para>
2104  Later defined actions always over-ride earlier ones.  For multi-valued
2105  actions, the actions are applied in the order they are specified.
2106 </para>
2107
2108 <para>
2109  The list of valid <application>Junkbuster</application> <quote>actions</quote> are:
2110 </para>
2111
2112 <para>
2113  <itemizedlist>
2114  
2115  <listitem>
2116   <para>  
2117    Add the specified HTTP header, which is not checked for validity.
2118    You may specify this many times to specify many different headers:
2119   </para>
2120   <para>
2121    <literal>
2122     <msgtext> 
2123      <literallayout>
2124   <emphasis>+add-header{Name: value}</emphasis>
2125      </literallayout>
2126     </msgtext> 
2127    </literal>
2128   </para>
2129  </listitem>
2130  
2131  
2132  <listitem>
2133   <para>  
2134    Block this URL totally.
2135   </para>
2136   <para>
2137    <literal>
2138     <msgtext> 
2139      <literallayout>
2140   <emphasis>+block</emphasis>
2141      </literallayout>
2142     </msgtext> 
2143    </literal>
2144   </para>
2145  </listitem>
2146  
2147  
2148  <listitem>
2149   <para>  
2150    De-animate all animated GIF images, i.e. reduce them to their last frame.
2151    This will also shrink the images considerably (in bytes, not pixels!). If
2152    the option <quote>first</quote> is given, the first frame of the animation
2153    is used as the replacement. If <quote>last</quote> is given, the last frame
2154    of the animation is used instead, which probably makes more sense for most
2155    banner animations, but also has the risk of not showing the entire last
2156    frame (if it is only a delta to an earlier frame).
2157   </para>
2158   <para>
2159    <literal>
2160     <msgtext> 
2161      <literallayout>
2162   <emphasis>+deanimate-gifs{last}</emphasis>
2163   <emphasis>+deanimate-gifs{first}</emphasis>
2164      </literallayout>
2165     </msgtext> 
2166    </literal>
2167   </para>
2168  </listitem>
2169  
2170  <listitem>
2171   <para>
2172    <quote>+downgrade</quote> will downgrade HTTP/1.1 client requests to
2173    HTTP/1.0 and downgrade the responses as well. Use this action for servers
2174    that use HTTP/1.1 protocol features that
2175    <application>Junkbuster</application> doesn't handle well yet. HTTP/1.1 
2176    is only partially implemented. Default is not to downgrade requests.
2177   </para>
2178   <para>
2179    <literal>
2180     <msgtext> 
2181      <literallayout>
2182   <emphasis>+downgrade</emphasis>
2183      </literallayout>
2184     </msgtext> 
2185    </literal>
2186   </para>
2187  </listitem> 
2188  
2189  <listitem>
2190   <para>  
2191    Many sites, like yahoo.com, don't just link to other sites. Instead, they
2192    will link to some script on their own server, giving the destination as a
2193    parameter, which will then redirect you to the final target. URLs resulting
2194    from this scheme typically look like:
2195    http://some.place/some_script?http://some.where-else.
2196   </para>
2197   <para>
2198    Sometimes, there are even multiple consecutive redirects encoded in the
2199    URL. These redirections via scripts make your web browsing more traceable,
2200    since the server from which you follow such a link can see where you go to.
2201    Apart from that, valuable bandwidth and time is wasted, while your browser
2202    ask the server for one redirect after the other. Plus, it feeds the
2203    advertisers.
2204   </para>
2205   <para>
2206    The <quote>+fast-redirects</quote> option enables interception of these
2207    requests by <application>Junkbuster</application>, who will cut off all but
2208    the last valid URL in the request and send a local redirect back to your
2209    browser without contacting the remote site.
2210   </para>
2211   <para>
2212    <literal>
2213     <msgtext> 
2214      <literallayout>
2215   <emphasis>+fast-redirects</emphasis>
2216      </literallayout>
2217     </msgtext> 
2218    </literal>
2219   </para>
2220  </listitem>
2221
2222  <listitem>
2223   <para>  
2224    Apply the filters in the <literal>section_header</literal> 
2225    section of the <filename>re_filterfile</filename> file to the site(s).
2226    <filename>Re_filterfile</filename> sections are grouped according to like
2227    functionality. 
2228   </para> 
2229    
2230   <para>
2231    <literal>
2232     <msgtext> 
2233      <literallayout>
2234  <emphasis>+filter{section_header}</emphasis>
2235      </literallayout>
2236     </msgtext> 
2237    </literal>
2238   </para>
2239
2240   <para>   
2241    Filter sections that are pre-defined in the supplied
2242    <filename>re_filterfile</filename> include:
2243   </para>
2244
2245  <blockquote>
2246   <simplelist>
2247    <member>
2248      <emphasis>html-annoyances</emphasis>:  Get rid of particularly annoying HTML abuse.
2249    </member>
2250   </simplelist>
2251   <simplelist>
2252    <member>
2253     <emphasis>js-annoyances</emphasis>:    Get rid of particularly annoying JavaScript abuse
2254    </member>
2255   </simplelist>
2256   <simplelist>
2257    <member>
2258     <emphasis>no-poups</emphasis>:         Kill all popups in JS and HTML
2259    </member>
2260   </simplelist>
2261   <simplelist>
2262    <member>
2263     <emphasis>frameset-borders</emphasis>: Give frames a border
2264    </member>
2265   </simplelist>
2266   <simplelist>
2267    <member>
2268     <emphasis>webbugs</emphasis>:          Squish WebBugs (1x1 invisible GIFs used for user tracking)
2269    </member>
2270   </simplelist>
2271   <simplelist>
2272    <member>
2273     <emphasis>no-refresh</emphasis>:       Automatic refresh sucks on auto-dialup lines
2274    </member>
2275   </simplelist>
2276   <simplelist>
2277    <member>
2278     <emphasis>fun</emphasis>:              Text replacements  for subversive browsing fun!
2279    </member>
2280   </simplelist>
2281   <simplelist>
2282    <member>
2283     <emphasis>nimda</emphasis>:            Remove (virus) Nimda code.
2284    </member>
2285   </simplelist>
2286   <simplelist>
2287    <member>
2288      <emphasis>banners-by-size</emphasis>:  Kill banners by size
2289    </member>
2290   </simplelist>
2291   <simplelist>
2292    <member>
2293     <emphasis>crude-parental</emphasis>:   Kill all web pages that contain the words "sex" or "warez"
2294    </member>
2295   </simplelist>
2296  </blockquote>
2297
2298  </listitem>
2299
2300  <listitem>
2301   <para>  
2302    Block any existing X-Forwarded-for header, and do not add a new one:
2303   </para>
2304   <para>
2305    <literal>
2306     <msgtext> 
2307      <literallayout>
2308   <emphasis>+hide-forwarded</emphasis>
2309      </literallayout>
2310     </msgtext> 
2311    </literal>
2312   </para>
2313  </listitem>
2314
2315  <listitem>
2316   <para>  
2317    If the browser sends a <quote>From:</quote> header containing your e-mail
2318    address, this either completely removes the header (<quote>block</quote>), or
2319    changes it to the specified e-mail address.
2320   </para>
2321   <para>
2322    <literal>
2323     <msgtext> 
2324      <literallayout>
2325   <emphasis>+hide-from{block}</emphasis>
2326   <emphasis>+hide-from{spam@sittingduck.xqq}</emphasis>
2327      </literallayout>
2328     </msgtext> 
2329    </literal>
2330   </para>
2331  </listitem>
2332  
2333  <listitem>
2334   <para>  
2335    Don't send the <quote>Referer:</quote> (sic) header to the web site.  You
2336    can block it, forge a URL to the same server as the request (which is
2337    preferred because some sites will not send images otherwise) or set it to a
2338    constant string of your choice.
2339   </para>
2340   <para>
2341    <literal>
2342     <msgtext> 
2343      <literallayout>
2344   <emphasis>+hide-referer{block}</emphasis>
2345   <emphasis>+hide-referer{forge}</emphasis>
2346   <emphasis>+hide-referer{http://nowhere.com}</emphasis>
2347      </literallayout>
2348     </msgtext> 
2349    </literal>
2350   </para>
2351  </listitem>
2352  
2353  <listitem>
2354   <para>  
2355    Alternative spelling of <quote>+hide-referer</quote>.  It has the same
2356    parameters, and can be freely mixed with, <quote>+hide-referer</quote>.
2357    (<quote>referrer</quote> is the correct English spelling, however the HTTP
2358    specification has a bug - it requires it to be spelled <quote>referer</quote>.) 
2359   </para>
2360   <para>
2361    <literal>
2362     <msgtext> 
2363      <literallayout>
2364   <emphasis>+hide-referrer{...}</emphasis>
2365      </literallayout>
2366     </msgtext> 
2367    </literal>
2368   </para>
2369  </listitem>
2370
2371  <listitem>
2372   <para>  
2373    Change the <quote>User-Agent:</quote> header so web servers can't tell your
2374    browser type.  Warning! This breaks many web sites.  Specify the
2375    user-agent value you want. Example, pretend to be using Netscape on
2376    Linux:
2377   </para>
2378   <para>
2379    <literal>
2380     <msgtext> 
2381      <literallayout>
2382   <emphasis>+hide-user-agent{Mozilla (X11; I; Linux 2.0.32 i586)}</emphasis>
2383      </literallayout>
2384     </msgtext> 
2385    </literal>
2386   </para>
2387  <!-- 
2388   <para>
2389    Or to identify yourself explicitly as a <quote>Junkbuster</quote> user:
2390   </para>
2391   <para>
2392    <literal>
2393     <msgtext> 
2394      <literallayout>
2395   <emphasis>+hide-user-agent{JunkBuster/1.0}</emphasis>
2396      </literallayout>
2397     </msgtext> 
2398    </literal>
2399   </para>
2400    (Don't change the version number from 1.0 - after all, why tell them?)
2401   <para>
2402   </para>
2403   <para>
2404    <literal>
2405     <msgtext> 
2406      <literallayout>
2407   <emphasis>+hide-user-agent{browser-type}</emphasis>
2408      </literallayout>
2409     </msgtext> 
2410    </literal>
2411   </para>
2412 -->
2413  </listitem>
2414
2415  <listitem>
2416   <para>  
2417    Treat this URL as an image.  This only matters if it's also <quote>+block</quote>ed,
2418     in which case a <quote>blocked</quote> image can be sent rather than a HTML page.
2419     See <quote>+image-blocker{}</quote> below for the control over what is actually sent.
2420   </para>
2421   <para>
2422    <literal>
2423     <msgtext> 
2424      <literallayout>
2425   <emphasis>+image</emphasis>
2426      </literallayout>
2427     </msgtext> 
2428    </literal>
2429   </para>
2430  </listitem>
2431  
2432  <listitem>
2433   <para>  
2434    Decides what to do with URLs that end up tagged with <quote>{+block
2435    +image}</quote>, e.g an advertizement. There are five options.
2436    <quote>-image-blocker</quote> will send a HTML <quote>blocked</quote> page,
2437    usually resulting in a <quote>broken image</quote> icon.
2438    <quote>+image-blocker{logo}</quote> will send a <quote>JunkBuster</quote>
2439    logo image. <quote>+image-blocker{blank}</quote> will send a 1x1
2440    transparent GIF image. And finally,
2441    <quote>+image-blocker{http://xyz.com}</quote> will send a HTTP temporary
2442    redirect to the specified image. This has the advantage of the icon being
2443    being cached by the browser, which will speed up the display.
2444    <quote>+image-blocker{pattern}</quote> will send a checkboard type pattern,
2445    which scales better than the logo (which can get blocky if the browser 
2446    enlarges it too much).
2447   </para>
2448   <para>
2449    <literal>
2450     <msgtext> 
2451      <literallayout>
2452   <emphasis>+image-blocker{logo}</emphasis>
2453   <emphasis>+image-blocker{blank}</emphasis>
2454   <emphasis>+image-blocker{pattern}</emphasis>
2455   <emphasis>+image-blocker{http://i.j.b/send-banner}</emphasis>
2456      </literallayout>
2457     </msgtext> 
2458    </literal>
2459   </para>
2460  </listitem>
2461  
2462  <listitem>
2463    <para> 
2464    By default (i.e. in the absence of a <quote>+limit-connect</quote>
2465    action), <application>Junkbuster</application> will only allow CONNECT
2466    requests to port 443, which is the standard port for https as a 
2467    precaution.
2468   </para>
2469  
2470   <para>
2471    The CONNECT methods exists in HTTP to allow access to secure websites
2472    (https:// URLs) through proxies. It works very simply: the proxy
2473    connects to the server on the specified port, and then short-circuits
2474    its connections to the client <emphasis>and</emphasis> to the remote proxy.
2475    This can be a big security hole, since CONNECT-enabled proxies can
2476    be abused as TCP relays very easily.
2477   </para>
2478   
2479   <para> 
2480    If you want to allow CONNECT for more ports than this, or want to forbid
2481    CONNECT altogether, you can specify a comma separated list of ports and
2482    port ranges (the latter using dashes, with the minimum defaulting to 0 and
2483    max to 65K):
2484   </para>
2485
2486   <para>
2487    <literal>
2488     <msgtext> 
2489      <literallayout>
2490   <emphasis>+limit-connect{443}                 # This is the default and need no be specified.</emphasis>
2491   <emphasis>+limit-connect{80,443}              # Ports 80 and 443 are OK.</emphasis>
2492   <emphasis>+limit-connect{-3, 7, 20-100, 500-} # Port less than 3, 7, 20 to 100</emphasis>
2493   <emphasis>                                    #and above 500 are OK.</emphasis>
2494      </literallayout>
2495     </msgtext> 
2496    </literal>
2497   </para>
2498
2499  </listitem> 
2500  
2501  <listitem>
2502   <para>
2503    <quote>+no-compression</quote> prevents the website from compressing the
2504    data. Some websites do this, which can be a problem for
2505    <application>Junkbuster</application>, since <quote>+filter</quote>,
2506    <quote>+no-popup</quote> and <quote>+gif-deanimate</quote> will not work on
2507    compressed data. This will slow down connections to those websites,
2508    though. Default is <quote>nocompression</quote> is turned on.
2509   </para>
2510
2511   <para>
2512    <literal>
2513     <msgtext> 
2514      <literallayout>
2515   <emphasis>+nocompression</emphasis>
2516      </literallayout>
2517     </msgtext> 
2518    </literal>
2519   </para>
2520  </listitem> 
2521  
2522  <listitem>
2523   <para>  
2524    If the website sets cookies, <quote>no-cookies-keep</quote> will make sure
2525    they are erased when you exit and restart your web browser. This makes
2526    profiling cookies useless, but won't break sites which require cookies so
2527    that you can log in for transactions. Default: on.
2528   </para>
2529   <para>
2530    <literal>
2531     <msgtext> 
2532      <literallayout>
2533   <emphasis>+no-cookies-keep</emphasis>
2534      </literallayout>
2535     </msgtext> 
2536    </literal>
2537   </para>
2538  </listitem>
2539  
2540  <listitem>
2541   <para>  
2542    Prevent the website from reading cookies:
2543   </para>
2544   <para>
2545    <literal>
2546     <msgtext> 
2547      <literallayout>
2548   <emphasis>+no-cookies-read</emphasis>
2549      </literallayout>
2550     </msgtext> 
2551    </literal>
2552   </para>
2553  </listitem>
2554  
2555  <listitem>
2556   <para>  
2557    Prevent the website from setting cookies:
2558   </para>
2559   <para>
2560    <literal>
2561     <msgtext> 
2562      <literallayout>
2563   <emphasis>+no-cookies-set</emphasis>
2564      </literallayout>
2565     </msgtext> 
2566    </literal>
2567   </para>
2568  </listitem>
2569  
2570  <listitem>
2571   <para>  
2572    Filter the website through a built-in filter to disable those obnoxious 
2573    JavaScript pop-up windows via window.open(), etc. The two alternative
2574    spellings are equivalent.
2575   </para>
2576   <para>
2577    <literal>
2578     <msgtext> 
2579      <literallayout>
2580   <emphasis>+no-popup</emphasis>
2581   <emphasis>+no-popups</emphasis>
2582      </literallayout>
2583     </msgtext> 
2584    </literal>
2585   </para>
2586  </listitem>
2587  
2588  <listitem>
2589   <para>  
2590    This action only applies if you are using a <filename>jarfile</filename>
2591    for saving cookies. It sends a cookie to every site stating that you do not
2592    accept any copyright on cookies sent to you, and asking them not to track
2593    you.  Of course, this is a (relatively) unique header they could use to
2594    track you.
2595   </para>
2596   <para>
2597    <literal>
2598     <msgtext> 
2599      <literallayout>
2600   <emphasis>+vanilla-wafer</emphasis>
2601      </literallayout>
2602     </msgtext> 
2603    </literal>
2604   </para>
2605  </listitem>
2606  
2607  <listitem>
2608   <para>  
2609    This allows you to add an arbitrary cookie. It can be specified multiple
2610    times in order to add as many cookies as you like.
2611   </para>
2612   <para>
2613    <literal>
2614     <msgtext> 
2615      <literallayout>
2616   <emphasis>+wafer{name=value}</emphasis>
2617      </literallayout>
2618     </msgtext> 
2619    </literal>
2620   </para>
2621  </listitem>
2622
2623  </itemizedlist>
2624 </para>
2625
2626 <para>
2627  The meaning of any of the above is reversed by preceding the action with a 
2628  <quote>-</quote>, in place of the <quote>+</quote>.
2629 </para>
2630
2631 <para>
2632  Some examples:
2633 </para>
2634
2635 <para>
2636  Turn off cookies by default, then allow a few through for specified sites:
2637 </para>
2638   
2639 <para>
2640  <literal>
2641   <msgtext> 
2642    <literallayout>
2643  # Turn off all persistent cookies
2644  { +no-cookies-read }
2645  { +no-cookies-set }
2646  # Allow cookies for this browser session ONLY
2647  { +no-cookies-keep }
2648
2649  # Exceptions to the above, sites that benefit from persistent cookies
2650  { -no-cookies-read }
2651  { -no-cookies-set }
2652  { -no-cookies-keep }
2653  .javasoft.com
2654  .sun.com
2655  .yahoo.com
2656  .msdn.microsoft.com
2657  .redhat.com
2658
2659  # Alternative way of saying the same thing
2660  {-no-cookies-set -no-cookies-read -no-cookies-keep}
2661  .sourceforge.net
2662  .sf.net
2663    </literallayout>
2664   </msgtext> 
2665  </literal>
2666 </para>
2667
2668 <para>
2669  Now turn off <quote>fast redirects</quote>, and then we allow two exceptions:
2670 </para>
2671
2672 <para>
2673  <literal>
2674   <msgtext> 
2675    <literallayout>
2676  # Turn them off!
2677  {+fast-redirects}
2678  
2679  # Reverse it for these two sites, which don't work right without it.
2680  {-fast-redirects}
2681  www.ukc.ac.uk/cgi-bin/wac\.cgi\?
2682  login.yahoo.com
2683    </literallayout>
2684   </msgtext> 
2685  </literal>
2686 </para>
2687
2688 <para>
2689  Turn on page filtering according to rules in the defined sections 
2690  of <filename>refilterfile</filename>, and make one exception for 
2691  sourceforge:
2692  </para>
2693
2694 <para>
2695  <literal>
2696   <msgtext> 
2697    <literallayout>
2698  # Run everything through the filter file, using only the
2699  # specified sections:
2700  +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}\
2701  +filter{webbugs} +filter{nimda} +filter{banners-by-size}
2702               
2703  # Then disable filtering of code from sourceforge!
2704  {-filter}
2705  .cvs.sourceforge.net
2706    </literallayout>
2707   </msgtext> 
2708  </literal>
2709 </para>
2710
2711 <para>
2712  Now some URLs that we want <quote>blocked</quote>, ie we won't see them.
2713  Many of these use regular expressions that will expand to match multiple 
2714  URLs:
2715 </para>
2716
2717 <para>
2718  <literal>
2719   <msgtext> 
2720    <literallayout>
2721   # Blocklist:
2722   {+block}
2723   /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\.(gif|jpe?g))
2724   /.*/(.*[-_.])?count(er)?(\.cgi|\.dll|\.exe|[?/])
2725   /.*/(ng)?adclient\.cgi
2726   /.*/(plain|live|rotate)[-_.]?ads?/
2727   /.*/(sponsor)s?[0-9]?/
2728   /.*/_?(plain|live)?ads?(-banners)?/
2729   /.*/abanners/
2730   /.*/ad(sdna_image|gifs?)/
2731   /.*/ad(server|stream|juggler)\.(cgi|pl|dll|exe)
2732   /.*/adbanners/
2733   /.*/adserver
2734   /.*/adstream\.cgi
2735   /.*/adv((er)?ts?|ertis(ing|ements?))?/
2736   /.*/banner_?ads/
2737   /.*/banners?/
2738   /.*/banners?\.cgi/
2739   /.*/cgi-bin/centralad/getimage
2740   /.*/images/addver\.gif
2741   /.*/images/marketing/.*\.(gif|jpe?g)
2742   /.*/popupads/
2743   /.*/siteads/
2744   /.*/sponsor.*\.gif
2745   /.*/sponsors?[0-9]?/
2746   /.*/advert[0-9]+\.jpg
2747   /Media/Images/Adds/
2748   /ad_images/
2749   /adimages/
2750   /.*/ads/
2751   /bannerfarm/
2752   /grafikk/annonse/
2753   /graphics/defaultAd/
2754   /image\.ng/AdType
2755   /image\.ng/transactionID
2756   /images/.*/.*_anim\.gif # alvin brattli
2757   /ip_img/.*\.(gif|jpe?g)
2758   /rotateads/
2759   /rotations/ 
2760   /worldnet/ad\.cgi
2761   /cgi-bin/nph-adclick.exe/
2762   /.*/Image/BannerAdvertising/
2763   /.*/ad-bin/
2764   /.*/adlib/server\.cgi
2765   /autoads/
2766    </literallayout>
2767   </msgtext> 
2768  </literal>
2769 </para>
2770
2771 </sect3>
2772
2773 <!--  ~  End section  ~  -->
2774
2775
2776 <!--   ~~~~~       New section      ~~~~~     -->
2777 <sect3>
2778 <title>Aliases</title>
2779 <para>
2780  Custom <quote>actions</quote>, known to <application>Junkbuster</application>
2781  as <quote>aliases</quote>, can be defined by combining other <quote>actions</quote>.
2782  These can in turn be invoked just like the built-in <quote>actions</quote>.
2783  Currently, an alias can contain any character except space, tab, <quote>=</quote>,
2784  <quote>{</quote> or <quote>}</quote>. But please use only <quote>a</quote>-
2785  <quote>z</quote>, <quote>0</quote>-<quote>9</quote>, <quote>+</quote>, and
2786  <quote>-</quote>. Alias names are not case sensitive, and 
2787  <emphasis>must be defined  before anything</emphasis> else in the
2788  <filename>ijb.action</filename>file ! And there can only be one set of
2789  <quote>aliases</quote> defined.
2790 </para>
2791
2792 <para>
2793  Now let's define a few aliases:
2794 </para>
2795
2796 <para>
2797  <literal>
2798   <msgtext> 
2799    <literallayout>
2800  # Useful customer aliases we can use later. These must come first!
2801  {{alias}}
2802  +no-cookies = +no-cookies-set +no-cookies-read
2803  -no-cookies = -no-cookies-set -no-cookies-read
2804  fragile     = -block -no-cookies -filter -fast-redirects -hide-referer -no-popups
2805  shop        = -no-cookies -filter -fast-redirects
2806  +imageblock = +block +image
2807
2808  #For people who don't like to type too much:  ;-)
2809  c0 = +no-cookies
2810  c1 = -no-cookies
2811  c2 = -no-cookies-set +no-cookies-read
2812  c3 = +no-cookies-set -no-cookies-read
2813  #... etc.  Customize to your heart's content.
2814    </literallayout>
2815   </msgtext> 
2816  </literal>
2817 </para>
2818
2819 <para>
2820  Some examples using our <quote>shop</quote> and <quote>fragile</quote>
2821  aliases from above:
2822 </para>
2823
2824 <para>
2825  <literal>
2826   <msgtext> 
2827    <literallayout>
2828  # These sites are very complex and require
2829  # minimal interference.
2830  {fragile}
2831  .office.microsoft.com
2832  .windowsupdate.microsoft.com
2833  .nytimes.com
2834
2835  # Shopping sites - still want to block ads.
2836  {shop}
2837  .quietpc.com
2838  .worldpay.com   # for quietpc.com
2839  .jungle.com
2840  .scan.co.uk
2841
2842  # These shops require pop-ups
2843  {shop -no-popups}
2844  .dabs.com
2845  .overclockers.co.uk
2846    </literallayout>
2847   </msgtext> 
2848  </literal>
2849 </para>
2850
2851 </sect3>
2852 </sect2>
2853
2854 <!--  ~  End section  ~  -->
2855
2856
2857 <!--   ~~~~~       New section      ~~~~~     -->
2858 <sect2 id="filterfile">
2859 <title>The Filter File</title>
2860 <para>
2861  Any web page can be dynamically modified with the filter file. This
2862  modification can be removal, or re-writing, of any web page content,
2863  including tags and non-visible content. The default filter file is
2864  <filename>re_filterfile</filename>, located in the config directory. 
2865 </para>
2866
2867 <para>
2868  The included example file is divided into sections. Each section begins 
2869  with the <literal>FILTER</literal> keyword, followed by the identifier 
2870  for that section, e.g. <quote>FILTER: webbugs</quote>. Each section performs
2871  a similar type of filtering, such as <quote>html-annoyances</quote>.
2872
2873 </para>
2874
2875 <para>
2876  This file uses regular expressions to alter or remove any string in the
2877  target page. The expressions can only operate on one line at a time. Some
2878  examples from the included default <filename>re_filterfile</filename>:
2879 </para>
2880
2881 <para>
2882  Stop web pages from displaying annoying messages in the status bar by
2883  deleting such references:
2884 </para>
2885
2886 <para>
2887  <literal>
2888   <msgtext> 
2889    <literallayout>
2890  FILTER: html-annoyances
2891
2892  # New browser windows should be resizeable and have a location and status
2893  # bar. Make it so.
2894  #
2895  s/resizable="?(no|0)"?/resizable=1/ig s/noresize/yesresize/ig
2896  s/location="?(no|0)"?/location=1/ig s/status="?(no|0)"?/status=1/ig
2897  s/scrolling="?(no|0|Auto)"?/scrolling=1/ig
2898  s/menubar="?(no|0)"?/menubar=1/ig 
2899
2900  # The &lt;BLINK&gt; tag was a crime!
2901  #
2902  s*&lt;blink&gt;|&lt;/blink&gt;**ig
2903
2904  # Is this evil? 
2905  #
2906  #s/framespacing="?(no|0)"?//ig
2907  #s/margin(height|width)=[0-9]*//gi
2908    </literallayout>
2909   </msgtext> 
2910  </literal>
2911 </para>
2912
2913 <para>
2914  Just for kicks, replace any occurrence of <quote>Microsoft</quote> with
2915  <quote>MicroSuck</quote>, and have a little fun with topical buzzwords: 
2916 </para>
2917
2918 <para>
2919  <literal>
2920   <msgtext> 
2921    <literallayout>
2922  FILTER: fun
2923
2924  s/microsoft(?!.com)/MicroSuck/ig
2925
2926  # Buzzword Bingo:
2927  #
2928  s/industry-leading|cutting-edge|award-winning/&lt;font color=red&gt;&lt;b&gt;BINGO!&lt;/b&gt;&lt;/font&gt;/ig
2929    </literallayout>
2930   </msgtext> 
2931  </literal>
2932 </para>
2933
2934 <para>
2935  Kill those pesky little web-bugs:
2936 </para>
2937
2938 <para>
2939  <literal>
2940   <msgtext> 
2941    <literallayout>
2942  # webbugs: Squish WebBugs (1x1 invisible GIFs used for user tracking)
2943  FILTER: webbugs
2944
2945  s/&lt;img\s+[^&gt;]*?(width|height)\s*=\s*['"]?1\D[^&gt;]*?(width|height)\s*=\s*['"]?1(\D[^&gt;]*?)?>/&lt;!-- Squished WebBug --&gt;/sig
2946    </literallayout>
2947   </msgtext> 
2948  </literal>
2949 </para>
2950
2951 </sect2>
2952
2953 <!--  ~  End section  ~  -->
2954
2955
2956
2957 <!--   ~~~~~       New section      ~~~~~     -->
2958
2959 <sect2>
2960 <title>Templates</title>
2961 <para>
2962  When <application>Junkbuster</application> displays one of its internal 
2963  pages, such as a 404 Not Found error page, it uses the appropriate template.
2964  On Linux, BSD, and Unix, these are located in
2965  <filename>/etc/junkbuster/templates</filename> by default. These may be
2966  customized, if desired.
2967
2968 </para>
2969 </sect2>
2970
2971 </sect1>
2972
2973 <!--  ~  End section  ~  -->
2974
2975
2976
2977 <!--   ~~~~~       New section      ~~~~~     -->
2978 <sect1 id="quickstart"><title>Quickstart to Using Junkbuster</title>
2979 <para>
2980  Install package, then run and enjoy! <application>JunkBuster</application> 
2981  is typically started by specifying the main configuration file to be 
2982  used on the command line. Example Unix startup command:
2983 </para>
2984
2985 <para>
2986  <screen>
2987  
2988  # /usr/sbin/junkbuster /etc/junkbuster/config
2989  
2990  </screen>
2991 </para>
2992
2993 <para>
2994  An init script is provided for SuSE and Redhat.
2995 </para>
2996
2997 <para>
2998 For for SuSE: /etc/rc.d/junkbuster start
2999 </para>
3000
3001 <para>
3002 For RedHat: /etc/rc.d/init.d/junkbuster start
3003 </para>
3004
3005
3006 <para>
3007  If no configuration file is specified on the command line,
3008  <application>Junkbuster</application> will look for a file named
3009  <filename>config</filename> in the current directory. Except on Win32 where
3010  it will try <filename>config.txt</filename>. If no file is specified on the
3011  command line and no default configuration file can be found, 
3012  <application>Junkbuster</application> will fail to start.
3013 </para>
3014
3015 <para>
3016  Be sure your browser is set to use the proxy which is by default at
3017  localhost, port 8118. With <application>Netscape</application> (and
3018  <application>Mozilla</application>), this can be set under <literal>Edit
3019  -&gt; Preferences -&gt; Advanced -&gt; Proxies -&gt; HTTP Proxy</literal>.
3020  For <application>Internet Explorer</application>: <literal>Tools &gt;
3021  Internet Properties -&gt; Connections -&gt; LAN Setting</literal>. Then,
3022  check <quote>Use Proxy</quote> and fill in the appropriate info (Address:
3023  localhost, Port: 8118). Include if HTTPS proxy support too.
3024 </para>
3025
3026 <para>
3027  The included default configuration files should give a reasonable starting
3028  point, though may be somewhat aggressive in blocking junk. You will probably
3029  want to keep an eye out for sites that require persistent cookies, and add these to
3030  <filename>ijb.action</filename> as needed. By default, most of these will
3031  be accepted only during the current browser session, until you add them to
3032  the configuration. If you want the browser to handle this instead, you will
3033  need to edit <filename>ijb.action</filename> and disable this feature. If you
3034  use more than one browser, it would make more sense to let
3035  <application>Junkbuster</application> handle this. In which case, the
3036  browser(s) should be set to accept all cookies.
3037 </para>
3038
3039 <para>
3040  If a particular site shows problems loading properly, try adding it 
3041  to the <literal>{fragile}</literal> section of
3042  <filename>ijb.action</filename>. This will turn off most actions for 
3043  this site.
3044 </para>
3045
3046 <para>
3047  <application>Junkbuster</application> is HTTP/1.1 compliant,  but not all 1.1
3048  features are as yet implemented. If browsers that support HTTP/1.1 (like
3049  <application>Mozilla</application> or recent versions of I.E.) experience
3050  problems, you might try to force HTTP/1.0 compatibility. For Mozilla, look
3051  under <literal>Edit -&gt; Preferences -&gt; Debug -&gt; Networking</literal>.
3052  Or set the <quote>+downgrade</quote> config option in
3053  <filename>ijb.action</filename>.
3054 </para>
3055
3056 <para>
3057  After running <application>Junkbuster</application> for a while, you can 
3058  start to fine tune the configuration to suit your personal, or site, 
3059  preferences and requirements. There are many, many aspects that can 
3060  be customized. <quote>Actions</quote> (as specified in <filename>ijb.action</filename>) 
3061  can be adjusted by pointing your browser to 
3062  <ulink url="http://i.j.b/">http://i.j.b/</ulink>, 
3063  and then follow the link to <quote>edit the actions list</quote>. 
3064  (This is an internal page and does not require Internet access.)
3065 </para>
3066
3067 <para>
3068  In fact, various aspects of <application>Junkbuster</application>
3069  configuration can be viewed from this page, including 
3070  current configuration parameters, source code version numbers, 
3071  the browser's request headers, and <quote>actions</quote> that apply 
3072  to a given URL. In addition to the <filename>ijb.action</filename> file 
3073  editor mentioned above, <application>Junkbuster</application> can also 
3074  be turned <quote>on</quote> and <quote>off</quote> from this page.
3075 </para>
3076
3077 <para>
3078  If you encounter problems, please verify it is a
3079  <application>Junkbuster</application> bug, by disabling
3080  <application>Junkbuster</application>, and then trying the same page. 
3081  Also, try another browser if possible to eliminate browser or site 
3082  problems. Before reporting it as a bug, see if there is not a configuration 
3083  option that is enabled that is causing the page not to load. You can 
3084  then add an exception for that page or site. If a bug, please report it to
3085  the developers (see below). 
3086 </para>
3087
3088
3089
3090 <!--   ~~~~~       New section      ~~~~~     -->
3091
3092 <sect2>
3093 <title>Command Line Options</title>
3094 <para>
3095  <application>JunkBuster</application> may be invoked with the following
3096  command-line options:
3097 </para>
3098
3099 <para>
3100  <itemizedlist>
3101
3102  <listitem>
3103   <para>
3104     <emphasis>--version</emphasis>
3105   </para>
3106   <para>
3107      Print version info and exit, Unix only.
3108   </para>
3109  </listitem> 
3110  <listitem>
3111   <para>
3112     <emphasis>--help</emphasis>
3113   </para>
3114   <para>
3115    Print a short usage info and exit, Unix only.
3116   </para>
3117  </listitem> 
3118  <listitem>
3119   <para>
3120    <emphasis>--no-daemon</emphasis>
3121   </para>
3122   <para>
3123    Don't become a daemon, i.e. don't fork and become process group
3124    leader, don't detach from controlling tty. Unix only.
3125   </para>
3126  </listitem> 
3127  <listitem>
3128   <para>
3129    <emphasis>--pidfile FILE</emphasis>
3130   
3131   </para>
3132   <para>
3133    On startup, write the process ID to <emphasis>FILE</emphasis>. Delete the
3134    <emphasis>FILE</emphasis> on exit. Failiure to create or delete the
3135    <emphasis>FILE</emphasis> is non-fatal. If no <emphasis>FILE</emphasis>
3136    option is given, no PID file will be used. Unix only.
3137   </para>
3138  </listitem> 
3139  <listitem>
3140   <para>
3141    <emphasis>--user USER[.GROUP]</emphasis>
3142   
3143   </para>
3144   <para>
3145    After (optionally) writing the PID file, assume the user  ID  of
3146    <emphasis>USER</emphasis>, and if included the GID of GROUP.  Exit if the
3147    privileges are not sufficient to do so. Unix only.
3148   </para>
3149  </listitem> 
3150  <listitem>
3151   <para>
3152     <emphasis>configfile</emphasis>
3153   </para>
3154   <para>
3155     If no <emphasis>configfile</emphasis> is included on the command line, 
3156     <application>JunkBuster</application> will look for a file named 
3157     <quote>config</quote> in the current directory (except on Win32 
3158     where it will look for <quote>config.txt</quote> instead). Specify 
3159     full path to avoid confusion.
3160   </para>
3161  </listitem> 
3162
3163  </itemizedlist>
3164 </para>
3165
3166 </sect2>
3167
3168 </sect1>
3169
3170 <!--  ~  End section  ~  -->
3171
3172
3173
3174 <!--   ~~~~~       New section      ~~~~~     -->
3175
3176 <sect1 id="contact"><title>Contacting the Developers, Bug Reporting and Feature
3177 Requests</title>
3178 <para>
3179 We value your feedback. However, to provide you with the best support,
3180 please note:
3181
3182  <itemizedlist>
3183
3184   <listitem><para>Use the <ulink url="http://sourceforge.net/tracker/?group_id=11118&#38;atid=211118">Sourceforge support forum</ulink> to get
3185   help.</para></listitem>
3186  
3187   <listitem><para>Submit bugs only thru our <ulink url="http://sourceforge.net/tracker/?group_id=11118&#38;atid=111118">Sourceforge bug
3188       forum</ulink>. 
3189 Make sure that the bug has not already been submitted.  Please try to
3190 verify that it is a <application>Junkbuster</application> bug, and not
3191 a browser or site bug first. If you are using your own custom configuration,
3192 please try the stock configs to see if the problem is a configuration
3193 related bug.  And if not using the latest development snapshot, please
3194 try the latest one. Or even better, CVS sources.</para>
3195 </listitem>
3196
3197  
3198   <listitem><para>Submit feature requests only thru our <ulink
3199       url="http://sourceforge.net/tracker/?atid=361118&#38;group_id=11118&#38;func=browse">Sourceforge feature request forum</ulink>.</para></listitem>
3200
3201
3202  </itemizedlist>
3203
3204 </para>
3205
3206 <para>
3207 For any other issues, feel free to use the <ulink url="http://sourceforge.net/mail/?group_id=11118">mailing lists</ulink>.
3208 </para>
3209
3210 <para>
3211  Anyone interested in actively participating in development and related 
3212  discussions can join the appropriate mailing list  
3213  <ulink url="http://sourceforge.net/mail/?group_id=11118">here</ulink>.
3214  Archives are available here too.
3215 </para>
3216
3217 </sect1>
3218
3219
3220 <!--   ~~~~~       New section      ~~~~~     -->
3221 <sect1 id="copyright"><title>Copyright and History</title>
3222
3223 <sect2>
3224 <title>License</title>
3225 <para>
3226  <application>Internet Junkbuster</application> is free software; you can
3227  redistribute it and/or modify it under the terms of the GNU General Public
3228  License as published by the Free Software Foundation; either version 2 of the
3229  License, or (at your option) any later version.
3230 </para>
3231
3232 <para>
3233  This program is distributed in the hope that it will be useful, but WITHOUT
3234  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
3235  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
3236  details, which is available from <ulink
3237  url="http://www.gnu.org/copyleft/gpl.html">the Free Software Foundation,
3238  Inc</ulink>, 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
3239 </para>
3240
3241 </sect2>
3242
3243 <!--  ~  End section  ~  -->
3244
3245
3246 <!--   ~~~~~       New section      ~~~~~     -->
3247
3248 <sect2>
3249 <title>History</title>
3250 <para>
3251  <application>Junkbuster</application> was originally written by Anonymous 
3252  Coders and <ulink
3253  url="http://www.junkbusters.com/ht/en/ijbfaq.html">Junkbuster's
3254  Corporation</ulink>, and was released as free open-source software under the
3255  GNU GPL. <ulink url="http://www.waldherr.org/junkbuster/">Stefan
3256  Waldherr</ulink> made many improvements, and started the <ulink
3257  url="http://sourceforge.net/projects/ijbswa/">SourceForge project</ulink> to
3258  rekindle development. There are now several active developers contributing.
3259  The last stable release was v2.0.2, which has now grown whiskers ;-).
3260 </para>
3261
3262 </sect2>
3263
3264 </sect1>
3265
3266 <!--   ~~~~~       New section      ~~~~~     -->
3267 <sect1 id="seealso"><title>See also</title>
3268 <para>
3269  
3270  <simplelist>
3271   <member>
3272    &nbsp; <ulink url="http://sourceforge.net/projects/ijbswa">http://sourceforge.net/projects/ijbswa</ulink>
3273   </member>
3274  </simplelist>
3275  <simplelist>
3276   <member>
3277    &nbsp; <ulink url="http://ijbswa.sourceforge.net/">http://ijbswa.sourceforge.net/</ulink>
3278   </member>
3279  </simplelist>
3280  <simplelist>
3281   <member>
3282    &nbsp; <ulink url="http://i.j.b/">http://i.j.b/</ulink>
3283   </member>
3284  </simplelist>
3285  <simplelist>
3286   <member>
3287    &nbsp; <ulink url="http://www.junkbusters.com/ht/en/cookies.html">http://www.junkbusters.com/ht/en/cookies.html</ulink>
3288   </member>
3289  </simplelist>
3290  <simplelist>
3291   <member>
3292    &nbsp; <ulink url="http://www.waldherr.org/junkbuster/">http://www.waldherr.org/junkbuster/</ulink>
3293   </member>
3294  </simplelist>
3295  <simplelist>
3296   <member>
3297    &nbsp; <ulink url="http://privacy.net/analyze/">http://privacy.net/analyze/</ulink>
3298   </member>
3299  </simplelist>
3300  <simplelist>
3301   <member>
3302    &nbsp;<ulink url="http://www.squid-cache.org/">http://www.squid-cache.org/</ulink>
3303   </member>
3304  </simplelist>
3305
3306 </para>
3307 </sect1>
3308
3309
3310
3311 <!--   ~~~~~       New section      ~~~~~     -->
3312 <sect1 id="appendix"><title>Appendix</title>
3313
3314
3315 <!--   ~~~~~       New section      ~~~~~     -->
3316 <sect2 id="regex">
3317 <title>Regular Expressions</title>
3318 <para>
3319  <application>Junkbuster</application> can use <quote>regular expressions</quote> 
3320  in various config files. Assuming support for <quote>pcre</quote> (Perl
3321  Compatible Regular Expressions) is compiled in, which is the default. Such
3322  configuration directives do not require regular expressions, but they can be
3323  used to increase flexibility by matching a pattern with wild-cards against
3324  URLs.
3325 </para>
3326
3327 <para>
3328  If you are reading this, you probably don't understand what <quote>regular
3329  expressions</quote> are, or what they can do. So this will be a very brief
3330  introduction only. A full explanation would require a book ;-)
3331 </para>
3332
3333 <para>
3334  <quote>Regular expressions</quote> is a way of matching one character
3335  expression against another to see if it matches or not. One of the
3336  <quote>expressions</quote> is a literal string of readable characters
3337  (letter, numbers, etc), and the other is a complex string of literal
3338  characters combined with wild-cards, and other special characters, called
3339  meta-characters. The <quote>meta-characters</quote> have special meanings and
3340  are used to build the complex pattern to be matched against. Perl Compatible
3341  Regular Expressions is an enhanced form of the regular expression language
3342  with backward compatibility.
3343 </para>
3344
3345 <para>
3346  To make a simple analogy, we do something similar when we use wild-card
3347  characters when listing files with the <command>dir</command> command in DOS. 
3348  <literal>*.*</literal> matches all filenames. The <quote>special</quote>
3349  character here is the asterisk which matches any and all characters. We can be
3350  more specific and use <literal>?</literal> to match just individual
3351  characters. So <quote>dir file?.text</quote> would match
3352  <quote>file1.txt</quote>, <quote>file2.txt</quote>, etc. We are pattern
3353  matching, using a similar technique to <quote>regular expressions</quote>!
3354 </para>
3355
3356 <para>
3357  Regular expressions do essentially the same thing, but are much, much more
3358  powerful. There are many more <quote>special characters</quote> and ways of 
3359  building complex patterns however. Let's look at a few of the common ones,
3360  and then some examples:
3361 </para>
3362
3363 <simplelist>
3364  <member>
3365   <emphasis>.</emphasis> - Matches any single character, e.g. <quote>a</quote>,
3366   <quote>A</quote>, <quote>4</quote>, <quote>:</quote>, or <quote>@</quote>.
3367  </member>
3368 </simplelist>
3369
3370 <simplelist>
3371  <member>
3372   <emphasis>?</emphasis> - The preceding character or expression is matched ZERO or ONE
3373   times. Either/or.
3374  </member>
3375 </simplelist>
3376
3377 <simplelist>
3378  <member>
3379   <emphasis>+</emphasis> - The preceding character or expression is matched ONE or MORE
3380   times.
3381  </member>
3382 </simplelist>
3383
3384 <simplelist>
3385  <member>
3386   <emphasis>*</emphasis> - The preceding character or expression is matched ZERO or MORE
3387   times.
3388  </member>
3389 </simplelist>
3390
3391 <simplelist>
3392  <member>
3393   <emphasis>\</emphasis> - The <quote>escape</quote> character denotes that
3394   the following character should be taken literally. This is used where one of the 
3395   special characters (e.g. <quote>.</quote>) needs to be taken literally and
3396   not as a special meta-character.
3397  </member>
3398 </simplelist>
3399
3400 <simplelist>
3401  <member>
3402   <emphasis>[]</emphasis> - Characters enclosed in brackets will be matched if
3403   any of the enclosed characters are encountered.
3404  </member>
3405 </simplelist>
3406
3407 <simplelist>
3408  <member>
3409   <emphasis>()</emphasis> - parentheses are used to group a sub-expression,
3410   or multiple sub-expressions.
3411  </member>
3412 </simplelist>
3413
3414 <simplelist>
3415  <member>
3416   <emphasis>|</emphasis> - The <quote>bar</quote> character works like an
3417   <quote>or</quote> conditional statement. A match is successful if the
3418   sub-expression on either side of <quote>|</quote> matches.
3419  </member>
3420 </simplelist>
3421
3422 <simplelist>
3423  <member>
3424   <emphasis>s/string1/string2/g</emphasis> - This is used to rewrite strings of text. 
3425   <quote>string1</quote> is replaced by <quote>string2</quote> in this
3426   example.
3427  </member>
3428 </simplelist>
3429
3430 <para>
3431  These are just some of the ones you are likely to use when matching URLs with 
3432  <application>Junkbuster</application>, and is a long way from a definitive
3433  list. This is enough to get us started with a few simple examples which may
3434  be more illuminating:
3435 </para>
3436
3437 <para>
3438  <emphasis><literal>/.*/banners/.*</literal></emphasis> - A  simple example
3439  that uses the common combination of <quote>.</quote> and <quote>*</quote> to 
3440  denote any character, zero or more times. In other words, any string at all.
3441  So we start with a literal forward slash, then our regular expression pattern 
3442  (<quote>.*</quote>) another literal forward slash, the string
3443  <quote>banners</quote>, another forward slash, and lastly another
3444  <quote>.*</quote>. We are building 
3445  a directory path here. This will match any file with the path that has a
3446  directory named <quote>banners</quote> in it. The <quote>.*</quote> matches
3447  any characters, and this could conceivably be more forward slashes, so it
3448  might expand into a much longer looking path. For example, this could match:
3449  <quote>/eye/hate/spammers/banners/annoy_me_please.gif</quote>, or just
3450  <quote>/banners/annoying.html</quote>, or almost an infinite number of other
3451  possible combinations, just so it has <quote>banners</quote> in the path
3452  somewhere.
3453 </para>
3454
3455 <para>
3456  A now something a little more complex:
3457 </para>
3458
3459 <para>
3460  <emphasis><literal>/.*/adv((er)?ts?|ertis(ing|ements?))?/</literal></emphasis> - 
3461  We have several literal forward slashes again (<quote>/</quote>), so we are
3462  building another expression that is a file path statement. We have another 
3463  <quote>.*</quote>, so we are matching against any conceivable sub-path, just so
3464  it matches our expression. The only true literal that <emphasis>must
3465  match</emphasis> our pattern is <application>adv</application>, together with
3466  the forward slashes. What comes after the <quote>adv</quote> string is the
3467  interesting part. 
3468 </para>
3469
3470 <para>
3471  Remember the <quote>?</quote> means the preceding expression (either a
3472  literal character or anything grouped with <quote>(...)</quote> in this case)
3473  can exist or not, since this means either zero or one match. So
3474  <quote>((er)?ts?|ertis(ing|ements?))</quote> is optional, as are the
3475  individual sub-expressions: <quote>(er)</quote>,
3476  <quote>(ing|ements?)</quote>, and the <quote>s</quote>. The <quote>|</quote>
3477  means <quote>or</quote>. We have two of those. For instance, 
3478  <quote>(ing|ements?)</quote>, can expand to match either <quote>ing</quote> 
3479  <emphasis>OR</emphasis> <quote>ements?</quote>. What is being done here, is an
3480  attempt at matching as many variations of <quote>advertisement</quote>, and 
3481  similar, as possible. So this would expand to match just <quote>adv</quote>,
3482  or <quote>advert</quote>, or <quote>adverts</quote>, or
3483  <quote>advertising</quote>, or <quote>advertisement</quote>, or
3484  <quote>advertisements</quote>. You get the idea. But it would not match 
3485  <quote>advertizements</quote> (with a <quote>z</quote>). We could fix that by
3486  changing our regular expression to: 
3487  <quote>/.*/adv((er)?ts?|erti(s|z)(ing|ements?))?/</quote>, which would then match
3488  either spelling.
3489 </para>
3490
3491 <para>
3492  <emphasis><literal>/.*/advert[0-9]+\.(gif|jpe?g)</literal></emphasis> - Again 
3493  another path statement with forward slashes. Anything in the square brackets 
3494  <quote>[]</quote> can be matched. This is using <quote>0-9</quote> as a
3495  shorthand expression to mean any digit one through nine. It is the same as
3496  saying <quote>0123456789</quote>. So any digit matches. The <quote>+</quote>
3497  means one or more of the preceding expression must be included. The preceding 
3498  expression here is what is in the square brackets -- in this case, any digit 
3499  one through nine. Then, at the end, we have a grouping: <quote>(gif|jpe?g)</quote>. 
3500  This includes a <quote>|</quote>, so this needs to match the expression on
3501  either side of that bar character also. A simple <quote>gif</quote> on one side, and the other
3502  side will in turn match either <quote>jpeg</quote> or <quote>jpg</quote>,
3503  since the <quote>?</quote> means the letter <quote>e</quote> is optional and
3504  can be matched once or not at all. So we are building an expression here to
3505  match image GIF or JPEG type image file. It must include the literal
3506  string <quote>advert</quote>, then one or more digits, and a <quote>.</quote>
3507  (which is now a literal, and not a special character, since it is escaped
3508  with <quote>\</quote>), and lastly either <quote>gif</quote>, or
3509  <quote>jpeg</quote>, or <quote>jpg</quote>. Some possible matches would
3510  include: <quote>//advert1.jpg</quote>,
3511  <quote>/nasty/ads/advert1234.gif</quote>,
3512  <quote>/banners/from/hell/advert99.jpg</quote>. It would not match
3513  <quote>advert1.gif</quote> (no leading slash), or
3514  <quote>/adverts232.jpg</quote> (the expression does not include an
3515  <quote>s</quote>), or <quote>/advert1.jsp</quote> (<quote>jsp</quote> is not
3516  in the expression anywhere).
3517 </para>
3518
3519 <para>
3520  <emphasis><literal>s/microsoft(?!.com)/MicroSuck/i</literal></emphasis> - This is 
3521  a substitution. <quote>MicroSuck</quote> will replace any occurrence of 
3522  <quote>microsoft</quote>.  The <quote>i</quote> at the end of the expression
3523  means ignore case. The <quote>(?!.com)</quote> means 
3524  the match should fail if <quote>microsoft</quote> is followed by
3525  <quote>.com</quote>. In other words, this acts like a <quote>NOT</quote>
3526  modifier. In case this is a hyperlink, we don't want to break it ;-).
3527 </para>
3528
3529 <para>
3530  We are barely scratching the surface of regular expressions here so that you
3531  can understand the default <application>Junkbuster</application>
3532  configuration files, and maybe use this knowledge to customize your own
3533  installation. There is much, much more that can be done with regular
3534  expressions. Now that you know enough to get started, you can learn more on
3535  your own :/
3536 </para>
3537
3538 <para>
3539  More reading on Perl Compatible Regular expressions: 
3540  <ulink url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>
3541 </para>
3542
3543 </sect2>
3544
3545 <!--  ~  End section  ~  -->
3546
3547
3548 <!--   ~~~~~       New section      ~~~~~     -->
3549 <sect2>
3550 <title>JunkBuster's Internal Pages</title>
3551
3552 <para>
3553  Since <application>JunkBuster</application> proxies each requested 
3554  web page, it is easy for <application>JunkBuster</application> to 
3555  trap certain URLs. In this way, we can talk directly to
3556  <application>JunkBuster</application>, and see how it is 
3557  configured, see how our rules are being applied, change these 
3558  rules and other configuration options, and even turn
3559  <application>JunkBuster's</application> filtering off, all with 
3560  a web browser.
3561
3562 </para>
3563
3564 <para>
3565  The URLs listed below are the special ones that allow direct access 
3566  to <application>JunkBuster</application>. Of course,
3567  <application>JunkBuster</application> must be running to access these. If 
3568  not, you will get a friendly error message.
3569
3570 </para>
3571
3572 <para>
3573  <itemizedlist>
3574
3575  <listitem>
3576   <para>  
3577    Junkbuster main page: 
3578   </para>
3579   <blockquote>
3580    <para> 
3581      <ulink url="http://ijbswa.sourceforge.net/config/">http://ijbswa.sourceforge.net/config/</ulink>
3582    </para>
3583   </blockquote>
3584   <para>
3585    Alternately, this may be reached at <ulink url="http://i.j.b/">http://i.j.b/</ulink>, 
3586    but this variation may not work as reliably as the above in some
3587    configurations.
3588   </para>
3589  </listitem>
3590
3591  <listitem>
3592   <para>  
3593     Show information about the current configuration: 
3594   </para>
3595    <blockquote>
3596    <para> 
3597     <ulink url="http://ijbswa.sourceforge.net/config/show-status">http://ijbswa.sourceforge.net/config/show-status</ulink>
3598    </para>
3599   </blockquote>
3600  </listitem>
3601  
3602  <listitem>
3603   <para>  
3604     Show the source code version numbers:
3605   </para>
3606   <blockquote>
3607    <para> 
3608     <ulink url="http://ijbswa.sourceforge.net/config/show-version">http://ijbswa.sourceforge.net/config/show-version</ulink>
3609    </para>
3610   </blockquote>
3611  </listitem>
3612  
3613  <listitem>
3614   <para>  
3615    Show the client's request headers:
3616   </para>
3617   <blockquote>
3618    <para> 
3619     <ulink url="http://ijbswa.sourceforge.net/config/show-request">http://ijbswa.sourceforge.net/config/show-request</ulink>
3620    </para>
3621   </blockquote>
3622  </listitem>
3623  
3624  <listitem>
3625   <para>  
3626    Show which actions apply to a URL and why:
3627   </para>
3628    <blockquote>
3629    <para> 
3630     <ulink url="http://ijbswa.sourceforge.net/config/show-url-info">http://ijbswa.sourceforge.net/config/show-url-info</ulink>
3631    </para>
3632   </blockquote>
3633  </listitem>
3634  
3635  <listitem>
3636   <para>  
3637    Toggle JunkBuster on or off:
3638   </para>
3639    <blockquote>
3640    <para> 
3641     <ulink url="http://ijbswa.sourceforge.net/config/toggle">http://ijbswa.sourceforge.net/config/toggle</ulink>
3642    </para>
3643   </blockquote>
3644   <para>
3645    Short cuts. Turn off, then on: 
3646   </para>
3647    <blockquote>
3648    <para> 
3649      <ulink url="http://ijbswa.sourceforge.net/config/toggle?set=disable">http://ijbswa.sourceforge.net/config/toggle?set=disable</ulink>
3650    </para>
3651   </blockquote>
3652    <blockquote>
3653    <para> 
3654      <ulink url="http://ijbswa.sourceforge.net/config/toggle?set=enable">http://ijbswa.sourceforge.net/config/toggle?set=enable</ulink>
3655    </para>
3656   </blockquote>
3657  </listitem>
3658
3659  <listitem>
3660   <para>  
3661    Edit the actions list file:
3662   </para>
3663    <blockquote>
3664    <para> 
3665     <ulink url="http://ijbswa.sourceforge.net/config/edit-actions">http://ijbswa.sourceforge.net/config/edit-actions</ulink>
3666    </para>
3667   </blockquote>
3668  </listitem>
3669  
3670  </itemizedlist>
3671 </para>
3672
3673 <para>
3674  These may be bookmarked for quick reference.
3675
3676 </para>
3677
3678 </sect2>
3679
3680 </sect1>
3681
3682  <!--
3683
3684  This program is free software; you can redistribute it 
3685  and/or modify it under the terms of the GNU General
3686  Public License as published by the Free Software
3687  Foundation; either version 2 of the License, or (at
3688  your option) any later version.
3689
3690  This program is distributed in the hope that it will
3691  be useful, but WITHOUT ANY WARRANTY; without even the
3692  implied warranty of MERCHANTABILITY or FITNESS FOR A
3693  PARTICULAR PURPOSE.  See the GNU General Public
3694  License for more details.
3695
3696  The GNU General Public License should be included with
3697  this file.  If not, you can view it at
3698  http://www.gnu.org/copyleft/gpl.html
3699  or write to the Free Software Foundation, Inc., 59
3700  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
3701
3702  $Log: user-manual.sgml,v $
3703  Revision 1.47  2002/03/11 13:13:27  swa
3704  correct feedback channels
3705
3706  Revision 1.46  2002/03/10 00:51:08  hal9
3707  Added section on JB internal pages in Appendix.
3708
3709  Revision 1.45  2002/03/09 17:43:53  swa
3710  more distros
3711
3712  Revision 1.44  2002/03/09 17:08:48  hal9
3713  New section on Jon's actions file editor, and move some stuff around.
3714
3715  Revision 1.43  2002/03/08 00:47:32  hal9
3716  Added imageblock{pattern}.
3717
3718  Revision 1.42  2002/03/07 18:16:55  swa
3719  looks better
3720
3721  Revision 1.41  2002/03/07 16:46:43  hal9
3722  Fix a few markup problems for jade.
3723
3724  Revision 1.40  2002/03/07 16:28:39  swa
3725  provide correct feedback channels
3726
3727  Revision 1.39  2002/03/06 16:19:28  hal9
3728  Note on perceived filtering slowdown per FR.
3729
3730  Revision 1.38  2002/03/05 23:55:14  hal9
3731  Stupid I did it again. Double hyphen in comment breaks jade.
3732
3733  Revision 1.37  2002/03/05 23:53:49  hal9
3734  jade barfs on '- -' embedded in comments. - -user option broke it.
3735
3736  Revision 1.36  2002/03/05 22:53:28  hal9
3737  Add new - - user option.
3738
3739  Revision 1.35  2002/03/05 00:17:27  hal9
3740  Added section on command line options.
3741
3742  Revision 1.34  2002/03/04 19:32:07  oes
3743  Changed default port to 8118
3744
3745  Revision 1.33  2002/03/03 19:46:13  hal9
3746  Emphasis on where/how to report bugs, etc
3747
3748  Revision 1.32  2002/03/03 09:26:06  joergs
3749  AmigaOS changes, config is now loaded from PROGDIR: instead of
3750  AmiTCP:db/junkbuster/ if no configuration file is specified on the
3751  command line.
3752
3753  Revision 1.31  2002/03/02 22:45:52  david__schmidt
3754  Just tweaking
3755
3756  Revision 1.30  2002/03/02 22:00:14  hal9
3757  Updated 'New Features' list. Ran through spell-checker.
3758
3759  Revision 1.29  2002/03/02 20:34:07  david__schmidt
3760  Update OS/2 build section
3761
3762  Revision 1.28  2002/02/24 14:34:24  jongfoster
3763  Formatting changes.  Now changing the doctype to DocBook XML 4.1
3764  will work - no other changes are needed.
3765
3766  Revision 1.27  2002/01/11 14:14:32  hal9
3767  Added a very short section on Templates
3768
3769  Revision 1.26  2002/01/09 20:02:50  hal9
3770  Fix bug re: auto-detect config file changes.
3771
3772  Revision 1.25  2002/01/09 18:20:30  hal9
3773  Touch ups for *.action files.
3774
3775  Revision 1.24  2001/12/02 01:13:42  hal9
3776  Fix typo.
3777
3778  Revision 1.23  2001/12/02 00:20:41  hal9
3779  Updates for recent changes.
3780
3781  Revision 1.22  2001/11/05 23:57:51  hal9
3782  Minor update for startup now daemon mode.
3783
3784  Revision 1.21  2001/10/31 21:11:03  hal9
3785  Correct 2 minor errors
3786
3787  Revision 1.18  2001/10/24 18:45:26  hal9
3788  *** empty log message ***
3789
3790  Revision 1.17  2001/10/24 17:10:55  hal9
3791  Catching up with Jon's recent work, and a few other things.
3792
3793  Revision 1.16  2001/10/21 17:19:21  swa
3794  wrong url in documentation
3795
3796  Revision 1.15  2001/10/14 23:46:24  hal9
3797  Various minor changes. Fleshed out SEE ALSO section.
3798
3799  Revision 1.13  2001/10/10 17:28:33  hal9
3800  Very minor changes.
3801
3802  Revision 1.12  2001/09/28 02:57:04  hal9
3803  Ditto :/
3804
3805  Revision 1.11  2001/09/28 02:25:20  hal9
3806  Ditto.
3807
3808  Revision 1.9  2001/09/27 23:50:29  hal9
3809  A few changes. A short section on regular expression in appendix.
3810
3811  Revision 1.8  2001/09/25 00:34:59  hal9
3812  Some additions, and re-arranging.
3813
3814  Revision 1.7  2001/09/24 14:31:36  hal9
3815  Diddling.
3816
3817  Revision 1.6  2001/09/24 14:10:32  hal9
3818  Including David's OS/2 installation instructions.
3819
3820  Revision 1.2  2001/09/13 15:27:40  swa
3821  cosmetics
3822
3823  Revision 1.1  2001/09/12 15:36:41  swa
3824  source files for junkbuster documentation
3825
3826  Revision 1.3  2001/09/10 17:43:59  swa
3827  first proposal of a structure.
3828
3829  Revision 1.2  2001/06/13 14:28:31  swa
3830  docs should have an author.
3831
3832  Revision 1.1  2001/06/13 14:20:37  swa
3833  first import of project's documentation for the webserver.
3834
3835  -->
3836
3837 </article>