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