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