From: swa Date: Sat, 4 May 2002 08:41:23 +0000 (+0000) Subject: generated X-Git-Tag: v_3_0_branchpoint~120 X-Git-Url: http://www.privoxy.org/gitweb/%40user-manual%40%40actions-help-prefix%40HANDLE-AS-EMPTY-DOCUMENT?a=commitdiff_plain;h=0212c18282eaa5f73843cbbec12c9137ea596e1c;p=privoxy.git generated --- diff --git a/README b/README index e48c7336..9c5af93b 100644 --- a/README +++ b/README @@ -31,7 +31,7 @@ * *********************************************************************/ -This README is included with the development version of Privoxy 2.9.14, which +This README is included with the development version of Privoxy 2.9.15, which will eventually become Privoxy v3.0 (and soon we hope!). See http:// www.privoxy.org/ for more information. The current code level is beta, and seems stable to us :). @@ -63,14 +63,14 @@ change your browser if upgrading!!! And maybe firewall, etc. INSTALL -------- -To build Privoxy from source, autoheader, autoconf, GNU make (gmake), and, of -course, a C compiler are required. +To build Privoxy from source, autoconf, GNU make (gmake), and, of course, a C +compiler like gcc are required. When building from a source tarball (either release version or nightly CVS tarball), first unpack the source: - tar xzvf privoxy-2.9.14-beta-src* [.tgz or .tar.gz] - cd privoxy-2.9.14-beta + tar xzvf privoxy-2.9.15-beta-src* [.tgz or .tar.gz] + cd privoxy-2.9.15-beta For retrieving the current CVS sources, you'll need CVS installed. Note that sources from CVS are development quality, and may not be stable, or well diff --git a/doc/pdf/privoxy-developer-manual.pdf b/doc/pdf/privoxy-developer-manual.pdf index f179197f..2575a0bd 100644 Binary files a/doc/pdf/privoxy-developer-manual.pdf and b/doc/pdf/privoxy-developer-manual.pdf differ diff --git a/doc/pdf/privoxy-faq.pdf b/doc/pdf/privoxy-faq.pdf index b071c572..e5a458c3 100644 Binary files a/doc/pdf/privoxy-faq.pdf and b/doc/pdf/privoxy-faq.pdf differ diff --git a/doc/pdf/privoxy-user-manual.pdf b/doc/pdf/privoxy-user-manual.pdf index dd137efb..012e2e43 100644 Binary files a/doc/pdf/privoxy-user-manual.pdf and b/doc/pdf/privoxy-user-manual.pdf differ diff --git a/doc/text/developer-manual.txt b/doc/text/developer-manual.txt index 9722f5be..5541e660 100644 --- a/doc/text/developer-manual.txt +++ b/doc/text/developer-manual.txt @@ -2,7 +2,7 @@ Privoxy Developer Manual By: Privoxy Developers -$Id: developer-manual.sgml,v 1.39 2002/05/02 15:08:25 oes Exp $ +$Id: developer-manual.sgml,v 1.40 2002/05/04 00:43:43 hal9 Exp $ The developer manual gives the users information on how to help the developer team. It provides guidance on coding, testing, documentation and other issues. @@ -296,17 +296,18 @@ sufficient for our purposes. Some common elements that you likely will use: -, paragraph delimiter. Most text needs to be within paragraph -elements (there are some exceptions). -, the stylesheets make this italics. -, files and directories. -, command examples. -, like
, more or less.                     
-, list with bullets.                              
-, member of the above.                                    
-, screen output, implies .                     
-, like HTML  tag.                          
-, for, doh, quoting text.                                       
+, paragraph delimiter. Most text needs to be within paragraph elements (there  
+are some exceptions).                                                          
+, the stylesheets make this italics.                                           
+, files and directories.                                                       
+, command examples.                                                            
+, like                                                                         
+, more or less.                                                                
+, list with bullets.                                                           
+, member of the above.                                                         
+, screen output, implies .                                                     
+, like HTML tag.                                                               
+, for, doh, quoting text.                                                      
 
 Look at any of the existing docs for examples of all these and more.
 
@@ -416,7 +417,7 @@ entities are listed below. See any of the main docs for examples.
    
   * Commonly used "internal entities":
    
-    p-version: the Privoxy version string, e.g. "2.9.14".                      
+    p-version: the Privoxy version string, e.g. "2.9.15".                      
     p-status: the project status, either "alpha", "beta", or "stable".         
     p-not-stable: use to conditionally include text in "not stable" releases   
     (e.g. "beta").                                                             
@@ -1081,13 +1082,13 @@ other header files.
 
 Example:
 
-#include      /* This is not a local include */                    
+#include      /* This is not a local include */                                
 #include "config.h"       /* This IS a local include */                        
 
 Exception:
 
 /* This is not a local include, but requires a path element. */                
-#include                                                       
+#include                                                                       
 
 Note: Please! do not add "-I." to the Makefile without a _very_ good reason.
 This duplicates the #include "file.h" behavior.
@@ -1370,49 +1371,49 @@ from the project).
 
 Example for file comments:
 
