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 .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 All \fBJunkbuster\fP configuration is done via 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 \fBJunkbuster's\fP configuration parameters can be viewed at\r
 112 \fIhttp://ijbswa.sourceforge.net/config\fP. This is an internal page. In\r
 113 addition, the \fIijb.action\fP file can be edited here, and \fBJunkbuster\fP can\r
 114 be toggled on/off.\r
 115 \r
 116 .SH "SAMPLE CONFIGURATION"\r
 117 .PP\r
 118 A brief example of what an \fIijb.action\fP configuration might look like:\r
 119 .PP\r
 120 .nf\r
 121 \r
 122 # Define a few useful custom aliases for later use\r
 123 {{alias}}\r
 124 # Don't accept cookies\r
 125 +no-cookies = +no-cookies-set +no-cookies-read\r
 126 # Do accept cookies\r
 127 -no-cookies = -no-cookies-set -no-cookies-read\r
 128 +imageblock = +block +image\r
 129 \r
 130 ## Default Policies (actions) ############################\r
 131 { \\\r
 132  -block \\\r
 133  -downgrade \\\r
 134  +fast-redirects \\\r
 135  +filter \\\r
 136  +no-compression \\\r
 137  +hide-forwarded \\\r
 138  +hide-from{block} \\\r
 139  +hide-referer{forge} \\\r
 140  -hide-user-agent \\\r
 141  -image \\\r
 142  +image-blocker{blank} \\\r
 143  +no-cookies-keep \\\r
 144  -no-cookies-read \\\r
 145  -no-cookies-set \\\r
 146  +no-popups \\\r
 147  -vanilla-wafer \\\r
 148  -wafer \\\r
 149 }\r
 150 /\r
 151 \r
 152 # Now set exceptions to the above defined policies #######\r
 153 \r
 154 # Sites where we want persistant cookies\r
 155 {-no-cookies -no-cookies-keep}\r
 156  .redhat.com\r
 157  .sun.com\r
 158  .yahoo.com\r
 159  .msdn.microsoft.com\r
 160 \r
 161 # This site requires cookies AND 'fast-redirects' on\r
 162 {-no-cookies -no-cookies-keep -fast-redirects}\r
 163  .nytimes.com\r
 164 \r
 165 # Add custom headers, and turn off filtering of page source\r
 166 {+add-header{X-Privacy: Yes please} #-add-header{*} \\\r
 167  +add-header{X-User-Tracking: No thanks!} -filter}\r
 168  privacy.net\r
 169 \r
 170 # Block, and treat these URLs as 'images'.\r
 171 {+imageblock}\r
 172  .adforce.imgis.com\r
 173  .ad.preferences.com/image.*\r
 174  .ads.web.aol.com\r
 175  .ad-adex3.flycast.com\r
 176  .ad.doubleclick.net\r
 177  .ln.doubleclick.net\r
 178  .ad.de.doubleclick.net\r
 179  /.*/count\\.cgi\\?.*df=\r
 180  194.221.183.22[1-7]\r
 181  a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/\r
 182 \r
 183 # Block any URLs that match these patterns\r
 184 {+block}\r
 185  /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\\.(gif|jpe?g))\r
 186  /.*/(plain|live|rotate)[-_.]?ads?/\r
 187  /.*/(sponsor)s?[0-9]?/\r
 188  /.*/ad(server|stream|juggler)\\.(cgi|pl|dll|exe)\r
 189  /.*/adbanners/\r
 190  /.*/adv((er)?ts?|ertis(ing|ements?))?/\r
 191  /.*/banners?/\r
 192  /.*/popupads/\r
 193  /.*/advert[0-9]+\\.jpg\r
 194  /ad_images/\r
 195  /.*/ads/\r
 196  /images/.*/.*_anim\\.gif\r
 197  /rotations/ \r
 198  /.*(ms)?backoff(ice)?.*\\.(gif|jpe?g)\r
 199  195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|)\r
 200  .images.nytimes.com\r
 201  .images.yahoo.com/adv/\r
 202  /.*cnnstore\\.gif\r
 203 \r
 204 .fi\r
 205 .sp\r
 206 .PP\r
 207 See the comments in the configuration files themselves, or the user-manual \r
 208 for explanations of the above syntax, and other \fBJunkbuster\fP configuration \r
 209 options.\r
 210 \r
 211 .SH "FILES"\r
 212 \fI/usr/sbin/junkbuster\fP\r
 213 .br\r
 214 \fI/etc/junkbuster/config\fP\r
 215 .br\r
 216 \fI/etc/junkbuster/ijb.action\fP\r
 217 .br\r
 218 \fI/etc/junkbuster/ijb-advanced.action\fP\r
 219 .br\r
 220 \fI/etc/junkbuster/ijb-basic.action\fP\r
 221 .br\r
 222 \fI/etc/junkbuster/ijb-intermediate.action\fP\r
 223 .br\r
 224 \fI/etc/junkbuster/re_filterfile\fP\r
 225 .br\r
 226 \fI/etc/junkbuster/trust\fP\r
 227 .br\r
 228 \fI/etc/junkbuster/templates/*\fP\r
 229 .br\r
 230 \fI/var/log/junkbuster/logfile\fP\r
 231 \r
 232 .P\r
 233 Various other files should be included, but may vary depending on platform \r
 234 and build configuration. More documentation should be included in the local\r
 235 documentation directory, though is not complete at this time.\r
 236 \r
 237 .SH SIGNALS\r
 238 \fBJunkbuster\fP teriminates on the \fBSIGINT\fP, \fBSIGTERM\fP and \fBSIGABRT\fP\r
 239 signals. Log rotation scripts may cause a re-opening of the logfile by sending\r
 240 a \fBSIGHUP\fP to \fBJunkbuster\fP. Note that unlike other daemons, \fBJunkbuster\fP\r
 241 does not need to be made aware of config file changes by \fBSIGHUP\fP -- it will\r
 242 detect them automatically.\r
 243  \r
 244 .SH NOTES\r
 245 This is a \fBBETA\fP version of \fBJunkbuster\fP. Not all features are  \r
 246 complete.\r
 247 .br\r
 248 Please see the user-maual on how to contact the developers for \r
 249 feature requests, reporting problems, and other questions.\r
 250 \r
 251 .SH BUGS\r
 252 Probably. Please see the user-manual for how and where to report bugs.\r
 253 \r
 254 .SH SEE ALSO\r
 255 .br\r
 256 http://ijbswa.sourceforge.net/config\r
 257 .br\r
 258 http://ijbswa.sourceforge.net/\r
 259 .br\r
 260 http://sourceforge.net/projects/ijbswa\r
 261 .br\r
 262 http://www.waldherr.org/junkbuster/\" waldherr.org#\r
 263 .br\r
 264 http://www.junkbusters.com/ht/en/cookies.html\" cookies.html#\r
 265 .br\r
 266 http://privacy.net/analyze/\r
 267 .br\r
 268 http://www.squid-cache.org/\r
 269 .br\r
 270 http://linuxalpha.ch/packages/\r
 271 \r
 272 .SH DEVELOPMENT TEAM\r
 273 .br\r
 274  Stefan Waldherr \r
 275 .br\r
 276  Andreas Oesterhelt \r
 277 .br\r
 278  Jon Foster \r
 279 .br\r
 280  Markus Breitenbach\r
 281 .br\r
 282  Thomas Steudten\r
 283 .br\r
 284  David Schmidt\r
 285 .br\r
 286  Haroon Rafique\r
 287 .br\r
 288  Joerg Strohmayer\r
 289 .br\r
 290  Shamim Mohamed\r
 291 .br\r
 292  Sarantis Paskalis\r
 293 .br\r
 294  Gabriel L. Somlo\r
 295 .br\r
 296  John Venvertloh\r
 297 .br\r
 298  Hal Burgiss\r
 299 \r
 300 .SH COPYRIGHT AND LICENSE\r
 301 Orginally written by, and copyrighted by, the Anonymous Coders and Junkbusters\r
 302 Corporation. \r
 303 .P\r
 304 This program is free software; you can redistribute it and/or modify\r
 305 it under the terms of the GNU General Public License as published by\r
 306 the Free Software Foundation; either version 2 of the License, or\r
 307 (at your option) any later version.\r
 308 .P\r
 309 This program is distributed in the hope that it will be useful,\r
 310 but WITHOUT ANY WARRANTY; without even the implied warranty of\r
 311 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
 312 GNU General Public License for more details.\r
 313 .P\r
 314 You should have received a copy of the GNU General Public License\r
 315 along with this program; if not, write to the Free Software\r
 316 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
 317 .P\r
 318 Internet Junkbuster\r
 319 Proxy\r
 320 is a\r
 321 trademark\" legal.html#marks\r
 322 of Junkbusters Corporation.\r