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