-const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.39 2002/05/02 15:08:25 oes Exp $"; 
-/*********************************************************************                         
- *                                                                                             
- * File        :  $Source$                                                                     
- *                                                                                             
- * Purpose     :  (Fill me in with a good description!)                                        
- *                                                                                             
- * Copyright   :  Written by and Copyright (C) 2001 the SourceForge                            
- *                Privoxy team. http://www.privoxy.org/                                        
- *                                                                                             
- *                Based on the Internet Junkbuster originally written                          
- *                by and Copyright (C) 1997 Anonymous Coders and                               
- *                Junkbusters Corporation.  http://www.junkbusters.com                         
- *                                                                                             
- *                This program is free software; you can redistribute it                       
- *                and/or modify it under the terms of the GNU General                          
- *                Public License as published by the Free Software                             
- *                Foundation; either version 2 of the License, or (at                          
- *                your option) any later version.                                              
- *                                                                                             
- *                This program is distributed in the hope that it will                         
- *                be useful, but WITHOUT ANY WARRANTY; without even the                        
- *                implied warranty of MERCHANTABILITY or FITNESS FOR A                         
- *                PARTICULAR PURPOSE.  See the GNU General Public                              
- *                License for more details.                                                    
- *                                                                                             
- *                The GNU General Public License should be included with                       
- *                this file.  If not, you can view it at                                       
- *                http://www.gnu.org/copyleft/gpl.html                                         
- *                or write to the Free Software Foundation, Inc., 59                           
- *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.                       
- *                                                                                             
- * Revisions   :                                                                               
- *    $Log$                                                                                    
- *                                                                                             
- *********************************************************************/                        
-                                                                                               
-                                                                                               
-#include "config.h"                                                                            
-                                                                                               
-   ...necessary include files for us to do our work...                                         
-                                                                                               
-const char FILENAME_h_rcs[] = FILENAME_H_VERSION;                                              
+const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.40 2002/05/04 00:43:43 hal9 Exp $"; 
+/*********************************************************************                          
+ *                                                                                              
+ * File        :  $Source$                                                                      
+ *                                                                                              
+ * Purpose     :  (Fill me in with a good description!)                                         
+ *                                                                                              
+ * Copyright   :  Written by and Copyright (C) 2001 the SourceForge                             
+ *                Privoxy team. http://www.privoxy.org/                                         
+ *                                                                                              
+ *                Based on the Internet Junkbuster originally written                           
+ *                by and Copyright (C) 1997 Anonymous Coders and                                
+ *                Junkbusters Corporation.  http://www.junkbusters.com                          
+ *                                                                                              
+ *                This program is free software; you can redistribute it                        
+ *                and/or modify it under the terms of the GNU General                           
+ *                Public License as published by the Free Software                              
+ *                Foundation; either version 2 of the License, or (at                           
+ *                your option) any later version.                                               
+ *                                                                                              
+ *                This program is distributed in the hope that it will                          
+ *                be useful, but WITHOUT ANY WARRANTY; without even the                         
+ *                implied warranty of MERCHANTABILITY or FITNESS FOR A                          
+ *                PARTICULAR PURPOSE.  See the GNU General Public                               
+ *                License for more details.                                                     
+ *                                                                                              
+ *                The GNU General Public License should be included with                        
+ *                this file.  If not, you can view it at                                        
+ *                http://www.gnu.org/copyleft/gpl.html                                          
+ *                or write to the Free Software Foundation, Inc., 59                            
+ *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.                        
+ *                                                                                              
+ * Revisions   :                                                                                
+ *    $Log$                                                                                     
+ *                                                                                              
+ *********************************************************************/                         
+                                                                                                
+                                                                                                
+#include "config.h"                                                                             
+                                                                                                
+   ...necessary include files for us to do our work...                                          
+                                                                                                
+const char FILENAME_h_rcs[] = FILENAME_H_VERSION;                                               
 
 Note: This declares the rcs variables that should be added to the
 "show-proxy-args" page. If this is a brand new creation by you, you are free to
@@ -1425,71 +1426,71 @@ can.
 
 Example for file header comments:
 
-#ifndef _FILENAME_H                                                                          
-#define _FILENAME_H                                                                          
-#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.39 2002/05/02 15:08:25 oes Exp $" 
-/*********************************************************************                       
- *                                                                                           
- * File        :  $Source$                                                                   
- *                                                                                           
- * Purpose     :  (Fill me in with a good description!)                                      
- *                                                                                           
- * Copyright   :  Written by and Copyright (C) 2001 the SourceForge                          
- *                Privoxy team. http://www.privoxy.org/                                      
- *                                                                                           
- *                Based on the Internet Junkbuster originally written                        
- *                by and Copyright (C) 1997 Anonymous Coders and                             
- *                Junkbusters Corporation.  http://www.junkbusters.com                       
- *                                                                                           
- *                This program is free software; you can redistribute it                     
- *                and/or modify it under the terms of the GNU General                        
- *                Public License as published by the Free Software                           
- *                Foundation; either version 2 of the License, or (at                        
- *                your option) any later version.                                            
- *                                                                                           
- *                This program is distributed in the hope that it will                       
- *                be useful, but WITHOUT ANY WARRANTY; without even the                      
- *                implied warranty of MERCHANTABILITY or FITNESS FOR A                       
- *                PARTICULAR PURPOSE.  See the GNU General Public                            
- *                License for more details.                                                  
- *                                                                                           
- *                The GNU General Public License should be included with                     
- *                this file.  If not, you can view it at                                     
- *                http://www.gnu.org/copyleft/gpl.html                                       
- *                or write to the Free Software Foundation, Inc., 59                         
- *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.                     
- *                                                                                           
- * Revisions   :                                                                             
- *    $Log$                                                                                  
- *                                                                                           
- *********************************************************************/                      
-                                                                                             
-                                                                                             
-#include "project.h"                                                                         
-                                                                                             
-#ifdef __cplusplus                                                                           
-extern "C" {                                                                                 
-#endif                                                                                       
-                                                                                             
-   ... function headers here ...                                                             
-                                                                                             
-                                                                                             
-/* Revision control strings from this header and associated .c file */                       
-extern const char FILENAME_rcs[];                                                            
-extern const char FILENAME_h_rcs[];                                                          
-                                                                                             
-                                                                                             
-#ifdef __cplusplus                                                                           
-} /* extern "C" */                                                                           
-#endif                                                                                       
-                                                                                             
-#endif /* ndef _FILENAME_H */                                                                
-                                                                                             
-/*                                                                                           
-  Local Variables:                                                                           
-  tab-width: 3                                                                               
-  end:                                                                                       
-*/                                                                                           
+#ifndef _FILENAME_H                                                                           
+#define _FILENAME_H                                                                           
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.40 2002/05/04 00:43:43 hal9 Exp $" 
+/*********************************************************************                        
+ *                                                                                            
+ * File        :  $Source$                                                                    
+ *                                                                                            
+ * Purpose     :  (Fill me in with a good description!)                                       
+ *                                                                                            
+ * Copyright   :  Written by and Copyright (C) 2001 the SourceForge                           
+ *                Privoxy team. http://www.privoxy.org/                                       
+ *                                                                                            
+ *                Based on the Internet Junkbuster originally written                         
+ *                by and Copyright (C) 1997 Anonymous Coders and                              
+ *                Junkbusters Corporation.  http://www.junkbusters.com                        
+ *                                                                                            
+ *                This program is free software; you can redistribute it                      
+ *                and/or modify it under the terms of the GNU General                         
+ *                Public License as published by the Free Software                            
+ *                Foundation; either version 2 of the License, or (at                         
+ *                your option) any later version.                                             
+ *                                                                                            
+ *                This program is distributed in the hope that it will                        
+ *                be useful, but WITHOUT ANY WARRANTY; without even the                       
+ *                implied warranty of MERCHANTABILITY or FITNESS FOR A                        
+ *                PARTICULAR PURPOSE.  See the GNU General Public                             
+ *                License for more details.                                                   
+ *                                                                                            
+ *                The GNU General Public License should be included with                      
+ *                this file.  If not, you can view it at                                      
+ *                http://www.gnu.org/copyleft/gpl.html                                        
+ *                or write to the Free Software Foundation, Inc., 59                          
+ *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.                      
+ *                                                                                            
+ * Revisions   :                                                                              
+ *    $Log$                                                                                   
+ *                                                                                            
+ *********************************************************************/                       
+                                                                                              
+                                                                                              
+#include "project.h"                                                                          
+                                                                                              
+#ifdef __cplusplus                                                                            
+extern "C" {                                                                                  
+#endif                                                                                        
+                                                                                              
+   ... function headers here ...                                                              
+                                                                                              
+                                                                                              
+/* Revision control strings from this header and associated .c file */                        
+extern const char FILENAME_rcs[];                                                             
+extern const char FILENAME_h_rcs[];                                                           
+                                                                                              
+                                                                                              
+#ifdef __cplusplus                                                                            
+} /* extern "C" */                                                                            
+#endif                                                                                        
+                                                                                              
+#endif /* ndef _FILENAME_H */                                                                 
+                                                                                              
+/*                                                                                            
+  Local Variables:                                                                            
+  tab-width: 3                                                                                
+  end:                                                                                        
+*/                                                                                            
 
 Example for function comments:
 
