Regenerate HTML docs with recent changes
[privoxy.git] / doc / webserver / man-page / privoxy-man-page.html
index 167822e..8d118f5 100644 (file)
-<html><head><title>Privoxy Man page</title><link rel="stylesheet" type="text/css" href="../p_web.css"></head><body><H2>NAME</H2>
-<PRE>
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
+<html>
+<head>
+  <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 -->
-       <B>privoxy</B> - Privacy enhancing Proxy
 
+</pre>
+  <h2>SYNOPSIS</h2>
+  <pre>
+       <b>privoxy</b> [<b>--chroot</b> ] [<b>--config-test</b> ] [<b>--help</b> ] [<b>--no-daemon</b> ]
+       [<b>--pidfile</b> <i>pidfile</i> ] [<b>--pre-chroot-nslookup</b> <i>hostname</i> ] [<b>--user</b>
+       <i>user[.group]</i> ] [<b>--version</b> ] [<i>configfile</i> ]
 
-</PRE>
-<H2>SYNOPSIS</H2><PRE>
-       <B>privoxy</B> [--help] [--version] [--no-daemon] [--pidfile <I>pid­</I>
-       <I>file</I>] [--user <I>user</I>[.<I>group</I>]] <I>[configfile]</I> (Unix)
 
-       <B>privoxy.exe</B> <I>[configfile]</I> (Windows)
 
+</pre>
+  <h2>OPTIONS</h2>
+  <pre>
+       <b>Privoxy</b> may be invoked with the following command line options:
 
+       <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
+              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.
 
-</PRE>
-<H2>OPTIONS</H2><PRE>
-       <B>Privoxy</B> may be invoked  with  the  following  command-line
-       options:
+       <b>--config-test</b>
+              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.
 
-       <B>--version</B> (unix only)
-              Print version info and exit.
+              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).
 
-       <B>--help</B> (unix only)
-              Print a short usage info and exit.
+              This option doesn't affect the log setting, combination with
+              "--no-daemon" is recommended if a configured log file shouldn't
+              be used.
 
