Added link to docbook crash course
[privoxy.git] / doc / text / user-manual.txt
index ee9d69c..4042576 100644 (file)
@@ -2,7 +2,7 @@ Privoxy User Manual
 
 By: Privoxy Developers
 
-$Id: user-manual.sgml,v 1.70 2002/04/08 20:53:56 swa 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
@@ -224,7 +227,7 @@ To install, of course:
                                                                                
 
 This will place the Privoxy configuration files in /etc/privoxy/, and log files
-in /var/log/privoxy/. Run ckconfig privoxy on to have Privoxy start
+in /var/log/privoxy/. Run "chkconfig privoxy on" to have Privoxy start
 automatically during init. 
 
 -------------------------------------------------------------------------------
@@ -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
@@ -449,7 +421,7 @@ Privoxy can be reached by the special URL http://p.p/ (or alternately http://
 config.privoxy.org/), which is an internal page. You will see the following
 section: 
 
-Please choose from the following options:                                      
+ Please choose from the following options:                                     
                                                                                
     * Show information about the current configuration                         
     * Show the source code version numbers                                     
@@ -1727,7 +1699,7 @@ Kill those pesky little web-bugs:
 When Privoxy displays one of its internal pages, such as a 404 Not Found error
 page, it uses the appropriate template. On Linux, BSD, and Unix, these are
 located in /etc/privoxy/templates by default. These may be customized, if
-desired.
+desired. cgi-style.css is used to control the HTML attributes (fonts, etc).
 
 The default "Blocked" banner page with the bright red top banner, is called
 just "blocked". This may be customized or replaced with something else if
@@ -1740,14 +1712,14 @@ 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
+        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. 
+        http://sourceforge.net/tracker/?group_id=11118&atid=111118. 
         
    
     Make sure that the bug has not already been submitted. Please try to verify
@@ -1759,27 +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.
+        http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.
        
    
-  * We will soon have an automated way to submit advertisements, incorrectly
-    blocked images, popups and the like. Check back.
+  * 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.
        
    
-  *  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.
+        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
@@ -1806,7 +1796,7 @@ Place, Suite 330, Boston, MA 02111-1307 USA.
 Privoxy is evolved, and derived from, the Internet Junkbuster, with many
 improvments and enhancements over the original.
 
-Junkbuster was originally written by Anonymous Coders and Junkbuster's
+Junkbuster was originally written by Anonymous Coders and Junkbusters
 Corporation, and was released as free open-source software under the GNU GPL. 
 Stefan Waldherr made many improvements, and started the SourceForge project
 Privoxy to rekindle development. There are now several active developers
@@ -1827,6 +1817,9 @@ Sourceforge.
 http://p.p/, access Privoxy from your browser. Alternately, http://            
 config.privoxy.org may work in some situations where the first does not.       
 
+http://p.p/, and select "actions file feedback system" to submit "misses" to   
+the developers.                                                                
+
 http://www.junkbusters.com/ht/en/cookies.html
 
 http://www.waldherr.org/junkbuster/
@@ -2029,11 +2022,11 @@ These may be bookmarked for quick reference.
 
 9.2.1. Bookmarklets
 
-Here are some bookmarklets to allow you to easily access a "mini" version of
-this page. They are designed for MS Internet Explorer, but should work equally
-well in Netscape, Mozilla, and other browsers which support JavaScript. They
-are designed to run directly from your bookmarks - not by clicking the links
-below (although that will work for testing).
+Below are some "bookmarklets" to allow you to easily access a "mini" version of
+some of Privoxy's special pages. They are designed for MS Internet Explorer,
+but should work equally well in Netscape, Mozilla, and other browsers which
+support JavaScript. They are designed to run directly from your bookmarks - not
+by clicking the links below (although that should work for testing).
 
 To save them, right-click the link and choose "Add to Favorites" (IE) or "Add
 Bookmark" (Netscape). You will get a warning that the bookmark "may not be
@@ -2050,6 +2043,8 @@ click.
    
   * View Privoxy Status
    
+  * Actions file feedback system
+   
 Credit: The site which gave me the general idea for these bookmarklets is 
 www.bookmarklets.com. They have more information about bookmarklets.
 
@@ -2093,7 +2088,7 @@ basically what Privoxy would do if there were not any "actions" defined, i.e.
 it does nothing. Every action is disabled. This is not particularly informative
 for our purposes here. OK, next section:
 
- Matches for http://google.com:                                                
+  Matches for http://google.com:                                               
                                                                                
  { -add-header -block +deanimate-gifs -downgrade +fast-redirects               
    +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}          
@@ -2133,7 +2128,7 @@ referenced in these sections.
 And now we pull it altogether in the bottom section and summarize how Privoxy
 is appying all its "actions" to "google.com": 
 
- Final results:                                                                
+  Final results:                                                               
                                                                                
  -add-header -block -deanimate-gifs -downgrade -fast-redirects                 
  +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}            
@@ -2147,7 +2142,7 @@ is appying all its "actions" to "google.com":
 
 Now another example, "ad.doubleclick.net":
 
- { +block +image }                                                             
+  { +block +image }                                                            
   .ad.doubleclick.net                                                          
                                                                                
  { +block +image }                                                             
@@ -2174,7 +2169,7 @@ defined as "ad.doubleclick.net" is done here -- as both a "+block" and an
 One last example. Let's try "http://www.rhapsodyk.net/adsl/HOWTO/". This one is
 giving us problems. We are getting a blank page. Hmmm...
 
- Matches for http://www.rhapsodyk.net/adsl/HOWTO/:                             
+  Matches for http://www.rhapsodyk.net/adsl/HOWTO/:                            
                                                                                
  { -add-header -block +deanimate-gifs -downgrade +fast-redirects               
    +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}          
@@ -2195,7 +2190,7 @@ see why we get the blank page. We could now add a new action below this that
 explictly does not block (-block) pages with "adsl". There are various ways to
 handle such exceptions. Example:
 
- { -block }                                                                    
+  { -block }                                                                   
   /adsl                                                                        
                                                                                
                                                                                
@@ -2206,7 +2201,7 @@ such changes. Or, try using Shift+Reload.
 But now what about a situation where we get no explicit matches like we did
 with:
 
- { -block }                                                                    
+  { -block }                                                                   
   /adsl                                                                        
                                                                                
                                                                                
@@ -2218,7 +2213,7 @@ and maybe a little trial and error to isolate the offending rule. One likely
 cause would be one of the "{+filter}" actions. Try adding the URL for the site
 to one of aliases that turn off "+filter":
 
- {shop}                                                                        
+  {shop}                                                                       
  .quietpc.com                                                                  
  .worldpay.com   # for quietpc.com                                             
  .jungle.com                                                                   
@@ -2230,7 +2225,7 @@ to one of aliases that turn off "+filter":
 "{shop}" is an "alias" that expands to "{ -filter -no-cookies -no-cookies-keep
 }". Or you could do your own exception to negate filtering: 
 
- {-filter}                                                                     
+  {-filter}                                                                    
  .forbes.com