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" "21 March 2009" "Privoxy 3.0.12" ""
   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 GPL2.
  69 .SH "INSTALLATION AND USAGE"
  70 .PP
  71 Browsers can either be individually configured to use
  72 \fBPrivoxy\fR as a HTTP proxy (recommended),
  73 or \fBPrivoxy\fR can be combined with a packet
  74 filter to build an intercepting proxy
  75 (see \fIconfig\fR).  The default setting is  for
  76 localhost,  on port  8118 (configurable in the main config file).  To set the
  77 HTTP proxy in 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, \fIdefault.action\fR and
  98 \fIdefault.action\fR. \fIuser.action\fR should
  99 be used for locally defined exceptions to the default rules in
 100 \fImatch-all.action\fR and \fIdefault.action\fR,
 101 and \fIuser.filter\fR for locally defined filters. These are
 102 well commented.  On Unix and Unix-like systems, these are located in
 103 \fI/etc/privoxy/\fR by default.
 104 .PP
 105 \fBPrivoxy\fR uses the concept of \fBactions\fR
 106 in order to manipulate the data stream between the browser and remote sites.
 107 There are various actions available with specific functions for such things
 108 as blocking web sites, managing cookies, etc. These actions can be invoked
 109 individually or combined, and used against individual URLs, or groups of URLs
 110 that can be defined using wildcards and regular expressions. The result is
 111 that the user has greatly enhanced control and freedom.
 112 .PP
 113 The actions list (ad blocks, etc) can also be configured with your
 114 web browser at http://config.privoxy.org/
 115 (assuming the configuration allows it).
 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 "FILES"
 124
 125 .nf
 126
 127  \fI/usr/sbin/privoxy\fR
 128  \fI/etc/privoxy/config\fR
 129  \fI/etc/privoxy/match-all.action\fR
 130  \fI/etc/privoxy/default.action\fR
 131  \fI/etc/privoxy/user.action\fR
 132  \fI/etc/privoxy/default.filter\fR
 133  \fI/etc/privoxy/user.filter\fR
 134  \fI/etc/privoxy/trust\fR
 135  \fI/etc/privoxy/templates/*\fR
 136  \fI/var/log/privoxy/logfile\fR
 137 .fi
 138 .PP
 139 Various other files should be included, but may vary depending on platform
 140 and build configuration. Additional documentation should be included in the local
 141 documentation directory.
 142 .SH "SIGNALS"
 143 .PP
 144 \fBPrivoxy\fR terminates on the \fBSIGINT\fR,
 145 \fBSIGTERM\fR and \fBSIGABRT\fR signals. Log
 146 rotation scripts may cause a re-opening of the logfile by sending a
 147 \fBSIGHUP\fR to \fBPrivoxy\fR. Note that unlike
 148 other daemons,  \fBPrivoxy\fR does not need to be made aware of
 149 config file changes by \fBSIGHUP\fR -- it will detect them
 150 automatically.
 151 .SH "NOTES"
 152 .PP
 153 Please see the \fIUser Manual\fR on how to contact the
 154 developers, for feature requests, reporting problems, and other questions.
 155 .SH "SEE ALSO"
 156 .PP
 157 Other references and sites of interest to \fBPrivoxy\fR
 158 users:
 159 .PP
 160
 161 http://www.privoxy.org/,
 162 the \fBPrivoxy\fR Home page.
 163
 164 http://www.privoxy.org/faq/,
 165 the \fBPrivoxy\fR FAQ.
 166
 167 http://www.privoxy.org/developer-manual/,
 168 the \fBPrivoxy\fR developer manual.
 169
 170 https://sourceforge.net/projects/ijbswa/,
 171 the Project Page for \fBPrivoxy\fR on
 172 SourceForge.
 173
 174 http://config.privoxy.org/,
 175 the web-based user interface. \fBPrivoxy\fR must be
 176 running for this to work. Shortcut: http://p.p/
 177
 178 https://sourceforge.net/tracker/?group_id=11118&atid=460288, to submit ``misses'' and other
 179 configuration related suggestions to the developers.
 180 .SH "DEVELOPMENT TEAM"
 181
 182 .nf
 183  Fabian Keil, lead developer
 184  David Schmidt, developer
 185
 186  Hal Burgiss
 187  Mark Miller
 188  Gerry Murphy
 189  Lee Rian
 190  Roland Rosenfeld
 191  J\[:o]rg Strohmayer
 192 .fi
 193 .SH "COPYRIGHT AND LICENSE"
 194 .SS "COPYRIGHT"
 195 .PP
 196 Copyright (C) 2001-2009 by Privoxy Developers <ijbswa-developers@lists.sourceforge.net>
 197 .PP
 198 Some source code is based on code Copyright (C) 1997 by Anonymous Coders
 199 and Junkbusters, Inc. and licensed under the \fIGNU General Public
 200 License\fR.
 201 .SS "LICENSE"
 202 .PP
 203 \fBPrivoxy\fR is free software; you can
 204 redistribute it and/or modify it under the terms of the
 205 \fIGNU General Public License\fR, version 2,
 206 as published by the Free Software Foundation.
 207 .PP
 208 This program is distributed in the hope that it will be useful, but WITHOUT
 209 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 210 FITNESS FOR A PARTICULAR PURPOSE.  See the  \fIGNU General Public License\fR for details.
 211 .PP
 212 You should have received a copy of the \fIGNU GPL\fR
 213 along with this program; if not, write to the  Free Software
 214 Foundation, Inc. 51 Franklin Street, Fifth Floor
 215 Boston, MA 02110-1301
 216 USA