privoxy.1

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