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 .\" Modified for privoxy-developers, 04/08/02.
   7 .TH "PRIVOXY" "1" "08 April 2002" "Privoxy 2.9.13 beta" ""
   8 .SH NAME
   9 privoxy \- Privacy Enhancing Proxy
  10 .SH SYNOPSIS
  11
  12 \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)
  13
  14
  15 \fBprivoxy.exe\fR [\fB\fIconfigfile\fB\fR] (Windows)
  16
  17 .SH "OPTIONS"
  18 .PP
  19 \fBPrivoxy\fR may be invoked with the following command line
  20 options:
  21 .TP
  22 \fB--help\fR
  23 Print brief usage info and exit.
  24 .TP
  25 \fB--version\fR
  26 Print version info and exit.
  27 .TP
  28 \fB--no-daemon\fR
  29 Don't  become  a daemon, i.e. don't fork and become process group
  30 leader, don't detach from controlling tty, and do all logging there.
  31 .TP
  32 \fB--pidfile \fIpidfile\fB\fR
  33 After (optionally) writing the PID file, assume the user  ID  of  user
  34 and the GID of group, or, if the optional group was not given, the
  35 default group  of user.  Exit if the privileges are not sufficient to
  36 do so.
  37 .TP
  38 \fB--user \fIuser[.group]\fB\fR
  39 After (optionally) writing the PID file, assume the user ID of
  40 \fIuser\fR and the GID of
  41 \fIgroup\fR, or, if the optional
  42 \fIgroup\fR was not given, the default group of
  43 \fIuser\fR. Exit if the privileges are not
  44 sufficient to do so.
  45 .PP
  46 If the \fIconfigfile\fR is not specified on  the  command  line,
  47 \fBPrivoxy\fR  will  look for a file named
  48 \fIconfig\fR in the current directory (except on Win32 where
  49 it will try \fIconfig.txt\fR). If no
  50 \fIconfigfile\fR is found, \fBPrivoxy\fR will
  51 fail to start.
  52 .SH "DESCRIPTION"
  53 .PP
  54 \fBPrivoxy\fR is a web proxy with advanced filtering
  55 capabilities for protecting privacy, filtering web page content, managing
  56 cookies, controlling access, and removing ads, banners, pop-ups and other
  57 obnoxious Internet junk. \fBPrivoxy\fR has a very
  58 flexible configuration and can be customized to suit individual needs and
  59 tastes. \fBPrivoxy\fR has application for both
  60 stand-alone systems and multi-user networks.
  61 .PP
  62 \fBPrivoxy\fR is based on the code of the
  63 \fBInternet Junkbuster\fR (tm).
  64 \fBJunkbuster\fR was originally written by Junkbusters
  65 Corporation, and was released as free open-source software under the GNU GPL.
  66 Stefan Waldherr made many improvements, and started the SourceForge project
  67 to continue development.
  68 .PP
  69 \fBPrivoxy\fR continues the
  70 \fBJunkbuster\fR tradition, but adds many
  71 refinements, enhancements and new features.
  72 .SH "INSTALLATION AND USAGE"
  73 .PP
  74 Browsers must be individually configured to use \fBPrivoxy\fR as
  75 a HTTP proxy.  The default setting is  for  localhost,  on port  8118
  76 (configurable in the main config file).  To set the HTTP proxy in Netscape
  77 and Mozilla, go through:  \fBEdit\fR;
  78 \fBPreferences\fR;  \fBAdvanced\fR;
  79 \fBProxies\fR;  \fBManual Proxy Configuration\fR;
  80 \fBView\fR.
  81 .PP
  82 For Internet Explorer, go through: \fBTools\fR;
  83 \fBInternet Properties\fR; \fBConnections\fR;
  84 \fBLAN Settings\fR.
  85 .PP
  86 The Secure (SSL) Proxy should also be set to the same values, otherwise
  87 https: URLs will not be proxied.
  88 .PP
  89 For other browsers, check the documentation.
  90 .SH "CONFIGURATION"
  91 .PP
  92 \fBPrivoxy\fR can be configured with the various configuration
  93 files. The default configuration files are: \fIconfig\fR,
  94 \fIdefault.action\fR, and
  95 \fIdefault.filter\fR. These are well commented.  On Unix and
  96 Unix-like systems, these are located in \fI/etc/privoxy/\fR by
  97 default. On Windows, OS/2 and AmigaOS, these files are in the same directory
  98 as the \fBPrivoxy\fR executable.
  99 .PP
 100 The name and number of configuration files has changed from previous
 101 versions, and is subject to change as development progresses. In fact, the
 102 configuration itself is changed  and  much more sophisticated. See the
 103 user-manual for a
 104 brief explanation of all configuration options.
 105 .PP
 106 The actions list (ad blocks, etc) can also be configured with your
 107 web browser at http://ijbswa.sourceforge.net/config.
 108 \fBPrivoxy's\fR configuration parameters  can also  be viewed at
 109 the same page. In addition, \fBPrivoxy\fR can be toggled on/off.
 110 This is an internal page.
 111 .SH "SAMPLE CONFIGURATION"
 112 .PP
 113 A brief example of what a \fIdefault.action\fR configuration
 114 might look like:
 115
 116 .nf
 117
 118  # Define a few useful custom aliases for later use
 119  {{alias}}
 120
 121  # Don't accept cookies
 122  +no-cookies = +no-cookies-set +no-cookies-read
 123
 124  # Do accept cookies
 125  -no-cookies = -no-cookies-set -no-cookies-read
 126
 127  # Treat these blocked URLs as images.
 128  +imageblock = +block +image
 129
 130  # Define page filters we want to use.
 131  myfilters = +filter{html-annoyances} +filter{js-annoyances}\\
 132              +filter{no-popups} +filter{webbugs}
 133
 134  ## Default Policies (actions) ############################
 135  { \\
 136   -block \\
 137   -downgrade \\
 138   +fast-redirects \\
 139   myfilters \\
 140   +no-compression \\
 141   +hide-forwarded \\
 142   +hide-from{block} \\
 143   +hide-referer{forge} \\
 144   -hide-user-agent \\
 145   -image \\
 146   +image-blocker{blank} \\
 147   +no-cookies-keep \\
 148   -no-cookies-read \\
 149   -no-cookies-set \\
 150   +no-popups \\
 151   -vanilla-wafer \\
 152   -wafer \\
 153  }
 154  /
 155
 156  # Now set exceptions to the above defined policies #######
 157
 158  # Sites where we want persistant cookies
 159  {-no-cookies -no-cookies-keep}
 160   .redhat.com
 161   .sun.com
 162   .yahoo.com
 163   .msdn.microsoft.com
 164
 165  # This site requires cookies AND 'fast-redirects' on
 166  {-no-cookies -no-cookies-keep -fast-redirects}
 167   .nytimes.com
 168
 169  # Add custom headers, and turn off filtering of page source
 170  {+add-header{X-Privacy: Yes please} #-add-header{*} \\
 171   +add-header{X-User-Tracking: No thanks!} -filter}
 172   privacy.net
 173
 174  # Block, and treat these URLs as 'images'.
 175  {+imageblock}
 176   .adforce.imgis.com
 177   .ad.preferences.com/image.*
 178   .ads.web.aol.com
 179   .ad-adex3.flycast.com
 180   .ad.doubleclick.net
 181   .ln.doubleclick.net
 182   .ad.de.doubleclick.net
 183   /.*/count\\.cgi\\?.*df=
 184   194.221.183.22[1-7]
 185   a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/
 186
 187  # Block any URLs that match these patterns
 188  {+block}
 189   /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\\.(gif|jpe?g))
 190   /.*/(plain|live|rotate)[-_.]?ads?/
 191   /.*/(sponsor)s?[0-9]?/
 192   /.*/ad(server|stream|juggler)\\.(cgi|pl|dll|exe)
 193   /.*/adbanners/
 194   /.*/adv((er)?ts?|ertis(ing|ements?))?/
 195   /.*/banners?/
 196   /.*/popupads/
 197   /.*/advert[0-9]+\\.jpg
 198   /ad_images/
 199   /.*/ads/
 200   /images/.*/.*_anim\\.gif
 201   /rotations/
 202   /.*(ms)?backoff(ice)?.*\\.(gif|jpe?g)
 203   195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|)
 204   .images.nytimes.com
 205   .images.yahoo.com/adv/
 206   /.*cnnstore\\.gif
 207 .fi
 208 .PP
 209 See the comments in the configuration files themselves, or the
 210 \fIuser-manual\fR
 211 for explanations of the above syntax, and other \fBPrivoxy\fR
 212 configuration options.
 213 .SH "FILES"
 214
 215 .nf
 216
 217  \fI/usr/sbin/privoxy\fR
 218  \fI/etc/privoxy/config\fR
 219  \fI/etc/privoxy/default.action\fR
 220  \fI/etc/privoxy/advanced.action\fR
 221  \fI/etc/privoxy/basic.action\fR
 222  \fI/etc/privoxy/intermediate.action\fR
 223  \fI/etc/privoxy/default.filter\fR
 224  \fI/etc/privoxy/trust\fR
 225  \fI/etc/privoxy/templates/*\fR
 226  \fI/var/log/privoxy/logfile\fR
 227 .fi
 228 .PP
 229 Various other files should be included, but may vary depending on platform
 230 and build configuration. More documentation should be included in the local
 231 documentation directory, though is not complete at this time.
 232 .SH "SIGNALS"
 233 .PP
 234 \fBPrivoxy\fR terminates on the \fBSIGINT\fR,
 235 \fBSIGTERM\fR and \fBSIGABRT\fR signals. Log
 236 rotation scripts may cause a re-opening of the logfile by sending a
 237 \fBSIGHUP\fR to \fBPrivoxy\fR. Note that unlike
 238 other daemons,  \fBPrivoxy\fR does not need to be made aware of
 239 config file changes by \fBSIGHUP\fR -- it will detect them
 240 automatically.
 241 .SH "NOTES"
 242 .PP
 243 This is a beta version of \fBPrivoxy\fR. Not
 244 all features are well tested.
 245 .PP
 246 Please see the \fIuser-manual\fR on how to contact the
 247 developers for feature requests, reporting problems, and other questions.
 248 .SH "SEE ALSO"
 249 .PP
 250 Other references and sites of interest to \fBPrivoxy\fR
 251 users:
 252 .PP
 253
 254 http://www.privoxy.org/,
 255 The \fBPrivoxy\fR Home page.
 256
 257 http://sourceforge.net/projects/ijbswa,
 258 the Project Page for \fBPrivoxy\fR on
 259 Sourceforge.
 260
 261 http://p.p/, access
 262 \fBPrivoxy\fR from your browser. Alternately,
 263 http://config.privoxy.org
 264 may work in some situations where the first does not.
 265
 266 http://www.junkbusters.com/ht/en/cookies.html
 267
 268 http://www.waldherr.org/junkbuster/
 269
 270 http://privacy.net/analyze/
 271
 272 http://www.squid-cache.org/
 273 .SH "DEVELOPMENT TEAM"
 274
 275 .nf
 276  Stefan Waldherr
 277  Andreas Oesterhelt
 278  Jon Foster
 279  Markus Breitenbach
 280  Thomas Steudten
 281  David Schmidt (OS/2, Mac OSX ports)
 282  Gabriel L. Somlo
 283  Hal Burgiss (docs)
 284  Haroon Rafique
 285  John Venvertloh
 286  Joerg Strohmayer
 287  Rodney Stromlund
 288  Rodrigo Barbosa (RPM specfiles)
 289  Sarantis Paskalis
 290  Shamim Mohamed
 291  Gábor Lipták
 292  Alexander Lazic
 293 .fi
 294 .SH "COPYRIGHT AND LICENSE"
 295 .PP
 296 \fBPrivoxy\fR is free software; you can
 297 redistribute it and/or modify it under the terms of the GNU General Public
 298 License as published by the Free Software Foundation; either version 2 of the
 299 License, or (at your option) any later version.
 300 .PP
 301 This program is distributed in the hope that it will be useful, but WITHOUT
 302 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 303 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 304 more details, which is available from the Free Software Foundation, Inc, 59
 305 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 306 .PP
 307 You should have received a copy of the GNU General Public License
 308 along with this program; if not, write to the Free Software Foundation, Inc.,
 309 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.