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