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" "13 November 2006" "Privoxy 3.0.6" ""
   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 ]
  12
  13 .SH "OPTIONS"
  14 .PP
  15 \fBPrivoxy\fR may be invoked with the following command line
  16 options:
  17 .TP
  18 \fB--help\fR
  19 Print brief usage info and exit.
  20 .TP
  21 \fB--version\fR
  22 Print version info and exit.
  23 .TP
  24 \fB--no-daemon\fR
  25 Don't  become  a daemon, i.e. don't fork and become process group
  26 leader, don't detach from controlling tty, and do all logging there.
  27 .TP
  28 \fB--pidfile \fIpidfile\fB\fR
  29 On startup, write the process ID to \fIpidfile\fR.
  30 Delete the \fIpidfile\fR on exit.
  31 Failure to create or delete the \fIpidfile\fR
  32 is non-fatal. If no \fB--pidfile\fR option is given, no PID file will be used.
  33 .TP
  34 \fB--user \fIuser[.group]\fB\fR
  35 After (optionally) writing the PID file, assume the user ID of
  36 \fIuser\fR and the GID of
  37 \fIgroup\fR, or, if the optional
  38 \fIgroup\fR was not given, the default group of
  39 \fIuser\fR. Exit if the privileges are not
  40 sufficient to do so.
  41 .TP
  42 \fB--chroot\fR
  43 Before changing to the user ID given in the --user option, chroot to
  44 that user's home directory, i.e. make the kernel pretend to the
  45 \fBPrivoxy\fR process that the directory tree starts
  46 there. If set up carefully, this can limit the impact of possible
  47 vulnerabilities in \fBPrivoxy\fR to the files contained in
  48 that hierarchy.
  49 .PP
  50 If the \fIconfigfile\fR is not specified on  the  command  line,
  51 \fBPrivoxy\fR  will  look for a file named
  52 \fIconfig\fR in the current directory . If no
  53 \fIconfigfile\fR is found, \fBPrivoxy\fR will
  54 fail to start.
  55 .SH "DESCRIPTION"
  56 .PP
  57 Privoxy is a
  58 web proxy
  59 with advanced filtering capabilities for protecting
  60 privacy, modifying web page data, managing
  61 cookies,
  62 controlling access, and removing ads, banners, pop-ups and other obnoxious
  63 Internet junk. Privoxy has a very flexible configuration and can be
  64 customized to suit individual needs and tastes. Privoxy has application for
  65 both stand-alone systems and multi-user networks.
  66 .PP
  67 Privoxy is based on Internet Junkbuster (tm).
  68 .SH "INSTALLATION AND USAGE"
  69 .PP
  70 Browsers must be individually configured to use \fBPrivoxy\fR as
  71 a HTTP proxy.  The default setting is  for  localhost,  on port  8118
  72 (configurable in the main config file).  To set the HTTP proxy in Netscape
  73 and Mozilla, go through:  \fBEdit\fR;
  74 \fBPreferences\fR;  \fBAdvanced\fR;
  75 \fBProxies\fR;  \fBManual Proxy Configuration\fR;
  76 \fBView\fR.
  77 .PP
  78 For Firefox, go through: \fBTools\fR;
  79 \fBOptions\fR; \fBGeneral\fR;
  80 \fBConnection Settings\fR;
  81 \fBManual Proxy Configuration\fR.
  82 .PP
  83 For Internet Explorer, go through: \fBTools\fR;
  84 \fBInternet Properties\fR; \fBConnections\fR;
  85 \fBLAN Settings\fR.
  86 .PP
  87 The Secure (SSL) Proxy should also be set to the same values, otherwise
  88 https: URLs will not be proxied. Note: \fBPrivoxy\fR can only
  89 proxy HTTP and HTTPS traffic. Do not try it with FTP or other protocols.
  90 HTTPS presents some limitations, and not all features will work with HTTPS
  91 connections.
  92 .PP
  93 For other browsers, check the documentation.
  94 .SH "CONFIGURATION"
  95 .PP
  96 \fBPrivoxy\fR can be configured with the various configuration
  97 files. The default configuration files are: \fIconfig\fR,
  98 \fIdefault.filter\fR, and
  99 \fIdefault.action\fR. \fIuser.action\fR should
 100 be used for locally defined exceptions to the default rules of
 101 \fIdefault.action\fR, and \fIuser.filter\fR for
 102 locally defined filters. These are well commented.  On Unix
 103 and Unix-like systems, these are located in
 104 \fI/etc/privoxy/\fR by default.
 105 .PP
 106 \fBPrivoxy\fR uses the concept of \fBactions\fR
 107 in order to manipulate the data stream between the browser and remote sites.
 108 There are various actions available with specific functions for such things
 109 as blocking web sites, managing cookies, etc. These actions can be invoked
 110 individually or combined, and used against individual URLs, or groups of URLs
 111 that can be defined using wildcards and regular expressions. The result is
 112 that the user has greatly enhanced control and freedom.
 113 .PP
 114 The actions list (ad blocks, etc) can also be configured with your
 115 web browser at http://config.privoxy.org/.
 116 \fBPrivoxy's\fR configuration parameters  can also  be viewed at
 117 the same page. In addition, \fBPrivoxy\fR can be toggled on/off.
 118 This is an internal page, and does not require Internet access.
 119 .PP
 120 See the \fIUser Manual\fR for a detailed
 121 explanation of installation, general usage, all configuration options, new
 122 features and notes on upgrading.
 123 .SH "SAMPLE CONFIGURATION"
 124 .PP
 125 A brief example of what a simple \fIdefault.action\fR
 126 configuration might look like:
 127
 128 .nf
 129  # Define a few useful custom aliases for later use
 130  {{alias}}
 131
 132  # Useful aliases that combine more than one action
 133  +crunch-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
 134  -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
 135  +block-as-image = +block +handle-as-image
 136
 137  # Fragile sites should have the minimum changes
 138  fragile     = -block -deanimate-gifs -fast-redirects -filter \\
 139                -hide-referer -prevent-cookies -kill-popups
 140
 141  ## Turn some actions on ################################
 142  ## NOTE: Actions are off by default, unless explictily turned on
 143  ## otherwise with the '+' operator.
 144
 145 { \\
 146 -add-header \\
 147 -block \\
 148 -content-type-overwrite \\
 149 -crunch-client-header \\
 150 -crunch-if-none-match \\
 151 -crunch-outgoing-cookies \\
 152 -crunch-incoming-cookies \\
 153 -crunch-server-header \\
 154 +deanimate-gifs{last} \\
 155 -downgrade-http-version \\
 156 -fast-redirects \\
 157 -filter{js-annoyances} \\
 158 -filter{js-events} \\
 159 -filter{html-annoyances} \\
 160 -filter{content-cookies} \\
 161 +filter{refresh-tags} \\
 162 -filter{unsolicited-popups} \\
 163 -filter{all-popups} \\
 164 -filter{img-reorder} \\
 165 -filter{banners-by-size} \\
 166 -filter{banners-by-link} \\
 167 +filter{webbugs} \\
 168 -filter{tiny-textforms} \\
 169 +filter{jumping-windows} \\
 170 -filter{frameset-borders} \\
 171 -filter{demoronizer} \\
 172 -filter{shockwave-flash} \\
 173 -filter{quicktime-kioskmode} \\
 174 -filter{fun} \\
 175 -filter{crude-parental} \\
 176 +filter{ie-exploits} \\
 177 -filter{site-specifics} \\
 178 -filter{google} \\
 179 -filter{yahoo} \\
 180 -filter{msn} \\
 181 -filter{blogspot} \\
 182 -filter{xml-to-html} \\
 183 -filter{html-to-xml} \\
 184 -filter{no-ping} \\
 185 -filter{hide-tor-exit-notation} \\
 186 -filter-client-headers \\
 187 -filter-server-headers \\
 188 -force-text-mode \\
 189 -handle-as-empty-document
 190 -handle-as-image \\
 191 -hide-accept-language \\
 192 -hide-content-disposition \\
 193 -hide-if-modified-since \\
 194 +hide-forwarded-for-headers \\
 195 +hide-from-header{block} \\
 196 +hide-referrer{forge} \\
 197 -hide-user-agent \\
 198 -inspect-jpegs \\
 199 -kill-popups \\
 200 -limit-connect \\
 201 -overwrite-last-modified \\
 202 -redirect \\
 203 +prevent-compression \\
 204 -send-vanilla-wafer \\
 205 -send-wafer \\
 206 +session-cookies-only \\
 207 +set-image-blocker{pattern} \\
 208 -treat-forbidden-connects-like-blocks \\
 209 }
 210 / # '/' Match *all* URL patterns
 211
 212
 213  # Block all URLs that match these patterns
 214  { +block }
 215   ad.
 216   ad[sv].
 217   .*ads.
 218   banner?.
 219   /.*count(er)?\\.(pl|cgi|exe|dll|asp|php[34]?)
 220   .hitbox.com
 221   media./.*(ads|banner)
 222
 223  # Block, and treat these URL patterns as if they were 'images'.
 224  # We would expect these to be ads.
 225  { +block-as-image }
 226   .ad.doubleclick.net
 227   .a[0-9].yimg.com/(?:(?!/i/).)*$
 228   ad.*.doubleclick.net
 229
 230  # Make exceptions for these harmless ones that would be
 231  # caught by our +block patterns just above.
 232  { -block }
 233   adsl.
 234   adobe.
 235   advice.
 236   .*downloads.
 237   # uploads or downloads
 238   /.*loads
 239 .fi
 240 .PP
 241 Then for a \fIuser.action\fR, we would put local,
 242 narrowly defined exceptions:
 243
 244 .nf
 245  # Re-define aliases as needed here
 246  {{alias}}
 247
 248  # Useful aliases
 249  -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
 250
 251  # Set personal exceptions to the policies in default.action #######
 252
 253  # Sites where we want persistent cookies, so allow *all* cookies
 254  { -crunch-cookies -session-cookies-only }
 255   .redhat.com
 256   .sun.com
 257   .msdn.microsoft.com
 258
 259  # These sites breaks easily. Use our "fragile" alias here.
 260  { fragile }
 261   .forbes.com
 262   mybank.example.com
 263
 264  # Replace example.com's style sheet with one of my choosing
 265  { +redirect{http://localhost/css-replacements/example.com.css} }
 266   example.com/stylesheet.css
 267 .fi
 268 .PP
 269 See the comments in the configuration files themselves, or the
 270 \fIUser Manual\fR
 271 for full explanations of the above syntax, and other \fBPrivoxy\fR
 272 configuration options.
 273 .SH "FILES"
 274
 275 .nf
 276
 277  \fI/usr/sbin/privoxy\fR
 278  \fI/etc/privoxy/config\fR
 279  \fI/etc/privoxy/default.action\fR
 280  \fI/etc/privoxy/standard.action\fR
 281  \fI/etc/privoxy/user.action\fR
 282  \fI/etc/privoxy/default.filter\fR
 283  \fI/etc/privoxy/user.filter\fR
 284  \fI/etc/privoxy/trust\fR
 285  \fI/etc/privoxy/templates/*\fR
 286  \fI/var/log/privoxy/logfile\fR
 287 .fi
 288 .PP
 289 Various other files should be included, but may vary depending on platform
 290 and build configuration. Additional documentation should be included in the local
 291 documentation directory.
 292 .SH "SIGNALS"
 293 .PP
 294 \fBPrivoxy\fR terminates on the \fBSIGINT\fR,
 295 \fBSIGTERM\fR and \fBSIGABRT\fR signals. Log
 296 rotation scripts may cause a re-opening of the logfile by sending a
 297 \fBSIGHUP\fR to \fBPrivoxy\fR. Note that unlike
 298 other daemons,  \fBPrivoxy\fR does not need to be made aware of
 299 config file changes by \fBSIGHUP\fR -- it will detect them
 300 automatically.
 301 .SH "NOTES"
 302 .PP
 303 Please see the \fIUser Manual\fR on how to contact the
 304 developers, for feature requests, reporting problems, and other questions.
 305 .SH "SEE ALSO"
 306 .PP
 307 Other references and sites of interest to \fBPrivoxy\fR
 308 users:
 309 .PP
 310
 311 http://www.privoxy.org/,
 312 the \fBPrivoxy\fR Home page.
 313
 314 http://www.privoxy.org/faq/,
 315 the \fBPrivoxy\fR FAQ.
 316
 317 http://sourceforge.net/projects/ijbswa/,
 318 the Project Page for \fBPrivoxy\fR on
 319 SourceForge.
 320
 321 http://config.privoxy.org/,
 322 the web-based user interface. \fBPrivoxy\fR must be
 323 running for this to work. Shortcut: http://p.p/
 324
 325 http://sourceforge.net/tracker/?group_id=11118&atid=460288, to submit ``misses'' and other
 326 configuration related suggestions to the developers.
 327
 328 http://www.junkbusters.com/ht/en/cookies.html,
 329 an explanation how cookies are used to track web users.
 330
 331 http://www.junkbusters.com/ijb.html,
 332 the original Internet Junkbuster.
 333
 334 http://privacy.net/, a useful site
 335 to check what information about you is leaked while you browse the web.
 336
 337 http://www.squid-cache.org/, a very popular
 338 caching proxy, which is often used together with \fBPrivoxy\fR.
 339
 340 http://tor.eff.org/,
 341 \fBTor\fR can help anonymize web browsing,
 342 web publishing, instant messaging, IRC, SSH, and other applications.
 343
 344 http://www.privoxy.org/developer-manual/,
 345 the \fBPrivoxy\fR developer manual.
 346 .SH "DEVELOPMENT TEAM"
 347
 348 .nf
 349  Fabian Keil, developer
 350  David Schmidt, developer
 351
 352  Hal Burgiss
 353  Ian Cummings
 354  Roland Rosenfeld
 355 .fi
 356 .SH "COPYRIGHT AND LICENSE"
 357 .SS "COPYRIGHT"
 358 .PP
 359 Copyright (C) 2001 - 2006 by Privoxy Developers <ijbswa-developers@lists.sourceforge.net>
 360 .PP
 361 Some source code is based on code Copyright (C) 1997 by Anonymous Coders
 362 and Junkbusters, Inc. and licensed under the \fIGNU General Public
 363 License\fR.
 364 .SS "LICENSE"
 365 .PP
 366 \fBPrivoxy\fR is free software; you can
 367 redistribute it and/or modify it under the terms of the
 368 \fIGNU General Public
 369 License\fR, version 2, as published by the Free Software Foundation.
 370 .PP
 371 This program is distributed in the hope that it will be useful, but WITHOUT
 372 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 373 FITNESS FOR A PARTICULAR PURPOSE.  See the
 374 \fIGNU General Public License\fR for
 375 more details, which is available from the Free Software Foundation, Inc,
 376 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 377 .PP
 378 You should have received a copy of the  \fIGNU General Public License\fR
 379 along with this program; if not, write to the  Free Software
 380 Foundation, Inc. 51 Franklin Street, Fifth Floor
 381 Boston, MA 02110-1301
 382 USA