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