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" "05 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 brief explanation of all configuration options.
  99 .PP
 100 The actions list (ad blocks, etc) can also be configured with your
 101 web browser at http://ijbswa.sourceforge.net/config.
 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  +prevent-cookies = +prevent-setting-cookies +prevent-reading-cookies
 116  -prevent-cookies = -prevent-setting-cookies -prevent-reading-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  +prevent-reading-cookies \\
 145  +prevent-setting-cookies \\
 146  -kill-popups \\
 147  }
 148  /   # Match all URLs
 149
 150  # Block, and treat these URL patterns as if they were 'images'.
 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   /(?:.*/)?(publicite|werbung|rekla(ma|me|am)|maino(kset|nta|s)?)/
 163   .hitbox.com
 164
 165  # Make exceptions for these harmless ones that would be
 166  # caught by +block above.
 167  {-block}
 168   adsl.
 169   advice.
 170   .*downloads.
 171 .fi
 172 .PP
 173 Then for a \fIuser.action\fR, we would put local,
 174 narrowly defined exceptions:
 175
 176 .nf
 177  # Set personal exceptions to the policies in default.action #######
 178
 179  # Sites where we want persistant cookies
 180  {-prevent-reading-cookies -prevent-setting-cookies -session-cookies-only}
 181   .redhat.com
 182   .sun.com
 183   .msdn.microsoft.com
 184
 185  {-block -fast-redirects}
 186   .forbes.com
 187 .fi
 188 .PP
 189 See the comments in the configuration files themselves, or the
 190 \fIuser-manual\fR
 191 for explanations of the above syntax, and other \fBPrivoxy\fR
 192 configuration options.
 193 .SH "FILES"
 194
 195 .nf
 196
 197  \fI/usr/sbin/privoxy\fR
 198  \fI/etc/privoxy/config\fR
 199  \fI/etc/privoxy/default.action\fR
 200  \fI/etc/privoxy/standard.action\fR
 201  \fI/etc/privoxy/user.action\fR
 202  \fI/etc/privoxy/default.filter\fR
 203  \fI/etc/privoxy/trust\fR
 204  \fI/etc/privoxy/templates/*\fR
 205  \fI/var/log/privoxy/logfile\fR
 206 .fi
 207 .PP
 208 Various other files should be included, but may vary depending on platform
 209 and build configuration. More documentation should be included in the local
 210 documentation directory, though is not complete at this time.
 211 .SH "SIGNALS"
 212 .PP
 213 \fBPrivoxy\fR terminates on the \fBSIGINT\fR,
 214 \fBSIGTERM\fR and \fBSIGABRT\fR signals. Log
 215 rotation scripts may cause a re-opening of the logfile by sending a
 216 \fBSIGHUP\fR to \fBPrivoxy\fR. Note that unlike
 217 other daemons,  \fBPrivoxy\fR does not need to be made aware of
 218 config file changes by \fBSIGHUP\fR -- it will detect them
 219 automatically.
 220 .SH "NOTES"
 221 .PP
 222 This is a beta version of \fBPrivoxy\fR. Not
 223 all features are well tested.
 224 .PP
 225 Please see the \fIuser-manual\fR on how to contact the
 226 developers for feature requests, reporting problems, and other questions.
 227 .SH "SEE ALSO"
 228 .PP
 229 Other references and sites of interest to \fBPrivoxy\fR
 230 users:
 231 .PP
 232
 233 http://www.privoxy.org/,
 234 The \fBPrivoxy\fR Home page.
 235
 236 http://sourceforge.net/projects/ijbswa,
 237 the Project Page for \fBPrivoxy\fR on
 238 Sourceforge.
 239
 240 http://p.p/, access
 241 \fBPrivoxy\fR from your browser. Alternately,
 242 http://config.privoxy.org
 243 may work in some situations where the first does not.
 244
 245 http://p.p/ to submit ``misses'' to the developers.
 246
 247 http://www.junkbusters.com/ht/en/cookies.html
 248
 249 http://www.waldherr.org/junkbuster/
 250
 251 http://privacy.net/analyze/
 252
 253 http://www.squid-cache.org/
 254 .SH "DEVELOPMENT TEAM"
 255
 256 .nf
 257  Jon Foster
 258  Andreas Oesterhelt
 259  Stefan Waldherr
 260  Thomas Steudten
 261  Rodney Stromlund
 262  Rodrigo Barbosa (RPM specfiles)
 263  Hal Burgiss (docs)
 264  Alexander Lazic
 265  Gábor Lipták
 266  Guy
 267  Haroon Rafique
 268  David Schmidt (OS/2, Mac OSX ports)
 269  Joerg Strohmayer
 270  Sarantis Paskalis
 271 .fi
 272 .SH "COPYRIGHT AND LICENSE"
 273 .SS "COPYRIGHT"
 274 .PP
 275 Permission is granted to copy, distribute and/or modify this document under
 276 the terms of the \fIGNU Free
 277 Documentation License\fR, Version 1.1 or any later version
 278 published by the Free Software Foundation with no Invariant Sections, no
 279 Front-Cover Texts, and no Back-Cover Texts.  A copy of the license can be
 280 found http://www.gnu.org/licenses/fdl.html.
 281 .SS "LICENSE"
 282 .PP
 283 \fBPrivoxy\fR is free software; you can
 284 redistribute it and/or modify it under the terms of the GNU General Public
 285 License as published by the Free Software Foundation; either version 2 of the
 286 License, or (at your option) any later version.
 287 .PP
 288 This program is distributed in the hope that it will be useful, but WITHOUT
 289 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 290 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 291 more details, which is available from the Free Software Foundation, Inc, 59
 292 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 293 .PP
 294 You should have received a copy of the GNU General Public License
 295 along with this program; if not, write to the Free Software Foundation, Inc.,
 296 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.