First rebuild for 3.0.18 stable
[privoxy.git] / doc / webserver / man-page / privoxy-man-page.html
index e69de29..e9e7885 100644 (file)
@@ -0,0 +1,215 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
+
+<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>