@@ -1951,7 +1952,7 @@ Once this done go to http://sourceforge.net/project/admin/editpackages.php?
 group_id=11118, making sure you are logged in. Find your target platform in the
 second column, and click Add Release. You will then need to create a new
 release for your package, using the format of $VERSION ($CODE_STATUS), e.g.
-2.9.14 (beta).
+2.9.15 (beta).
 
 Now just follow the prompts. Be sure to add any appropriate Release notes. You
 should see your freshly uploaded packages in "Step 2. Add Files To This
diff --git a/doc/text/faq.txt b/doc/text/faq.txt
index 917696f8..5027daa8 100644
--- a/doc/text/faq.txt
+++ b/doc/text/faq.txt
@@ -2,7 +2,7 @@ Privoxy Frequently Asked Questions
 
 By: Privoxy Developers
 
-$Id: faq.sgml,v 1.54 2002/05/03 05:06:44 hal9 Exp $
+$Id: faq.sgml,v 1.55 2002/05/04 00:41:56 hal9 Exp $
 
 This FAQ gives users and developers alike answers to frequently asked questions
 about Privoxy .
@@ -119,12 +119,12 @@ Table of Contents
 
 1.1. What is this new version of Privoxy?
 
-The original Internet JunkbusterTM (tm) is a copyrighted product of Junkbusters
-Corporation. Development of this effort stopped some time ago as of version
-2.0.2. Stefan Waldherr started the ijbswa project on Sourceforge to rekindle
-development. Other developers subsequently joined with Stefan, and have since
-added many new features, refinements and enhancements. The result of this
-effort is Privoxy.
+The original Internet Junkbuster™ (tm) is a copyrighted product of 
+Junkbusters Corporation. Development of this effort stopped some time ago as of
+version 2.0.2. Stefan Waldherr started the ijbswa project on Sourceforge to
+rekindle development. Other developers subsequently joined with Stefan, and
+have since added many new features, refinements and enhancements. The result of
+this effort is Privoxy.
 
 Privoxy has evolved from the Junkbuster 2.0.2 code base, and has advanced
 significantly at this point.
@@ -661,7 +661,7 @@ Privoxy.
 
 If you have version 2.0.2, then the equivalent is http://example.com/
 show-proxy-args (but you get far less information, and you should really
-consider upgrading to 2.9.14).
+consider upgrading to 2.9.15).
 
 -------------------------------------------------------------------------------
 
diff --git a/doc/text/user-manual.txt b/doc/text/user-manual.txt
index 680bee08..9aa97ee2 100644
--- a/doc/text/user-manual.txt
+++ b/doc/text/user-manual.txt
@@ -2,7 +2,7 @@ Privoxy User Manual
 
 By: Privoxy Developers
 
-$Id: user-manual.sgml,v 1.102 2002/05/03 17:46:00 oes Exp $
+$Id: user-manual.sgml,v 1.103 2002/05/04 00:40:53 hal9 Exp $
 
 The user manual gives users information on how to install, configure and use 
 Privoxy.
@@ -168,7 +168,7 @@ Table of Contents
 1. Introduction
 
 This documentation is included with the current beta version of Privoxy,
-v.2.9.14, and is mostly complete at this point. The most up to date reference
+v.2.9.15, 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
@@ -248,7 +248,7 @@ How to install the binary packages depends on your operating system:
 
 2.1.1. Red Hat and SuSE RPMs
 
-RPMs can be installed with rpm -Uvh privoxy-2.9.14-1.rpm, and will use /etc/
+RPMs can be installed with rpm -Uvh privoxy-2.9.15-1.rpm, and will use /etc/
 privoxy for the location of configuration files.
 
 Note that on Red Hat, Privoxy will not be automatically started on system boot.
@@ -256,7 +256,7 @@ You will need to enable that using chkconfig, ntsysv, or similar methods. Note
 that SuSE will automatically start Privoxy in the boot process.
 
 If you have problems with failed dependencies, try rebuilding the SRC RPM: rpm
---rebuild privoxy-2.9.14-1.src.rpm;. This will use your locally installed
+--rebuild privoxy-2.9.15-1.src.rpm;. This will use your locally installed
 libraries and RPM version.
 
 Also note that if you have a Junkbuster RPM installed on your system, you need
@@ -341,8 +341,8 @@ compiler like gcc are required.
 When building from a source tarball (either release version or nightly CVS
 tarball), first unpack the source:
 
- tar xzvf privoxy-2.9.14-beta-src* [.tgz or .tar.gz]                           
- cd privoxy-2.9.14-beta                                                        
+ tar xzvf privoxy-2.9.15-beta-src* [.tgz or .tar.gz]                           
+ cd privoxy-2.9.15-beta                                                        
 
 For retrieving the current CVS sources, you'll need CVS installed. Note that
 sources from CVS are development quality, and may not be stable, or well
