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" "18 April 2002" "Privoxy 2.9.14 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.action\fR, and
  86 \fIdefault.filter\fR. These are well commented.  On Unix and
  87 Unix-like systems, these are located in \fI/etc/privoxy/\fR by
  88 default. On Windows, OS/2 and AmigaOS, these files are in the same directory
  89 as the \fBPrivoxy\fR executable.
  90 .PP
  91 The name and number of configuration files has changed from previous
  92 versions, and is subject to change as development progresses. In fact, the
  93 configuration itself is changed  and  much more sophisticated. See the
  94 user-manual for a
  95 brief explanation of all configuration options.
  96 .PP
  97 The actions list (ad blocks, etc) can also be configured with your
  98 web browser at http://ijbswa.sourceforge.net/config.
  99 \fBPrivoxy's\fR configuration parameters  can also  be viewed at
 100 the same page. In addition, \fBPrivoxy\fR can be toggled on/off.
 101 This is an internal page.
 102 .SH "SAMPLE CONFIGURATION"
 103 .PP
 104 A brief example of what a \fIdefault.action\fR configuration
 105 might look like:
 106
 107 .nf
 108
 109  # Define a few useful custom aliases for later use
 110  {{alias}}
 111
 112  # Don't accept cookies
 113  +no-cookies = +no-cookies-set +no-cookies-read
 114
 115  # Do accept cookies
 116  -no-cookies = -no-cookies-set -no-cookies-read
 117
 118  # Treat these blocked URLs as images.
 119  +imageblock = +block +image
 120
 121  # Define page filters we want to use.
 122  myfilters = +filter{html-annoyances} +filter{js-annoyances}\\
 123              +filter{no-popups} +filter{webbugs}
 124
 125  ## Default Policies (actions) ############################
 126  { \\
 127   -block \\
 128   -downgrade \\
 129   +fast-redirects \\
 130   myfilters \\
 131   +no-compression \\
 132   +hide-forwarded \\
 133   +hide-from{block} \\
 134   +hide-referer{forge} \\
 135   -hide-user-agent \\
 136   -image \\
 137   +image-blocker{blank} \\
 138   +no-cookies-keep \\
 139   -no-cookies-read \\
 140   -no-cookies-set \\
 141   +no-popups \\
 142   -vanilla-wafer \\
 143   -wafer \\
 144  }
 145  /
 146
 147  # Now set exceptions to the above defined policies #######
 148
 149  # Sites where we want persistant cookies
 150  {-no-cookies -no-cookies-keep}
 151   .redhat.com
 152   .sun.com
 153   .yahoo.com
 154   .msdn.microsoft.com
 155
 156  # This site requires cookies AND 'fast-redirects' on
 157  {-no-cookies -no-cookies-keep -fast-redirects}
 158   .nytimes.com
 159
 160  # Add custom headers, and turn off filtering of page source
 161  {+add-header{X-Privacy: Yes please} #-add-header{*} \\
 162   +add-header{X-User-Tracking: No thanks!} -filter}
 163   privacy.net
 164
 165  # Block, and treat these URLs as 'images'.
 166  {+imageblock}
 167   .adforce.imgis.com
 168   .ad.preferences.com/image.*
 169   .ads.web.aol.com
 170   .ad-adex3.flycast.com
 171   .ad.doubleclick.net
 172   .ln.doubleclick.net
 173   .ad.de.doubleclick.net
 174   /.*/count\\.cgi\\?.*df=
 175   194.221.183.22[1-7]
 176   a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/
 177
 178  # Block any URLs that match these patterns
 179  {+block}
 180   /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\\.(gif|jpe?g))
 181   /.*/(plain|live|rotate)[-_.]?ads?/
 182   /.*/(sponsor)s?[0-9]?/
 183   /.*/ad(server|stream|juggler)\\.(cgi|pl|dll|exe)
 184   /.*/adbanners/
 185   /.*/adv((er)?ts?|ertis(ing|ements?))?/
 186   /.*/banners?/
 187   /.*/popupads/
 188   /.*/advert[0-9]+\\.jpg
 189   /ad_images/
 190   /.*/ads/
 191   /images/.*/.*_anim\\.gif
 192   /rotations/
 193   /.*(ms)?backoff(ice)?.*\\.(gif|jpe?g)
 194   195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|)
 195   .images.nytimes.com
 196   .images.yahoo.com/adv/
 197   /.*cnnstore\\.gif
 198 .fi
 199 .PP
 200 See the comments in the configuration files themselves, or the
 201 \fIuser-manual\fR
 202 for explanations of the above syntax, and other \fBPrivoxy\fR
 203 configuration options.
 204 .SH "FILES"
 205
 206 .nf
 207
 208  \fI/usr/sbin/privoxy\fR
 209  \fI/etc/privoxy/config\fR
 210  \fI/etc/privoxy/default.action\fR
 211  \fI/etc/privoxy/advanced.action\fR
 212  \fI/etc/privoxy/basic.action\fR
 213  \fI/etc/privoxy/intermediate.action\fR
 214  \fI/etc/privoxy/default.filter\fR
 215  \fI/etc/privoxy/trust\fR
 216  \fI/etc/privoxy/templates/*\fR
 217  \fI/var/log/privoxy/logfile\fR
 218 .fi
 219 .PP
 220 Various other files should be included, but may vary depending on platform
 221 and build configuration. More documentation should be included in the local
 222 documentation directory, though is not complete at this time.
 223 .SH "SIGNALS"
 224 .PP
 225 \fBPrivoxy\fR terminates on the \fBSIGINT\fR,
 226 \fBSIGTERM\fR and \fBSIGABRT\fR signals. Log
 227 rotation scripts may cause a re-opening of the logfile by sending a
 228 \fBSIGHUP\fR to \fBPrivoxy\fR. Note that unlike
 229 other daemons,  \fBPrivoxy\fR does not need to be made aware of
 230 config file changes by \fBSIGHUP\fR -- it will detect them
 231 automatically.
 232 .SH "NOTES"
 233 .PP
 234 This is a beta version of \fBPrivoxy\fR. Not
 235 all features are well tested.
 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://sourceforge.net/projects/ijbswa,
 249 the Project Page for \fBPrivoxy\fR on
 250 Sourceforge.
 251
 252 http://p.p/, access
 253 \fBPrivoxy\fR from your browser. Alternately,
 254 http://config.privoxy.org
 255 may work in some situations where the first does not.
 256
 257 http://p.p/
 258 to submit ``misses'' to the developers.
 259
 260 http://www.junkbusters.com/ht/en/cookies.html
 261
 262 http://www.waldherr.org/junkbuster/
 263
 264 http://privacy.net/analyze/
 265
 266 http://www.squid-cache.org/
 267 .SH "DEVELOPMENT TEAM"
 268
 269 .nf
 270  Jon Foster
 271  Andreas Oesterhelt
 272  Stefan Waldherr
 273  Thomas Steudten
 274  Rodney Stromlund
 275  Rodrigo Barbosa (RPM specfiles)
 276  Hal Burgiss (docs)
 277  Alexander Lazic
 278  Gábor Lipták
 279  Guy
 280  Haroon Rafique
 281  David Schmidt (OS/2, Mac OSX ports)
 282  Joerg Strohmayer
 283  Sarantis Paskalis
 284 .fi
 285 .SH "COPYRIGHT AND LICENSE"
 286 .PP
 287 \fBPrivoxy\fR is free software; you can
 288 redistribute it and/or modify it under the terms of the GNU General Public
 289 License as published by the Free Software Foundation; either version 2 of the
 290 License, or (at your option) any later version.
 291 .PP
 292 This program is distributed in the hope that it will be useful, but WITHOUT
 293 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 294 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 295 more details, which is available from the Free Software Foundation, Inc, 59
 296 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 297 .PP
 298 You should have received a copy of the GNU General Public License
 299 along with this program; if not, write to the Free Software Foundation, Inc.,
 300 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.