Fix sort order messed up in the previous commit.
[privoxy.git] / doc / source / faq.sgml
index 3032855..e1aae83 100644 (file)
@@ -8,8 +8,8 @@
 <!entity history SYSTEM "history.sgml">
 <!entity copyright SYSTEM "copyright.sgml">
 <!entity license SYSTEM "license.sgml">
-<!entity p-version "3.0.11">
-<!entity p-status "UNRELEASED">
+<!entity p-version "3.0.14">
+<!entity p-status "BETA">
 <!entity % p-not-stable "INCLUDE">
 <!entity % p-stable "IGNORE">
 <!entity % p-text "IGNORE">        <!-- define we are not a text only doc -->
@@ -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.48 2009/01/13 16:50:35 fabiankeil Exp $
+ $Id: faq.sgml,v 2.64 2009/07/18 12:18:52 fabiankeil Exp $
 
  Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/
  See LICENSE.
@@ -77,7 +78,7 @@
  </subscript>
 </pubdate>
 
-<pubdate>$Id: faq.sgml,v 2.48 2009/01/13 16:50:35 fabiankeil Exp $</pubdate>
+<pubdate>$Id: faq.sgml,v 2.64 2009/07/18 12:18:52 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>
+
+<para>
+ We intend to use the donations to pay for our domain after transfering
+ 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>
-</sect3>
 
+<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>
 
@@ -553,7 +580,7 @@ Include supported.sgml here:
  <quote>browser</quote> or not. Though this may not be the best approach for
  dealing with some of the common abuses of HTML in email. See <link
  linkend="outlook">How can I configure <application>Privoxy</application>
- with <application>Outlook Express</application>?</link> below for more on
+ with <application>Outlook</application>?</link> below for more on
  this. 
 </para>
 <para>
@@ -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>
@@ -1219,13 +1231,20 @@ and thus avoid individual browser configuration?</title>
 </sect2>
 
 <sect2 renderas="sect3" id="outlook">
-<title>How can I configure Privoxy for use with Outlook
- Express?</title>
+<title>How can I configure Privoxy for use with Outlook?</title>
+<para>
+ Versions of <application>Outlook</application> prior to Office 2007, use
+ <application>Internet Explorer</application> components to both render HTML,
+ and fetch any HTTP requests that may be embedded in an HTML email. So however
+ you have <application>Privoxy</application> configured to work with IE, this
+ configuration should automatically be shared, at least with older version of
+ Internet Explorer.
+</para>
 <para>
- <application>Outlook Express</application> uses <application>Internet Explorer</application> 
- components to both render HTML, and fetch any HTTP requests that may be embedded in an HTML email.
- So however you have <application>Privoxy</application> configured to work
- with IE, this configuration should automatically be shared.
+ Starting with Office 2007, Microsoft is instead using the MS-Word rendering
+ engine with Outlook. It is unknown whether this can be configured to use a
+ proxy.
+ <!-- FIXME HB 2009-02-15 -->
 </para>
 </sect2>
 
@@ -1760,7 +1779,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>
@@ -2772,6 +2791,64 @@ browsing has slowed to a crawl. What gives? </title>
 ]]>
 </screen>
 </para>
+<para>
+ Additionally you have to configure your browser to contact
+ <quote>127.0.0.1:0</quote> directly (instead of through &my-app;).
+</para>
+<para>
+ To add a proxy exception in <application>Mozilla Firefox</application>
+ open the <quote>Preferences</quote>, click the <quote>Settings</quote>
+ button located on the <quote>Network</quote> tab in the <quote>Advanced</quote>
+ section, and add <quote>127.0.0.1:0</quote> in the <quote>No Proxy for:</quote>
+ field.
+</para>
+</sect2>
+
+
+<sect2 renderas="sect3" id="se-linux">
+<title>I get selinux error messages. How can I fix this?</title>
+<para>
+ Please report the problem to the creator of your selinux policies.
+</para>
+<para>
+ The problem is that some selinux policy writers aren't familiar
+ with the application they are trying to <quote>secure</quote> and
+ thus create policies that make no sense.
+</para>
+<para>
+ In <application>Privoxy's</application> case the problem usually
+ is that the policy only allows outgoing connections for certain
+ destination ports (e.g. 80 and 443). While this may cover the
+ standard ports, websites occasionally use other ports as well.
+ This isn't a security problem and therefore <application>Privoxy's</application>
+ default configuration doesn't block these requests.
+</para>
+<para>
+ If you really want to block these ports (and don't be able
+ to load websites that don't use standard ports), you should
+ configure Privoxy to block these ports as well, so it doesn't
+ trigger the selinux warnings.
+</para>
+</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>
 
 
@@ -2853,6 +2930,61 @@ 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.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.
+
+Revision 2.52  2009/02/14 10:27:52  fabiankeil
+Finish last paragraph in the selinux entry which
+I unintentionally committed with the last commit.
+
+Revision 2.51  2009/02/12 16:08:26  fabiankeil
+Declare the code stable.
+
+Revision 2.50  2009/02/11 18:13:36  fabiankeil
+State the obvious.
+
+Revision 2.49  2009/02/10 16:30:20  fabiankeil
+Add a workaround for "unauthenticated content" warnings on HTTPS sites.
+
 Revision 2.48  2009/01/13 16:50:35  fabiankeil
 The standard.action file is gone.