@@ -582,11 +582,11 @@ config.privoxy.org/ (shortcut: http://p.p/), which is a built-in page and works
 without Internet access. You will see the following section: 
 
  Privoxy Menu                                                                  
-        ?  View & change the current configuration                             
-        ?  View the source code version numbers                                
-        ?  View the request headers.                                           
-        ?  Look up which actions apply to a URL and why                        
-        ?  Toggle Privoxy on or off                                            
+        ??  View & change the current configuration                            
+        ??  View the source code version numbers                               
+        ??  View the request headers.                                          
+        ??  Look up which actions apply to a URL and why                       
+        ??  Toggle Privoxy on or off                                           
                                                                                
 
 This should be self-explanatory. Note the first item leads to an editor for the
@@ -958,7 +958,7 @@ Notes:
    
     Unix, in local filesystem:
    
-    user-manual  file:///usr/share/doc/privoxy-2.9.14/user-manual/     
+    user-manual  file:///usr/share/doc/privoxy-2.9.15/user-manual/     
    
     Any platform, on local webserver (called "local-webserver"):
    
@@ -3508,7 +3508,7 @@ Then, for our user.action file, we again have no hits.
 And finally we pull it all together in the bottom section and summarize how
 Privoxy is applying all its "actions" to "google.com": 
 
- Final results:                                                                    
+  Final results:                                                                   
  -add-header -block +deanimate-gifs{last} -downgrade-http-version -fast-redirects  
  -filter{popups} -filter{fun} -filter{shockwave-flash} -filter{crude-parental}     
  +filter{html-annoyances} +filter{js-annoyances} +filter{content-cookies}          
@@ -3523,7 +3523,7 @@ and "session-cookies-only".
 
 Now another example, "ad.doubleclick.net":
 
- { +block +handle-as-image }                                                   
+  { +block +handle-as-image }                                                  
   .ad.doubleclick.net                                                          
                                                                                
  { +block +handle-as-image }                                                   
@@ -3549,7 +3549,7 @@ and make it more readable.
 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-http-version +fast-redirects        
    +filter{html-annoyances} +filter{js-annoyances} +filter{kill-popups}              
@@ -3568,7 +3568,7 @@ see why we get the blank page. We could now add a new action below this that
 explicitly does not block ("{-block}") paths with "adsl". There are various
 ways to handle such exceptions. Example:
 
- { -block }                                                                    
+  { -block }                                                                   
   /adsl                                                                        
 
 Now the page displays ;-) Be sure to flush your browser's caches when making
@@ -3577,7 +3577,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 +handle-as-image }                                                   
+  { +block +handle-as-image }                                                  
  /ads                                                                          
 
 That actually was very telling and pointed us quickly to where the problem was.
@@ -3587,7 +3587,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                                                                   
@@ -3597,7 +3597,7 @@ to one of aliases that turn off "+filter":
 "{shop}" is an "alias" that expands to "{ -filter -session-cookies-only }". Or
 you could do your own exception to negate filtering: 
 
- {-filter}                                                                     
+  {-filter}                                                                    
  .forbes.com                                                                   
 
 This would probably be most appropriately put in user.action, for local site
diff --git a/doc/webserver/developer-manual/coding.html b/doc/webserver/developer-manual/coding.html
index d30b7406..28b00173 100644
--- a/doc/webserver/developer-manual/coding.html
+++ b/doc/webserver/developer-manual/coding.html
@@ -71,7 +71,7 @@ CLASS="SECT1"
 CLASS="SECT1"
 >6. Coding Guidelines4. Coding Guidelines
6.1. Introduction4.1. Introduction

This set of standards is designed to make our lives easier. It is @@ -102,7 +102,7 @@ CLASS="SECT2" CLASS="SECT2" >6.2. Using Comments4.2. Using Comments

6.2.1. Comment, Comment, Comment4.2.1. Comment, Comment, Comment

6.2.2. Use blocks for comments4.2.2. Use blocks for comments

6.2.3. Keep Comments on their own line4.2.3. Keep Comments on their own line

6.2.4. Comment each logical step4.2.4. Comment each logical step

6.2.5. Comment All Functions Thoroughly4.2.5. Comment All Functions Thoroughly

6.2.6. Comment at the end of braces if the +>4.2.6. Comment at the end of braces if the content is more than one screen length

6.3. Naming Conventions4.3. Naming Conventions

6.3.1. Variable Names4.3.1. Variable Names

6.3.2. Function Names4.3.2. Function Names

6.3.3. Header file prototypes4.3.3. Header file prototypes

6.3.4. Enumerations, and #defines4.3.4. Enumerations, and #defines

6.3.5. Constants4.3.5. Constants

6.4. Using Space4.4. Using Space

6.4.1. Put braces on a line by themselves.4.4.1. Put braces on a line by themselves.

6.4.2. ALL control statements should have a +>4.4.2. ALL control statements should have a block

6.4.3. Do not belabor/blow-up boolean +>4.4.3. Do not belabor/blow-up boolean expressions

6.4.4. Use white space freely because it is +>4.4.4. Use white space freely because it is free

6.4.5. Don't use white space around structure +>4.4.5. Don't use white space around structure operators

6.4.6. Make the last brace of a function stand +>4.4.6. Make the last brace of a function stand out

6.4.7. Use 3 character indentions4.4.7. Use 3 character indentions

6.5. Initializing4.5. Initializing

6.5.1. Initialize all variables4.5.1. Initialize all variables

6.6. Functions4.6. Functions

6.6.1. Name functions that return a boolean as a +>4.6.1. Name functions that return a boolean as a question.

6.6.2. Always specify a return type for a +>4.6.2. Always specify a return type for a function.

6.6.3. Minimize function calls when iterating by +>4.6.3. Minimize function calls when iterating by using variables

6.6.4. Pass and Return by Const Reference4.6.4. Pass and Return by Const Reference

6.6.5. Pass and Return by Value4.6.5. Pass and Return by Value

6.6.6. Names of include files4.6.6. Names of include files

6.6.7. Provide multiple inclusion +>4.6.7. Provide multiple inclusion protection

6.6.8. Use `extern "C"` when appropriate4.6.8. Use `extern "C"` when appropriate

6.6.9. Where Possible, Use Forward Struct +>4.6.9. Where Possible, Use Forward Struct Declaration Instead of Includes

6.7. General Coding Practices4.7. General Coding Practices

6.7.1. Turn on warnings4.7.1. Turn on warnings

6.7.2. Provide a default case for all switch +>4.7.2. Provide a default case for all switch statements

6.7.3. Try to avoid falling through cases in a +>4.7.3. Try to avoid falling through cases in a switch statement.

6.7.4. Use 'long' or 'short' Instead of +>4.7.4. Use 'long' or 'short' Instead of 'int'

6.7.5. Don't mix size_t and other types4.7.5. Don't mix size_t and other types

6.7.6. Declare each variable and struct on its +>4.7.6. Declare each variable and struct on its own line.

6.7.7. Use malloc/zalloc sparingly4.7.7. Use malloc/zalloc sparingly

6.7.8. The Programmer Who Uses 'malloc' is +>4.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring 'free'

6.7.9. Add loaders to the `file_list' structure +>4.7.9. Add loaders to the `file_list' structure and in order

6.7.10. "Uncertain" new code and/or changes to +>4.7.10. "Uncertain" new code and/or changes to existing code, use FIXME

6.8. Addendum: Template for files and function +>4.8. Addendum: Template for files and function comment blocks:

const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.39 2002/05/02 15:08:25 oes Exp $";
+>const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.40 2002/05/04 00:43:43 hal9 Exp $";
 /*********************************************************************
  *
  * File        :  $Source$
@@ -2097,7 +2097,7 @@ WIDTH="100%"
 CLASS="PROGRAMLISTING"
 >#ifndef _FILENAME_H
 #define _FILENAME_H
-#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.39 2002/05/02 15:08:25 oes Exp $"
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.40 2002/05/04 00:43:43 hal9 Exp $"
 /*********************************************************************
  *
  * File        :  $Source$
diff --git a/doc/webserver/developer-manual/contact.html b/doc/webserver/developer-manual/contact.html
index 2ab0bcb7..1e5a773f 100644
--- a/doc/webserver/developer-manual/contact.html
+++ b/doc/webserver/developer-manual/contact.html
@@ -71,7 +71,7 @@ CLASS="SECT1"
 CLASS="SECT1"
 >10. Contacting the developers, Bug Reporting and Feature Requests8. Contacting the developers, Bug Reporting and Feature Requests

We value your feedback. However, to provide you with the best support, please @@ -82,7 +82,7 @@ CLASS="SECT2" CLASS="SECT2" >10.1. Get Support8.1. Get Support

10.2. Report bugs8.2. Report bugs

10.3. Request new features8.3. Request new features

10.4. Report ads or other filter problems8.4. Report ads or other filter problems

You can also send feedback on websites that Privoxy has problems with. Please bookmark @@ -194,7 +194,7 @@ CLASS="SECT2" CLASS="SECT2" >10.5. Other8.5. Other

11. Copyright and History9. Copyright and History

11.1. Copyright9.1. Copyright

11.2. History9.2. History

Prev4. The CVS Repository2. The CVS Repository

If you intend to help us with programming, documentation or packaging @@ -84,7 +84,7 @@ CLASS="SECT2" CLASS="SECT2" >4.1. Access to CVS2.1. Access to CVS

The project's CVS repository is hosted on @@ -121,7 +121,7 @@ CLASS="SECT2" CLASS="SECT2" >4.2. CVS Commit Guideline2.2. CVS Commit Guideline

The source tree is the heart of every software project. Every effort must @@ -185,7 +185,7 @@ CLASS="SECT2" CLASS="SECT2" >4.3. Discussing Changes First2.3. Discussing Changes First

We don't have a too formal policy on this, just use common sense. Hints: If it is.. @@ -257,7 +257,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" >PrevQuickstart to Privoxy DevelopmentIntroduction5. Documentation Guidelines3. Documentation Guidelines

All formal documents are maintained in Docbook SGML and located in the @@ -251,7 +251,7 @@ CLASS="SECT2" CLASS="SECT2" >5.1. Quickstart to Docbook and SGML3.1. Quickstart to Docbook and SGML

If you are not familiar with SGML, it is a markup language similar to HTML. @@ -467,7 +467,7 @@ CLASS="SECT2" CLASS="SECT2" >5.2. 3.2. Privoxy Documentation Style

5.3. Privoxy Custom Entities3.3. Privoxy Custom Entities

version string, e.g. "2.9.14""2.9.15".

$Id: developer-manual.sgml,v 1.39 2002/05/02 15:08:25 oes Exp $

$Id: developer-manual.sgml,v 1.40 2002/05/04 00:43:43 hal9 Exp $

Table of Contents
1. Introduction
3. 1.1. Quickstart to Privoxy Development
4. 2. The CVS Repository
4.1. 2.1. Access to CVS
4.2. 2.2. CVS Commit Guideline
4.3. 2.3. Discussing Changes First
5. 3. Documentation Guidelines
5.1. 3.1. Quickstart to Docbook and SGML
5.2. 3.2. Documentation Style
5.3. 3.3. Privoxy Custom Entities
6. 4. Coding Guidelines
6.1. 4.1. Introduction
6.2. 4.2. Using Comments
6.2.1. 4.2.1. Comment, Comment, Comment
6.2.2. 4.2.2. Use blocks for comments
6.2.3. 4.2.3. Keep Comments on their own line
6.2.4. 4.2.4. Comment each logical step
6.2.5. 4.2.5. Comment All Functions Thoroughly
6.2.6. 4.2.6. Comment at the end of braces if the content is more than one screen length
6.3. 4.3. Naming Conventions
6.3.1. 4.3.1. Variable Names
6.3.2. 4.3.2. Function Names
6.3.3. 4.3.3. Header file prototypes
6.3.4. 4.3.4. Enumerations, and #defines
6.3.5. 4.3.5. Constants
6.4. 4.4. Using Space
6.4.1. 4.4.1. Put braces on a line by themselves.
6.4.2. 4.4.2. ALL control statements should have a block
6.4.3. 4.4.3. Do not belabor/blow-up boolean expressions
6.4.4. 4.4.4. Use white space freely because it is free
6.4.5. 4.4.5. Don't use white space around structure operators
6.4.6. 4.4.6. Make the last brace of a function stand out
6.4.7. 4.4.7. Use 3 character indentions
6.5. 4.5. Initializing
6.5.1. 4.5.1. Initialize all variables
6.6. 4.6. Functions
6.6.1. 4.6.1. Name functions that return a boolean as a question.
6.6.2. 4.6.2. Always specify a return type for a function.
6.6.3. 4.6.3. Minimize function calls when iterating by using variables
6.6.4. 4.6.4. Pass and Return by Const Reference
6.6.5. 4.6.5. Pass and Return by Value
6.6.6. 4.6.6. Names of include files
6.6.7. 4.6.7. Provide multiple inclusion protection
6.6.8. 4.6.8. Use `extern "C"` when appropriate
6.6.9. 4.6.9. Where Possible, Use Forward Struct Declaration Instead of Includes
6.7. 4.7. General Coding Practices
6.7.1. 4.7.1. Turn on warnings
6.7.2. 4.7.2. Provide a default case for all switch statements
6.7.3. 4.7.3. Try to avoid falling through cases in a switch statement.
6.7.4. 4.7.4. Use 'long' or 'short' Instead of 'int'
6.7.5. 4.7.5. Don't mix size_t and other types
6.7.6. 4.7.6. Declare each variable and struct on its own line.
6.7.7. 4.7.7. Use malloc/zalloc sparingly
6.7.8. 4.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring 'free'
6.7.9. 4.7.9. Add loaders to the `file_list' structure and in order
6.7.10. 4.7.10. "Uncertain" new code and/or changes to existing code, use FIXME
6.8. 4.8. Addendum: Template for files and function comment blocks:
7. 5. Testing Guidelines
7.1. 5.1. Testplan for releases
7.2. 5.2. Test reports
8. 6. Releasing a New Version
8.1. 6.1. Version numbers
8.2. 6.2. Before the Release: Freeze
8.3. 6.3. Building and Releasing the Packages
8.3.1. 6.3.1. Source Tarball
8.3.2. 6.3.2. SuSE or Red Hat RPM
8.3.3. 6.3.3. OS/2
8.3.4. 6.3.4. Solaris
8.3.5. 6.3.5. Windows
8.3.6. 6.3.6. Debian
8.3.7. 6.3.7. Mac OSX
8.3.8. 6.3.8. FreeBSD
8.3.9. 6.3.9. HP-UX 11
8.3.10. 6.3.10. Amiga OS
8.3.11. 6.3.11. AIX
8.4. 6.4. Uploading and Releasing Your Package
8.5. 6.5. After the Release
9. 7. Update the Webserver
10. 8. Contacting the developers, Bug Reporting and Feature Requests
10.1. 8.1. Get Support
10.2. 8.2. Report bugs
10.3. 8.3. Request new features
10.4. 8.4. Report ads or other filter problems
10.5. 8.5. Other
11. 9. Copyright and History
11.1. 9.1. Copyright
11.2. 9.2. History
12. 10. See also

8. Releasing a New Version6. Releasing a New Version

When we release versions of 8.1. Version numbers6.1. Version numbers

First you need to determine which version number the release will have. @@ -177,7 +177,7 @@ CLASS="SECT2" CLASS="SECT2" >8.2. Before the Release: Freeze6.2. Before the Release: Freeze

The following 8.3. Building and Releasing the Packages6.3. Building and Releasing the Packages

Now the individual packages can be built and released. Note that for @@ -369,7 +369,7 @@ CLASS="SECT3" CLASS="SECT3" >8.3.1. Source Tarball6.3.1. Source Tarball

First, 8.3.2. SuSE or Red Hat RPM6.3.2. SuSE or Red Hat RPM

In following text, replace 8.3.3. OS/26.3.3. OS/2

First, 8.3.4. Solaris6.3.4. Solaris

Login to Sourceforge's compilefarm via ssh: @@ -805,7 +805,7 @@ CLASS="SECT3" CLASS="SECT3" >8.3.5. Windows6.3.5. Windows

You should ensure you have the latest version of Cygwin (from @@ -882,7 +882,7 @@ CLASS="SECT3" CLASS="SECT3" >8.3.6. Debian6.3.6. Debian

First, 8.3.7. Mac OSX6.3.7. Mac OSX

First, 8.3.8. FreeBSD6.3.8. FreeBSD

Login to Sourceforge's compilefarm via ssh: @@ -1103,7 +1103,7 @@ CLASS="SECT3" CLASS="SECT3" >8.3.9. HP-UX 116.3.9. HP-UX 11

First, 8.3.10. Amiga OS6.3.10. Amiga OS

First, 8.3.11. AIX6.3.11. AIX

Login to Sourceforge's compilefarm via ssh: @@ -1256,7 +1256,7 @@ CLASS="SECT2" CLASS="SECT2" >8.4. Uploading and Releasing Your Package6.4. Uploading and Releasing Your Package

After the package is ready, it is time to upload it @@ -1312,7 +1312,7 @@ CLASS="LITERAL" >$VERSION ($CODE_STATUS), e.g. 2.9.14 +>2.9.15 (beta).

8.5. After the Release6.5. After the Release

When all (or: most of the) packages have been uploaded and made available, diff --git a/doc/webserver/developer-manual/seealso.html b/doc/webserver/developer-manual/seealso.html index a6bc4ad3..1dc8fce0 100644 --- a/doc/webserver/developer-manual/seealso.html +++ b/doc/webserver/developer-manual/seealso.html @@ -65,7 +65,7 @@ CLASS="SECT1" CLASS="SECT1" >12. See also10. See also

Other references and sites of interest to 7. Testing Guidelines5. Testing Guidelines

To be filled.

7.1. Testplan for releases5.1. Testplan for releases

Explain release numbers. major, minor. developer releases. etc. @@ -156,7 +156,7 @@ CLASS="SECT2" CLASS="SECT2" >7.2. Test reports5.2. Test reports

Please submit test reports only with the 9. Update the Webserver7. Update the Webserver

When updating the webserver, please follow these steps to make diff --git a/doc/webserver/faq/configuration.html b/doc/webserver/faq/configuration.html index 45bfeacf..d575d161 100644 --- a/doc/webserver/faq/configuration.html +++ b/doc/webserver/faq/configuration.html @@ -105,7 +105,7 @@ CLASS="SECT2" >

3.2. What is an "actions"

3.4. How are actions files configured? What is the easiest way to do this?

3.5. There are several different "actions"

3.7. What is "default.filter"

3.8. How can I set up Privoxy

3.9. Instead of ads, now I get a checkerboard pattern. I don't want to see anything.

3.10. Why would anybody want to see a checkerboard pattern?

3.11. I see large red banners on some pages that say user manual, - which describes how to do this.

3.15. Can Privoxy run as a "transparent" proxy?

No, Privoxy currently does not have this ability, + though it is planned for a future release. Transparent proxies require + special handling of the request headers beyond what + Privoxy is now capable of.

Chaining Privoxy with another proxy that has + this ability should work though. + See the user + manual, which describes this, and also http://www.transproxy.nlc.net.au/.

7. Contacting the developers, Bug Reporting and Feature Requests6. Contacting the developers, Bug Reporting and Feature Requests

We value your feedback. However, to provide you with the best support, please @@ -82,7 +82,7 @@ CLASS="SECT2" CLASS="SECT2" >7.1. Get Support6.1. Get Support

7.2. Report bugs6.2. Report bugs

7.3. Request new features6.3. Request new features

7.4. Report ads or other filter problems6.4. Report ads or other filter problems

You can also send feedback on websites that Privoxy has problems with. Please bookmark @@ -194,7 +194,7 @@ CLASS="SECT2" CLASS="SECT2" >7.5. Other6.5. Other

8. Copyright and History7. Copyright and History

$Id: faq.sgml,v 1.52 2002/04/29 03:08:43 hal9 Exp $

$Id: faq.sgml,v 1.55 2002/05/04 00:41:56 hal9 Exp $

4.7. Can Privoxy

4.8. Might some things break because header information is being altered?

4.9. Can Privoxy

4.10. What about as a firewall? Can Privoxy

4.11. The Privoxy

4.12. I have large empty spaces now where ads used to be. Why?

4.13. How can Privoxy

4.14. Privoxy

5.1. I just upgraded and am getting "connection refused"

5.2. I just added a new rule, but the steenkin ad is still getting through. How?

5.3. One of my favorite sites does not work with Privoxy9. Actions Files8. Actions Files

The actions files are used to define what actions Privoxy takes for which URLs, and thus determines +> takes for which URLs, and thus determine how ad images, cookies and various other aspects of HTTP content and transactions are handled, and on which sites (or even parts thereof). There are three such files included with default.action. These have increasing levels of - aggressiveness. It is not recommend to edit this file. + aggressiveness and have no influence on your browsing unless + you select them explicitly in the editor. It is not recommend + to edit this file.

  • http://config.privoxy.org/show-status.

    An actions file typically has sections. Near the top, An actions file typically has multiple sections. If you want to use + "aliases" are - optionally defined (discussed in an actions file, you have to place the (optional) + below), then the default set of rules - which will apply universally to all sites and pages. And then below that, - exceptions to the defined universal policies.

    alias section at the top of that file. + Then comes the default set of rules which will apply universally to all + sites and pages (be very careful with using such a + universal set in user.action or any other actions file after + default.action, because it will override the result + from consulting any previous file). And then below that, + exceptions to the defined universal policies. You can regard + user.action as an appendix to default.action, + with the advantage that is a separate file, which makes preserving your + personal settings across Privoxy upgrades easier.

    Actions can be used to block anything you want, including ads, banners, or just some obnoxious URL that you would rather not see. Cookies can be accepted or rejected, or accepted only during the current browser session (i.e. not written to disk), content can be modified, JavaScripts tamed, user-tracking - fooled, and much more. See below for a complete list of actions.

    complete list + of actions.

    9.1. Finding the Right Mix8.1. Finding the Right Mix

    Note that some

    9.2. How to Edit8.2. How to Edit

    The easiest way to edit the "actions" files is with a browser by +> The easiest way to edit the actions files is with a browser by using our browser-based editor, which can be reached from http://config.privoxy.org/show-status. + The editor allows both fine-grained control over every single feature on a + per-URL basis, and easy choosing from wholesale sets of defaults like + "Cautious", "Medium" or "Advanced".

    If you prefer plain text editing to GUIs, you can of course also directly edit the - the actions files.

    default.action which is richly + commented.

    9.3. How Actions are Applied to URLs8.3. How Actions are Applied to URLs

    Actions files are divided into sections. There are special sections, @@ -242,7 +289,7 @@ HREF="actions-file.html#ALIASES" is a list of URL patterns, each on a separate line.

    To determine which actions apply to a request, the URL of the request is - compared to all patterns in this file. Every time it matches, the list of + compared to all patterns in each action file file. Every time it matches, the list of applicable actions for the URL is incrementally updated, using the heading of the section in which the pattern is located. If multiple matches for the same URL set the same action differently, the last match wins. If not, @@ -265,7 +312,7 @@ CLASS="QUOTE" > actions).

    You can trace this process by visiting You can trace this process for any given URL by visiting http://config.privoxy.org/show-url-info

    9.4. Patterns8.4. Patterns

    Generally, a pattern has the form

    9.4.1. The Domain Pattern8.4.1. The Domain Pattern

    The matching of the domain part offers some flexible options: if the @@ -562,8 +609,8 @@ CLASS="SECT3" >

    9.4.2. The Path Pattern8.4.2. The Path Pattern

    9.5. Actions8.5. Actions

  • All actions are disabled by default, until they are explicitly enabled @@ -649,26 +696,46 @@ CLASS="QUOTE" CLASS="QUOTE" >"-". So a - "+action"+action means "do that action", e.g. - +block means "+block" means please "please block URLs that match the + following patterns", and -block means "block the following URL - patterns".

    "don't + block URLs that match the following patterns, even if +block + previously applied."

    + Again, actions are invoked by placing them on a line, enclosed in curly braces and + separated by whitespace, like in + {+some-action -some-other-action{some-parameter}}, + followed by a list of URL patterns, one per line, to which they apply. + Together, the actions line and the following pattern lines make up a section + of the actions file.

    - Actions are invoked by enclosing the action name in curly braces (e.g. - {+some_action}), followed by a list of URLs (or patterns that match URLs) to - which the action applies. There are three classes of actions:

    Boolean, i.e the action can only be "on""enabled" or "off". Examples: -

    "disabled". Syntax: +

      +name        # enable action name
    +  -name        # disable action name
    +

    + Example:

      {+name}        # enable this action
    -  {-name}        # disable this action
    -     

    - +block

  • - Parameterized, e.g. "+/-hide-user-agent{ Mozilla 1.0 }", - where some value is required in order to enable this type of action. - Examples: + Parameterized, where some value is required in order to enable this type of action. + Syntax: +

      +name{param}  # enable action and set parameter to param,
    +               # overwriting parameter from previous match if necessary
    +  -name         # disable action. The parameter can be omitted
    +

    Note that if the URL matches multiple positive forms of a parameterized action, + the last match wins, i.e. the params from earlier matches are simply ignored.

    + Example:

      {+name{param}}  # enable action and set parameter to "param"
    -  {-name}         # disable action ("parameter") can be omitted
    -     

    - +hide-user-agent{ Mozilla 1.0 }

  • - - Multi-value, e.g. "{+/-add-header{Name: value}}" or - "{+/-send-wafer{name=value}}"), where some value needs to be defined - in addition to simply enabling the action. Examples: + Multi-value. These look exactly like parameterized actions, + but they behave differently: If the action applies multiple times to the + same URL, but with different parameters, all the parameters + from all matches are remembered. This is used for actions + that can be executed for the same request repeatedly, like adding multiple + headers, or filtering through multiple filters. Syntax: +

      +name{param}   # enable action and add param to the list of parameters
    +  -name{param}   # remove the parameter param from the list of parameters
    +                # If it was the last one left, disable the action.
    +  -name          # disable this action completely and remove all parameters from the list

    + Examples:

      {+name{param=value}}   # enable action and set "param" to "value"
    -  {-name{param=value}}   # remove the parameter "param" completely
    -  {-name}                # disable this action totally and remove param too
    -     

    - +add-header{X-Fun-Header: Some text} and + +filter{html-annoyances}

  • config (the default installation has three actions files). It also quite possible for any given URL pattern to match more than - one action!

    The list of valid Privoxy "actions" are:

    actions are:

    9.5.1. 8.5.1. +add-headerMulti-value.

    Typical uses:
    Purpose and typical uses:

    Send a user defined HTTP header to the web server. +> Send a user defined HTTP header to the web server. Can be used to confuse log analysis.

    Any value is possible. Validity of the defined HTTP headers is not checked. + It is recommended that you use the "X-" prefix + for custom headers.

    .example.com
    -    

    Notes:
    9.5.2. 8.5.2. +blockBoolean.

    Typical uses:
    Purpose and typical uses:

    Used to block a URL from reaching your browser. The URL may be - anything, but is typically used to block ads or other obnoxious - content. +> Requests for URLs to which this action applies are blocked, i.e. the requests are not + forwarded to the remote server, but answered locally with a substitute page or image, + as determined by the handle-as-image and + set-image-blocker actions. + It is typically used to block ads or other obnoxious content.

    9.5.3. 8.5.3. +deanimate-gifs9.5.4. 8.5.4. +downgrade-http-version9.5.5. 8.5.5. +fast-redirects9.5.6. 8.5.6. +filter9.5.7. 8.5.7. +hide-forwarded-for-headers9.5.8. 8.5.8. +hide-from-header9.5.9. 8.5.9. +hide-referer9.5.10. 8.5.10. +hide-user-agent9.5.11. 8.5.11. +handle-as-image9.5.12. 8.5.12. +set-image-blocker9.5.13. 8.5.13. +limit-connect9.5.14. 8.5.14. +prevent-compression9.5.15. 8.5.15. +session-cookies-only9.5.16. 8.5.16. +prevent-reading-cookies9.5.17. 8.5.17. +prevent-setting-cookies9.5.18. 8.5.18. +kill-popups9.5.19. 8.5.19. +send-vanilla-wafer9.5.20. 8.5.20. +send-wafer

    9.5.21. Summary8.5.21. Summary

    Note that many of these actions have the potential to cause a page to @@ -2859,7 +3015,7 @@ CLASS="SECT3" CLASS="SECT3" >9.5.22. Sample Actions Files8.5.22. Sample Actions Files

    Remember that the meaning of any of the above references is reversed by preceding @@ -3350,7 +3506,7 @@ CLASS="SECT2" CLASS="SECT2" >9.6. Aliases8.6. Aliases

    Custom 15. Appendix14. Appendix

    15.1. Regular Expressions14.1. Regular Expressions

    15.2. 14.2. Privoxy's Internal Pages
    Short cuts. Turn off, then on:

    15.2.1. Bookmarklets14.2.1. Bookmarklets

    Below are some 15.3. Chain of Events14.3. Chain of Events

    Let's take a quick look at the basic sequence of events when a web page is @@ -1314,7 +1314,7 @@ CLASS="SECT2" CLASS="SECT2" >15.4. Anatomy of an Action14.4. Anatomy of an Action

    The way 8. The Main Configuration File7. The Main Configuration File

    Again, the main configuration file is named   confdir /etc/privoxy
    -   

    8.1. Configuration and Log File Locations7.1. Configuration and Log File Locations

    Privoxy where to find those other files.

    The user running Privoxy, must have read permission for all + configuration files, and write permission to any files that would + be modified, such as log files.

    8.1.1. confdir7.1.1. confdir

    8.1.2. logdir7.1.2. logdir

    8.1.3. actionsfile7.1.3. actionsfile

    The actions file(s) to use +HREF="actions-file.html" +>actions file(s) to use

    File name, relative to confdir

    , without the .action suffix

    Default value:

      standard     # Internal purposes, recommended not editing

      standard     # Internal purposes, no editing recommended

    8.1.4. filterfile7.1.4. filterfile} - actions in the actions files are turned off + actions in the actions files are turned neutral.

    8.1.5. logfile7.1.5. logfile

    Any log files must be writable by whatever user Privoxy + is being run as (default on UNIX, user id is "privoxy"). +

    8.1.6. jarfile7.1.6. jarfile

    8.1.7. trustfile7.1.7. trustfile

    7.2. Local Set-up Documentation

    If you intend to operate Privoxy for more users + that just yourself, it might be a good idea to let them know how to reach + you, what you block and why you do that, your policies etc. +

    8.1.8. user-manual7.2.1. user-manual

    Default value:

    http://www.privoxy.org/user-manual/Unset

    Effect if unset:

    The default will be used. +> http://www.privoxy.org/version/user-manual/ + will be used, where version is the Privoxy version.

    Notes:

    The User Manual is used for help hints from some of the internal CGI pages. - It is normally packaged with the binary distributions, and would make more - sense to have this pointed at a locally installed copy. +> The User Manual URI is used for help links from some of the internal CGI pages. + The manual itself is normally packaged with the binary distributions, so you propably want + to set this to a locally installed copy. For multi-user setups, you could provide a copy on + a local webserver for all your users and use the corresponding URL here.

    A more useful example (Unix): +> Examples:

    -   user-manual  file:///usr/share/doc/privoxy-2.9.14/user-manual/ Unix, in local filesystem: +

    user-manual  file:///usr/share/doc/privoxy-2.9.15/user-manual/
    +

    Any platform, on local webserver (called "local-webserver"): +

    user-manual  http://local-webserver/privoxy-user-manual/

    Warning

    If set, this option should be the first option in the config file, because + it is used while the config file is being read. +

    8.2. Local Set-up Documentation

    If you intend to operate Privoxy for more users - that just yourself, it might be a good idea to let them know how to reach - you, what you block and why you do that, your policies etc. -

    8.2.1. trust-info-url7.2.2. trust-info-url

    8.2.2. admin-address7.2.3. admin-address

    8.2.3. proxy-info-url7.2.4. proxy-info-url

    8.3. Debugging7.3. Debugging

    These options are mainly useful when tracing a problem. @@ -1041,7 +1136,7 @@ CLASS="SECT3" CLASS="SECT3" >8.3.1. debug7.3.1. debug

    8.3.2. single-threaded7.3.2. single-threaded

    8.4. Access Control and Security7.4. Access Control and Security

    This section of the config file controls the security-relevant aspects @@ -1231,7 +1326,7 @@ CLASS="SECT3" CLASS="SECT3" >8.4.1. listen-address7.4.1. listen-address

    8.4.2. toggle7.4.2. toggle

    8.4.3. enable-remote-toggle7.4.3. enable-remote-toggle

    8.4.4. enable-edit-actions7.4.4. enable-edit-actions

    8.4.5. ACLs: permit-access and deny-access7.4.5. ACLs: permit-access and deny-access8.4.6. buffer-limit7.4.6. buffer-limit

    8.5. Forwarding7.5. Forwarding

    This feature allows routing of HTTP requests through a chain of @@ -1975,7 +2070,7 @@ CLASS="SECT3" CLASS="SECT3" >8.5.1. forward7.5.1. forward

    8.5.2. forward-socks4 and forward-socks4a7.5.2. forward-socks4 and forward-socks4a8.5.3. Advanced Forwarding Examples7.5.3. Advanced Forwarding Examples

    If you have links to multiple ISPs that provide various special content @@ -2465,7 +2560,7 @@ CLASS="SECT2" CLASS="SECT2" >8.6. Windows GUI Options7.6. Windows GUI Options

    7. 6. Privoxy Configuration

    7.1. Controlling 6.1. Controlling Privoxy with Your Web Browser

    This should be self-explanatory. Note the first item leads to an editor for the - "actions list", which is where the ad, banner, cookie, - and URL blocking magic is configured as well as other advanced features of + actions files, which is where the ad, banner, + cookie, and URL blocking magic is configured as well as other advanced features of PrivoxyPrivoxy continues - to run as a proxy in this case, but all filtering is disabled. There + to run as a proxy in this case, but all manipulation is disabled, i.e. + Privoxy acts like a normal forwarding proxy. There is even a toggle Bookmarklet7.2. Configuration Files Overview6.2. Configuration Files Overview

    For Unix, *BSD and Linux, all configuration files are located in @@ -257,9 +261,12 @@ CLASS="APPLICATION" >