#94: Add a config directive to let Privoxy prefer either IPv4 (or IPv6) addresses
[privoxy.git] / doc / source / faq.sgml
index 896704b..f99c085 100644 (file)
@@ -8,7 +8,7 @@
 <!entity history SYSTEM "history.sgml">
 <!entity copyright SYSTEM "copyright.sgml">
 <!entity license SYSTEM "license.sgml">
-<!entity p-version "3.0.11">
+<!entity p-version "3.0.17">
 <!entity p-status "stable">
 <!entity % p-not-stable "IGNORE">
 <!entity % p-stable "INCLUDE">
@@ -17,6 +17,7 @@
 <!entity % p-supp-userman "INCLUDE"> <!-- Include all from supported.sgml -->
 <!entity  my-copy "&copy;">          <!-- kludge for docbook2man          -->
 <!entity % p-newstuff "INCLUDE">      <!-- exclude stuff from devel versions -->
+<!entity % seealso-extra "INCLUDE"> <!-- extra stuff from seealso.sgml    -->
 <!entity  my-app "<application>Privoxy</application>">
 ]>
 <!--
@@ -26,7 +27,7 @@
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
                 
- $Id: faq.sgml,v 2.53 2009/02/15 20:46:13 hal9 Exp $
+ $Id: faq.sgml,v 2.77 2011/03/03 14:22:12 fabiankeil Exp $
 
  Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/
  See LICENSE.
  <subscript>
 <!-- Completely the wrong markup, but very little is allowed  -->
 <!-- in this part of an article. FIXME -->
- <link linkend="copyright">Copyright</link> &my-copy; 2001-2009 by 
+ <link linkend="copyright">Copyright</link> &my-copy; 2001-2010 by
  <ulink url="http://www.privoxy.org/">Privoxy Developers</ulink>
  </subscript>
 </pubdate>
 
-<pubdate>$Id: faq.sgml,v 2.53 2009/02/15 20:46:13 hal9 Exp $</pubdate>
+<pubdate>$Id: faq.sgml,v 2.77 2011/03/03 14:22:12 fabiankeil Exp $</pubdate>
 
 <!--
 
@@ -463,9 +464,9 @@ warranty? Registration?</title>
 </para>
 </sect2>
 
-<sect2 renderas="sect3" id="jointeam"><title>I would like to help you, what can I do?</title>
+<sect2 renderas="sect3" id="help-the-developers"><title id="jointeam">I would like to help you, what can I do?</title>
 
-<sect3 renderas="sect4" id="jointeam-work"><title>Would you like to participate?</title>
+<sect3 renderas="sect4" id="participate"><title id="jointeam-work">Would you like to participate?</title>
 <para>
    Well, we <emphasis>always</emphasis> need help. There is something for
    everybody who wants to help us. We welcome new developers, packagers,
@@ -474,44 +475,70 @@ warranty? Registration?</title>
    <quote>programmer</quote>. There are many other tasks available. In fact,
    the programmers often can't spend as much time programming because of some
    of the other, more mundane things that need to be done, like checking the
-   Tracker feedback sections. 
+   Tracker feedback sections or responding to user questions on the mailing
+   lists.
  </para>
  <para>
-  So first thing, <ulink
-   url="https://sourceforge.net/account/register.php">get an account on SourceForge.net</ulink>
-   and mail your id to the <ulink url="mailto:ijbswa-developers@lists.sourceforge.net">developers
-   mailing list</ulink>. Then, please read the <ulink
-   url="../developer-manual/index.html">Developer's Manual</ulink>, at least
-   the pertinent sections.
-</para>
+  So first thing, subscribe to the <ulink
+   url="https://lists.sourceforge.net/lists/listinfo/ijbswa-users">Privoxy Users</ulink>
+  or the <ulink url="https://lists.sourceforge.net/lists/listinfo/ijbswa-developers">Privoxy
+  Developers</ulink> mailing list, join the discussion, help out other users, provide general
+  feedback or report problems you noticed.
+ </para>
  <para>
-  You can also start helping out without SourceForge.net account,
-  simply by showing up on the mailing list, helping out other users,
-  providing general feedback or reporting problems you noticed.
+  If you intend to help out with the trackers, you also might want to <ulink
+   url="https://sourceforge.net/account/register.php">get an account on SourceForge.net</ulink>
+   so we don't confuse you with the other name-less users.
  </para>
+ <para>
+   We also have a <ulink
+   url="../developer-manual/index.html">Developer's Manual</ulink>.
+   While it is partly out of date, it's still worth reading.
+</para>
+<para>
+   Our <ulink url="http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/current/TODO?view=markup">TODO list</ulink>
+   may be of interest to you as well.
+   Please let us know if you want to work on one of the items listed.
+</para>
 </sect3>
 