-       <B>--no-daemon</B> (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.
+       <b>--help</b> Print brief usage info and exit.
 
-        <B>--pidfile</B> <I>pidfile</I> (unix only)
-              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.
+       <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
+              logging there.
 
-        <B>--user</B> <I>user</I>[.<I>group</I>] (unix only)
-              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>--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>--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 <B>config</B> in the current
-       directory (except on Win32 where it will try  <B>config.txt</B>).
+       <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
 
+       individual needs and tastes.  It has application for both stand-alone
+       systems and multi-user networks.
 
+       Privoxy is Free Software and licensed under the GNU GPLv2.
 
+       Privoxy is an associated project of Software in the Public Interest
+       (SPI).
 
-</PRE>
-<H2>DESCRIPTION</H2><PRE>
-       <B>Privoxy</B>  is  a web proxy with advanced filtering capabili­
-       ties 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 cus­
-       tomized to suit individual needs and tastes.  <B>Privoxy</B>  has
-       application  for  both  stand-alone systems and multi-user
-       <B>Junkbuster</B>  was originally written by JunkBusters Corpora­
-       tion, 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.
+       Helping hands and donations are welcome:
 
+       â€¢ https://www.privoxy.org/faq/general.html#PARTICIPATE
 
+       â€¢ https://www.privoxy.org/faq/general.html#DONATE
 
-</PRE>
-<H2>INSTALLATION AND USE</H2><PRE>
-       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</B>  <B>Proxy</B>  <B>Configura­</B>
-       <B>tion</B>; <B>View</B>.
 
-       For Internet Explorer, go through: <B>Tools</B>; <B>Internet</B> <B>Proper­</B>
-       <B>ties</B>; <B>Connections</B>; <B>LAN</B> <B>Settings</B>.
-
-       The Secure (SSL) Proxy should also be set to the same val­
-       ues, otherwise <B>https:</B> URLs will not be proxied.
-
-       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.action</I>,  and  <I>default.filter</I>.  These are well com­
-       mented.  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>  exe­
-       cutable.
-
-       The  name  and  number  of configuration files has changed
-       from previous versions, and is subject to change as devel­
-       opment  progresses.  In  fact, the configuration itself is
-       changed and much more sophisticated. See  the  user-manual
-       for a brief explanation of all configuration options.
-
-       The  actions  list (ad blocks, etc) can also be configured
-       with your web  browser  at  <I>http://www.privoxy.org/config</I>.
-       <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.
-
-
-
-</PRE>
-<H2>SAMPLE CONFIGURATION</H2><PRE>
-       A  brief  example  of  what a <I>default.action</I> configuration
-       might look like:
-
-
-       # Define a few useful custom aliases for later use
-       {{alias}}
-       +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
-
-        .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
-
-
-
-       See the comments in the configuration files themselves, or
-       the  user-manual for explanations of the above syntax, and
-       other <B>Privoxy</B> configuration options.
-
-
-
-</PRE>
-<H2>FILES</H2><PRE>
-       <I>/usr/sbin/privoxy</I>
-       <I>/etc/privoxy/config</I>
-       <I>/etc/privoxy/default.action</I>
-       <I>/etc/privoxy/advanced.action</I>
-       <I>/etc/privoxy/basic.action</I>
-       <I>/etc/privoxy/intermediate.action</I>
-       <I>/etc/privoxy/default.filter</I>
-       <I>/etc/privoxy/trust</I>
-       <I>/etc/privoxy/templates/*</I>
-       <I>/var/log/privoxy/logfile</I>
-
-
-       mentation should be included in  the  local  documentation
-       directory, though is not complete at this time.
-
-
-
-</PRE>
-<H2>SIGNALS</H2><PRE>
-       <B>Privoxy</B> terminates on the <B>SIGINT</B>, <B>SIGTERM</B> and <B>SIGABRT</B> sig­
-       nals. 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 auto­
-       matically.
-
-
-
-</PRE>
-<H2>NOTES</H2><PRE>
-       This is a <B>BETA</B> version of <B>Privoxy</B>. Not  all  features  are
-       well tested.
-
-       Please see the user-maual on how to contact the developers
-       for feature requests, reporting problems, and other  ques­
-       tions.
-
-
-
-</PRE>
-<H2>BUGS</H2><PRE>
-       Probably.  Please see the user-manual for how and where to
-       report bugs.
-
-
-
-</PRE>
-<H2>SEE ALSO</H2><PRE>
-       http://www.privoxy.org/
-       http://config.privoxy.org/
-       http://www.privoxy.org/faq/
-       http://www.privoxy.org/user-manual/
-       http://www.privoxy.org/developer-manual/
-       http://sourceforge.net/projects/ijbswa  (Privoxy   Project
-       Page)
-       http://www.waldherr.org/junkbuster/
-       http://www.junkbusters.com/ht/en/cookies.html
-       http://privacy.net/analyze/
-       http://www.squid-cache.org/
-       http://linuxalpha.ch/steudten/software/
-
-
-
-</PRE>
-<H2>DEVELOPMENT TEAM</H2><PRE>
-        Stefan Waldherr
-        Andreas Oesterhelt
-        Jon Foster
-        Markus Breitenbach
-        Thomas Steudten
-        David Schmidt
-        Haroon Rafique
-        Joerg Strohmayer
-        Shamim Mohamed
-        John Venvertloh
-        Hal Burgiss
-        Rodrigo Barbosa
-        Gábor Lipták
-
-
-
-</PRE>
-<H2>COPYRIGHT AND LICENSE</H2><PRE>
-       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.
-
-       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.
-
-       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
-
-       Internet Junkbuster Proxy is a  trademark  of  Junkbusters
-       Corporation.
+</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>Connections</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
+        <i>/etc/privoxy/user.filter</i>
+        <i>/etc/privoxy/trust</i>
+        <i>/etc/privoxy/templates/*</i>
+        <i>/var/log/privoxy/logfile</i>
 
+       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.
 
 
+</pre>
+  <h2>SIGNALS</h2>
+  <pre>
+       <b>Privoxy</b> terminates on the <b>SIGINT</b> and <b>SIGTERM</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. Signals other than the ones listed above aren't
+       explicitly handled and result in the default action defined by the
+       operating system.
 
 
+</pre>
+  <h2>NOTES</h2>
+  <pre>
+       Please see the <i>User</i> <i>Manual</i> on how to contact the developers, for
+       feature requests, reporting problems, and other questions.
 
 
+</pre>
+  <h2>SEE ALSO</h2>
+  <pre>
+       Other references and sites of interest to <b>Privoxy</b> users:
 
+       https://www.privoxy.org/, the <b>Privoxy</b> Home page.
 
+       https://www.privoxy.org/faq/, the <b>Privoxy</b> FAQ.
 
+       https://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
+       developers.
 
 
+</pre>
+  <h2>DEVELOPMENT TEAM</h2>
+  <pre>
+        Fabian Keil, lead developer
+        David Schmidt
+        Hal Burgiss
+        Lee Rian
+        Roland Rosenfeld
+        Ian Silvester
 
+       <b>Privoxy</b> 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>license</i> for details.
 
 
 
-</PRE>
-</body></html>
+Privoxy 3.0.26                  29 August 2016                      <b>PRIVOXY(1)</b>
+</pre>
+</body>
+</html>