.\" This manpage has been automatically generated by docbook2man .\" from a DocBook document. This tool can be found at: .\" .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng . .\" Modified for privoxy-developers, 04/08/02. .TH "PRIVOXY" "1" "08 April 2002" "Privoxy 2.9.13 beta" "" .SH NAME privoxy \- Privacy Enhancing Proxy .SH SYNOPSIS \fBprivoxy\fR [\fB--help\fR] [\fB--version\fR] [\fB--no-daemon\fR] [\fB--pidfile \fIpidfile\fB\fR] [\fB--user \fIuser[.group]\fB\fR] [\fB\fIconfigfile\fB\fR] (UNIX) \fBprivoxy.exe\fR [\fB\fIconfigfile\fB\fR] (Windows) .SH "OPTIONS" .PP \fBPrivoxy\fR may be invoked with the following command line options: .TP \fB--help\fR Print brief usage info and exit. .TP \fB--version\fR Print version info and exit. .TP \fB--no-daemon\fR Don't become a daemon, i.e. don't fork and become process group leader, don't detach from controlling tty, and do all logging there. .TP \fB--pidfile \fIpidfile\fB\fR After (optionally) writing the PID file, assume the user ID of user and the GID of group, or, if the optional group was not given, the default group of user. Exit if the privileges are not sufficient to do so. .TP \fB--user \fIuser[.group]\fB\fR After (optionally) writing the PID file, assume the user ID of \fIuser\fR and the GID of \fIgroup\fR, or, if the optional \fIgroup\fR was not given, the default group of \fIuser\fR. Exit if the privileges are not sufficient to do so. .PP If the \fIconfigfile\fR is not specified on the command line, \fBPrivoxy\fR will look for a file named \fIconfig\fR in the current directory (except on Win32 where it will try \fIconfig.txt\fR). If no \fIconfigfile\fR is found, \fBPrivoxy\fR will fail to start. .SH "DESCRIPTION" .PP \fBPrivoxy\fR is a web proxy with advanced filtering capabilities for protecting privacy, filtering web page content, managing cookies, controlling access, and removing ads, banners, pop-ups and other obnoxious Internet junk. \fBPrivoxy\fR has a very flexible configuration and can be customized to suit individual needs and tastes. \fBPrivoxy\fR has application for both stand-alone systems and multi-user networks. .PP \fBPrivoxy\fR is based on the code of the \fBInternet Junkbuster\fR (tm). \fBJunkbuster\fR was originally written by JunkBusters Corporation, and was released as free open-source software under the GNU GPL. Stefan Waldherr made many improvements, and started the SourceForge project to continue development. .PP \fBPrivoxy\fR continues the \fBJunkbuster\fR tradition, but adds many refinements, enhancements and new features. .SH "INSTALLATION AND USAGE" .PP Browsers must be individually configured to use \fBPrivoxy\fR as a HTTP proxy. The default setting is for localhost, on port 8118 (configurable in the main config file). To set the HTTP proxy in Netscape and Mozilla, go through: \fBEdit\fR; \fBPreferences\fR; \fBAdvanced\fR; \fBProxies\fR; \fBManual Proxy Configuration\fR; \fBView\fR. .PP For Internet Explorer, go through: \fBTools\fR; \fBInternet Properties\fR; \fBConnections\fR; \fBLAN Settings\fR. .PP The Secure (SSL) Proxy should also be set to the same values, otherwise https: URLs will not be proxied. .PP For other browsers, check the documentation. .SH "CONFIGURATION" .PP \fBPrivoxy\fR can be configured with the various configuration files. The default configuration files are: \fIconfig\fR, \fIdefault.action\fR, and \fIdefault.filter\fR. These are well commented. On Unix and Unix-like systems, these are located in \fI/etc/privoxy/\fR by default. On Windows, OS/2 and AmigaOS, these files are in the same directory as the \fBPrivoxy\fR executable. .PP The name and number of configuration files has changed from previous versions, and is subject to change as development progresses. In fact, the configuration itself is changed and much more sophisticated. See the user-manual for a brief explanation of all configuration options. .PP The actions list (ad blocks, etc) can also be configured with your web browser at http://ijbswa.sourceforge.net/config. \fBPrivoxy's\fR configuration parameters can also be viewed at the same page. In addition, \fBPrivoxy\fR can be toggled on/off. This is an internal page. .SH "SAMPLE CONFIGURATION" .PP A brief example of what a \fIdefault.action\fR configuration might look like: .nf # Define a few useful custom aliases for later use {{alias}} # Don't accept cookies +no-cookies = +no-cookies-set +no-cookies-read # Do accept cookies -no-cookies = -no-cookies-set -no-cookies-read # Treat these blocked URLs as images. +imageblock = +block +image # Define page filters we want to use. myfilters = +filter{html-annoyances} +filter{js-annoyances}\\ +filter{no-popups} +filter{webbugs} ## Default Policies (actions) ############################ { \\ -block \\ -downgrade \\ +fast-redirects \\ myfilters \\ +no-compression \\ +hide-forwarded \\ +hide-from{block} \\ +hide-referer{forge} \\ -hide-user-agent \\ -image \\ +image-blocker{blank} \\ +no-cookies-keep \\ -no-cookies-read \\ -no-cookies-set \\ +no-popups \\ -vanilla-wafer \\ -wafer \\ } / # Now set exceptions to the above defined policies ####### # Sites where we want persistant cookies {-no-cookies -no-cookies-keep} .redhat.com .sun.com .yahoo.com .msdn.microsoft.com # This site requires cookies AND 'fast-redirects' on {-no-cookies -no-cookies-keep -fast-redirects} .nytimes.com # Add custom headers, and turn off filtering of page source {+add-header{X-Privacy: Yes please} #-add-header{*} \\ +add-header{X-User-Tracking: No thanks!} -filter} privacy.net # Block, and treat these URLs as 'images'. {+imageblock} .adforce.imgis.com .ad.preferences.com/image.* .ads.web.aol.com .ad-adex3.flycast.com .ad.doubleclick.net .ln.doubleclick.net .ad.de.doubleclick.net /.*/count\\.cgi\\?.*df= 194.221.183.22[1-7] a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/ # Block any URLs that match these patterns {+block} /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\\.(gif|jpe?g)) /.*/(plain|live|rotate)[-_.]?ads?/ /.*/(sponsor)s?[0-9]?/ /.*/ad(server|stream|juggler)\\.(cgi|pl|dll|exe) /.*/adbanners/ /.*/adv((er)?ts?|ertis(ing|ements?))?/ /.*/banners?/ /.*/popupads/ /.*/advert[0-9]+\\.jpg /ad_images/ /.*/ads/ /images/.*/.*_anim\\.gif /rotations/ /.*(ms)?backoff(ice)?.*\\.(gif|jpe?g) 195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|) .images.nytimes.com .images.yahoo.com/adv/ /.*cnnstore\\.gif .fi .PP See the comments in the configuration files themselves, or the \fIuser-manual\fR for explanations of the above syntax, and other \fBPrivoxy\fR configuration options. .SH "FILES" .nf \fI/usr/sbin/privoxy\fR \fI/etc/privoxy/config\fR \fI/etc/privoxy/default.action\fR \fI/etc/privoxy/advanced.action\fR \fI/etc/privoxy/basic.action\fR \fI/etc/privoxy/intermediate.action\fR \fI/etc/privoxy/default.filter\fR \fI/etc/privoxy/trust\fR \fI/etc/privoxy/templates/*\fR \fI/var/log/privoxy/logfile\fR .fi .PP Various other files should be included, but may vary depending on platform and build configuration. More documentation should be included in the local documentation directory, though is not complete at this time. .SH "SIGNALS" .PP \fBPrivoxy\fR terminates on the \fBSIGINT\fR, \fBSIGTERM\fR and \fBSIGABRT\fR signals. Log rotation scripts may cause a re-opening of the logfile by sending a \fBSIGHUP\fR to \fBPrivoxy\fR. Note that unlike other daemons, \fBPrivoxy\fR does not need to be made aware of config file changes by \fBSIGHUP\fR -- it will detect them automatically. .SH "NOTES" .PP This is a beta version of \fBPrivoxy\fR. Not all features are well tested. .PP Please see the \fIuser-manual\fR on how to contact the developers for feature requests, reporting problems, and other questions. .SH "SEE ALSO" .PP Other references and sites of interest to \fBPrivoxy\fR users: .PP http://www.privoxy.org/, The \fBPrivoxy\fR Home page. http://sourceforge.net/projects/ijbswa, the Project Page for \fBPrivoxy\fR on Sourceforge. http://p.p/, access \fBPrivoxy\fR from your browser. Alternately, http://config.privoxy.org may work in some situations where the first does not. http://www.junkbusters.com/ht/en/cookies.html http://www.waldherr.org/junkbuster/ http://privacy.net/analyze/ http://www.squid-cache.org/ .SH "DEVELOPMENT TEAM" .nf Stefan Waldherr Andreas Oesterhelt Jon Foster Markus Breitenbach Thomas Steudten David Schmidt (OS/2, Mac OSX ports) Gabriel L. Somlo Hal Burgiss (docs) Haroon Rafique John Venvertloh Joerg Strohmayer Rodney Stromlund Rodrigo Barbosa (RPM specfiles) Sarantis Paskalis Shamim Mohamed Gábor Lipták Alexander Lazic .fi .SH "COPYRIGHT AND LICENSE" .PP \fBPrivoxy\fR is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. .PP This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details, which is available from the Free Software Foundation, Inc, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. .PP You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.