-<sect3 renderas="sect4" id="jointeam-money"><title>Contribute!</title>
+<sect3 renderas="sect4" id="donate"><title>Would you like to donate?</title>
 <para>
- We, of course, welcome donations and could use money for domain registering,
- buying software to test <application>Privoxy</application> with, and, of course,
- for regular world-wide get-togethers (hahaha). If you enjoy the software and feel
- like helping us with a donation, just <ulink
- url="mailto: ijbswa-developers@lists.sourceforge.net">drop us a note</ulink>
- and get your name on the list of contributors.
+ <application>Privoxy</application> is developed by unpaid volunteers
+ and thus our current running costs are pretty low. Nevertheless, we
+ have plans that will cost money in the future. We would like to get
+ this money through donations made by our users.
 </para>
-</sect3>
 
-<sect3 renderas="sect4" id="jointeam-software"><title>Software</title>
 <para>
- If you are a vendor of a web-related software like a browser, web server
- or proxy, and would like us to ensure that <application>Privoxy</application>
- runs smoothly with your product, you might consider supplying us with a
- copy or license. We can't, however, guarantee that we will fix all potential
- compatibility issues as a result.
+ <application>Privoxy</application> has therefore become an associated
+ project of <ulink url="http://www.spi-inc.org/about-spi/about-spi">Software
+ in the Public Interest (SPI)</ulink>, which allows us to receive tax-deductible
+ donations in most western countries.
 </para>
-</sect3>
 
+<para>
+ We intend to use the donations to pay for our domain after transferring
+ it to SPI. Our goal is to make sure there's no single point of failure
+ and the bill gets paid and the site keeps running even if a some of
+ the currently active developers were to suddenly disappear for a while.
+</para>
+
+<para>
+ We would also like to spend some money on more reliable hosting,
+ on hardware to help make sure <application>Privoxy</application>
+ keeps running on platforms the developers currently can't test on,
+ and on technical books to educate our developers about said platforms
+ or to improve their knowledge in general.
+</para>
+
+<para>
+ If you enjoy our software and feel like helping out with a donation,
+ please have a look at
+ <ulink url="http://www.spi-inc.org/donations">SPI's donation page</ulink>
+ to see what the options are.
+</para>
+</sect3>
 
 </sect2>
 
@@ -781,23 +808,8 @@ way to do this?</title>
 <title>There are several different <quote>actions</quote> files. What are
 the differences?</title>
 <para>
- Three actions files 
- are being included by the developers, to be used for 
- different purposes: These are 
- <filename>default.action</filename>, the <quote>main</quote> actions file
- which is actively maintained by the <application>Privoxy</application>
- developers and typically sets the default policies, <filename>user.action</filename>,
- where users are encouraged to make their private customizations.
- Please see <ulink url="../user-manual/actions-file.html">the actions chapter</ulink>
- in the <ulink url="../user-manual/index.html">User Manual</ulink> for a more
- detailed explanation.
-</para>
-
-<para>
- Earlier versions included three different versions of the 
- <filename>default.action</filename> file. The new scheme allows for 
- greater flexibility of local configuration, and for browser based 
- selection of pre-defined <quote>aggressiveness</quote> levels.
+ Please have a look at the <ulink url="../user-manual/actions-file.html">the actions chapter</ulink>
+ in the <ulink url="../user-manual/index.html">User Manual</ulink> for a detailed explanation.
 </para>
 
 </sect2>
@@ -936,7 +948,7 @@ with a browser? Does that not raise security issues?</title>
  <para>
   If you run <application>Privoxy</application> for multiple untrusted users (e.g. in
   a LAN) or aren't entirely in control of your own browser, you will probably want
-  to make sure that the the web-based editor and remote toggle features are
+  to make sure that the web-based editor and remote toggle features are
   <quote>off</quote> by setting <quote><literal><ulink
   url="../user-manual/config.html#ENABLE-EDIT-ACTIONS">enable-edit-actions</ulink>
   0</literal></quote> and <quote><literal><ulink
@@ -966,7 +978,7 @@ with a browser? Does that not raise security issues?</title>
  <ulink
  url="../user-manual/actions-file.html#FILTER"><literal>filter</literal>
  action</ulink> in one of the actions files. Content filtering is automatically
- disabled for inappropriate MIME types, but if you now better than Privoxy
+ disabled for inappropriate MIME types, but if you know better than Privoxy
  what should or should not be filtered you can filter any content you like.
 </para>
 <para>
