README

   1 /*********************************************************************\r
   2  *\r
   3  * File        :  $Source: /cvsroot/ijbswa/current/README,v $\r
   4  *\r
   5  * Purpose     :  README file to give a short intro.\r
   6  *\r
   7  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge\r
   8  *                IJBSWA team.  http://ijbswa.sourceforge.net\r
   9  *\r
  10  *                Based on the Internet Junkbuster originally written\r
  11  *                by and Copyright (C) 1997 Anonymous Coders and \r
  12  *                Junkbusters Corporation.  http://www.junkbusters.com\r
  13  *\r
  14  *                This program is free software; you can redistribute it \r
  15  *                and/or modify it under the terms of the GNU General\r
  16  *                Public License as published by the Free Software\r
  17  *                Foundation; either version 2 of the License, or (at\r
  18  *                your option) any later version.\r
  19  *\r
  20  *                This program is distributed in the hope that it will\r
  21  *                be useful, but WITHOUT ANY WARRANTY; without even the\r
  22  *                implied warranty of MERCHANTABILITY or FITNESS FOR A\r
  23  *                PARTICULAR PURPOSE.  See the GNU General Public\r
  24  *                License for more details.\r
  25  *\r
  26  *                The GNU General Public License should be included with\r
  27  *                this file.  If not, you can view it at\r
  28  *                http://www.gnu.org/copyleft/gpl.html\r
  29  *                or write to the Free Software Foundation, Inc., 59\r
  30  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.\r
  31  *\r
  32  *********************************************************************/\r
  33 \r
  34 This README is included with the development version of Junkbuster,\r
  35 which will eventually become Junkbuster v3.0. See\r
  36 http://ijbswa.sourceforge.net.\r
  37 \r
  38 Internet Junkbuster is a web proxy with advanced filtering\r
  39 capabilities for protecting privacy and removing ads, banners, pop-ups\r
  40 and other obnoxious Internet Junk.\r
  41 \r
  42 \r
  43  INSTALL\r
  44 --------\r
  45 \r
  46 For tarball, first unpack:\r
  47 \r
  48  tar zxvf ijb_source_*\r
  49  cd ijb_source_2.9.9_alpha\r
  50 \r
  51  autoconf     [suggested for CVS source]\r
  52  ./configure\r
  53  make         (gmake on BSD?)\r
  54  su\r
  55  make install\r
  56 \r
  57 Redhat and SuSE src and binary RPMs can be built with 'make\r
  58 redhat-dist' or 'make suse-dist' (run ./configure first). BSD\r
  59 will (probably?) require gmake (from http://gnu.org). See the \r
  60 user-manual for OS/2 build instructions.\r
  61 \r
  62 Junkbuster is also availabe via anonymous CVS:\r
  63 \r
  64  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login\r
  65  cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current\r
  66 \r
  67 This will create a directory named 'current'. Then, 'cd current', and then\r
  68 build as above.\r
  69 \r
  70 \r
  71  RUN\r
  72 ----\r
  73 \r
  74  junkbuster /etc/junkbuster/config &\r
  75 \r
  76 Or for RPMS: /etc/rc.d/init.d/junkbuster start\r
  77 \r
  78 The only command line option supported is the location of the \r
  79 main configuration file. If none is specified, Junkbuster will \r
  80 look for a file named 'config' in the current directory.\r
  81 \r
  82 \r
  83  CONFIGURATION\r
  84 --------------\r
  85 \r
  86 See: 'config', 'actionsfile', and 're_filterfile'. These are all well\r
  87 commented. On Unix-like systems, these files are installed in /etc/junkbuster.\r
  88 On Windows, then wherever the executable itself is installed. There are many\r
  89 significant changes and advances since v2.0.x. The user-manual has a \r
  90 run down of configuration options, and examples: \r
  91 http://ijbswa.sourceforge.net/user-manual/.\r
  92 \r
  93 Be sure to set your browser(s) for HTTP/HTTPS Proxy at localhost:8000.\r
  94 \r
  95 \r
  96  DOCUMENTATION\r
  97 --------------\r
  98 \r
  99 The best source of information on the current development version, is\r
 100 either comments in the source code, or the included configuration\r
 101 files, which are all well commented. These are 'config',\r
 102 'actionsfile', and 're_filterfile' in the toplevel source directory.\r
 103 \r
 104 There is a growing amount of new documentation in the 'doc'\r
 105 subdirectory, but it is sparse at this point. In particular, see \r
 106 the user-manual there, which is 'nearly there'.\r
 107 \r
 108 Some legacy documentation is also included only to give an idea of\r
 109 what Junkbuster can do under doc/obsolete/*. Much has changed since\r
 110 these docs were written, so beware.\r
 111 \r
 112 \r
 113  BUGS\r
 114 -----\r
 115 \r
 116 Use the form at\r
 117 http://sourceforge.net/tracker/index.php?group_id=11118&atid=111118 to\r
 118 report bugs. Please read the exising bug reports before submitting\r
 119 anything new.\r
 120 \r
 121 -------------------------------------------------------------------------\r
 122 ijbswa-developers@lists.sourceforge.net\r
 123 \r
 124 $Id: README,v 1.5 2001/10/16 01:31:53 hal9 Exp $\r