junkbuster.1

   1 .\" Revised man page 10/13/01, for development version.\r
   2 .\" Hal Burgiss <hal@foobox.net> \r
   3 .\" for Junkbuster developers: ijbswa-developers@lists.sourceforge.net\r
   4 .\"\r
   5 .TH JUNKBUSTER 1 "v2.9.11 (beta) Date: 2002/03/06"\r
   6 \r
   7 .SH NAME\r
   8 \fBjunkbuster\fP\r
   9 - The\r
  10 Internet Junkbuster\r
  11 Proxy\r
  12 \s-2(TM)\s+2\r
  13 .SH SYNOPSIS\r
  14 \fBjunkbuster\fP\r
  15 [--help] [--version] [--no-daemon] [--pidfile \fIPID_FILE\fP] [--user USER] \r
  16 \fI\&[config_file]\fP (Unix)\r
  17 .TP\r
  18 \fBjunkbstr.exe\fP\r
  19 \fI\&[config_file]\fP\r
  20 (Windows)\r
  21 .br\r
  22 \r
  23 .SH OPTIONS\r
  24 \fBJunkbuster\fP may be invoked with the following command-line options:\r
  25 .TP\r
  26 .BR --version " (unix only)"\r
  27 Print version info and exit.\r
  28 .TP\r
  29 .BR --help " (unix only)"\r
  30 Print a short usage info and exit.\r
  31 .TP\r
  32 .BR --no-daemon " (unix only)"\r
  33 Don't become a daemon, i.e. don't fork and become process group\r
  34 leader, don't detach from controlling tty.\r
  35 .TP\r
  36 \fB --pidfile\fP \fIPID_FILE\fP (unix only)\r
  37 On startup, write the process ID to \fIpidfile\fP. Delete the\r
  38 \fIpidfile\fP on exit. Failiure to create or delete the\r
  39 \fIpidfile\fP is non-fatal. If no \fB--pidfile\fP option\r
  40 is given, no PID file will be used.\r
  41 .TP\r
  42 \fB --user\fP \fIUSER\fP (unix only)\r
  43 After (optionally) writing the PID file, assume the user ID\r
  44 of \fIuser\fP. Exit if the privileges are not sufficient to\r
  45 do so.\r
  46 \r
  47 .PP\r
  48 If the \fIconfig file\fP is not specified on the command line,\r
  49 \fBJunkbuster\fP will look for a file named \fBconfig\fP in the \r
  50 current directory (except on Win32 where it will try \fBconfig.txt\fP).\r
  51 \r
  52 \r
  53 .SH DESCRIPTION\r
  54 \fBJunkbuster\fP\r
  55 is an instrumentable HTTP proxy that filters the \r
  56 \s-2HTTP\s0\r
  57 data stream between\r
  58 web servers and browsers.\r
  59 \fBJunkbuster\fP can be used to protect privacy, manage cookies, filter web\r
  60 page content, manage access restrictions, and to discard such annoying Internet\r
  61 junk as ads, banners, and pop-ups. Or whatever other annoyances strike your\r
  62 fancy.\r
  63 \r
  64 .SH INSTALLATION AND USE\r
  65 Browsers must be configured to use \r
  66 \fBJunkbuster\fP\r
  67 (the default is localhost, \r
  68 port 8118).\r
  69 To set the \r
  70 \s-2HTTP\s0\r
  71 proxy in Netscape and Mozilla,\r
  72 go through:\r
  73 \fB\&Edit\fP;\r
  74 \fB\&Preferences\fP;\r
  75 \fB\&Advanced\fP;\r
  76 \fB\&Proxies\fP;\r
  77 \fB\&Manual Proxy Configuration\fP;\r
  78 \fB\&View\fP.\r
  79 .P\r
  80 For Internet Explorer,\r
  81 go through:\r
  82 \fB\&Tools\fP;\r
  83 \fB\&Internet Properties\fP;\r
  84 \fB\&Connections\fP;\r
  85 \fB\&LAN Settings\fP.\r
  86 .P\r
  87 Set the HTTP proxy location for localhost, port 8118.\r
  88 The\r
  89 Secure (SSL) Proxy\" ijbfaq.html#security\r
  90 should also be set to the same values,\r
  91 otherwise\r
  92 \fB\&https:\fP\r
  93 \s-2URL\s0s\r
  94 won't be proxied.\r
  95 .P\r
  96 For other browsers, check the documentation.\r
  97 \r
  98 .SH CONFIGURATION\r
  99 \fBJunkbuster\fP can be configured with the various configuration \r
 100 files. The default configuration files are: \fIconfig\fP, \r
 101 \fIijb.action\fP, and \fIre_filterfile\fP. These are well commented. \r
 102 On Unix and Unix-like systems, these are located in \fI/etc/junkbuster/\fP \r
 103 by default. On Windows, OS/2 and AmigaOS, these files are in the same directory \r
 104 as the \fBJunkbuster\fP executable. \r
 105 .P\r
 106 The name and number of configuration files has changed from previous versions,\r
 107 and is subject to change as development progresses. In fact, the configuration\r
 108 itself is changed and much more sophisticated. See the user-manual for a brief\r
 109 explanation of all configuration options.\r
 110 .P\r
 111 The actions list (ad blocks, etc) can also be configured with your \r
 112 web browser at \fIhttp://ijbswa.sourceforge.net/config\fP.\r
 113 \fBJunkbuster's\fP configuration parameters can also be viewed at\r
 114 at the same page. In addition, \fBJunkbuster\fP can be toggled on/off.\r
 115 This is an internal page. \r
 116 \r
 117 .SH "SAMPLE CONFIGURATION"\r
 118 .PP\r
 119 A brief example of what an \fIijb.action\fP configuration might look like:\r
 120 .PP\r
 121 .nf\r
 122 \r
 123 # Define a few useful custom aliases for later use\r
 124 {{alias}}\r
 125 # Don't accept cookies\r
 126 +no-cookies = +no-cookies-set +no-cookies-read\r
 127 # Do accept cookies\r
 128 -no-cookies = -no-cookies-set -no-cookies-read\r
 129 +imageblock = +block +image\r
 130 \r
 131 ## Default Policies (actions) ############################\r
 132 { \\\r
 133  -block \\\r
 134  -downgrade \\\r
 135  +fast-redirects \\\r
 136  +filter \\\r
 137  +no-compression \\\r
 138  +hide-forwarded \\\r
 139  +hide-from{block} \\\r
 140  +hide-referer{forge} \\\r
 141  -hide-user-agent \\\r
 142  -image \\\r
 143  +image-blocker{blank} \\\r
 144  +no-cookies-keep \\\r
 145  -no-cookies-read \\\r
 146  -no-cookies-set \\\r
 147  +no-popups \\\r
 148  -vanilla-wafer \\\r
 149  -wafer \\\r
 150 }\r
 151 /\r
 152 \r
 153 # Now set exceptions to the above defined policies #######\r
 154 \r
 155 # Sites where we want persistant cookies\r
 156 {-no-cookies -no-cookies-keep}\r
 157  .redhat.com\r
 158  .sun.com\r
 159  .yahoo.com\r
 160  .msdn.microsoft.com\r
 161 \r
 162 # This site requires cookies AND 'fast-redirects' on\r
 163 {-no-cookies -no-cookies-keep -fast-redirects}\r
 164  .nytimes.com\r
 165 \r
 166 # Add custom headers, and turn off filtering of page source\r
 167 {+add-header{X-Privacy: Yes please} #-add-header{*} \\\r
 168  +add-header{X-User-Tracking: No thanks!} -filter}\r
 169  privacy.net\r
 170 \r
 171 # Block, and treat these URLs as 'images'.\r
 172 {+imageblock}\r
 173  .adforce.imgis.com\r
 174  .ad.preferences.com/image.*\r
 175  .ads.web.aol.com\r
 176  .ad-adex3.flycast.com\r
 177  .ad.doubleclick.net\r
 178  .ln.doubleclick.net\r
 179  .ad.de.doubleclick.net\r
 180  /.*/count\\.cgi\\?.*df=\r
 181  194.221.183.22[1-7]\r
 182  a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/\r
 183 \r
 184 # Block any URLs that match these patterns\r
 185 {+block}\r
 186  /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\\.(gif|jpe?g))\r
 187  /.*/(plain|live|rotate)[-_.]?ads?/\r
 188  /.*/(sponsor)s?[0-9]?/\r
 189  /.*/ad(server|stream|juggler)\\.(cgi|pl|dll|exe)\r
 190  /.*/adbanners/\r
 191  /.*/adv((er)?ts?|ertis(ing|ements?))?/\r
 192  /.*/banners?/\r
 193  /.*/popupads/\r
 194  /.*/advert[0-9]+\\.jpg\r
 195  /ad_images/\r
 196  /.*/ads/\r
 197  /images/.*/.*_anim\\.gif\r
 198  /rotations/ \r
 199  /.*(ms)?backoff(ice)?.*\\.(gif|jpe?g)\r
 200  195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|)\r
 201  .images.nytimes.com\r
 202  .images.yahoo.com/adv/\r
 203  /.*cnnstore\\.gif\r
 204 \r
 205 .fi\r
 206 .sp\r
 207 .PP\r
 208 See the comments in the configuration files themselves, or the user-manual \r
 209 for explanations of the above syntax, and other \fBJunkbuster\fP configuration \r
 210 options.\r
 211 \r
 212 .SH "FILES"\r
 213 \fI/usr/sbin/junkbuster\fP\r
 214 .br\r
 215 \fI/etc/junkbuster/config\fP\r
 216 .br\r
 217 \fI/etc/junkbuster/ijb.action\fP\r
 218 .br\r
 219 \fI/etc/junkbuster/ijb-advanced.action\fP\r
 220 .br\r
 221 \fI/etc/junkbuster/ijb-basic.action\fP\r
 222 .br\r
 223 \fI/etc/junkbuster/ijb-intermediate.action\fP\r
 224 .br\r
 225 \fI/etc/junkbuster/re_filterfile\fP\r
 226 .br\r
 227 \fI/etc/junkbuster/trust\fP\r
 228 .br\r
 229 \fI/etc/junkbuster/templates/*\fP\r
 230 .br\r
 231 \fI/var/log/junkbuster/logfile\fP\r
 232 \r
 233 .P\r
 234 Various other files should be included, but may vary depending on platform \r
 235 and build configuration. More documentation should be included in the local\r
 236 documentation directory, though is not complete at this time.\r
 237 \r
 238 .SH SIGNALS\r
 239 \fBJunkbuster\fP teriminates on the \fBSIGINT\fP, \fBSIGTERM\fP and \fBSIGABRT\fP\r
 240 signals. Log rotation scripts may cause a re-opening of the logfile by sending\r
 241 a \fBSIGHUP\fP to \fBJunkbuster\fP. Note that unlike other daemons, \fBJunkbuster\fP\r
 242 does not need to be made aware of config file changes by \fBSIGHUP\fP -- it will\r
 243 detect them automatically.\r
 244  \r
 245 .SH NOTES\r
 246 This is a \fBBETA\fP version of \fBJunkbuster\fP. Not all features are  \r
 247 complete.\r
 248 .br\r
 249 Please see the user-maual on how to contact the developers for \r
 250 feature requests, reporting problems, and other questions.\r
 251 \r
 252 .SH BUGS\r
 253 Probably. Please see the user-manual for how and where to report bugs.\r
 254 \r
 255 .SH SEE ALSO\r
 256 .br\r
 257 http://ijbswa.sourceforge.net/config\r
 258 .br\r
 259 http://ijbswa.sourceforge.net/\r
 260 .br\r
 261 http://sourceforge.net/projects/ijbswa\r
 262 .br\r
 263 http://www.waldherr.org/junkbuster/\" waldherr.org#\r
 264 .br\r
 265 http://www.junkbusters.com/ht/en/cookies.html\" cookies.html#\r
 266 .br\r
 267 http://privacy.net/analyze/\r
 268 .br\r
 269 http://www.squid-cache.org/\r
 270 .br\r
 271 http://linuxalpha.ch/packages/\r
 272 \r
 273 .SH DEVELOPMENT TEAM\r
 274 .br\r
 275  Stefan Waldherr \r
 276 .br\r
 277  Andreas Oesterhelt \r
 278 .br\r
 279  Jon Foster \r
 280 .br\r
 281  Markus Breitenbach\r
 282 .br\r
 283  Thomas Steudten\r
 284 .br\r
 285  David Schmidt\r
 286 .br\r
 287  Haroon Rafique\r
 288 .br\r
 289  Joerg Strohmayer\r
 290 .br\r
 291  Shamim Mohamed\r
 292 .br\r
 293  Sarantis Paskalis\r
 294 .br\r
 295  Gabriel L. Somlo\r
 296 .br\r
 297  John Venvertloh\r
 298 .br\r
 299  Hal Burgiss\r
 300 \r
 301 .SH COPYRIGHT AND LICENSE\r
 302 Orginally written by, and copyrighted by, the Anonymous Coders and Junkbusters\r
 303 Corporation. \r
 304 .P\r
 305 This program is free software; you can redistribute it and/or modify\r
 306 it under the terms of the GNU General Public License as published by\r
 307 the Free Software Foundation; either version 2 of the License, or\r
 308 (at your option) any later version.\r
 309 .P\r
 310 This program is distributed in the hope that it will be useful,\r
 311 but WITHOUT ANY WARRANTY; without even the implied warranty of\r
 312 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
 313 GNU General Public License for more details.\r
 314 .P\r
 315 You should have received a copy of the GNU General Public License\r
 316 along with this program; if not, write to the Free Software\r
 317 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
 318 .P\r
 319 Internet Junkbuster\r
 320 Proxy\r
 321 is a\r
 322 trademark\" legal.html#marks\r
 323 of Junkbusters Corporation.\r