<HTML><HEAD><TITLE>Manpage of PRIVOXY</TITLE>
<LINK REL="STYLESHEET" TYPE="text/css" HREF="../p_doc.css"></HEAD><BODY>
<H1>PRIVOXY</H1>
-Section: (1)<BR>Updated: 2
4 April 2002<BR><A HREF="#index">Index</A>
+Section: (1)<BR>Updated: 2
1 September 2006<BR><A HREF="#index">Index</A>
<HR>
<A NAME="lbAB"> </A>
<H2>SYNOPSIS</H2>
<P>
-<B>privoxy</B> [<B>--help</B>] [<B>--version</B>] [<B>--no-daemon</B>] [<B>--pidfile </B><I>pidfile</I><B></B>] [<B>--user </B><I>user[.group]</I><B></B>] [<B></B><I>configfile</I><B></B>] <B>(UNIX)</B>
-<P>
-<P>
-<B>privoxy.exe</B> [<B></B><I>configfile</I><B></B>] <B>(Windows)</B>
+<B>privoxy</B> [<B>--help</B> ] [<B>--version</B> ] [<B>--no-daemon</B> ] [<B>--pidfile </B><I>pidfile</I><B></B> ] [<B>--user </B><I>user[.group]</I><B></B> ] [<B>--chroot</B> ] [<B></B><I>configfile</I><B></B> ]
<P>
<A NAME="lbAD"> </A>
<H2>OPTIONS</H2>
<DT><B>--pidfile </B><I>pidfile</I><B></B><DD>
On startup, write the process ID to <I>pidfile</I>.
Delete the <I>pidfile</I> on exit.
-Failiure to create or delete the <I>pidfile</I>
+Failure to create or delete the <I>pidfile</I>
is non-fatal. If no <B>--pidfile</B> option is given, no PID file will be used.
<DT><B>--user </B><I>user[.group]</I><B></B><DD>
After (optionally) writing the PID file, assume the user ID of
<I>group</I> was not given, the default group of
<I>user</I>. Exit if the privileges are not
sufficient to do so.
+<DT><B>--chroot</B><DD>
+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
+<B>Privoxy</B> process that the directory tree starts
+there. If set up carefully, this can limit the impact of possible
+vulnerabilities in <B>Privoxy</B> to the files contained in
+that hierarchy.
</DL>
<P>
If the <I>configfile</I> is not specified on the command line,
<B>Privoxy</B> will look for a file named
-<I>config</I> in the current directory (except on Win32 where
-it will try <I>config.txt</I>). If no
+<I>config</I> in the current directory . If no
<I>configfile</I> is found, <B>Privoxy</B> will
fail to start.
<A NAME="lbAE"> </A>
<P>
-<B>Privoxy</B> 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. <B>Privoxy</B> has a very
-flexible configuration and can be customized to suit individual needs and
-tastes. <B>Privoxy</B> has application for both
-stand-alone systems and multi-user networks.
+Privoxy is a
+web proxy
+with advanced filtering capabilities for protecting
+privacy, modifying web page data, managing
+cookies,
+controlling access, and removing ads, banners, pop-ups and other obnoxious
+Internet junk. Privoxy has a very flexible configuration and can be
+customized to suit individual needs and tastes. Privoxy has application for
+both stand-alone systems and multi-user networks.
<P>
-<B>Privoxy</B> is based on <B>Internet
-Junkbuster</B> (tm).
+Privoxy is based on Internet Junkbuster (tm).
<A NAME="lbAF"> </A>
<H2>INSTALLATION AND USAGE</H2>
<B>View</B>.
<P>
+For Firefox, go through: <B>Tools</B>;
+<B>Options</B>; <B>General</B>;
+<B>Connection Settings</B>;
+<B>Manual Proxy Configuration</B>.
+<P>
+
For Internet Explorer, go through: <B>Tools</B>;
<B>Internet Properties</B>; <B>Connections</B>;
<B>LAN Settings</B>.
<P>
The Secure (SSL) Proxy should also be set to the same values, otherwise
-https: URLs will not be proxied.
+https: URLs will not be proxied. Note: <B>Privoxy</B> 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.
<P>
For other browsers, check the documentation.
<B>Privoxy</B> can be configured with the various configuration
files. The default configuration files are: <I>config</I>,
-<I>default.action</I>, and
-<I>default.filter</I>. These are well commented. On Unix and
-Unix-like systems, these are located in <I>/etc/privoxy/</I> by
-default. On Windows, OS/2 and AmigaOS, these files are in the same directory
-as the <B>Privoxy</B> executable.
+<I>default.filter</I>, and
+<I>default.action</I>. <I>user.action</I> should
+be used for locally defined exceptions to the default rules of
+<I>default.action</I>, and <I>user.filter</I> for
+locally defined filters. These are well commented. On Unix
+and Unix-like systems, these are located in
+<I>/etc/privoxy/</I> by default.
<P>
-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.
+<B>Privoxy</B> uses the concept of <B>actions</B>
+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.
<P>
The actions list (ad blocks, etc) can also be configured with your
-web browser at <A HREF="http://ijbswa.sourceforge.net/config.">http://ijbswa.sourceforge.net/config.</A>
+web browser at <A HREF="http://config.privoxy.org/">http://config.privoxy.org/.</A>
<B>Privoxy's</B> configuration parameters can also be viewed at
the same page. In addition, <B>Privoxy</B> can be toggled on/off.
-This is an internal page.
+This is an internal page, and does not require Internet access.
+<P>
+
+See the <I>User Manual</I> for a detailed
+explanation of installation, general usage, all configuration options, new
+features and notes on upgrading.
<A NAME="lbAH"> </A>
<H2>SAMPLE CONFIGURATION</H2>
<P>
-A brief example of what a <I>default.action</I> configuration
-might look like:
+A brief example of what a simple <I>default.action</I>
+configuration might look like:
<P>
<PRE>
-
# Define a few useful custom aliases for later use
{{alias}}
- # Useful aliases
- +prevent-cookies = +prevent-setting-cookies +prevent-reading-cookies
- -prevent-cookies = -prevent-setting-cookies -prevent-reading-cookies
- +imageblock = +block +handle-as-image
+ # Useful aliases that combine more than one action
+ +crunch-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
+ -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
+ +block-as-image = +block +handle-as-image
# Fragile sites should have the minimum changes
fragile = -block -deanimate-gifs -fast-redirects -filter \
-hide-referer -prevent-cookies -kill-popups
- # Shops should be allowed to set persistent cookies
- shop = -filter -prevent-cookies -prevent-keeping-cookies
-
- # Your favourite blend of filters:
- #
- myfilters = +filter{html-annoyances} +filter{js-annoyances} \
- +filter{popups} +filter{webbugs} +filter{banners-by-size}
-
- ## Default Policies (actions) ############################
- { \
- -add-header \
- -block \
- +deanimate-gifs{last} \
- -downgrade-http-version \
- -fast-redirects \
- +filter{html-annoyances} \
- +filter{js-annoyances} \
- +filter{content-cookies} \
- -filter{popups} \
- +filter{webbugs} \
- +filter{refresh-tags} \
- -filter{fun} \
- +filter{nimda} \
- +filter{banners-by-size} \
- -filter{shockwave-flash} \
- -filter{crude-prental} \
- +hide-forwarded-for-headers \
- +hide-from-header{block} \
- +hide-referrer{forge} \
- -hide-user-agent \
- -handle-as-image \
- +set-image-blocker{pattern} \
- -limit-connect \
- +prevent-compression \
- +session-cookies-only \
- +prevent-reading-cookies \
- +prevent-setting-cookies \
- -kill-popups \
- -send-vanilla-wafer \
- -send-wafer \
- }
- /
- # Now set exceptions to the above defined policies #######
-
- # Sites where we want persistant cookies
- {-prevent-reading-cookies -prevent-setting-cookies}
- .redhat.com
- .sun.com
- .yahoo.com
- .msdn.microsoft.com
+ ## Turn some actions on ################################
+ ## NOTE: Actions are off by default, unless explictily turned on
+ ## otherwise with the '+' operator.
+
+{ \
+-add-header \
+-block \
+-content-type-overwrite \
+-crunch-client-header \
+-crunch-if-none-match \
+-crunch-outgoing-cookies \
+-crunch-incoming-cookies \
+-crunch-server-header \
++deanimate-gifs{last} \
+-downgrade-http-version \
+-fast-redirects \
+-filter{js-annoyances} \
+-filter{js-events} \
+-filter{html-annoyances} \
+-filter{content-cookies} \
++filter{refresh-tags} \
+-filter{unsolicited-popups} \
+-filter{all-popups} \
++filter{img-reorder} \
++filter{banners-by-size} \
+-filter{banners-by-link} \
++filter{webbugs} \
+-filter{tiny-textforms} \
++filter{jumping-windows} \
+-filter{frameset-borders} \
+-filter{demoronizer} \
+-filter{shockwave-flash} \
+-filter{quicktime-kioskmode} \
+-filter{fun} \
+-filter{crude-parental} \
++filter{ie-exploits} \
+-filter{site-specifics} \
+-filter-client-headers \
+-filter-server-headers \
+-force-text-mode \
+-handle-as-empty-document
+-handle-as-image \
+-hide-accept-language \
+-hide-content-disposition \
+-hide-if-modified-since \
++hide-forwarded-for-headers \
++hide-from-header{block} \
++hide-referrer{forge} \
+-hide-user-agent \
+-inspect-jpegs \
+-kill-popups \
+-limit-connect \
+-overwrite-last-modified \
+-redirect \
++prevent-compression \
+-send-vanilla-wafer \
+-send-wafer \
++session-cookies-only \
++set-image-blocker{pattern} \
+-treat-forbidden-connects-like-blocks \
+}
+/ # '/' Match *all* URL patterns
- # This site requires cookies AND 'fast-redirects' on
- {-prevent-reading-cookies -prevent-setting-cookies -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}
- ar.atwola.com
- .ad.doubleclick.net
- .a.yimg.com/(?:(?!/i/).)*$
- .a[0-9].yimg.com/(?:(?!/i/).)*$
- bs*.gsanet.com
- bs*.einets.com
- .qkimg.net
- ad.*.doubleclick.net
-
- # Block any URLs that match these patterns
- {+block}
- ad*.
- .*ads.
- banner?.
- count*.
- /(?:.*/)?(ads(erver?|tream)?|.*?ads|adv(ert(s|enties|is(ing|e?ments)?)?)?|(ad)?[-_]?banner(s|ads?|farm)?)/
- /.*count(er)?\.(pl|cgi|exe|dll|asp|php[34]?)
- /(?:.*/)?(publicite|werbung|rekla(ma|me|am)|annonse|maino(kset|nta|s)?)/
- .hitbox.com
+
+ # Block, and treat these URL patterns as if they were 'images'.
+ # We would expect these to be ads.
+ { +block-as-image }
+ .ad.doubleclick.net
+ .a[0-9].yimg.com/(?:(?!/i/).)*$
+ ad.*.doubleclick.net
+
+ # Block all URLs that match these patterns
+ { +block }
+ ad*.
+ .*ads.
+ banner?.
+ /.*count(er)?\.(pl|cgi|exe|dll|asp|php[34]?)
+ .hitbox.com
+ media./.*(ads|banner)
# Make exceptions for these harmless ones that would be
- # caught by +block.
- {-block}
- include.ebay.com
- adsl.
- advice.
- .edu
- .ac.uk
- .uni-*.de
- .*downloads.
+ # caught by our +block patterns just above.
+ { -block }
+ adsl.
+ advice.
+ .*downloads.
+</PRE>
+
+<P>
+
+Then for a <I>user.action</I>, we would put local,
+narrowly defined exceptions:
+<P>
+<PRE>
+ # Re-define aliases as needed here
+ {{alias}}
+
+ # Useful aliases
+ -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
+
+ # Set personal exceptions to the policies in default.action #######
+
+ # Sites where we want persistent cookies, so allow *all* cookies
+ { -crunch-cookies -session-cookies-only }
+ .redhat.com
+ .sun.com
+ .msdn.microsoft.com
+
+ # These sites breaks easily. Use our "fragile" alias here.
+ { fragile }
+ .forbes.com
+ mybank.example.com
+
+ # Replace example.com's style sheet with one of my choosing
+ { +redirect{<A HREF="http://localhost/css-replacements/example.com.css}">http://localhost/css-replacements/example.com.css}</A> }
+ example.com/stylesheet.css
</PRE>
<P>
See the comments in the configuration files themselves, or the
-<I>user-manual</I>
-for explanations of the above syntax, and other <B>Privoxy</B>
+<I>User Manual</I>
+for full explanations of the above syntax, and other <B>Privoxy</B>
configuration options.
<A NAME="lbAI"> </A>
<H2>FILES</H2>
<I>/etc/privoxy/standard.action</I>
<I>/etc/privoxy/user.action</I>
<I>/etc/privoxy/default.filter</I>
+ <I>/etc/privoxy/user.filter</I>
<I>/etc/privoxy/trust</I>
<I>/etc/privoxy/templates/*</I>
<I>/var/log/privoxy/logfile</I>
<P>
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.
+and build configuration. Additional documentation should be included in the local
+documentation directory.
<A NAME="lbAJ"> </A>
<H2>SIGNALS</H2>
<P>
-This is a beta version of <B>Privoxy</B>. Not
+This is a BETA version of <B>Privoxy</B>. Not
all features are well tested.
<P>
-Please see the <I>user-manual</I> on how to contact the
-developers for feature requests, reporting problems, and other questions.
+Please see the <I>User Manual</I> on how to contact the
+developers, for feature requests, reporting problems, and other questions.
<A NAME="lbAL"> </A>
<H2>SEE ALSO</H2>
<P>
<P>
-<A HREF="http://www.privoxy.org/,">http://www.privoxy.org/,</A>
-The <B>Privoxy</B> Home page.
+<A HREF="http://www.privoxy.org/">http://www.privoxy.org/,</A>
+the <B>Privoxy</B> Home page.
+<P>
+<A HREF="http://www.privoxy.org/faq/">http://www.privoxy.org/faq/,</A>
+the <B>Privoxy</B> FAQ.
<P>
-<A HREF="http://sourceforge.net/projects/ijbswa,">http://sourceforge.net/projects/ijbswa,</A>
+<A HREF="http://sourceforge.net/projects/ijbswa/">http://sourceforge.net/projects/ijbswa/,</A>
the Project Page for <B>Privoxy</B> on
-Sourceforge.
+SourceForge.
+<P>
+<A HREF="http://config.privoxy.org/">http://config.privoxy.org/,</A>
+the web-based user interface. <B>Privoxy</B> must be
+running for this to work. Shortcut: <A HREF="http://p.p/">http://p.p/</A>
+<P>
+<A HREF="http://sourceforge.net/tracker/?group_id=11118">http://sourceforge.net/tracker/?group_id=11118</A>&atid=460288, to submit ``misses'' and other
+configuration related suggestions to the developers.
<P>
-<A HREF="http://p.p/,">http://p.p/,</A> access
-<B>Privoxy</B> from your browser. Alternately,
-<A HREF="http://config.privoxy.org">http://config.privoxy.org</A>
-may work in some situations where the first does not.
+<A HREF="http://www.junkbusters.com/ht/en/cookies.html">http://www.junkbusters.com/ht/en/cookies.html,</A>
+an explanation how cookies are used to track web users.
<P>
-<A HREF="http://p.p/">http://p.p/</A>
-to submit ``misses'' to the developers.
+<A HREF="http://www.junkbusters.com/ijb.html">http://www.junkbusters.com/ijb.html,</A>
+the original Internet Junkbuster.
<P>
-<A HREF="http://www.junkbusters.com/ht/en/cookies.html">http://www.junkbusters.com/ht/en/cookies.html</A>
+<A HREF="http://privacy.net/">http://privacy.net/,</A> a useful site
+to check what information about you is leaked while you browse the web.
<P>
-<A HREF="http://www.waldherr.org/junkbuster/">http://www.waldherr.org/junkbuster/</A>
+<A HREF="http://www.squid-cache.org/">http://www.squid-cache.org/,</A> a very popular
+caching proxy, which is often used together with <B>Privoxy</B>.
<P>
-<A HREF="http://privacy.net/analyze/">http://privacy.net/analyze/</A>
+<A HREF="http://tor.eff.org/">http://tor.eff.org/,</A>
+<B>Tor</B> can help anonymize web browsing,
+web publishing, instant messaging, IRC, SSH, and other applications.
<P>
-<A HREF="http://www.squid-cache.org/">http://www.squid-cache.org/</A>
+<A HREF="http://www.privoxy.org/developer-manual/">http://www.privoxy.org/developer-manual/,</A>
+the <B>Privoxy</B> developer manual.
<A NAME="lbAM"> </A>
<H2>DEVELOPMENT TEAM</H2>
<P>
<PRE>
- Jon Foster
- Andreas Oesterhelt
- Stefan Waldherr
- Thomas Steudten
- Rodney Stromlund
- Rodrigo Barbosa (RPM specfiles)
- Hal Burgiss (docs)
- Alexander Lazic
- Gábor Lipták
- Guy
- Haroon Rafique
- David Schmidt (OS/2, Mac OSX ports)
- Joerg Strohmayer
- Sarantis Paskalis
+ Fabian Keil, developer
+ David Schmidt, developer
+
+ Hal Burgiss
+ Ian Cummings
+ Félix Rauch
+ Roland Rosenfeld
</PRE>
<A NAME="lbAN"> </A>
<H2>COPYRIGHT AND LICENSE</H2>
+<A NAME="lbAO"> </A>
+<H3>COPYRIGHT</H3>
+
+<P>
+
+Copyright (C) 2001 - 2006 by Privoxy Developers <<A HREF="mailto:ijbswa-developers@lists.sourceforge.net">ijbswa-developers@lists.sourceforge.net</A>>
+<P>
+
+Some source code is based on code Copyright (C) 1997 by Anonymous Coders
+and Junkbusters, Inc. and licensed under the <I>GNU General Public
+License</I>.
+<A NAME="lbAP"> </A>
+<H3>LICENSE</H3>
+
<P>
<B>Privoxy</B> 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.
+redistribute it and/or modify it under the terms of the
+<I>GNU General Public
+License</I>, version 2, as published by the Free Software Foundation.
<P>
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.
+FITNESS FOR A PARTICULAR PURPOSE. See the
+<I>GNU General Public License</I> for
+more details, which is available from the Free Software Foundation, Inc,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
<P>
-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.
+You should have received a copy of the <I>GNU General Public License</I>
+along with this program; if not, write to the Free Software
+Foundation, Inc. 51 Franklin Street, Fifth Floor
+Boston, MA 02110-1301
+USA
<P>
<HR>
<DT><A HREF="#lbAL">SEE ALSO</A><DD>
<DT><A HREF="#lbAM">DEVELOPMENT TEAM</A><DD>
<DT><A HREF="#lbAN">COPYRIGHT AND LICENSE</A><DD>
+<DL>
+<DT><A HREF="#lbAO">COPYRIGHT</A><DD>
+<DT><A HREF="#lbAP">LICENSE</A><DD>
+</DL>
</DL>
<HR>
This document was created by
man2html,
using the manual pages.<BR>
-Time: 23:48:45 GMT, April 24, 2002
+Time: 01:21:32 GMT, September 22, 2006
</BODY>
</HTML>
projects / privoxy.git / blobdiff