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