Updated for recent changes to the main man page.
[privoxy.git] / doc / webserver / man-page / privoxy-man-page.html
index bed7a12..789a202 100644 (file)
@@ -1,8 +1,9 @@
 
 
-<HTML><HEAD><TITLE>Manpage of PRIVOXY</TITLE>
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<HTML><HEAD><TITLE>Man page of PRIVOXY</TITLE>
 <LINK REL="STYLESHEET" TYPE="text/css" HREF="../p_doc.css"></HEAD><BODY>
 <H1>PRIVOXY</H1>
 <LINK REL="STYLESHEET" TYPE="text/css" HREF="../p_doc.css"></HEAD><BODY>
 <H1>PRIVOXY</H1>
-Section:  (1)<BR>Updated: 21 September 2006<BR><A HREF="#index">Index</A>
+Section:  (1)<BR>Updated: 15 February 2009<BR><A HREF="#index">Index</A>
 <HR>
 
 <A NAME="lbAB">&nbsp;</A>
 <HR>
 
 <A NAME="lbAB">&nbsp;</A>
@@ -13,7 +14,7 @@ privoxy - Privacy Enhancing Proxy
 <H2>SYNOPSIS</H2>
 
 <P>
 <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>--chroot</B> ] [<B></B><I>configfile</I><B></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>--pre-chroot-nslookup </B><I>hostname</I><B></B> ] [<B></B><I>configfile</I><B></B> ]
 <P>
 <A NAME="lbAD">&nbsp;</A>
 <H2>OPTIONS</H2>
 <P>
 <A NAME="lbAD">&nbsp;</A>
 <H2>OPTIONS</H2>
@@ -49,12 +50,16 @@ that user's home directory, i.e. make the kernel pretend to the
 there. If set up carefully, this can limit the impact of possible
 vulnerabilities in <B>Privoxy</B> to the files contained in
 that hierarchy. 
 there. If set up carefully, this can limit the impact of possible
 vulnerabilities in <B>Privoxy</B> to the files contained in
 that hierarchy. 
+<DT><B>--pre-chroot-nslookup </B><I>hostname</I><B></B><DD>
+Initialize the resolver library using <I>hostname</I>
+before chroot'ing. On some systems this reduces the number of files
+that must be copied into the chroot tree.
 </DL>
 <P>
 
 If the <I>configfile</I> is not specified on  the  command  line,
 <B>Privoxy</B>  will  look for a file named
 </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 . 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">&nbsp;</A>
 <I>configfile</I> is found, <B>Privoxy</B> will 
 fail to start.
 <A NAME="lbAE">&nbsp;</A>
@@ -62,13 +67,13 @@ fail to start.
 
 <P>
 
 
 <P>
 
-Privoxy is a 
+Privoxy is a non-caching
 web proxy
 web proxy
-with advanced filtering capabilities for protecting
-privacy, modifying web page data, managing 
+with advanced filtering capabilities for enhancing privacy,
+modifying web page data, managing HTTP
 cookies, 
 controlling access, and removing ads, banners, pop-ups and other obnoxious
 cookies, 
 controlling access, and removing ads, banners, pop-ups and other obnoxious
-Internet junk. Privoxy has a very flexible configuration and can be
+Internet junk. Privoxy has a 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>
 customized to suit individual needs and tastes. Privoxy has application for
 both stand-alone systems and multi-user networks.
 <P>
@@ -79,16 +84,13 @@ Privoxy is based on Internet Junkbuster (tm).
 
 <P>
 
 
 <P>
 
-Browsers must be individually configured to use <B>Privoxy</B> 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:  <B>Edit</B>;
-<B>Preferences</B>;  <B>Advanced</B>;
-<B>Proxies</B>;  <B>Manual Proxy Configuration</B>;
-<B>View</B>. 
-<P>
-
-For Firefox, go through: <B>Tools</B>; 
+Browsers can either be individually configured to use
+<B>Privoxy</B> as a HTTP proxy (recommended),
+or <B>Privoxy</B> can be combined with a packet
+filter to build an intercepting proxy
+(see <I>config</I>).  The default setting is  for
+localhost,  on port  8118 (configurable in the main config file).  To set the
+HTTP proxy in Firefox, go through: <B>Tools</B>; 
 <B>Options</B>; <B>General</B>;
 <B>Connection Settings</B>;
 <B>Manual Proxy Configuration</B>. 
 <B>Options</B>; <B>General</B>;
 <B>Connection Settings</B>;
 <B>Manual Proxy Configuration</B>. 
@@ -114,12 +116,12 @@ 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>,
 
 <B>Privoxy</B> can be configured with the various configuration
 files. The default configuration files are: <I>config</I>,
