Touch ups for name change.
[privoxy.git] / doc / source / faq.sgml
index b19a2be..bbbf493 100644 (file)
@@ -6,10 +6,10 @@
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
                 
- $Id: faq.sgml,v 1.22 2002/03/24 11:51:00 swa Exp $
+ $Id: faq.sgml,v 1.31 2002/03/26 22:29:55 swa Exp $
 
  Written by and Copyright (C) 2001 the SourceForge
- PRIVOXY team.  http://ijbswa.sourceforge.net
+ Privoxy team. http://www.privoxy.org/
 
  Based on the Internet Junkbuster originally written
  by and Copyright (C) 1997 Anonymous Coders and 
@@ -20,7 +20,7 @@
 <artheader>
 <title>Privoxy Frequently Asked Questions</title>
 
-<pubdate>$Id: faq.sgml,v 1.22 2002/03/24 11:51:00 swa Exp $</pubdate>
+<pubdate>$Id: faq.sgml,v 1.31 2002/03/26 22:29:55 swa Exp $</pubdate>
 
 <authorgroup>
  <author>
 
 <abstract>
  <para>
-The FAQ document gives users and developers alike answers to frequently asked
-questions about
-<application>Privoxy</application>. <application>Privoxy</application> 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. <application>Privoxy</application> has a very flexible configuration and
-can be customized to suit individual needs and
-tastes. <application>Privoxy</application> has application for both stand-alone
-systems and multi-user networks.
+ This FAQ gives users and developers alike answers to frequently asked
+ questions about <application>Privoxy</application>. 
  </para>
  <para>
-You can find the latest version of the document at <ulink url="http://ijbswa.sourceforge.net/faq/">http://ijbswa.sourceforge.net/faq/</ulink>.
+ <application>Privoxy</application> 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. <application>Privoxy</application> has a very
+ flexible configuration and can be customized to suit individual needs and
+ tastes. <application>Privoxy</application> has application for both
+ stand-alone systems and multi-user networks.
+</para>
+<para>
+ <application>Privoxy</application> is based on the code of the 
+ <application>Internet Junkbuster</application>.
+ <application>Junkbuster</application> was originally written by JunkBusters
+ Corporation, 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.
+</para>
+
+
+ <para>
+You can find the latest version of the document at <ulink url="http://www.privoxy.org/faq/">http://www.privoxy.org/faq/</ulink>.
 Please see the Contact section in the 
-<ulink url="http://ijbswa.sourceforge.net/user-manual/contact.html">user-manual</ulink> if you want to contact the developers.
+<ulink url="http://www.privoxy.org/user-manual/contact.html">user-manual</ulink> if you want to contact the developers.
  </para>
 
 <!--   <para> -->
@@ -76,7 +87,7 @@ Please see the Contact section in the
 <sect3 id="newjb"><title>What is this new version of <application>Privoxy</application>?</title>
  <para>
   The original <application>Internet Junkbuster</application> (tm) is a 
-  coyrighted product of <ulink url="http://www.junkbusters.com">Junkbusters
+  copyrighted product of <ulink url="http://www.junkbusters.com">Junkbusters
   Corporation</ulink>. Development of this effort stopped some time ago as of
   version 2.0.2. Stefan Waldherr started the ijbswa project on <ulink
   url="http://ijbswa.sourceforge.net">Sourceforge</ulink> to rekindle
@@ -85,11 +96,35 @@ Please see the Contact section in the
  </para>
  <para>
   The new <application>Privoxy</application> started with the same
-  code base, but has changed significantly at this point.
+  <application>Junkbuster</application> code base, but has changed
+  significantly at this point. 
  </para>
 
 </sect3>
 
+
+<sect3>
+<title id="whyprivoxy">Why <quote>Privoxy</quote>? Why a name change at all?</title>
+<para>
+ <application>Privoxy</application> is for <quote>Privacy Enhancing Proxy</quote>.
+ There are possible legal complications from the continued use of the 
+ <application>Junkbuster</application> name, which is a trademark of 
+ <ulink url="http://junkbusters.com">Junkbusters Corporation</ulink>.
+ (There are no objections from Junkbusters Corporation to the 
+ <application>Privoxy</application> project itself though, and they 
+ in fact still share our ideals and goals.)
+</para>
+
+<para>
+ The developers also believed that there so many changes from the original 
+ code, that it was time to make a clean break from the past and make 
+ a name in their own right, especially now with the pending release of 
+ version 3.0.
+
+</para>
+</sect3>
+
+
 <sect3 id="differs"><title>How does it differ from the old <application>Junkbuster?</application></title>
  <para>
    All the old features remain. The new <application>Privoxy</application> 
