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" "26 August 2011" "Privoxy 3.0.18 UNRELEASED" ""
   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\-\-pre-chroot-nslookup \fIhostname\fB\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 .TP
  50 \fB\-\-pre-chroot-nslookup \fIhostname\fB\fR
  51 Initialize the resolver library using \fIhostname\fR
  52 before chroot'ing. On some systems this reduces the number of files
  53 that must be copied into the chroot tree.
  54 .PP
  55 If the \fIconfigfile\fR is not specified on  the  command  line,
  56 \fBPrivoxy\fR  will  look for a file named
  57 \fIconfig\fR in the current directory. If no
  58 \fIconfigfile\fR is found, \fBPrivoxy\fR will
  59 fail to start.
  60 .SH "DESCRIPTION"
  61 .PP
  62 Privoxy is a non-caching web proxy with advanced filtering capabilities
  63 for enhancing privacy, modifying web page data and HTTP headers, controlling
  64 access, and removing ads and other obnoxious Internet junk. Privoxy has a
  65 flexible configuration and can be customized to suit individual needs and tastes.
  66 It has application for both stand-alone systems and multi-user networks.
  67 .PP
  68 Privoxy is Free Software and licensed under the GNU GPLv2.
  69 .PP
  70 Privoxy is an associated project of Software in the Public Interest (SPI).
  71 .PP
  72 Helping hands and donations are welcome:
  73 .TP 0.2i
  74 \(bu
  75 http://www.privoxy.org/faq/general.html#PARTICIPATE
  76 .TP 0.2i
  77 \(bu
  78 http://www.privoxy.org/faq/general.html#DONATE
  79 .SH "INSTALLATION AND USAGE"
  80 .PP
  81 Browsers can either be individually configured to use
  82 \fBPrivoxy\fR as a HTTP proxy (recommended),
  83 or \fBPrivoxy\fR can be combined with a packet
  84 filter to build an intercepting proxy
  85 (see \fIconfig\fR).  The default setting is  for
  86 localhost,  on port  8118 (configurable in the main config file).  To set the
  87 HTTP proxy in Firefox, go through: \fBTools\fR;
  88 \fBOptions\fR; \fBGeneral\fR;
  89 \fBConnection Settings\fR;
  90 \fBManual Proxy Configuration\fR.
  91 .PP
  92 For Internet Explorer, go through: \fBTools\fR;
  93 \fBInternet Properties\fR; \fBConnections\fR;
  94 \fBLAN Settings\fR.
  95 .PP
  96 The Secure (SSL) Proxy should also be set to the same values, otherwise
  97 https: URLs will not be proxied. Note: \fBPrivoxy\fR can only
  98 proxy HTTP and HTTPS traffic. Do not try it with FTP or other protocols.
  99 HTTPS presents some limitations, and not all features will work with HTTPS
 100 connections.
 101 .PP
 102 For other browsers, check the documentation.
 103 .SH "CONFIGURATION"
 104 .PP
 105 \fBPrivoxy\fR can be configured with the various configuration
 106 files. The default configuration files are: \fIconfig\fR,
 107 \fIdefault.filter\fR, \fIdefault.action\fR and
 108 \fIdefault.action\fR. \fIuser.action\fR should
 109 be used for locally defined exceptions to the default rules in
 110 \fImatch-all.action\fR and \fIdefault.action\fR,
 111 and \fIuser.filter\fR for locally defined filters. These are
 112 well commented.  On Unix and Unix-like systems, these are located in
 113 \fI/etc/privoxy/\fR by default.
 114 .PP
 115 \fBPrivoxy\fR uses the concept of \fBactions\fR
 116 in order to manipulate the data stream between the browser and remote sites.
 117 There are various actions available with specific functions for such things
 118 as blocking web sites, managing cookies, etc. These actions can be invoked
 119 individually or combined, and used against individual URLs, or groups of URLs
 120 that can be defined using wildcards and regular expressions. The result is
 121 that the user has greatly enhanced control and freedom.
 122 .PP
 123 The actions list (ad blocks, etc) can also be configured with your
 124 web browser at http://config.privoxy.org/
 125 (assuming the configuration allows it).
 126 \fBPrivoxy's\fR configuration parameters  can also  be viewed at
 127 the same page. In addition, \fBPrivoxy\fR can be toggled on/off.
 128 This is an internal page, and does not require Internet access.
 129 .PP
 130 See the \fIUser Manual\fR for a detailed
 131 explanation of installation, general usage, all configuration options, new
 132 features and notes on upgrading.
 133 .SH "FILES"
 134
 135 .nf
 136
 137  \fI/usr/sbin/privoxy\fR
 138  \fI/etc/privoxy/config\fR
 139  \fI/etc/privoxy/match-all.action\fR
 140  \fI/etc/privoxy/default.action\fR
 141  \fI/etc/privoxy/user.action\fR
 142  \fI/etc/privoxy/default.filter\fR
 143  \fI/etc/privoxy/user.filter\fR
 144  \fI/etc/privoxy/trust\fR
 145  \fI/etc/privoxy/templates/*\fR
 146  \fI/var/log/privoxy/logfile\fR
 147 .fi
 148 .PP
 149 Various other files should be included, but may vary depending on platform
 150 and build configuration. Additional documentation should be included in the local
 151 documentation directory.
 152 .SH "SIGNALS"
 153 .PP
 154 \fBPrivoxy\fR terminates on the \fBSIGINT\fR,
 155 \fBSIGTERM\fR and \fBSIGABRT\fR signals. Log
 156 rotation scripts may cause a re-opening of the logfile by sending a
 157 \fBSIGHUP\fR to \fBPrivoxy\fR. Note that unlike
 158 other daemons,  \fBPrivoxy\fR does not need to be made aware of
 159 config file changes by \fBSIGHUP\fR -- it will detect them
 160 automatically.
 161 .SH "NOTES"
 162 .PP
 163 This is a UNRELEASED version of \fBPrivoxy\fR. Not
 164 all features are well tested.
 165 .PP
 166 Please see the \fIUser Manual\fR on how to contact the
 167 developers, for feature requests, reporting problems, and other questions.
 168 .SH "SEE ALSO"
 169 .PP
 170 Other references and sites of interest to \fBPrivoxy\fR
 171 users:
 172 .PP
 173
 174 http://www.privoxy.org/,
 175 the \fBPrivoxy\fR Home page.
 176
 177 http://www.privoxy.org/faq/,
 178 the \fBPrivoxy\fR FAQ.
 179
 180 http://www.privoxy.org/developer-manual/,
 181 the \fBPrivoxy\fR developer manual.
 182
 183 https://sourceforge.net/projects/ijbswa/,
 184 the Project Page for \fBPrivoxy\fR on
 185 SourceForge.
 186
 187 http://config.privoxy.org/,
 188 the web-based user interface. \fBPrivoxy\fR must be
 189 running for this to work. Shortcut: http://p.p/
 190
 191 https://sourceforge.net/tracker/?group_id=11118&atid=460288, to submit ``misses'' and other
 192 configuration related suggestions to the developers.
 193 .SH "DEVELOPMENT TEAM"
 194
 195 .nf
 196  Fabian Keil, lead developer
 197  David Schmidt, developer
 198
 199  Hal Burgiss
 200  Mark Miller
 201  Gerry Murphy
 202  Lee Rian
 203  Roland Rosenfeld
 204 .fi
 205 .SH "COPYRIGHT AND LICENSE"
 206 .SS "COPYRIGHT"
 207 .PP
 208 Copyright (C) 2001-2011 by Privoxy Developers <ijbswa-developers@lists.sourceforge.net>
 209 .PP
 210 Some source code is based on code Copyright (C) 1997 by Anonymous Coders
 211 and Junkbusters, Inc. and licensed under the \fIGNU General Public
 212 License\fR.
 213 .SS "LICENSE"
 214 .PP
 215 \fBPrivoxy\fR is free software; you can
 216 redistribute it and/or modify it under the terms of the
 217 \fIGNU General Public License\fR, version 2,
 218 as published by the Free Software Foundation.
 219 .PP
 220 This program is distributed in the hope that it will be useful, but WITHOUT
 221 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 222 FITNESS FOR A PARTICULAR PURPOSE.  See the  \fIGNU General Public License\fR for details.
 223 .PP
 224 You should have received a copy of the \fIGNU GPL\fR
 225 along with this program; if not, write to the  Free Software
 226 Foundation, Inc. 51 Franklin Street, Fifth Floor
 227 Boston, MA 02110-1301
 228 USA