@@ -1153,17 +1165,17 @@ on Win2K/NT/XP?</title>
 
 
 <sect2 renderas="sect3" id="otherproxy">
-<title>How can I make Privoxy work with other 
-proxies like Squid or Tor?</title>
+<title>How can I make Privoxy work with other proxies?</title>
 <para>
  This can be done and is often useful to combine the benefits of
- <application>Privoxy</application> with those of a another proxy.
+ <application>Privoxy</application> with those of a another proxy,
+ for example to cache content.
  See the <ulink
  url="../user-manual/config.html#FORWARDING">forwarding chapter</ulink>
  in the <ulink url="../user-manual/index.html">User Manual</ulink> which
- describes how to do this, and the <link linkend="TOR">
- How do I use Privoxy together with 
Tor</link> section below.
+ describes how to do this. If you intend to use Privoxy with Tor,
+ please also have a look at
<link linkend="TOR">How do I use Privoxy together with Tor</link>.
 </para>
 </sect2>
 
@@ -1173,7 +1185,8 @@ and thus avoid individual browser configuration?</title>
 
 <para>
  No, its more complicated than that. This only works with special kinds 
- of proxies known as <quote>intercepting</quote> proxies (see below).
+ of proxies known as <quote>intercepting</quote> proxies
+ (<link linkend="INTERCEPTING">see below</link>).
 </para>
 
 </sect2>
@@ -1190,7 +1203,7 @@ and thus avoid individual browser configuration?</title>
 <para>
  However, some people say <quote>transparent proxy</quote> when they
  mean <quote>intercepting proxy</quote>. If you are one of them,
- please read the <ulink url="#intercepting">next entry</ulink>.
+ please read the <link linkend="INTERCEPTING">next entry</link>.
 </para>
 
 </sect2>
@@ -1750,9 +1763,11 @@ us help you. Your efforts are not wasted, and we do appreciate them.
  If you verified that <application>Privoxy</application> and <application>Tor</application>
  are working, it is time to connect them. As far as <application>Privoxy</application>
  is concerned, <application>Tor</application> is just another proxy that can be reached
