First rebuild for 3.0.18 stable
[privoxy.git] / doc / webserver / man-page / privoxy-man-page.html
index 1548d07..e9e7885 100644 (file)
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 
-<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: 24 April 2002<BR><A HREF="#index">Index</A>
-<HR>
-
-<A NAME="lbAB">&nbsp;</A>
-<H2>NAME</H2>
-
-privoxy - Privacy Enhancing Proxy
-<A NAME="lbAC">&nbsp;</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>
-<P>
-<A NAME="lbAD">&nbsp;</A>
-<H2>OPTIONS</H2>
-
-<P>
-
-<B>Privoxy</B> may be invoked with the following command line
-options:
-<DL COMPACT>
-<DT><B>--help</B><DD>
-Print brief usage info and exit.
-<DT><B>--version</B><DD>
-Print version info and exit.
-<DT><B>--no-daemon</B><DD>
-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.
-<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>
-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>user</I> and the GID of
-<I>group</I>, or, if the optional
-<I>group</I> was not given, the default group of
-<I>user</I>. Exit if the privileges are not
-sufficient to do so.
-</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>configfile</I> is found, <B>Privoxy</B> will 
-fail to start.
-<A NAME="lbAE">&nbsp;</A>
-<H2>DESCRIPTION</H2>
-
-<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.
-<P>
-
-<B>Privoxy</B> is based on <B>Internet
-Junkbuster</B> (tm).
-<A NAME="lbAF">&nbsp;</A>
-<H2>INSTALLATION AND USAGE</H2>
-
-<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 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. 
-<P>
-
-For other browsers, check the documentation.
-<A NAME="lbAG">&nbsp;</A>
-<H2>CONFIGURATION</H2>
-
-<P>
-
-<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.
-<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. 
-<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>
-<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.
-<A NAME="lbAH">&nbsp;</A>
-<H2>SAMPLE CONFIGURATION</H2>
-
-<P>
-
-A brief example of what a <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
-
- # 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
-
- # 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 
-
- # Make exceptions for these harmless ones that would be 
- # caught by +block.
- {-block}
- include.ebay.com
- adsl.
- advice.
- .edu
- .ac.uk
- .uni-*.de
- .*downloads.
-</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>
-configuration options.
-<A NAME="lbAI">&nbsp;</A>
-<H2>FILES</H2>
-
-<P>
-<PRE>
- <I>/usr/sbin/privoxy</I>
- <I>/etc/privoxy/config</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/trust</I>
- <I>/etc/privoxy/templates/*</I>
- <I>/var/log/privoxy/logfile</I>
-</PRE>
-
-<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.
-<A NAME="lbAJ">&nbsp;</A>
-<H2>SIGNALS</H2>
-
-<P>
-
-<B>Privoxy</B> terminates on the <B>SIGINT</B>,
-<B>SIGTERM</B> and <B>SIGABRT</B> signals. Log
-rotation scripts may cause a re-opening of the logfile by sending a 
-<B>SIGHUP</B> to <B>Privoxy</B>. Note that unlike
-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>
-<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.
-<A NAME="lbAL">&nbsp;</A>
-<H2>SEE ALSO</H2>
-
-<P>
-
-Other references and sites of interest to <B>Privoxy</B>
-users:
-<P>
-
-<P>
-<A HREF="http://www.privoxy.org/,">http://www.privoxy.org/,</A> 
-The <B>Privoxy</B> Home page. 
-<P>
-<A HREF="http://sourceforge.net/projects/ijbswa,">http://sourceforge.net/projects/ijbswa,</A> 
-the Project Page for <B>Privoxy</B> on 
-Sourceforge.
-<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.
-<P>
-<A HREF="http://p.p/">http://p.p/</A>  
-to submit ``misses'' to the developers. 
-<P>
-<A HREF="http://www.junkbusters.com/ht/en/cookies.html">http://www.junkbusters.com/ht/en/cookies.html</A>
-<P>
-<A HREF="http://www.waldherr.org/junkbuster/">http://www.waldherr.org/junkbuster/</A>
-<P>
-<A HREF="http://privacy.net/analyze/">http://privacy.net/analyze/</A>
-<P>
-<A HREF="http://www.squid-cache.org/">http://www.squid-cache.org/</A>
-<A NAME="lbAM">&nbsp;</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&#225;bor Lipt&#225;k
- Guy
- Haroon Rafique
- David Schmidt (OS/2, Mac OSX ports)
- Joerg Strohmayer
- Sarantis Paskalis
-</PRE>
-
-<A NAME="lbAN">&nbsp;</A>
-<H2>COPYRIGHT AND LICENSE</H2>
-
-<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.
-<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.
-<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.
-<P>
-
-<HR>
-<A NAME="index">&nbsp;</A><H2>Index</H2>
-<DL>
-<DT><A HREF="#lbAB">NAME</A><DD>
-<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
-<DT><A HREF="#lbAD">OPTIONS</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>
-</DL>
-<HR>
-This document was created by
-man2html,
-using the manual pages.<BR>
-Time: 23:48:45 GMT, April 24, 2002
-</BODY>
-</HTML>
+<html>
+<head>
+  <meta name="generator" content=
+  "HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org">
+
+  <title>Privoxy Man page</title>
+  <link rel="stylesheet" type="text/css" href="../p_web.css">
+</head>
+
+<body>
+  <h2>NAME</h2>
+  <pre>
+<!-- Manpage converted by man2html 3.0.1 -->
+
+</pre>
+
+  <h2>SYNOPSIS</h2>
+  <pre>
+       <b>privoxy</b>   [<b>--help</b>   ]  [<b>--version</b>   ]  [<b>--no-daemon</b>  ] [<b>--pidfile</b> <i>pidfile</i> ]
+       [<b>--user</b> <i>user[.group]</i> ] [<b>--chroot</b>    ]  [<b>--pre-chroot-nslookup</b>  <i>hostname</i>  ]
+       [<i>configfile</i> ]
+
+
+
+</pre>
+
+  <h2>OPTIONS</h2>
+  <pre>
+       <b>Privoxy</b> may be invoked with the following command line options:
+
+       <b>--help</b> Print brief usage  info and exit.
+
+       <b>--version</b>
+          Print version info and exit.
+
+       <b>--no-daemon</b>
+          Don't   become   a  daemon,  i.e.  don't fork and become process
+          group leader, don't detach from controlling tty, and do all log-
+          ging there.
+
+       <b>--pidfile</b> <i>pidfile</i>
+          On startup, write the process ID to <i>pidfile</i>.  Delete the <i>pidfile</i>
+          on exit.  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.
+
+       <b>--user</b> <i>user[.group]</i>
+          After  (optionally)  writing the PID file, assume the user ID of
+          <i>user</i> and the GID of <i>group</i>, or, if   the  optional  <i>group</i>  was  not
+          given, the default group of <i>user</i>.  Exit if the privileges are not
+          sufficient to do so.
+
+       <b>--chroot</b>
+          Before changing to the user  ID  given  in  the  --user  option,
+          chroot  to that user's home directory, i.e. make the kernel pre-
+          tend to the <b>Privoxy</b>  process  that  the  directory  tree   starts
+          there.  If set up carefully, this can limit the impact of possi-
+          ble vulnerabilities in <b>Privoxy</b> to  the files  contained  in  that
+          hierarchy.
+
+       <b>--pre-chroot-nslookup</b> <i>hostname</i>
+          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.
+
+       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>con-</i>
+       <i>figfile</i> is found, <b>Privoxy</b> will fail to start.
+
+
+</pre>
+
+  <h2>DESCRIPTION</h2>
+  <pre>
+       Privoxy is a non-caching web proxy with advanced filtering capabilities
+       for enhancing privacy, modifying web page data and HTTP  headers,  con-
+       trolling  access,  and  removing ads and other obnoxious Internet junk.
+       Privoxy has a flexible configuration and  can  be  customized  to  suit
+
+
+</pre>
+
+  <h2>INSTALLATION AND USAGE</h2>
+  <pre>
+       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</b> <b>Settings</b>; <b>Manual</b> <b>Proxy</b> <b>Configuration</b>.
+
+       For Internet Explorer, go through: <b>Tools</b>; <b>Internet</b> <b>Properties</b>;  <b>Connec-</b>
+       <b>tions</b>; <b>LAN</b> <b>Settings</b>.
+
+       The Secure (SSL) Proxy should also be set to the same values, otherwise
+       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.
+
+       For other browsers, check the documentation.
+
+
+</pre>
+
+  <h2>CONFIGURATION</h2>
+  <pre>
+       <b>Privoxy</b>   can  be  configured  with the various configuration files. The
+       default configuration files are: <i>config</i>,  <i>default.filter</i>,  <i>default.action</i>
+       and  <i>default.action</i>.  <i>user.action</i>  should  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.
+
+       <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.
+
+       The  actions list (ad blocks, etc) can also be configured with your web
+       browser  at  http://config.privoxy.org/  (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.
+
+       See the <i>User</i> <i>Manual</i> for a detailed explanation of installation, general
+       usage, all configuration options, new features and notes on  upgrading.
+
+
+</pre>
+
+  <h2>FILES</h2>
+  <pre>
+    <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/user.action</i>
+    <i>/etc/privoxy/default.filter</i>
+       detect them automatically.
+
+
+</pre>
+
+  <h2>NOTES</h2>
+  <pre>
+       This  is  a  UNRELEASED  version  of <b>Privoxy</b>. Not all features are well
+       tested.
+
+       Please see the <i>User</i> <i>Manual</i> on how to contact the   developers,  for  fea-
+       ture requests, reporting problems, and other questions.
+
+
+</pre>
+
+  <h2>SEE ALSO</h2>
+  <pre>
+       Other references and sites of interest to <b>Privoxy</b> users:
+
+
+       http://www.privoxy.org/, the <b>Privoxy</b> Home page.
+
+       http://www.privoxy.org/faq/, the <b>Privoxy</b>  FAQ.
+
+       http://www.privoxy.org/developer-manual/, the <b>Privoxy</b> developer manual.
+
+       https://sourceforge.net/projects/ijbswa/, the Project Page for  <b>Privoxy</b>
+       on SourceForge.
+
+       http://config.privoxy.org/,  the web-based user interface. <b>Privoxy</b> must
+       be running for this to work. Shortcut: http://p.p/
+
+       https://sourceforge.net/tracker/?group_id=11118&amp;atid=460288, to  submit
+       ``misses''  and other configuration related suggestions to the develop-
+       ers.
+
+
+</pre>
+
+  <h2>DEVELOPMENT TEAM</h2>
+  <pre>
+    Fabian Keil, lead developer
+    David Schmidt, developer
+
+    Hal Burgiss
+    Mark Miller
+    Gerry Murphy
+    Lee Rian
+    Roland Rosenfeld
+
+
+</pre>
+
+  <h2>COPYRIGHT AND LICENSE</h2>
+  <pre>
+   <b>COPYRIGHT</b>
+       Copyright  (C)  2001-2011  by   Privoxy   Developers   &lt;ijbswa-develop-
+       ers@lists.sourceforge.net&gt;
+
+       Some  source  code  is  based  on  code Copyright (C) 1997 by Anonymous
+       Coders and Junkbusters, Inc. and licensed under the <i>GNU</i> <i>General</i>    <i>Public</i>
+       <i>License</i>.
+
+   <b>LICENSE</b>
+       <b>Privoxy</b>   is  free  software;  you  can redistribute it and/or modify it
+       under the terms of the <i>GNU</i> <i>General</i> <i>Public</i> <i>License</i>, version 2,  as  pub-
+       lished by the Free Software Foundation.
+</pre>
+</body>
+</html>