X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=privoxy.1;h=f20d7a25cb4c39cddf2fe9e578228d7cd3c5e81f;hp=57ca5580a3e7b5090dd37041a3b6c0b7ddc339e4;hb=1aa00a4ce177cc446e66d6f5ff5ab88d272f73ad;hpb=067ad6a04495bf01e179bfa32ceaa0c43f64c11d diff --git a/privoxy.1 b/privoxy.1 index 57ca5580..f20d7a25 100644 --- a/privoxy.1 +++ b/privoxy.1 @@ -1,335 +1,237 @@ -.\" Revised man page 10/13/01, for development version. -.\" Hal Burgiss -.\" for Privoxy developers: ijbswa-developers@lists.sourceforge.net -.\" -.TH PRIVOXY 1 "v2.9.13 (beta) Date: 2002/03/24" - +.\" This manpage has been generated by docbook2man-spec.pl +.\" (included in the Privoxy source tarball) from a DocBook document. +.TH "PRIVOXY" "1" "20 January 2021" "Privoxy 3.0.30" "" .SH NAME -\fBprivoxy\fP -- Privacy enhancing -Proxy -.\"\s-2(TM)\s+2 +privoxy \- Privacy Enhancing Proxy .SH SYNOPSIS -\fBprivoxy\fP -[--help] [--version] [--no-daemon] [--pidfile \fIpidfile\fP] [--user \fIuser\fP[.\fIgroup\fP]] -\fI\&[configfile]\fP (Unix) -.TP -\fBprivoxy.exe\fP \fI[configfile]\fP (Windows) -.br -.SH OPTIONS -\fBPrivoxy\fP may be invoked with the following command-line options: +\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 ] + +.SH "OPTIONS" +.PP +\fBPrivoxy\fR may be invoked with the following command line +options: .TP -.BR --version " (unix only)" -Print version info and exit. +\fB\-\-chroot\fR +Before changing to the user ID given in the \-\-user option, chroot to +that user's home directory, i.e. make the kernel pretend to the +\fBPrivoxy\fR process that the directory tree starts +there. If set up carefully, this can limit the impact of possible +vulnerabilities in \fBPrivoxy\fR to the files contained in +that hierarchy. .TP -.BR --help " (unix only)" -Print a short usage info and exit. +\fB\-\-config-test\fR +Exit after loading the configuration files before binding to +the listen address. The exit code signals whether or not the +configuration files have been successfully loaded. + +If the exit code is 1, at least one of the configuration files +is invalid, if it is 0, all the configuration files have been +successfully loaded (but may still contain errors that can +currently only be detected at run time). + +This option doesn't affect the log setting, combination with +"--no-daemon" is recommended if a configured log file shouldn't +be used. .TP -.BR --no-daemon " (unix only)" -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. +\fB\-\-help\fR +Print brief usage info and exit. .TP -\fB --pidfile\fP \fIpidfile\fP (unix only) -On startup, write the process ID to \fIpidfile\fP. Delete the -\fIpidfile\fP on exit. Failiure to create or delete the -\fIpidfile\fP is non-fatal. If no \fB--pidfile\fP option -is given, no PID file will be used. +\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 --user\fP \fIuser\fP[.\fIgroup\fP] (unix only) -After (optionally) writing the PID file, assume the user ID -of \fIuser\fP and the GID of \fIgroup\fP, or, if the optional -\fIgroup\fP was not given, the default group of \fIuser\fP. -Exit if the privileges are not sufficient to do so. - -.PP -If the \fIconfigfile\fP is not specified on the command line, -\fBPrivoxy\fP will look for a file named \fBconfig\fP in the -current directory (except on Win32 where it will try \fBconfig.txt\fP). - - -.SH DESCRIPTION -\fBPrivoxy\fP -is an instrumentable HTTP proxy that filters the -\s-2HTTP\s0 -data stream between -web servers and browsers. -\fBPrivoxy\fP can be used to protect privacy, manage cookies, filter web -page content, manage access restrictions, and to discard such annoying Internet -junk as ads, banners, and pop-ups. Or whatever other annoyances strike your -fancy. -.PP -\fBPrivoxy\fP is derived from \fBInternet Junkbuster (tm)\fP by -Junkbusters Corporation, which is no longer being developed. Many -new features and enhancements have been added. - -.SH INSTALLATION AND USE -Browsers must be individually configured to use -\fBPrivoxy\fP as a HTTP proxy. -The default setting is for localhost, -on port 8118 (configurable in the main config file). -To set the -\s-2HTTP\s0 -proxy in Netscape and Mozilla, -go through: -\fB\&Edit\fP; -\fB\&Preferences\fP; -\fB\&Advanced\fP; -\fB\&Proxies\fP; -\fB\&Manual Proxy Configuration\fP; -\fB\&View\fP. -.PP -For Internet Explorer, -go through: -\fB\&Tools\fP; -\fB\&Internet Properties\fP; -\fB\&Connections\fP; -\fB\&LAN Settings\fP. +\fB\-\-pidfile \fIpidfile\fB\fR +On startup, write the process ID to \fIpidfile\fR. +Delete the \fIpidfile\fR on exit. +Failure to create or delete the \fIpidfile\fR +is non-fatal. If no \fB\-\-pidfile\fR option is given, no PID file will be used. +.TP +\fB\-\-pre-chroot-nslookup \fIhostname\fB\fR +Initialize the resolver library using \fIhostname\fR +before chroot'ing. On some systems this reduces the number of files +that must be copied into the chroot tree. +.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. +.TP +\fB\-\-version\fR +Print version info and exit. .PP -The -Secure (SSL) Proxy \" ijbfaq.html#security -should also be set to the same values, -otherwise -\fB\&https:\fP -\s-2URL\s0s -will not be proxied. +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. If no +\fIconfigfile\fR is found, \fBPrivoxy\fR will +fail to start. +.SH "DESCRIPTION" +.PP +Privoxy is a non-caching web proxy with advanced filtering capabilities +for enhancing privacy, modifying web page data and HTTP headers, controlling +access, and removing ads and other obnoxious Internet junk. Privoxy has a +flexible configuration and can be customized to suit individual needs and tastes. +It has application for both stand-alone systems and multi-user networks. +.PP +Privoxy is Free Software and licensed under the GNU GPLv2 or later. +.PP +Privoxy is an associated project of Software in the Public Interest (SPI). +.PP +Helping hands and donations are welcome: +.PP +.TP 0.2i +\(bu +https://www.privoxy.org/participate +.TP 0.2i +\(bu +https://www.privoxy.org/donate +.SH "INSTALLATION AND USAGE" +.PP +Browsers can either be individually configured to use +\fBPrivoxy\fR as a HTTP proxy (recommended), +or \fBPrivoxy\fR can be combined with a packet +filter to build an intercepting proxy +(see \fIconfig\fR). The default setting is for +localhost, on port 8118 (configurable in the main config file). To set the +HTTP proxy in Firefox, go through: \fBTools\fR; +\fBOptions\fR; \fBGeneral\fR; +\fBConnection Settings\fR; +\fBManual Proxy Configuration\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. Note: \fBPrivoxy\fR can only +proxy HTTP and HTTPS traffic. Do not try it with FTP or other protocols. +HTTPS presents some limitations, and not all features will work with HTTPS +connections. .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.filter\fR, \fIdefault.action\fR and +\fIdefault.action\fR. \fIuser.action\fR should +be used for locally defined exceptions to the default rules in +\fImatch-all.action\fR and \fIdefault.action\fR, +and \fIuser.filter\fR for locally defined filters. These are +well commented. On Unix and Unix-like systems, these are located in +\fI/etc/privoxy/\fR by default. +.PP +\fBPrivoxy\fR uses the concept of \fBactions\fR +in order to manipulate the data stream between the browser and remote sites. +There are various actions available with specific functions for such things +as blocking web sites, managing cookies, etc. These actions can be invoked +individually or combined, and used against individual URLs, or groups of URLs +that can be defined using wildcards and regular expressions. The result is +that the user has greatly enhanced control and freedom. +.PP +The actions list (ad blocks, etc) can also be configured with your +web browser at http://config.privoxy.org/ +(assuming the configuration allows it). +\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, and does not require Internet access. +.PP +See the \fIUser Manual\fR for a detailed +explanation of installation, general usage, all configuration options, new +features and notes on upgrading. +.SH "FILES" -.SH CONFIGURATION -\fBPrivoxy\fP can be configured with the various configuration -files. The default configuration files are: \fIconfig\fP, -\fIdefault.action\fP, and \fIdefault.filter\fP. These are well commented. -On Unix and Unix-like systems, these are located in \fI/etc/privoxy/\fP -by default. On Windows, OS/2 and AmigaOS, these files are in the same directory -as the \fBPrivoxy\fP executable. +.nf + \fI/usr/sbin/privoxy\fR + \fI/etc/privoxy/config\fR + \fI/etc/privoxy/match-all.action\fR + \fI/etc/privoxy/default.action\fR + \fI/etc/privoxy/user.action\fR + \fI/etc/privoxy/default.filter\fR + \fI/etc/privoxy/user.filter\fR + \fI/etc/privoxy/trust\fR + \fI/etc/privoxy/templates/*\fR + \fI/var/log/privoxy/logfile\fR +.fi .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. +Various other files should be included, but may vary depending on platform +and build configuration. Additional documentation should be included in the local +documentation directory. +.SH "SIGNALS" .PP -The actions list (ad blocks, etc) can also be configured with your -web browser at \fIhttp://ijbswa.sourceforge.net/config\fP. -\fBPrivoxy's\fP configuration parameters can also be viewed -at the same page. In addition, \fBPrivoxy\fP can be toggled on/off. -This is an internal page. - -.SH "SAMPLE CONFIGURATION" +\fBPrivoxy\fR terminates on the \fBSIGINT\fR +and \fBSIGTERM\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. Signals other than the ones listed above aren't explicitly +handled and result in the default action defined by the operating system. +.SH "NOTES" .PP -A brief example of what a \fIdefault.action\fP configuration might look like: +Please see the \fIUser Manual\fR on how to contact the +developers, for feature requests, reporting problems, and other questions. +.SH "SEE ALSO" .PP -.nf - -# Define a few useful custom aliases for later use -{{alias}} - -# Don't accept cookies -+no-cookies = +no-cookies-set +no-cookies-read +Other references and sites of interest to \fBPrivoxy\fR +users: -# Do accept cookies --no-cookies = -no-cookies-set -no-cookies-read +https://www.privoxy.org/, +the \fBPrivoxy\fR Home page. -# Treat these blocked URLs as images. -+imageblock = +block +image +https://www.privoxy.org/faq/, +the \fBPrivoxy\fR FAQ. -# Define page filters we want to use. -myfilters = +filter{html-annoyances} +filter{js-annoyances}\\ - +filter{no-popups} +filter{webbugs} +https://www.privoxy.org/developer-manual/, +the \fBPrivoxy\fR developer manual. -## 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 \\ -} -/ +https://sourceforge.net/projects/ijbswa/, +the Project Page for \fBPrivoxy\fR on +SourceForge. -# Now set exceptions to the above defined policies ####### +http://config.privoxy.org/, +the web-based user interface. \fBPrivoxy\fR must be +running for this to work. Shortcut: http://p.p/ -# Sites where we want persistant cookies -{-no-cookies -no-cookies-keep} - .redhat.com - .sun.com - .yahoo.com - .msdn.microsoft.com +https://sourceforge.net/p/ijbswa/actionsfile-feedback/, to submit ``misses'' and other +configuration related suggestions to the developers. +.SH "DEVELOPMENT TEAM" -# 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 -.sp -.PP -See the comments in the configuration files themselves, or the user-manual -for explanations of the above syntax, and other \fBPrivoxy\fP configuration -options. - -.SH "FILES" -\fI/usr/sbin/privoxy\fP -.br -\fI/etc/privoxy/config\fP -.br -\fI/etc/privoxy/default.action\fP -.br -\fI/etc/privoxy/advanced.action\fP -.br -\fI/etc/privoxy/basic.action\fP -.br -\fI/etc/privoxy/intermediate.action\fP -.br -\fI/etc/privoxy/default.filter\fP -.br -\fI/etc/privoxy/trust\fP -.br -\fI/etc/privoxy/templates/*\fP -.br -\fI/var/log/privoxy/logfile\fP - -.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 -\fBPrivoxy\fP terminates on the \fBSIGINT\fP, \fBSIGTERM\fP and \fBSIGABRT\fP -signals. Log rotation scripts may cause a re-opening of the logfile by sending -a \fBSIGHUP\fP to \fBPrivoxy\fP. Note that unlike other daemons, \fBPrivoxy\fP -does not need to be made aware of config file changes by \fBSIGHUP\fP -- it will -detect them automatically. - -.SH NOTES -This is a \fBBETA\fP version of \fBPrivoxy\fP. Not all features are -complete or well tested. -.PP -Please see the user-maual on how to contact the developers for -feature requests, reporting problems, and other questions. - -.SH BUGS -Probably. Please see the user-manual for how and where to report bugs. - -.SH SEE ALSO -.br -http://ijbswa.sourceforge.net/config -.br -http://ijbswa.sourceforge.net/ -.br -http://sourceforge.net/projects/ijbswa -.br -http://www.waldherr.org/junkbuster/\" waldherr.org# -.br -http://www.junkbusters.com/ht/en/cookies.html\" cookies.html# -.br -http://privacy.net/analyze/ -.br -http://www.squid-cache.org/ -.br -http://linuxalpha.ch/packages/ - -.SH DEVELOPMENT TEAM -.br - Stefan Waldherr -.br - Andreas Oesterhelt -.br - Jon Foster -.br - Markus Breitenbach -.br - Thomas Steudten -.br +.nf + Fabian Keil, lead developer David Schmidt -.br - Haroon Rafique -.br - Joerg Strohmayer -.br - Shamim Mohamed -.br - Sarantis Paskalis -.br - Gabriel L. Somlo -.br - John Venvertloh -.br - Hal Burgiss -.br - Rodrigo Barbosa - -.SH COPYRIGHT AND LICENSE -Orginally written by, and copyrighted by, the Anonymous Coders and Junkbusters -Corporation. -.PP -This program 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. -.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 -.PP -Internet Junkbuster -Proxy -is a -trademark \" legal.html#marks -of Junkbusters Corporation. + Lee Rian + Roland Rosenfeld + Ian Silvester +.fi +.SH "COPYRIGHT AND LICENSE" +.SS "COPYRIGHT" +.PP +Copyright (C) 2001-2020 by Privoxy Developers +.PP +Some source code is based on code Copyright (C) 1997 by Anonymous Coders +and Junkbusters, Inc. +.SS "LICENSE" +.PP +\fBPrivoxy\fR is free software; you can +redistribute and/or modify its source code under the terms +of the \fIGNU General Public License\fR +as published by the Free Software Foundation, either version 2 +of the license, or (at your option) any later version. +.PP +The same is true for \fBPrivoxy\fR binaries +unless they are linked with a +mbed TLS version +that is licensed under the Apache 2.0 license in which +case you can redistribute and/or modify the \fBPrivoxy\fR +binaries under the terms of the \fIGNU General Public License\fR +as published by the Free Software Foundation, either version 3 +of the license, or (at your option) any later version. +.PP +\fBPrivoxy\fR 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 \fIlicense\fR for details.