@@ -109,7 +144,7 @@ Please see the Contact section in the
 
 <sect3 id="features"><title>What are some of the new features?</title>
 <!--
- The section is in both user-manual and faq. Please keep in sync!!!
+ This section is in both user-manual and faq. Please keep in sync!!!
 -->
 <para>
  <itemizedlist>
@@ -117,7 +152,7 @@ Please see the Contact section in the
  <listitem>
   <para>
    Integrated browser based configuration and control utility (<ulink
-   url="http://i.j.b">http://i.j.b</ulink>). Browser-based tracing of rule
+   url="http://p.p">http://p.p</ulink>). Browser-based tracing of rule
    and filter effects.
   </para>
  </listitem> 
@@ -249,7 +284,7 @@ Please see the Contact section in the
   Modern browsers do indeed have <emphasis>some</emphasis> of the same
   functionality as <application>Privoxy</application>. Maybe this is
   adequate for you. But <application>Privoxy</application> is much more
-  verstatile and powerful, and can do a number of things that browsers just can't.
+  versatile and powerful, and can do a number of things that browsers just can't.
  </para>
  <para>
   In addition, a proxy is good choice if you use multiple browsers, or 
@@ -313,17 +348,41 @@ repository, and together we'll find a suitable task for you.
 
 <sect2 id="installation"><title>Installation</title>
 
-<sect3 id="newinstall"><title>Can I install the new 
- <application>Privoxy</application> over the old one?</title>
+<sect3 id="whichbrowsers">
+<title>Which browsers are supported by <application>Privoxy</application>?</title>
+<para>
+ Any browser that can be configured to use a <quote>proxy</quote>, which 
+ is probably almost all browsers. Direct browser support is not necessary
+ since <application>Privoxy</application> runs as a separate application and
+ just exchanges standard HTML data with your browser.
+</para>
+</sect3>
+
+<sect3 id="whichos">
+<title>Which operating systems are supported?</title>
+<para>
+ Right now Win32, Mac OSX, OS/2, AmigaOS, Linux, and many 
+ flavors of Unix.
+</para>
+
+<para>
+ Source code is available, so porting to other operating systems, 
+ is always a possibility.
+
+</para>
+</sect3>
+
+<sect3 id="newinstall"><title>Can I install  
+ <application>Privoxy</application> over <application>Junkbuster</application>?</title>
  <para>
-   We recommend you uninstall the old <application>Junkbuster</application>
+   We recommend you uninstall <application>Junkbuster</application>
    first to minimize conflicts and confusion. You may want to 
    save your old configuration files for future reference. The configuration
    is substantially changed.
  </para>
  <para>
   See the <ulink
-  url="http://ijbswa.sourceforge.net/user-manual/">user-manual</ulink> for
+  url="http://www.privoxy.org/user-manual/">user-manual</ulink> for
   platform specific installation instructions. [FIXME: This is meant for after
   the name change for 3.0!]
  </para>
@@ -359,7 +418,7 @@ special I have to do now?</title>
   and <quote>Secure</quote> (HTTPS) and then the number <quote>8118</quote>
   for <quote>port</quote>.  This tells your browser to send all web 
   requests to <application>Privoxy</application> instead of directly to the 
-  Interenet.
+  Internet.
  </para>
  <para>
   <application>Privoxy</application> can also be used to proxy for 
@@ -385,7 +444,7 @@ All the ads are there. What's wrong?</title>
  the browser's caches to force a full re-reading of pages. You can verify 
  that <application>Privoxy</application> is running, and your browser 
  is correctly configured by entering the special URL: 
- <ulink url="http://i.j.b/">http://i.j.b/</ulink>. This should give you 
+ <ulink url="http://p.p/">http://p.p/</ulink>. This should give you 
  a banner that says <quote>This is Privoxy</quote> and 
  access to <application>Privoxy's</application> internal configuration. 
  If you see this, then you are good to go. If not, the browser or 
@@ -447,7 +506,7 @@ All the ads are there. What's wrong?</title>
 some of these <quote>actions</quote>.</title>
 <para>
  These are all explained in the 
- <ulink url="http://ijbswa.sourceforge.net/user-manual/configuration.html#ACTIONSFILE">user-manual</ulink>.
+ <ulink url="../user-manual/configuration.html#ACTIONSFILE">user-manual</ulink>.
  Please refer to that.
 </para>
 </sect3>
@@ -459,9 +518,9 @@ way to do this?</title>
 
 <para>
  The easiest way to do this, is to access <application>Privoxy</application>
- with your web browser at <ulink url="http://i.j.b/">http://i.j.b/</ulink>, 
+ with your web browser at <ulink url="http://p.p/">http://p.p/</ulink>, 
  and then select 
- "<ulink url="http://ijbswa.sourceforge.net/config/edit-actions">Edit the actions list</ulink>"
+ "<ulink url="http://www.privoxy.org/config/edit-actions">Edit the actions list</ulink>"
  from the selection list. You can also do this by editing the appropriate 
  file with a text editor.
 </para>
@@ -469,7 +528,7 @@ way to do this?</title>
 <para>
  Please see the 
  <ulink
- url="http://ijbswa.sourceforge.net/user-manual/configuration.html#ACTIONSFILE">user-manual</ulink> for a
+ url="../user-manual/configuration.html#ACTIONSFILE">user-manual</ulink> for a
  detailed explanation of these and other configuration files, and their
  various options and syntax.
 </para>
@@ -670,6 +729,32 @@ Note that normally only local users can connect to <application>Privoxy</applica
  </para>
 </sect3>
 
+
+<sect3>
+<title id="filterfile">What is a <quote>default.filter</quote>?</title>
+<para>
+ The <quote>default.filter</quote> file is used to <quote>filter</quote> any
+ web page content. By <quote>filtering</quote> we mean it can modify, remove, 
+ or change <emphasis>anything</emphasis> on the page, including HTML tags, and
+ JavaScript. Regular expressions are used to accomplish this, and operate 
+ on a line by line basis. This is potentially a very powerful feature, but
+ requires some expertise. 
+</para>
+
+<para>
+ If you are familiar with regular expressions, and HTML, you can look at 
+ the provided <filename>default.filter</filename> with a text editor and see
+ some of things it can be used for.
+</para>
+
+<para>
+ Presently, there is no GUI editor option for this part of the configuration, 
+ but you can disable/enable various sections of the included default 
+ file with the <quote>Actions List Editor</quote> from your browser.
+</para>
+
+</sect3>
+
 <sect3>
 <title id="lanconfig">How can I set up <application>Privoxy</application> to act as a proxy for my 
  LAN?</title>
@@ -698,20 +783,20 @@ Note that normally only local users can connect to <application>Privoxy</applica
 
 
 <sect3>
-<title id="noseeum">Instead of ads, now I get a Privoxy logo [or 
-checkerboard]. I don't want to see anything.</title>
+<title id="noseeum">Instead of ads, now I get a checkerboard pattern. I don't want to see anything.</title>
 <para>
  This is a configuration option for images that
- <application>Privoxy</application> is stopping. You have the choice of the
- <application>Privoxy</application> logo, a checkerboard pattern (this
- scales better), a transparent 1x1 GIF image, or a custom URL or your choice.
+ <application>Privoxy</application> is stopping. You have the choice <!-- of
+ the --> <!-- <application>Privoxy</application> logo, --> a checkerboard
+ pattern, a transparent 1x1 GIF image (aka <quote>blank</quote>), or a custom
+ URL or your choice.
 </para>
 
 <para>
  If you want to see nothing, then change the <quote>+image-blocker</quote> 
  action to <quote>+image-blocker{blank}</quote>. This can be done from the 
  <quote>Edit Actions List</quote> selection at <ulink
- url="http://i.j.b/">http://i.j.b/</ulink>. Or by hand editing the appropriate 
+ url="http://p.p/">http://p.p/</ulink>. Or by hand editing the appropriate 
  actions file. This will only effect what is defined as <quote>images</quote>
  though. 
 
@@ -721,12 +806,12 @@ checkerboard]. I don't want to see anything.</title>
 
 
 <sect3>