-<I>default.filter</I>, and
+<I>default.filter</I>, <I>default.action</I> and
 <I>default.action</I>. <I>user.action</I> should 
 <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
+be used for locally defined exceptions to the default rules in
+<I>match-all.action</I> and <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>
 
 <I>/etc/privoxy/</I> by default. 
 <P>
 
@@ -133,7 +135,8 @@ that the user has greatly enhanced control and freedom.
 <P>
 
 The actions list (ad blocks, etc) can also be configured with your
 <P>
 
 The actions list (ad blocks, etc) can also be configured with your
-web browser at <A HREF="http://config.privoxy.org/">http://config.privoxy.org/.</A>
+web browser at <A HREF="http://config.privoxy.org/">http://config.privoxy.org/</A> 
+(assuming the configuration allows it).
 <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, and does not require Internet access.
 <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, and does not require Internet access.
@@ -143,151 +146,6 @@ 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">&nbsp;</A>
 explanation of installation, general usage, all configuration options, new
 features and notes on upgrading.
 <A NAME="lbAH">&nbsp;</A>
-<H2>SAMPLE CONFIGURATION</H2>
-
-<P>
-
-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 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
-
- ## 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
-
- # 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 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 &quot;fragile&quot; 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 full explanations of the above syntax, and other <B>Privoxy</B>
-configuration options.
-<A NAME="lbAI">&nbsp;</A>
 <H2>FILES</H2>
 
 <P>
 <H2>FILES</H2>
 
 <P>
@@ -295,8 +153,8 @@ configuration options.
  
  <I>/usr/sbin/privoxy</I>
  <I>/etc/privoxy/config</I>
  
  <I>/usr/sbin/privoxy</I>
  <I>/etc/privoxy/config</I>
+ <I>/etc/privoxy/match-all.action</I>
  <I>/etc/privoxy/default.action</I>
  <I>/etc/privoxy/default.action</I>
- <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/user.action</I>
  <I>/etc/privoxy/default.filter</I>
  <I>/etc/privoxy/user.filter</I>
@@ -310,7 +168,7 @@ 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.
 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.
-<A NAME="lbAJ">&nbsp;</A>
+<A NAME="lbAI">&nbsp;</A>
 <H2>SIGNALS</H2>
 
 <P>
 <H2>SIGNALS</H2>
 
 <P>
@@ -322,18 +180,14 @@ rotation scripts may cause a re-opening of the logfile by sending a
 other daemons,  <B>Privoxy</B> does not need to be made aware of
 config file changes by <B>SIGHUP</B> -- it will detect them
 automatically. 
 other daemons,  <B>Privoxy</B> does not need to be made aware of
 config file changes by <B>SIGHUP</B> -- it will detect them
 automatically. 
-<A NAME="lbAK">&nbsp;</A>
+<A NAME="lbAJ">&nbsp;</A>
 <H2>NOTES</H2>
 
 <P>
 
 <H2>NOTES</H2>
 
 <P>
 
-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">&nbsp;</A>
+<A NAME="lbAK">&nbsp;</A>
 <H2>SEE ALSO</H2>
 
 <P>
 <H2>SEE ALSO</H2>
 
 <P>
@@ -349,7 +203,7 @@ the <B>Privoxy</B> Home page.
 <A HREF="http://www.privoxy.org/faq/">http://www.privoxy.org/faq/,</A> 
 the <B>Privoxy</B> FAQ. 
 <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="https://sourceforge.net/projects/ijbswa/">https://sourceforge.net/projects/ijbswa/,</A> 
 the Project Page for <B>Privoxy</B> on 
 SourceForge.
 <P>
 the Project Page for <B>Privoxy</B> on 
 SourceForge.
 <P>
@@ -357,75 +211,58 @@ SourceForge.
 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>
 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>&amp;atid=460288, to submit ``misses'' and other
+<A HREF="https://sourceforge.net/tracker/?group_id=11118">https://sourceforge.net/tracker/?group_id=11118</A>&amp;atid=460288, to submit ``misses'' and other
 configuration related suggestions to the developers. 
 <P>
 configuration related suggestions to the developers. 
 <P>
-<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://www.junkbusters.com/ijb.html">http://www.junkbusters.com/ijb.html,</A>
-the original Internet Junkbuster.
-<P>
-<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.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://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.privoxy.org/developer-manual/">http://www.privoxy.org/developer-manual/,</A> 
 the <B>Privoxy</B> developer manual. 
 <A HREF="http://www.privoxy.org/developer-manual/">http://www.privoxy.org/developer-manual/,</A> 
 the <B>Privoxy</B> developer manual. 
