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