-<title id="whyseeum">Why would anybody want to see the logo or checkerboard?</title>
+<title id="whyseeum">Why would anybody want to see a checkerboard pattern?</title>
 <para>
  This can be helpful for troubleshooting problems. It might also be good 
  for anyone new to <application>Privoxy</application> so that they can 
  see if their favorite pages are displaying correctly, and
- <application>Privoxy</application> is not inadvertantly removing something 
+ <application>Privoxy</application> is not inadvertently removing something 
  important.
 </para>
 
@@ -741,7 +826,7 @@ checkerboard]. I don't want to see anything.</title>
  to be a warning so that you know something has been blocked and an easy way
  for you to see why. These are handled differently than what has been defined
  as <quote>images</quote> (e.g. ad banners). If you want them to be treated
- as if they were images, so that they can be invisible, then move the
+ as if they were images, so that they can be made invisible, then move the
  offending URL from the <quote>+block</quote> section to the
  <quote>+imageblock</quote> section of your actions file. Alternately, you
  could modify the <quote><filename>block</filename></quote> HTML template that
@@ -751,11 +836,23 @@ checkerboard]. I don't want to see anything.</title>
 
 </sect3>
 
+<sect3 id="otherproxy">
+<title>How can I make <application>Privoxy</application> work with other 
+proxies like <application>Squid</application>?</title>
+<para>
+ This can be done. See the <ulink
+ url="../user-manual/configuration.html#FORWARDING">user manual</ulink>, 
+ which describes how to do this.
+
+</para>
+
+</sect3>
+
 </sect2>
 
 <!--   ~~~~~       New section      ~~~~~     -->
 
