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" "14 May 2002" "Privoxy 2.9.15 beta" ""
   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 Failiure 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.
  79 .PP
  80 For other browsers, check the documentation.
  81 .SH "CONFIGURATION"
  82 .PP
  83 \fBPrivoxy\fR can be configured with the various configuration
  84 files. The default configuration files are: \fIconfig\fR,
  85 \fIdefault.filter\fR, and
  86 \fIdefault.action\fR. \fIuser.action\fR should
  87 be used for locally defined exceptions to the default rules of
  88 \fIdefault.action\fR These are all well commented.  On Unix
  89 and Unix-like systems, these are located in
  90 \fI/etc/privoxy/\fR by default. On Windows, OS/2 and AmigaOS,
  91 these files are in the same directory as the \fBPrivoxy\fR
  92 executable.
  93 .PP
  94 The name and number of configuration files has changed from previous
  95 versions, and is subject to change as development progresses. In fact, the
  96 configuration itself is changed  and  much more sophisticated. See the
  97 user-manual for a
  98 complete explanation of all configuration options and general usage.
  99 .PP
 100 The actions list (ad blocks, etc) can also be configured with your
 101 web browser at http://config.privoxy.org/.
 102 \fBPrivoxy's\fR configuration parameters  can also  be viewed at
 103 the same page. In addition, \fBPrivoxy\fR can be toggled on/off.
 104 This is an internal page.
 105 .SH "SAMPLE CONFIGURATION"
 106 .PP
 107 A brief example of what a simple \fIdefault.action\fR
 108 configuration might look like:
 109
 110 .nf
 111  # Define a few useful custom aliases for later use
 112  {{alias}}
 113
 114  # Useful aliases
 115  +crunch-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
 116  -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
 117  +imageblock      = +block +handle-as-image
 118
 119  # Fragile sites should have the minimum changes
 120  fragile     = -block -deanimate-gifs -fast-redirects -filter \\
 121                -hide-referer -prevent-cookies -kill-popups
 122
 123  ## Turn some actions on ################################
 124  { \\
 125  -add-header \\
 126  -block \\
 127  +deanimate-gifs{last} \\
 128  -downgrade-http-version \\
 129  -fast-redirects \\
 130  +filter{html-annoyances} \\
 131  +filter{js-annoyances} \\
 132  +filter{content-cookies} \\
 133  +filter{webbugs} \\
 134  +filter{banners-by-size} \\
 135  +hide-forwarded-for-headers \\
 136  +hide-from-header{block} \\
 137  +hide-referrer{forge} \\
 138  -hide-user-agent \\
 139  -handle-as-image \\
 140  +set-image-blocker{pattern} \\
 141  -limit-connect \\
 142  +prevent-compression \\
 143  +session-cookies-only \\
 144  -crunch-cookies \\
 145  -kill-popups \\
 146  }
 147  /   # '/' Matches *all* URL patterns
 148
 149  # Block, and treat these URL patterns as if they were 'images'.
 150  # We would expect these to be ads.
 151  {+imageblock}
 152   .ad.doubleclick.net
 153   .a[0-9].yimg.com/(?:(?!/i/).)*$
 154   ad.*.doubleclick.net
 155
 156  # Block any URLs that match these patterns
 157  {+block}
 158   ad*.
 159   .*ads.
 160   banner?.
 161   /.*count(er)?\\.(pl|cgi|exe|dll|asp|php[34]?)
 162   .hitbox.com
 163
 164  # Make exceptions for these harmless ones that would be
 165  # caught by our +block patterns just above.
 166  {-block}
 167   adsl.
 168   advice.
 169   .*downloads.
 170 .fi
 171 .PP
 172 Then for a \fIuser.action\fR, we would put local,
 173 narrowly defined exceptions:
 174
 175 .nf
 176  # Re-define aliases as needed here
 177  {{alias}}
 178
 179  # Useful aliases
 180  -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
 181
 182  # Set personal exceptions to the policies in default.action #######
 183
 184  # Sites where we want persistant cookies, so allow *all* cookies
 185  {-crunch-cookies -session-cookies-only}
 186   .redhat.com
 187   .sun.com
 188   .msdn.microsoft.com
 189
 190  # This site breaks easily.
 191  {-block -fast-redirects}
 192   .forbes.com
 193 .fi
 194 .PP
 195 See the comments in the configuration files themselves, or the
 196 \fIuser-manual\fR
 197 for explanations of the above syntax, and other \fBPrivoxy\fR
 198 configuration options.
 199 .SH "FILES"
 200
 201 .nf
 202
 203  \fI/usr/sbin/privoxy\fR
 204  \fI/etc/privoxy/config\fR
 205  \fI/etc/privoxy/default.action\fR
 206  \fI/etc/privoxy/standard.action\fR
 207  \fI/etc/privoxy/user.action\fR
 208  \fI/etc/privoxy/default.filter\fR
 209  \fI/etc/privoxy/trust\fR
 210  \fI/etc/privoxy/templates/*\fR
 211  \fI/var/log/privoxy/logfile\fR
 212 .fi
 213 .PP
 214 Various other files should be included, but may vary depending on platform
 215 and build configuration. More documentation should be included in the local
 216 documentation directory.
 217 .SH "SIGNALS"
 218 .PP
 219 \fBPrivoxy\fR terminates on the \fBSIGINT\fR,
 220 \fBSIGTERM\fR and \fBSIGABRT\fR signals. Log
 221 rotation scripts may cause a re-opening of the logfile by sending a
 222 \fBSIGHUP\fR to \fBPrivoxy\fR. Note that unlike
 223 other daemons,  \fBPrivoxy\fR does not need to be made aware of
 224 config file changes by \fBSIGHUP\fR -- it will detect them
 225 automatically.
 226 .SH "NOTES"
 227 .PP
 228 This is a beta version of \fBPrivoxy\fR. Not
 229 all features are well tested.
 230 .PP
 231 Please see the \fIuser-manual\fR on how to contact the
 232 developers for feature requests, reporting problems, and other questions.
 233 .SH "SEE ALSO"
 234 .PP
 235 Other references and sites of interest to \fBPrivoxy\fR
 236 users:
 237 .PP
 238
 239 http://www.privoxy.org/,
 240 The \fBPrivoxy\fR Home page.
 241
 242 http://sourceforge.net/projects/ijbswa,
 243 the Project Page for \fBPrivoxy\fR on
 244 Sourceforge.
 245
 246 http://p.p/, access
 247 \fBPrivoxy\fR from your browser. Alternately,
 248 http://config.privoxy.org
 249 may work in some situations where the first does not.
 250
 251 http://p.p/ to submit ``misses'' to the developers.
 252
 253 http://www.junkbusters.com/ht/en/cookies.html
 254
 255 http://www.waldherr.org/junkbuster/
 256
 257 http://privacy.net/analyze/
 258
 259 http://www.squid-cache.org/
 260 .SH "DEVELOPMENT TEAM"
 261
 262 .nf
 263  Jon Foster
 264  Andreas Oesterhelt
 265  Stefan Waldherr
 266  Thomas Steudten
 267  Rodney Stromlund
 268  Rodrigo Barbosa (RPM specfiles)
 269  Hal Burgiss (docs)
 270  Alexander Lazic
 271  Gábor Lipták
 272  Guy
 273  Haroon Rafique
 274  David Schmidt (OS/2, Mac OSX ports)
 275  Joerg Strohmayer
 276  Sarantis Paskalis
 277 .fi
 278 .SH "COPYRIGHT AND LICENSE"
 279 .SS "COPYRIGHT"
 280 .PP
 281 Copyright (C) 2001, 2002 by Privoxy Developers <developers@privoxy.org>
 282 .PP
 283 Some source code is based on code Copyright (C) 1997 by Anonymous Coders
 284 and Junkbusters, Inc. and licensed under the \fIGNU General Public
 285 License\fR.
 286 .SS "LICENSE"
 287 .PP
 288 \fBPrivoxy\fR is free software; you can
 289 redistribute it and/or modify it under the terms of the
 290 \fIGNU General Public
 291 License\fR, version 2, as published by the Free Software Foundation.
 292 .PP
 293 This program is distributed in the hope that it will be useful, but WITHOUT
 294 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 295 FITNESS FOR A PARTICULAR PURPOSE.  See the
 296 \fIGNU General Public License\fR for
 297 more details, which is available from the Free Software Foundation, Inc, 59
 298 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 299 .PP
 300 You should have received a copy of the  \fIGNU General Public License\fR
 301 along with this program; if not, write to the  Free Software
 302 Foundation, Inc. 59 Temple Place - Suite 330
 303 Boston, MA 02111-1307
 304 USA