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