-<A NAME="lbAM">&nbsp;</A>
+<A NAME="lbAL">&nbsp;</A>
 <H2>DEVELOPMENT TEAM</H2>
 
 <P>
 <PRE>
 <H2>DEVELOPMENT TEAM</H2>
 
 <P>
 <PRE>
- Fabian Keil, developer
+ Fabian Keil, lead developer
  David Schmidt, developer
  David Schmidt, developer
+
  Hal Burgiss
  Hal Burgiss
- Ian Cummings
- F&#233;lix Rauch
+ Mark Miller
+ Gerry Murphy
+ Lee Rian
  Roland Rosenfeld
  Roland Rosenfeld
+ J&ouml;rg Strohmayer
 </PRE>
 
 </PRE>
 
-<A NAME="lbAN">&nbsp;</A>
+<A NAME="lbAM">&nbsp;</A>
 <H2>COPYRIGHT AND LICENSE</H2>
 
 <H2>COPYRIGHT AND LICENSE</H2>
 
-<A NAME="lbAO">&nbsp;</A>
+<A NAME="lbAN">&nbsp;</A>
 <H3>COPYRIGHT</H3>
 
 <P>
 
 <H3>COPYRIGHT</H3>
 
 <P>
 
-Copyright (C) 2001 - 2006 by Privoxy Developers &lt;<A HREF="mailto:ijbswa-developers@lists.sourceforge.net">ijbswa-developers@lists.sourceforge.net</A>&gt;
+Copyright (C) 2001-2009 by Privoxy Developers &lt;<A HREF="mailto:ijbswa-developers@lists.sourceforge.net">ijbswa-developers@lists.sourceforge.net</A>&gt;
 <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>.
 <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">&nbsp;</A>
+<A NAME="lbAO">&nbsp;</A>
 <H3>LICENSE</H3>
 
 <P>
 
 <B>Privoxy</B> is free software; you can
 redistribute it and/or modify it under the terms of the 
 <H3>LICENSE</H3>
 
 <P>
 
 <B>Privoxy</B> is free software; you can
 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.
+<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
 <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 
-<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
+FITNESS FOR A PARTICULAR PURPOSE.  See the  <I>GNU General Public License</I> for details.
 <P>
 
 <P>
 
-You should have received a copy of the  <I>GNU General Public License</I>
+You should have received a copy of the <I>GNU GPL</I>
 along with this program; if not, write to the  Free Software
 Foundation, Inc. 51 Franklin Street, Fifth Floor
 Boston, MA 02110-1301
 along with this program; if not, write to the  Free Software
 Foundation, Inc. 51 Franklin Street, Fifth Floor
 Boston, MA 02110-1301
@@ -441,22 +278,21 @@ USA
 <DT><A HREF="#lbAE">DESCRIPTION</A><DD>
 <DT><A HREF="#lbAF">INSTALLATION AND USAGE</A><DD>
 <DT><A HREF="#lbAG">CONFIGURATION</A><DD>
 <DT><A HREF="#lbAE">DESCRIPTION</A><DD>
 <DT><A HREF="#lbAF">INSTALLATION AND USAGE</A><DD>
 <DT><A HREF="#lbAG">CONFIGURATION</A><DD>
-<DT><A HREF="#lbAH">SAMPLE CONFIGURATION</A><DD>
-<DT><A HREF="#lbAI">FILES</A><DD>
-<DT><A HREF="#lbAJ">SIGNALS</A><DD>
-<DT><A HREF="#lbAK">NOTES</A><DD>
-<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>
+<DT><A HREF="#lbAH">FILES</A><DD>
+<DT><A HREF="#lbAI">SIGNALS</A><DD>
+<DT><A HREF="#lbAJ">NOTES</A><DD>
+<DT><A HREF="#lbAK">SEE ALSO</A><DD>
+<DT><A HREF="#lbAL">DEVELOPMENT TEAM</A><DD>
+<DT><A HREF="#lbAM">COPYRIGHT AND LICENSE</A><DD>
 <DL>
 <DL>
-<DT><A HREF="#lbAO">COPYRIGHT</A><DD>
-<DT><A HREF="#lbAP">LICENSE</A><DD>
+<DT><A HREF="#lbAN">COPYRIGHT</A><DD>
+<DT><A HREF="#lbAO">LICENSE</A><DD>
 </DL>
 </DL>
 <HR>
 This document was created by
 man2html,
 using the manual pages.<BR>
 </DL>
 </DL>
 <HR>
 This document was created by
 man2html,
 using the manual pages.<BR>
-Time: 01:21:32 GMT, September 22, 2006
+Time: 20:29:58 GMT, February 15, 2009
 </BODY>
 </HTML>
 </BODY>
 </HTML>