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" "02 March 2013" "Privoxy 3.0.21" ""
   7 .SH NAME
   8 privoxy \- Privacy Enhancing Proxy
   9 .SH SYNOPSIS
  10
  11 \fBprivoxy\fR [\fB\-\-chroot\fR ] [\fB\-\-config-test\fR ] [\fB\-\-help\fR ] [\fB\-\-no-daemon\fR ] [\fB\-\-pidfile \fIpidfile\fB\fR ] [\fB\-\-pre-chroot-nslookup \fIhostname\fB\fR ] [\fB\-\-user \fIuser[.group]\fB\fR ] [\fB\-\-version\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\-\-chroot\fR
  19 Before changing to the user ID given in the \-\-user option, chroot to
  20 that user's home directory, i.e. make the kernel pretend to the
  21 \fBPrivoxy\fR process that the directory tree starts
  22 there. If set up carefully, this can limit the impact of possible
  23 vulnerabilities in \fBPrivoxy\fR to the files contained in
  24 that hierarchy.
  25 .TP
  26 \fB\-\-config-test\fR
  27 Exit after loading the configuration files before binding to
  28 the listen address. The exit code signals whether or not the
  29 configuration files have been successfully loaded.
  30
  31 If the exit code is 1, at least one of the configuration files
  32 is invalid, if it is 0, all the configuration files have been
  33 successfully loaded (but may still contain errors that can
  34 currently only be detected at run time).
  35
  36 This option doesn't affect the log setting, combination with
  37 "--no-daemon" is recommended if a configured log file shouldn't
  38 be used.
  39 .TP
  40 \fB\-\-help\fR
  41 Print brief usage info and exit.
  42 .TP
  43 \fB\-\-no-daemon\fR
  44 Don't  become  a daemon, i.e. don't fork and become process group
  45 leader, don't detach from controlling tty, and do all logging there.
  46 .TP
  47 \fB\-\-pidfile \fIpidfile\fB\fR
  48 On startup, write the process ID to \fIpidfile\fR.
  49 Delete the \fIpidfile\fR on exit.
  50 Failure to create or delete the \fIpidfile\fR
  51 is non-fatal. If no \fB\-\-pidfile\fR option is given, no PID file will be used.
  52 .TP
  53 \fB\-\-pre-chroot-nslookup \fIhostname\fB\fR
  54 Initialize the resolver library using \fIhostname\fR
  55 before chroot'ing. On some systems this reduces the number of files
  56 that must be copied into the chroot tree.
  57 .TP
  58 \fB\-\-user \fIuser[.group]\fB\fR
  59 After (optionally) writing the PID file, assume the user ID of
  60 \fIuser\fR and the GID of
  61 \fIgroup\fR, or, if the optional
  62 \fIgroup\fR was not given, the default group of
  63 \fIuser\fR. Exit if the privileges are not
  64 sufficient to do so.
  65 .TP
  66 \fB\-\-version\fR
  67 Print version info and exit.
  68 .PP
  69 If the \fIconfigfile\fR is not specified on  the  command  line,
  70 \fBPrivoxy\fR  will  look for a file named
  71 \fIconfig\fR in the current directory. If no
  72 \fIconfigfile\fR is found, \fBPrivoxy\fR will
  73 fail to start.
  74 .SH "DESCRIPTION"
  75 .PP
  76 Privoxy is a non-caching web proxy with advanced filtering capabilities
  77 for enhancing privacy, modifying web page data and HTTP headers, controlling
  78 access, and removing ads and other obnoxious Internet junk. Privoxy has a
  79 flexible configuration and can be customized to suit individual needs and tastes.
  80 It has application for both stand-alone systems and multi-user networks.
  81 .PP
  82 Privoxy is Free Software and licensed under the GNU GPLv2.
  83 .PP
  84 Privoxy is an associated project of Software in the Public Interest (SPI).
  85 .PP
  86 Helping hands and donations are welcome:
  87 .TP 0.2i
  88 \(bu
  89 http://www.privoxy.org/faq/general.html#PARTICIPATE
  90 .TP 0.2i
  91 \(bu
  92 http://www.privoxy.org/faq/general.html#DONATE
  93 .SH "INSTALLATION AND USAGE"
  94 .PP
  95 Browsers can either be individually configured to use
  96 \fBPrivoxy\fR as a HTTP proxy (recommended),
  97 or \fBPrivoxy\fR can be combined with a packet
  98 filter to build an intercepting proxy
  99 (see \fIconfig\fR).  The default setting is  for
 100 localhost,  on port  8118 (configurable in the main config file).  To set the
 101 HTTP proxy in Firefox, go through: \fBTools\fR;
 102 \fBOptions\fR; \fBGeneral\fR;
 103 \fBConnection Settings\fR;
 104 \fBManual Proxy Configuration\fR.
 105 .PP
 106 For Internet Explorer, go through: \fBTools\fR;
 107 \fBInternet Properties\fR; \fBConnections\fR;
 108 \fBLAN Settings\fR.
 109 .PP
 110 The Secure (SSL) Proxy should also be set to the same values, otherwise
 111 https: URLs will not be proxied. Note: \fBPrivoxy\fR can only
 112 proxy HTTP and HTTPS traffic. Do not try it with FTP or other protocols.
 113 HTTPS presents some limitations, and not all features will work with HTTPS
 114 connections.
 115 .PP
 116 For other browsers, check the documentation.
 117 .SH "CONFIGURATION"
 118 .PP
 119 \fBPrivoxy\fR can be configured with the various configuration
 120 files. The default configuration files are: \fIconfig\fR,
 121 \fIdefault.filter\fR, \fIdefault.action\fR and
 122 \fIdefault.action\fR. \fIuser.action\fR should
 123 be used for locally defined exceptions to the default rules in
 124 \fImatch-all.action\fR and \fIdefault.action\fR,
 125 and \fIuser.filter\fR for locally defined filters. These are
 126 well commented.  On Unix and Unix-like systems, these are located in
 127 \fI/etc/privoxy/\fR by default.
 128 .PP
 129 \fBPrivoxy\fR uses the concept of \fBactions\fR
 130 in order to manipulate the data stream between the browser and remote sites.
 131 There are various actions available with specific functions for such things
 132 as blocking web sites, managing cookies, etc. These actions can be invoked
 133 individually or combined, and used against individual URLs, or groups of URLs
 134 that can be defined using wildcards and regular expressions. The result is
 135 that the user has greatly enhanced control and freedom.
 136 .PP
 137 The actions list (ad blocks, etc) can also be configured with your
 138 web browser at http://config.privoxy.org/
 139 (assuming the configuration allows it).
 140 \fBPrivoxy's\fR configuration parameters  can also  be viewed at
 141 the same page. In addition, \fBPrivoxy\fR can be toggled on/off.
 142 This is an internal page, and does not require Internet access.
 143 .PP
 144 See the \fIUser Manual\fR for a detailed
 145 explanation of installation, general usage, all configuration options, new
 146 features and notes on upgrading.
 147 .SH "FILES"
 148
 149 .nf
 150  \fI/usr/sbin/privoxy\fR
 151  \fI/etc/privoxy/config\fR
 152  \fI/etc/privoxy/match-all.action\fR
 153  \fI/etc/privoxy/default.action\fR
 154  \fI/etc/privoxy/user.action\fR
 155  \fI/etc/privoxy/default.filter\fR
 156  \fI/etc/privoxy/user.filter\fR
 157  \fI/etc/privoxy/trust\fR
 158  \fI/etc/privoxy/templates/*\fR
 159  \fI/var/log/privoxy/logfile\fR
 160 .fi
 161 .PP
 162 Various other files should be included, but may vary depending on platform
 163 and build configuration. Additional documentation should be included in the local
 164 documentation directory.
 165 .SH "SIGNALS"
 166 .PP
 167 \fBPrivoxy\fR terminates on the \fBSIGINT\fR
 168 and \fBSIGTERM\fR signals. Log
 169 rotation scripts may cause a re-opening of the logfile by sending a
 170 \fBSIGHUP\fR to \fBPrivoxy\fR. Note that unlike
 171 other daemons,  \fBPrivoxy\fR does not need to be made aware of
 172 config file changes by \fBSIGHUP\fR -- it will detect them
 173 automatically. Signals other than the ones listed above aren't explicitly
 174 handled and result in the default action defined by the operating system.
 175 .SH "NOTES"
 176 .PP
 177 Please see the \fIUser Manual\fR on how to contact the
 178 developers, for feature requests, reporting problems, and other questions.
 179 .SH "SEE ALSO"
 180 .PP
 181 Other references and sites of interest to \fBPrivoxy\fR
 182 users:
 183 .PP
 184
 185 http://www.privoxy.org/,
 186 the \fBPrivoxy\fR Home page.
 187
 188 http://www.privoxy.org/faq/,
 189 the \fBPrivoxy\fR FAQ.
 190
 191 http://www.privoxy.org/developer-manual/,
 192 the \fBPrivoxy\fR developer manual.
 193
 194 https://sourceforge.net/projects/ijbswa/,
 195 the Project Page for \fBPrivoxy\fR on
 196 SourceForge.
 197
 198 http://config.privoxy.org/,
 199 the web-based user interface. \fBPrivoxy\fR must be
 200 running for this to work. Shortcut: http://p.p/
 201
 202 https://sourceforge.net/tracker/?group_id=11118&atid=460288, to submit ``misses'' and other
 203 configuration related suggestions to the developers.
 204 .SH "DEVELOPMENT TEAM"
 205
 206 .nf
 207  Fabian Keil, lead developer
 208  David Schmidt
 209  Hal Burgiss
 210  Lee Rian
 211  Roland Rosenfeld
 212  Ian Silvester
 213 .fi
 214 .SH "COPYRIGHT AND LICENSE"
 215 .SS "COPYRIGHT"
 216 .PP
 217 Copyright (C) 2001-2013 by Privoxy Developers <ijbswa-developers@lists.sourceforge.net>
 218 .PP
 219 Some source code is based on code Copyright (C) 1997 by Anonymous Coders
 220 and Junkbusters, Inc. and licensed under the \fIGNU General Public
 221 License\fR.
 222 .SS "LICENSE"
 223 .PP
 224 \fBPrivoxy\fR is free software; you can
 225 redistribute it and/or modify it under the terms of the
 226 \fIGNU General Public License\fR, version 2,
 227 as published by the Free Software Foundation.
 228 .PP
 229 \fBPrivoxy\fR is distributed in the hope that
 230 it will be useful, but WITHOUT ANY WARRANTY; without even the implied
 231 warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 232 See the  \fIlicense\fR for details.