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