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