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" "01 September 2006" "Privoxy 3.0.4 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--chroot\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 Failure 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 .TP
  45 \fB--chroot\fR
  46 Before changing to the user ID given in the --user option, chroot to
  47 that user's home directory, i.e. make the kernel pretend to the
  48 \fBPrivoxy\fR process that the directory tree starts
  49 there. If set up carefully, this can limit the impact of possible
  50 vulnerabilities in \fBPrivoxy\fR to the files contained in
  51 that hierarchy.
  52 .PP
  53 If the \fIconfigfile\fR is not specified on  the  command  line,
  54 \fBPrivoxy\fR  will  look for a file named
  55 \fIconfig\fR in the current directory (except on Win32 where
  56 it will try \fIconfig.txt\fR). If no
  57 \fIconfigfile\fR is found, \fBPrivoxy\fR will
  58 fail to start.
  59 .SH "DESCRIPTION"
  60 .PP
  61 \fBPrivoxy\fR is a web proxy with advanced filtering
  62 capabilities for protecting privacy, modifying web page data, managing
  63 cookies, controlling access, and removing ads, banners, pop-ups and other
  64 obnoxious Internet junk. \fBPrivoxy\fR has a very
  65 flexible configuration and can be customized to suit individual needs and
  66 tastes. \fBPrivoxy\fR has application for both
  67 stand-alone systems and multi-user networks.
  68 .PP
  69 \fBPrivoxy\fR is based on \fBInternet
  70 Junkbuster\fR (tm).
  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. Note: \fBPrivoxy\fR can only
  87 proxy HTTP and HTTPS traffic. Do not try it with FTP or other protocols.
  88 HTTPS presents some limitations, and not all features will work with HTTPS
  89 connections.
  90 .PP
  91 For other browsers, check the documentation.
  92 .SH "CONFIGURATION"
  93 .PP
  94 \fBPrivoxy\fR can be configured with the various configuration
  95 files. The default configuration files are: \fIconfig\fR,
  96 \fIdefault.filter\fR, and
  97 \fIdefault.action\fR. \fIuser.action\fR should
  98 be used for locally defined exceptions to the default rules of
  99 \fIdefault.action\fR, and \fIuser.filter\fR for
 100 locally defined filters. These are well commented.  On Unix
 101 and Unix-like systems, these are located in
 102 \fI/etc/privoxy/\fR by default. On Windows, OS/2 and AmigaOS,
 103 these files are in the same directory as the \fBPrivoxy\fR
 104 executable.
 105 .PP
 106 See the user-manual for a complete
 107 explanation of installation, general usage, all configuration options, new
 108 features and notes on upgrading.
 109 .PP
 110 The actions list (ad blocks, etc) can also be configured with your
 111 web browser at http://config.privoxy.org/.
 112 \fBPrivoxy's\fR configuration parameters  can also  be viewed at
 113 the same page. In addition, \fBPrivoxy\fR can be toggled on/off.
 114 This is an internal page, and does not require Internet access.
 115 .SH "SAMPLE CONFIGURATION"
 116 .PP
 117 A brief example of what a simple \fIdefault.action\fR
 118 configuration might look like:
 119
 120 .nf
 121  # Define a few useful custom aliases for later use
 122  {{alias}}
 123
 124  # Useful aliases
 125  +crunch-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
 126  -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
 127  +imageblock      = +block +handle-as-image
 128
 129  # Fragile sites should have the minimum changes
 130  fragile     = -block -deanimate-gifs -fast-redirects -filter \\
 131                -hide-referer -prevent-cookies -kill-popups
 132
 133  ## Turn some actions on ################################
 134  ## NOTE: Actions are off by default, unless explictily turned on
 135  ## otherwise.
 136
 137 { \\
 138 -add-header \\
 139 -block \\
 140 -content-type-overwrite \\
 141 -crunch-client-header \\
 142 -crunch-if-none-match \\
 143 -crunch-outgoing-cookies \\
 144 -crunch-incoming-cookies \\
 145 -crunch-server-header \\
 146 +deanimate-gifs{last} \\
 147 -downgrade-http-version \\
 148 -fast-redirects \\
 149 +filter{js-annoyances} \\
 150 -filter{js-events} \\
 151 +filter{html-annoyances} \\
 152 -filter{content-cookies} \\
 153 +filter{refresh-tags} \\
 154 +filter{unsolicited-popups} \\
 155 -filter{all-popups} \\
 156 +filter{img-reorder} \\
 157 +filter{banners-by-size} \\
 158 -filter{banners-by-link} \\
 159 +filter{webbugs} \\
 160 -filter{tiny-textforms} \\
 161 +filter{jumping-windows} \\
 162 -filter{frameset-borders} \\
 163 -filter{demoronizer} \\
 164 -filter{shockwave-flash} \\
 165 -filter{quicktime-kioskmode} \\
 166 -filter{fun} \\
 167 -filter{crude-parental} \\
 168 +filter{ie-exploits} \\
 169 -filter{site-specifics} \\
 170 -filter-client-headers \\
 171 -filter-server-headers \\
 172 -force-text-mode \\
 173 -handle-as-empty-document
 174 -handle-as-image \\
 175 -hide-accept-language \\
 176 -hide-content-disposition \\
 177 -hide-if-modified-since \\
 178 +hide-forwarded-for-headers \\
 179 +hide-from-header{block} \\
 180 +hide-referrer{forge} \\
 181 -hide-user-agent \\
 182 -inspect-jpegs \\
 183 -kill-popups \\
 184 -limit-connect \\
 185 -overwrite-last-modified \\
 186 -redirect \\
 187 +prevent-compression \\
 188 -send-vanilla-wafer \\
 189 -send-wafer \\
 190 +session-cookies-only \\
 191 +set-image-blocker{pattern} \\
 192 -treat-forbidden-connects-like-blocks \\
 193 }
 194 / # '/' Match *all* URL patterns
 195
 196
 197
 198  # Block, and treat these URL patterns as if they were 'images'.
 199  # We would expect these to be ads.
 200  {+imageblock}
 201   .ad.doubleclick.net
 202   .a[0-9].yimg.com/(?:(?!/i/).)*$
 203   ad.*.doubleclick.net
 204
 205  # Block any URLs that match these patterns
 206  {+block}
 207   ad*.
 208   .*ads.
 209   banner?.
 210   /.*count(er)?\\.(pl|cgi|exe|dll|asp|php[34]?)
 211   .hitbox.com
 212
 213  # Make exceptions for these harmless ones that would be
 214  # caught by our +block patterns just above.
 215  {-block}
 216   adsl.
 217   advice.
 218   .*downloads.
 219 .fi
 220 .PP
 221 Then for a \fIuser.action\fR, we would put local,
 222 narrowly defined exceptions:
 223
 224 .nf
 225  # Re-define aliases as needed here
 226  {{alias}}
 227
 228  # Useful aliases
 229  -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
 230
 231  # Set personal exceptions to the policies in default.action #######
 232
 233  # Sites where we want persistant cookies, so allow *all* cookies
 234  {-crunch-cookies -session-cookies-only}
 235   .redhat.com
 236   .sun.com
 237   .msdn.microsoft.com
 238
 239  # This site breaks easily.
 240  {-block -fast-redirects}
 241   .forbes.com
 242 .fi
 243 .PP
 244 See the comments in the configuration files themselves, or the
 245 \fIuser-manual\fR
 246 for explanations of the above syntax, and other \fBPrivoxy\fR
 247 configuration options.
 248 .SH "FILES"
 249
 250 .nf
 251
 252  \fI/usr/sbin/privoxy\fR
 253  \fI/etc/privoxy/config\fR
 254  \fI/etc/privoxy/default.action\fR
 255  \fI/etc/privoxy/standard.action\fR
 256  \fI/etc/privoxy/user.action\fR
 257  \fI/etc/privoxy/default.filter\fR
 258  \fI/etc/privoxy/user.filter\fR
 259  \fI/etc/privoxy/trust\fR
 260  \fI/etc/privoxy/templates/*\fR
 261  \fI/var/log/privoxy/logfile\fR
 262 .fi
 263 .PP
 264 Various other files should be included, but may vary depending on platform
 265 and build configuration. Additional documentation should be included in the local
 266 documentation directory.
 267 .SH "SIGNALS"
 268 .PP
 269 \fBPrivoxy\fR terminates on the \fBSIGINT\fR,
 270 \fBSIGTERM\fR and \fBSIGABRT\fR signals. Log
 271 rotation scripts may cause a re-opening of the logfile by sending a
 272 \fBSIGHUP\fR to \fBPrivoxy\fR. Note that unlike
 273 other daemons,  \fBPrivoxy\fR does not need to be made aware of
 274 config file changes by \fBSIGHUP\fR -- it will detect them
 275 automatically.
 276 .SH "NOTES"
 277 .PP
 278 This is a beta version of \fBPrivoxy\fR. Not
 279 all features are well tested.
 280 .PP
 281 Please see the \fIUser Manual\fR on how to contact the
 282 developers, for feature requests, reporting problems, and other questions.
 283 .SH "SEE ALSO"
 284 .PP
 285 Other references and sites of interest to \fBPrivoxy\fR
 286 users:
 287 .PP
 288
 289 http://www.privoxy.org/,
 290 the \fBPrivoxy\fR Home page.
 291
 292 http://www.privoxy.org/faq/,
 293 the \fBPrivoxy\fR FAQ.
 294
 295 http://sourceforge.net/projects/ijbswa/,
 296 the Project Page for \fBPrivoxy\fR on
 297 SourceForge.
 298
 299 http://config.privoxy.org/,
 300 the web-based user interface. \fBPrivoxy\fR must be
 301 running for this to work. Shortcut: http://p.p/
 302
 303 http://www.privoxy.org/actions/, to submit ``misses'' to the developers.
 304
 305 http://www.junkbusters.com/ht/en/cookies.html,
 306 an explanation how cookies are used to track web users.
 307
 308 http://www.junkbusters.com/ijb.html,
 309 the original Internet Junkbuster.
 310
 311 http://privacy.net/analyze/, a useful site
 312 to check what information about you is leaked while you browse the web.
 313
 314 http://www.squid-cache.org/, a very popular
 315 caching proxy, which is often used together with \fBPrivoxy\fR.
 316
 317 http://www.privoxy.org/developer-manual/,
 318 the \fBPrivoxy\fR developer manual.
 319 .SH "DEVELOPMENT TEAM"
 320
 321 .nf
 322  Fabian Keil
 323  David Schmidt
 324
 325
 326  Johny Agotnes
 327  Moritz Barsnick
 328  Hal Burgiss
 329  Mattes Dolak
 330  Roland Rosenfeld
 331 .fi
 332 .SH "COPYRIGHT AND LICENSE"
 333 .SS "COPYRIGHT"
 334 .PP
 335 Copyright (C) 2001 - 2006 by Privoxy Developers <ijbswa-developers@lists.sourceforge.net>
 336 .PP
 337 Some source code is based on code Copyright (C) 1997 by Anonymous Coders
 338 and Junkbusters, Inc. and licensed under the \fIGNU General Public
 339 License\fR.
 340 .SS "LICENSE"
 341 .PP
 342 \fBPrivoxy\fR is free software; you can
 343 redistribute it and/or modify it under the terms of the
 344 \fIGNU General Public
 345 License\fR, version 2, as published by the Free Software Foundation.
 346 .PP
 347 This program is distributed in the hope that it will be useful, but WITHOUT
 348 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 349 FITNESS FOR A PARTICULAR PURPOSE.  See the
 350 \fIGNU General Public License\fR for
 351 more details, which is available from the Free Software Foundation, Inc, 59
 352 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 353 .PP
 354 You should have received a copy of the  \fIGNU General Public License\fR
 355 along with this program; if not, write to the  Free Software
 356 Foundation, Inc. 59 Temple Place - Suite 330
 357 Boston, MA 02111-1307
 358 USA