- by socks4 or socks4a. Most likely you are interested in <application>Tor</application>
- to increase your anonymity level, therefore you should use socks4a, to make sure DNS requests are
- done through <application>Tor</application> and thus invisible to your local network.
+ by socks4, socks4a and socks5. Most likely you are interested in <application>Tor</application>
+ to increase your anonymity level, therefore you should use socks5, to make sure DNS
+ requests are done through <application>Tor</application> and thus invisible to your
+ local network. Using socks4a would work too, but with socks5 you get more precise error
+ messages.
 </para>
 
 <![%p-newstuff;[
@@ -1767,7 +1782,7 @@ us help you. Your efforts are not wasted, and we do appreciate them.
 </para>
 <para>
  <screen>
-#        forward-socks4a             /     127.0.0.1:9050 .
+#        forward-socks5             /     127.0.0.1:9050 .
  </screen>
 </para>
 <para>
@@ -2182,6 +2197,42 @@ and related issues?</title>
 </para>
 </sect2>
 
+<sect2 renderas="sect3" id="surprise-privoxy">
+<title>How did you manage to get Privoxy on my computer without my consent?</title>
+
+<para>
+ We didn't. We make Privoxy available for download, but we don't go
+ around installing it on other people's systems behind their back.
+ If you discover Privoxy running on your system and are sure you didn't
+ install it yourself, somebody else did. You may not even be running
+ the real Privoxy, but maybe something else that only pretends to be
+ Privoxy, or maybe something that is based on the real Privoxy,
+ but has been modified.
+</para>
+<para>
+ Lately there have been reports of problems with some kind of
+ Privoxy versions that come preinstalled on some Netbooks.
+ Some of the problems described are inconsistent with the behaviour
+ of official Privoxy versions, which suggests that the preinstalled
+ software may contain vendor modifications that we don't know about
+ and thus can't debug.
+</para>
+<para>
+ Privoxy's <link linkend="copyright">license</link> allows vendor
+ modifications, but the vendor has to comply with the license,
+ which involves informing the user about the changes and to make
+ the changes available under the same license as Privoxy itself.
+</para>
+<para>
+ If you are having trouble with a modified Privoxy version,
+ please try to talk to whoever made the modifications before
+ reporting the problem to us. Please also try to convince
+ whoever made the modifications to talk to us.  If you think
+ somebody gave you a modified Privoxy version without complying
+ to the license, please let us know.
+</para>
+</sect2>
+
 
 </sect1>
 
@@ -2820,6 +2871,26 @@ browsing has slowed to a crawl. What gives? </title>
 </sect2>
 
 
+<sect2 renderas="sect3" id="gentoo-ricers">
+<title>I compiled &my-app; with Gentoo's portage and it appears to be very slow. Why?</title>
+<para>
+ Probably you unintentionally compiled &my-app; without threading support
+ in which case requests have to be serialized and only one can be served
+ at the same time.
+</para>
+<para>
+ Check your <quote>USE</quote> flags and make sure they include
+ <quote>threads</quote>. If they don't, add the flag and rebuild &my-app;.
+</para>
+<para>
+ If you compiled &my-app; with threading support (on POSIX-based systems),
+ the <quote>Conditional #defines</quote> section on <ulink
+ url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
+ will list <quote>FEATURE_PTHREAD</quote> as <quote>enabled</quote>. 
+</para>
+</sect2>
+
+
 </sect1>
 
   <!--   ~~~~~       New section      ~~~~~     -->
@@ -2898,6 +2969,90 @@ browsing has slowed to a crawl. What gives? </title>
  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 
 $Log: faq.sgml,v $
+Revision 2.77  2011/03/03 14:22:12  fabiankeil
+Remove duplicated 'the'
+
+Revision 2.76  2010/11/22 10:35:02  fabiankeil
+Mention socks5 in another part of the Tor section.
+
+Revision 2.75  2010/11/13 10:08:00  fabiankeil
+Fix a link to the 'intercepting' entry and add another one
+
+Revision 2.74  2010/11/13 10:07:46  fabiankeil
+Remove the product names in the 'otherproxy' entry's title.
+
+I'm tired of getting the 'otherproxy' entry as first hit
+when searching the index for the Tor FAQ.
+
+Revision 2.73  2010/11/06 12:55:48  fabiankeil
+Set p-version to 3.0.17
+
+Revision 2.72  2010/02/27 12:13:17  fabiankeil
+Fix spelling.
+
+Revision 2.71  2010/02/27 12:12:13  fabiankeil
+Consistently recommending socks5 in the Tor entry and mention its advantage compared to socks4a.
+Reported by David in #2960129.
+
+Revision 2.70  2010/02/20 18:08:31  ler762
+fix typo
+
+Revision 2.69  2010/02/13 17:38:27  fabiankeil
+Update entities for 3.0.16 stable.
+
+Revision 2.68  2010/01/30 19:51:28  fabiankeil
+New FAQ entry: How did you manage to get Privoxy on my computer without my consent?
+
+Also bump copyright.
+
+Revision 2.67  2009/11/15 14:24:12  fabiankeil
+Prepare to generate docs for 3.0.16 UNRELEASED.
+
+Revision 2.66  2009/10/10 05:48:55  fabiankeil
+Prepare for 3.0.15 beta.
+
+Revision 2.65  2009/07/18 16:24:39  fabiankeil
+Bump entities for 3.0.14 beta.
+
+Revision 2.64  2009/07/18 12:18:52  fabiankeil
+Don't describe the action files in the FAQ when we can simply link to the description in the User Manual.
+
+Revision 2.63  2009/06/15 15:08:03  fabiankeil
+Patch #2806626 from Frédéric Crozat to fix a closing tag.
+
+Revision 2.62  2009/06/12 14:30:58  fabiankeil
+Update entities for 3.0.13 beta.
+
+Revision 2.61  2009/06/12 11:52:33  fabiankeil
+Mention the TODO list in the participate entry.
+
+Revision 2.60  2009/04/07 12:25:05  fabiankeil
+In the "I would like to help ..." entry:
+- Change the ids to more general ones as helping out doesn't require
+  joining the team (and joining the team requires significantly helping
+  out first, anyway).
+- Add links to the subscription pages for the main mailing lists.
+
+Revision 2.59  2009/03/28 15:33:41  fabiankeil
+Recommend the use of forward-socks5 when forwarding to Tor.
+The error messages are more detailed than with forward-socks4a.
+
+Revision 2.58  2009/03/21 12:27:44  fabiankeil
+Turn the donation entry title into a question,
+also rephrase the content a bit.
+
+Revision 2.57  2009/03/19 19:07:49  fabiankeil
+First draft of a "Donating" entry. To be polished tomorrow.
+
+Revision 2.56  2009/02/19 17:05:05  fabiankeil
+Explain slowness when build with Gentoo's portage.
+
+Revision 2.55  2009/02/19 02:20:21  hal9
+Make some links in seealso conditional. Man page is now privoxy only links.
+
+Revision 2.54  2009/02/15 20:47:12  hal9
+Fix small typo.
+
 Revision 2.53  2009/02/15 20:46:13  hal9
 Update Outlook HTML rendering engine comments re: Office 2007.