Added link to docbook crash course
[privoxy.git] / doc / text / user-manual.txt
index ebc0bba..4042576 100644 (file)
@@ -2,7 +2,7 @@ Privoxy User Manual
 
 By: Privoxy Developers
 
-$Id: user-manual.sgml,v 1.72 2002/04/10 04:06:19 hal9 Exp $
+$Id: user-manual.sgml,v 1.75 2002/04/12 02:08:48 david__schmidt Exp $
 
 The user manual gives users information on how to install, configure and use
 Privoxy.
@@ -69,6 +69,9 @@ Table of Contents
     5.6. Templates
    
 6. Contacting the Developers, Bug Reporting and Feature Requests
+   
+    6.1. Submitting Ads and "Action" Problems
+   
 7. Copyright and History
    
     7.1. Copyright
@@ -89,7 +92,7 @@ Table of Contents
 1. Introduction
 
 This documentation is included with the current beta version of Privoxy,
-v.2.9.13, and is mostly complete at this point. The most up to date reference
+v.2.9.14, and is mostly complete at this point. The most up to date reference
 for the time being is still the comments in the source files and in the
 individual configuration files. Development of version 3.0 is currently nearing
 completion, and includes many significant changes and enhancements over earlier
@@ -166,8 +169,8 @@ There are several ways to install Privoxy.
 To build Privoxy from source, autoconf and GNU make (gmake) are required.
 Source is available as gzipped tar archives. For this, first unpack the source:
 
- tar xzvf privoxy-2.9.13-beta-src* [.tgz or .tar.gz]                           
- cd privoxy-2.9.13-beta                                                        
+ tar xzvf privoxy-2.9.14-beta-src* [.tgz or .tar.gz]                           
+ cd privoxy-2.9.14-beta                                                        
                                                                                
 
 For retrieving the current CVS sources, you'll need the CVS package installed
@@ -214,13 +217,13 @@ To build Redhat RPM packages from source, install source as above. Then:
 
 This will create both binary and src RPMs in the usual places. Example:
 
-   /usr/src/redhat/RPMS/i686/privoxy-2.9.13-1.i686.rpm
+   /usr/src/redhat/RPMS/i686/privoxy-2.9.14-1.i686.rpm
 
-   /usr/src/redhat/SRPMS/privoxy-2.9.13-1.src.rpm
+   /usr/src/redhat/SRPMS/privoxy-2.9.14-1.src.rpm
 
 To install, of course:
 
- rpm -Uvv /usr/src/redhat/RPMS/i686/privoxy-2.9.13-1.i686.rpm                  
+ rpm -Uvv /usr/src/redhat/RPMS/i686/privoxy-2.9.14-1.i686.rpm                  
                                                                                
 
 This will place the Privoxy configuration files in /etc/privoxy/, and log files
@@ -241,13 +244,13 @@ To build SuSE RPM packages, install source as above. Then:
 
 This will create both binary and src RPMs in the usual places. Example:
 
-   /usr/src/packages/RPMS/i686/privoxy-2.9.13-1.i686.rpm
+   /usr/src/packages/RPMS/i686/privoxy-2.9.14-1.i686.rpm
 
-   /usr/src/packages/SRPMS/privoxy-2.9.13-1.src.rpm
+   /usr/src/packages/SRPMS/privoxy-2.9.14-1.src.rpm
 
 To install, of course:
 
- rpm -Uvv /usr/src/packages/RPMS/i686/privoxy-2.9.13-1.i686.rpm                
+ rpm -Uvv /usr/src/packages/RPMS/i686/privoxy-2.9.14-1.i686.rpm                
                                                                                
 
 This will place the Privoxy configuration files in /etc/privoxy/, and log files
@@ -259,7 +262,7 @@ in /var/log/privoxy/.
 
 Privoxy is packaged in a WarpIN self- installing archive. The self-installing
 program will be named depending on the release version, something like:
