privoxy.1

   1 .\" This manpage has been automatically generated by docbook2man
   2 .\" from a DocBook document.  This tool can be found at:
   3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
   4 .\" Please send any bug reports, improvements, comments, patches,
   5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
   6 .TH "PRIVOXY" "1" "17 March 2003" "Privoxy 3.0.1" ""
   7 .SH NAME
   8 privoxy \- Privacy Enhancing Proxy
   9 .SH SYNOPSIS
  10
  11 \fBprivoxy\fR [\fB--help\fR ] [\fB--version\fR ] [\fB--no-daemon\fR ] [\fB--pidfile \fIpidfile\fB\fR ] [\fB--user \fIuser[.group]\fB\fR ] [\fB\fIconfigfile\fB\fR ]\fB (UNIX)\fR
  12
  13
  14 \fBprivoxy.exe\fR [\fB\fIconfigfile\fB\fR ]\fB (Windows)\fR
  15
  16 .SH "OPTIONS"
  17 .PP
  18 \fBPrivoxy\fR may be invoked with the following command line
  19 options:
  20 .TP
  21 \fB--help\fR
  22 Print brief usage info and exit.
  23 .TP
  24 \fB--version\fR
  25 Print version info and exit.
  26 .TP
  27 \fB--no-daemon\fR
  28 Don't  become  a daemon, i.e. don't fork and become process group
  29 leader, don't detach from controlling tty, and do all logging there.
  30 .TP
  31 \fB--pidfile \fIpidfile\fB\fR
  32 On startup, write the process ID to \fIpidfile\fR.
  33 Delete the \fIpidfile\fR on exit.
  34 Failure to create or delete the \fIpidfile\fR
  35 is non-fatal. If no \fB--pidfile\fR option is given, no PID file will be used.
  36 .TP
  37 \fB--user \fIuser[.group]\fB\fR
  38 After (optionally) writing the PID file, assume the user ID of
  39 \fIuser\fR and the GID of
  40 \fIgroup\fR, or, if the optional
  41 \fIgroup\fR was not given, the default group of
  42 \fIuser\fR. Exit if the privileges are not
  43 sufficient to do so.
  44 .TP
  45 \fB--chroot\fR
  46 Before changing to the user ID given in the --user option, chroot to that user's home
  47 directory, i.e. make the kernel pretend to the Privoxy process that the directory tree
  48 starts there. If set up carefully, this can limit the impact of possible vulnerabilities
  49 in Privoxy to the files contained in that hierarchy.
  50 .PP
  51 If the \fIconfigfile\fR is not specified on  the  command  line,
  52 \fBPrivoxy\fR  will  look for a file named
  53 \fIconfig\fR in the current directory (except on Win32 where
  54 it will try \fIconfig.txt\fR). If no
  55 \fIconfigfile\fR is found, \fBPrivoxy\fR will
  56 fail to start.
  57 .SH "DESCRIPTION"
  58 .PP
  59 \fBPrivoxy\fR is a web proxy with advanced filtering
  60 capabilities for protecting privacy, filtering web page content, managing
  61 cookies, controlling access, and removing ads, banners, pop-ups and other
  62 obnoxious Internet junk. \fBPrivoxy\fR has a very
  63 flexible configuration and can be customized to suit individual needs and
  64 tastes. \fBPrivoxy\fR has application for both
  65 stand-alone systems and multi-user networks.
  66 .PP
  67 \fBPrivoxy\fR is based on \fBInternet
  68 Junkbuster\fR (tm).
  69 .SH "INSTALLATION AND USAGE"
  70 .PP
  71 Browsers must be individually configured to use \fBPrivoxy\fR as
  72 a HTTP proxy.  The default setting is  for  localhost,  on port  8118
  73 (configurable in the main config file).  To set the HTTP proxy in Netscape
  74 and Mozilla, go through:  \fBEdit\fR;
  75 \fBPreferences\fR;  \fBAdvanced\fR;
  76 \fBProxies\fR;  \fBManual Proxy Configuration\fR;
  77 \fBView\fR.
  78 .PP
  79 For Internet Explorer, go through: \fBTools\fR;
  80 \fBInternet Properties\fR; \fBConnections\fR;
  81 \fBLAN Settings\fR.
  82 .PP
  83 The Secure (SSL) Proxy should also be set to the same values, otherwise
  84 https: URLs will not be proxied. Note: \fBPrivoxy\fR can only
  85 proxy HTTP and HTTPS traffic. Do not try it with FTP or other protocols.
  86 .PP
  87 For other browsers, check the documentation.
  88 .SH "CONFIGURATION"
  89 .PP
  90 \fBPrivoxy\fR can be configured with the various configuration
  91 files. The default configuration files are: \fIconfig\fR,
  92 \fIdefault.filter\fR, and
  93 \fIdefault.action\fR. \fIuser.action\fR should
  94 be used for locally defined exceptions to the default rules of
  95 \fIdefault.action\fR These are all well commented.  On Unix
  96 and Unix-like systems, these are located in
  97 \fI/etc/privoxy/\fR by default. On Windows, OS/2 and AmigaOS,
  98 these files are in the same directory as the \fBPrivoxy\fR
  99 executable.
 100 .PP
 101 The name and number of configuration files has changed from previous
 102 versions, and is subject to change as development
 103 progresses. In fact, the configuration itself is changed  and  much more
 104 sophisticated. See the user-manual for a complete
 105 explanation of all configuration options and general usage, and notes for
 106 upgrading from \fBJunkbuster\fR and earlier \fBPrivoxy\fR
 107 versions.
 108 .PP
 109 The actions list (ad blocks, etc) can also be configured with your
 110 web browser at http://config.privoxy.org/.
 111 \fBPrivoxy's\fR configuration parameters  can also  be viewed at
 112 the same page. In addition, \fBPrivoxy\fR can be toggled on/off.
 113 This is an internal page, and does not require Internet access.
 114 .SH "SAMPLE CONFIGURATION"
 115 .PP
 116 A brief example of what a simple \fIdefault.action\fR
 117 configuration might look like:
 118
 119 .nf
 120  # Define a few useful custom aliases for later use
 121  {{alias}}
 122
 123  # Useful aliases
 124  +crunch-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
 125  -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
 126  +imageblock      = +block +handle-as-image
 127
 128  # Fragile sites should have the minimum changes
 129  fragile     = -block -deanimate-gifs -fast-redirects -filter \\
 130                -hide-referer -prevent-cookies -kill-popups
 131
 132  ## Turn some actions on ################################
 133  { \\
 134  -add-header \\
 135  -block \\
 136  +deanimate-gifs{last} \\
 137  -downgrade-http-version \\
 138  -fast-redirects \\
 139  +filter{html-annoyances} \\
 140  +filter{js-annoyances} \\
 141  +filter{content-cookies} \\
 142  +filter{webbugs} \\
 143  +filter{banners-by-size} \\
 144  +hide-forwarded-for-headers \\
 145  +hide-from-header{block} \\
 146  +hide-referrer{forge} \\
 147  -hide-user-agent \\
 148  -handle-as-image \\
 149  +set-image-blocker{pattern} \\
 150  -limit-connect \\
 151  +prevent-compression \\
 152  +session-cookies-only \\
 153  -crunch-cookies \\
 154  -kill-popups \\
 155  }
 156  /   # '/' Matches *all* URL patterns
 157
 158  # Block, and treat these URL patterns as if they were 'images'.
 159  # We would expect these to be ads.
 160  {+imageblock}
 161   .ad.doubleclick.net
 162   .a[0-9].yimg.com/(?:(?!/i/).)*$
 163   ad.*.doubleclick.net
 164
 165  # Block any URLs that match these patterns
 166  {+block}
 167   ad*.
 168   .*ads.
 169   banner?.
 170   /.*count(er)?\\.(pl|cgi|exe|dll|asp|php[34]?)
 171   .hitbox.com
 172
 173  # Make exceptions for these harmless ones that would be
 174  # caught by our +block patterns just above.
 175  {-block}
 176   adsl.
 177   advice.
 178   .*downloads.
 179 .fi
 180 .PP
 181 Then for a \fIuser.action\fR, we would put local,
 182 narrowly defined exceptions:
 183
 184 .nf
 185  # Re-define aliases as needed here
 186  {{alias}}
 187
 188  # Useful aliases
 189  -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
 190
 191  # Set personal exceptions to the policies in default.action #######
 192
 193  # Sites where we want persistant cookies, so allow *all* cookies
 194  {-crunch-cookies -session-cookies-only}
 195   .redhat.com
 196   .sun.com
 197   .msdn.microsoft.com
 198
 199  # This site breaks easily.
 200  {-block -fast-redirects}
 201   .forbes.com
 202 .fi
 203 .PP
 204 See the comments in the configuration files themselves, or the
 205 \fIuser-manual\fR
 206 for explanations of the above syntax, and other \fBPrivoxy\fR
 207 configuration options.
 208 .SH "FILES"
 209
 210 .nf
 211
 212  \fI/usr/sbin/privoxy\fR
 213  \fI/etc/privoxy/config\fR
 214  \fI/etc/privoxy/default.action\fR
 215  \fI/etc/privoxy/standard.action\fR
 216  \fI/etc/privoxy/user.action\fR
 217  \fI/etc/privoxy/default.filter\fR
 218  \fI/etc/privoxy/trust\fR
 219  \fI/etc/privoxy/templates/*\fR
 220  \fI/var/log/privoxy/logfile\fR
 221 .fi
 222 .PP
 223 Various other files should be included, but may vary depending on platform
 224 and build configuration. More documentation should be included in the local
 225 documentation directory.
 226 .SH "SIGNALS"
 227 .PP
 228 \fBPrivoxy\fR terminates on the \fBSIGINT\fR,
 229 \fBSIGTERM\fR and \fBSIGABRT\fR signals. Log
 230 rotation scripts may cause a re-opening of the logfile by sending a
 231 \fBSIGHUP\fR to \fBPrivoxy\fR. Note that unlike
 232 other daemons,  \fBPrivoxy\fR does not need to be made aware of
 233 config file changes by \fBSIGHUP\fR -- it will detect them
 234 automatically.
 235 .SH "NOTES"
 236 .PP
 237 Please see the \fIUser Manual\fR on how to contact the
 238 developers for feature requests, reporting problems, and other questions.
 239 .SH "SEE ALSO"
 240 .PP
 241 Other references and sites of interest to \fBPrivoxy\fR
 242 users:
 243 .PP
 244
 245 http://www.privoxy.org/,
 246 the \fBPrivoxy\fR Home page.
 247
 248 http://www.privoxy.org/faq/,
 249 the \fBPrivoxy\fR FAQ.
 250
 251 http://sourceforge.net/projects/ijbswa/,
 252 the Project Page for \fBPrivoxy\fR on
 253 SourceForge.
 254
 255 http://config.privoxy.org/,
 256 the web-based user interface. \fBPrivoxy\fR must be
 257 running for this to work. Shortcut: http://p.p/
 258
 259 http://www.privoxy.org/actions/, to submit ``misses'' to the developers.
 260
 261 http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/contrib/, cool
 262 and fun ideas from \fBPrivoxy\fR users.
 263
 264 http://www.junkbusters.com/ht/en/cookies.html,
 265 an explanation how cookies are used to track web users.
 266
 267 http://www.junkbusters.com/ijb.html,
 268 the original Internet Junkbuster.
 269
 270 http://www.waldherr.org/junkbuster/,
 271 Stefan Waldherr's version of Junkbuster, from which \fBPrivoxy\fR was
 272 derived.
 273
 274 http://privacy.net/analyze/, a useful site
 275 to check what information about you is leaked while you browse the web.
 276
 277 http://www.squid-cache.org/, a very popular
 278 caching proxy, which is often used together with \fBPrivoxy\fR.
 279
 280 http://www.privoxy.org/developer-manual/,
 281 the \fBPrivoxy\fR developer manual.
 282 .SH "DEVELOPMENT TEAM"
 283
 284 .nf
 285  Jon Foster
 286  Andreas Oesterhelt
 287  Stefan Waldherr
 288  Thomas Steudten
 289  Rodney Stromlund
 290  Johny Agotnes
 291  Rodrigo Barbosa (RPM specfiles)
 292  Moritz Barsnick
 293  Hal Burgiss (docs)
 294  Mattes Dolak
 295  Karsten Hopp (Red Hat)
 296  Alexander Lazic
 297  Daniel Leite
 298  Gábor Lipták
 299  Andrew Lock (Win32)
 300  Guy Laroche
 301  Haroon Rafique
 302  Roland Rosenfeld (Debian)
 303  Georg Sauthoff (Gentoo)
 304  David Schmidt (OS/2, Mac OSX ports)
 305  Joerg Strohmayer (Amiga)
 306  Sviatoslav Sviridov
 307  Sarantis Paskalis
 308 .fi
 309 .SH "COPYRIGHT AND LICENSE"
 310 .SS "COPYRIGHT"
 311 .PP
 312 Copyright (C) 2001, 2002 by Privoxy Developers <developers@privoxy.org>
 313 .PP
 314 Some source code is based on code Copyright (C) 1997 by Anonymous Coders
 315 and Junkbusters, Inc. and licensed under the \fIGNU General Public
 316 License\fR.
 317 .SS "LICENSE"
 318 .PP
 319 \fBPrivoxy\fR is free software; you can
 320 redistribute it and/or modify it under the terms of the
 321 \fIGNU General Public
 322 License\fR, version 2, as published by the Free Software Foundation.
 323 .PP
 324 This program is distributed in the hope that it will be useful, but WITHOUT
 325 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 326 FITNESS FOR A PARTICULAR PURPOSE.  See the
 327 \fIGNU General Public License\fR for
 328 more details, which is available from the Free Software Foundation, Inc, 59
 329 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 330 .PP
 331 You should have received a copy of the  \fIGNU General Public License\fR
 332 along with this program; if not, write to the  Free Software
 333 Foundation, Inc. 59 Temple Place - Suite 330
 334 Boston, MA 02111-1307
 335 USA