privoxy.1

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