-privoxyos2_setup_2.9.13.exe. In order to install it, simply run this executable
+privoxyos2_setup_2.9.14.exe. In order to install it, simply run this executable
 or double-click on its icon and follow the WarpIN installation panels. A shadow
 of the Privoxy executable will be placed in your startup folder so it will
 start automatically whenever OS/2 starts.
@@ -267,37 +270,6 @@ start automatically whenever OS/2 starts.
 The directory you choose to install Privoxy into will contain all of the
 configuration files.
 
-If you would like to build binary images on OS/2 yourself, you will need a few
-Unix-like tools: autoconf, autoheader and sh. These tools will be used to
-create the required config.h file, which is not part of the source distribution
-because it differs based on platform. You will also need a compiler. The
-distribution has been created using IBM VisualAge compilers, but you can use
-any compiler you like. GCC/EMX has the disadvantage of needing to be
-single-threaded due to a limitation of EMX's implementation of the select()
-socket call.
-
-In addition to needing the source code distribution as outlined earlier, you
-will want to extract the os2seutp directory from CVS:
-
- cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login           
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup 
-                                                                                     
-
-This will create a directory named os2setup/, which will contain the
-Makefile.vac makefile and os2build.cmd which is used to completely create the
-binary distribution. The sequence of events for building the executable for
-yourself goes something like this:
-
- cd current                                                                    
- autoheader                                                                    
- autoconf                                                                      
- sh configure                                                                  
- cd ..\os2setup                                                                
- nmake -f Makefile.vac                                                         
-                                                                               
-
-You will see this sequence laid out in os2build.cmd.
-
 -------------------------------------------------------------------------------
 
 3.1.4. Windows
@@ -1740,12 +1712,12 @@ desired.
 We value your feedback. However, to provide you with the best support, please
 note:
 
-  *  Use the Sourceforge Support Forum to get help:
+  * Use the Sourceforge Support Forum to get help:
        
         http://sourceforge.net/tracker/?group_id=11118&atid=211118
        
    
-  *  Submit bugs only through our Sourceforge Bug Forum:
+  * Submit bugs only through our Sourceforge Bug Forum:
      
         http://sourceforge.net/tracker/?group_id=11118&atid=111118. 
         
@@ -1759,29 +1731,45 @@ note:
     platform, browser, any pertinent log data, any other relevant details
     (please be specific) and, if possible, some way to reproduce the bug.
    
-  *  Submit feature requests only through our Sourceforge feature request forum:
+  * Submit feature requests only through our Sourceforge feature request forum:
      
         http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.
        
    
-  *  Submit missed ads and banners, and incorrectly blocked images, popups, etc:
-          
-        http://p.p/, and select "actions file feedback system"
+  * You can also send feedback on websites that Privoxy has problems with. Please bookmark
+    the following link: "Privoxy - Submit Filter Feedback"
+    . Once you surf to a page with problems, use the
+    bookmark to send us feedback. We will look into the issue as soon as possible.
        
    
-    This page can also be reached from many of the internal CGI pages.
-   
-  *  For any other issues, feel free to use the mailing lists:
+  * For any other issues, feel free to use the mailing lists:
      
         http://sourceforge.net/mail/?group_id=11118.
      
    
     Anyone interested in actively participating in development and related
     discussions can also join the appropriate mailing list. Archives are
-    available too.
+    available, too.
    
 -------------------------------------------------------------------------------
 
+6.1. Submitting Ads and "Action" Problems
+
+Ads and banners that are not stopped by Privoxy can be submitted to the
+developers by accessing a special page and filling out the brief, required
+form. Conversely, you can also report pages, images, etc. that Privoxy is
+blocking, but should not. The form itself does require Internet access.
+
+To do this, point your browser to Privoxy at http://p.p/, and then select 
+Actions file feedback system, near the bottom of the page. Paste in the URL
+that is the cause of the unwanted behavior, and follow the prompts. The
+developers will try to incorporate your submission into future versions.
+
+New default.actions files will occasionally be made available based on your
+feedback. These will be announced on the ijbswa-announce list.
+
+-------------------------------------------------------------------------------
+
 7. Copyright and History
 
 7.1. Copyright