-<sect2 id="misc"><title>Misc</title>
+<sect2 id="misc"><title>Miscellaneous</title>
 
 <sect3>
 <title id="slowsme">How much does <application>Privoxy</application> slow my browsing down? This 
@@ -801,7 +898,7 @@ entire page first, do its content magic and then send the page to the browser.
 </sect3>
 
 
-<sect3 id="configurl"><title>What is the "http://i.j.b/"?</title>
+<sect3 id="configurl"><title>What is the "http://p.p/"?</title>
 <para>
 Since <application>Privoxy</application> sits between your web browser and the Internet, it can be
 programmed to handle certain pages specially.
@@ -810,19 +907,19 @@ programmed to handle certain pages specially.
 <para>
 With recent versions of <application>Privoxy</application> (version 2.9.x), you can get some
 information about <application>Privoxy</application> and change some settings by going to
-http://i.j.b/ or, equivalently, http://ijbswa.sourceforge.net/config/
-(Note that i.j.b is far easier to type but may not work in some
+http://p.p/ or, equivalently, http://www.privoxy.org/config/
+(Note that p.p is far easier to type but may not work in some
 configurations).
 </para>
 
 <para>
-These pages are *not* forwarded to a server on the internet - instead they are
+These pages are *not* forwarded to a server on the Internet - instead they are
 handled by a special web server which is built in to <application>Privoxy</application>.
 </para>
 
 <para>
-If you are not running <application>Privoxy</application>, then http://i.j.b/ will fail, and
-http://ijbswa.sourceforge.net/config/ will return a web page telling you
+If you are not running <application>Privoxy</application>, then http://p.p/ will fail, and
+http://www.privoxy.org/config/ will return a web page telling you
 you're not running <application>Privoxy</application>.
 </para>
 
@@ -1001,7 +1098,11 @@ and ugly looking. Can't a better font be used?</title>
  image is scaled to fill a largish area. There is not much to be done 
  about this, other than to use one of the other
  <quote>imageblock</quote> directives: <emphasis>pattern</emphasis>, 
- <emphasis>blank</emphasis>, or a URL of your chosing.
+ <emphasis>blank</emphasis>, or a URL of your choosing.
+</para>
+<para>
+Given the above problem, we have decided to remove the logo option entirely 
+[as of v2.9.13].
 </para>
 </sect3>
 
@@ -1057,27 +1158,16 @@ secure is it? Do I need to take any special precautions?</title>
 
 </sect3>
 
-<sect3>
-<title id="filterfile">What is a <quote>default.filter</quote>?</title>
-<para>
- The <quote>default.filter</quote> is used to <quote>filter</quote> any
- page content. By <quote>filtering</quote> we mean it can modify, remove, 
- or change <emphasis>anything</emphasis> on the page, including HTML tags, and
- JavaScript. Regular expressions are used to accomplish this. This is
- potentially a very powerful feature, but requires some expertise.
-</para>
-
+<sect3 id="turnoff">
+<title>How can I temporarily disable <application>Privoxy</application>?</title>
 <para>
- If you are familiar with regular expressions, and HTML, you can look at 
- the provided <filename>default.filter</filename> with a text editor and see
- some of things it can be used for.
-</para>
+ The easiest way is to access <application>Privoxy</application> with your 
+ browser by using the special URL: <ulink url="http://p.p/">http://p.p/</ulink>
+ and select "Toggle Privoxy on or off" from that page.
 
-<para>
- Presently, there is no GUI editor option for this part of the configuration.
 </para>
-
 </sect3>
+
 </sect2>
 
 
@@ -1096,7 +1186,8 @@ with every web page?</title>
 </para>
 
 <para>
- The old <application>Privoxy</application> used port 8000 by 
+ The old <application>Privoxy</application> (and also
+ <application>Junkbuster</application>) used port 8000 by 
  default. This has been changed to port 8118 now, due to a conflict 
  with NAS (Network Audio Service), which uses port 8000. If you haven't, 
  you need to change your browser to the new port number, or alternately 
@@ -1114,14 +1205,14 @@ still getting through. How?</title>
  If the ad had been displayed before you added its URL, it will probably be
  held in the browser's cache for some time, so it will be displayed without
  the need for any request to the server, and <application>Privoxy</application>
- will not be in the picture. The best thing to do is try flusing the browser's
+ will not be in the picture. The best thing to do is try flushing the browser's
  caches. And then try again.
 </para>
 
 <para>
  If this doesn't help, you probably have an error in the rule you
  applied. Try pasting the full URL of the offending ad into <ulink
- url="http://ijbswa.sourceforge.net/config/show-url-info">http://ijbswa.sourceforge.net/config/show-url-info</ulink>
+ url="http://www.privoxy.org/config/show-url-info">http://www.privoxy.org/config/show-url-info</ulink>
  and see if any actions match your new rule.
 </para>
 
@@ -1134,14 +1225,14 @@ What can I do?</title>
 <para>
  First verify that it is indeed a <application>Privoxy</application> problem, 
  by disabling <application>Privoxy</application> filtering and blocking. 
- Go to <ulink url="http://i.j.b/">http://i.j.b/</ulink> and click on 
+ Go to <ulink url="http://p.p/">http://p.p/</ulink> and click on 
  <quote>Toggle Privoxy On or Off</quote>, then disable it. Now try that 
  page again.
 </para>
 
 <para>
  If still a problem, go to <quote>Show which actions apply to a URL and
- why</quote> from <ulink url="http://i.j.b/">http://i.j.b/</ulink> and paste
+ why</quote> from <ulink url="http://p.p/">http://p.p/</ulink> and paste
  the full URL of the page in question into the prompt. See which actions are
  being applied to the URL. Now, armed with this information, go to <quote>Edit
  the actions list</quote>. Here you should see various sections that have
@@ -1151,7 +1242,7 @@ What can I do?</title>
  that looks like it is disabling the feature that is causing the
  problem. Re-try the page. There might be some trial and error involved. This
  is discussed in a little more detail in the <ulink
- url="http://ijbswa.sourceforge.net/user-manual/appenix.html#ACTIONSANAT">user-manual
+ url="../user-manual/appendix.html#ACTIONSANAT">user-manual
  appendix</ulink>.
 
 </para>
@@ -1184,12 +1275,17 @@ FIXME: Commented out until we have something to put here. HB 03/18/02.
 </para>
 </sect1>
 -->
+
 <!--   ~~~~~       New section      ~~~~~     -->
+<!--
+
+This is referenced in the doc header already. HB 03/25/02
+
 <sect1 id="contact"><title>Contact the developers</title>
 <para>Please see the user manual for information on how to contact the developers.
 </para>
 </sect1>
-
+-->
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect1 id="copyright"><title>Copyright and History</title>
 <para>Please see the user manual for information on Copyright and History.
@@ -1227,6 +1323,28 @@ FIXME: Commented out until we have something to put here. HB 03/18/02.
  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 $Log: faq.sgml,v $
+Revision 1.31  2002/03/26 22:29:55  swa
+we have a new homepage!
+
+Revision 1.30  2002/03/25 16:39:22  hal9
+A few new sections. Made all links relative to user-manual.
+
+Revision 1.29  2002/03/25 05:23:57  hal9
+Moved section, and touch ups.
+
+Revision 1.28  2002/03/25 04:27:33  hal9
+New section related to name change.
+
+Revision 1.25  2002/03/24 16:08:08  swa
+we are too lazy to make a block-built
+privoxy logo. hence removed the option.
+
+Revision 1.24  2002/03/24 15:46:20  swa
+name change related issue.
+
+Revision 1.23  2002/03/24 12:33:01  swa
+more additions.
+
 Revision 1.22  2002/03/24 11:51:00  swa
 name change. changed filenames.