From: Fabian Keil Date: Sat, 2 Mar 2013 14:41:28 +0000 (+0000) Subject: Rebuild docs with recent changes X-Git-Tag: v_3_0_21~17 X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=commitdiff_plain;h=bbfe461fae901a7daf3bae1e3087c02f98a24deb Rebuild docs with recent changes --- diff --git a/AUTHORS b/AUTHORS index 256b0749..fb7ec691 100644 --- a/AUTHORS +++ b/AUTHORS @@ -4,8 +4,7 @@ Current Privoxy Team: Fabian Keil, lead developer - David Schmidt, developer - + David Schmidt Hal Burgiss Lee Rian Roland Rosenfeld @@ -43,6 +42,7 @@ patches, made suggestions or contributed in some way. These include (in alphabetical order): Ken Arromdee + Natxo Asenjo Devin Bayer Havard Berland David Bo @@ -81,6 +81,7 @@ alphabetical order): Derek Jennings Andrew Jones Julien Joubert + Ralf Jungblut Petr Kadlec Steven Kolins Zeno Kugy diff --git a/INSTALL b/INSTALL index 81e1f708..f7763cf1 100644 --- a/INSTALL +++ b/INSTALL @@ -40,8 +40,8 @@ compiler like gcc are required. When building from a source tarball, first unpack the source: - tar xzvf privoxy-3.0.20-beta-src.tar.gz - cd privoxy-3.0.20-beta + tar xzvf privoxy-3.0.21-stable-src.tar.gz + cd privoxy-3.0.21-stable For retrieving the current CVS sources, you'll need a CVS client installed. Note that sources from CVS are typically development quality, and may not be diff --git a/README b/README index ad7d3d15..7e8331a4 100644 --- a/README +++ b/README @@ -32,9 +32,8 @@ * *********************************************************************/ -This README is included with the development version of Privoxy 3.0.20. See -http://www.privoxy.org/ for more information. The current code maturity level -is "beta", but seems stable to us :). +This README is included with Privoxy 3.0.21. See http://www.privoxy.org/ for +more information. The current code maturity level is "stable". ------------------------------------------------------------------------------- @@ -105,22 +104,16 @@ try it with FTP or other protocols for the simple reason it does not work. The actions list can be configured via the web interface accessed via http:// p.p/, as well other options. -All configuration files are subject to unannounced changes during the -development process. - ------------------------------------------------------------------------------- 5. DOCUMENTATION -There should be documentation in the 'doc' subdirectory, but it may not be -completed at this point. In particular, see the User Manual there, the FAQ, and -those interested in Privoxy development, should look at developer-manual. +There should be documentation in the 'doc' subdirectory. In particular, see the +User Manual there, the FAQ, and those interested in Privoxy development, should +look at developer-manual. -The most up to date source of information on the current development version, -may still be either comments in the source code, or the included configuration -files. The source and configuration files are all well commented. The main -configuration files are: 'config', 'default.action', and 'default.filter' in -the top-level source directory. +The source and configuration files are all well commented. The main +configuration files are: 'config', 'default.action', and 'default.filter'. Included documentation may vary according to platform and packager. All documentation is posted on http://www.privoxy.org, in case you don't have it, @@ -132,98 +125,36 @@ or can't find it. We value your feedback. In fact, we rely on it to improve Privoxy and its configuration. However, please note the following hints, so we can provide you -with the best support: +with the best support. ------------------------------------------------------------------------------- -6.1. Get Support +6.1. Please provide sufficient information -For casual users, our support forum at SourceForge is probably best suited: -http://sourceforge.net/tracker/?group_id=11118&atid=211118 +A lot of support requests don't contain enough information and can't be solved +without a lot of back and forth which causes unnecessary delays. Reading this +section should help to prevent that. -All users are of course welcome to discuss their issues on the users mailing -list, where the developers also hang around. +Before contacting us to report a problem, please try to verify that it is a +Privoxy problem, and not a browser or site problem or documented behaviour that +just happens to be different than what you expected. If unsure, try toggling +off Privoxy, and see if the problem persists. -Please don't sent private support requests to individual Privoxy developers, -either use the mailing lists or the support trackers. +If you are using your own custom configuration, please try the default +configuration to see if the problem is configuration related. If you're having +problems with a feature that is disabled by default, please ask around on the +mailing list if others can reproduce the problem. -If you have to contact a Privoxy developer directly for other reasons, please -send a real mail and do not bother with SourceForge's messaging system. Answers -to SourceForge messages are usually bounced by SourceForge's mail server in -which case the developer wasted time writing a response you don't get. From -your point of view it will look like your message has been completely ignored, -so this is frustrating for all parties involved. +If you aren't using the latest Privoxy version, the problem may have been found +and fixed in the meantime. We would appreciate if you could take the time to +upgrade to the latest version and verify that the problem still exists. -Note that the Privoxy mailing lists are moderated. Posts from unsubscribed -addresses have to be accepted manually by a moderator. This may cause a delay -of several days and if you use a subject that doesn't clearly mention Privoxy -or one of its features, your message may be accidentally discarded as spam. +Please be sure to provide the following information when reporting problems or +requesting support: -If you aren't subscribed, you should therefore spend a few seconds to come up -with a proper subject. Additionally you should make it clear that you want to -get CC'd. Otherwise some responses will be directed to the mailing list only, -and you won't see them. + * The exact Privoxy version you are using. -------------------------------------------------------------------------------- - -6.2. Reporting Problems - -"Problems" for our purposes, come in two forms: - - * Configuration issues, such as ads that slip through, or sites that don't - function properly due to one Privoxy "action" or another being turned "on". - - * "Bugs" in the programming code that makes up Privoxy, such as that might - cause a crash. - -------------------------------------------------------------------------------- - -6.2.1. Reporting Ads or Other Configuration Problems - -Please send feedback on ads that slipped through, innocent images that were -blocked, sites that don't work properly, and other configuration related -problem of default.action file, to http://sourceforge.net/tracker/?group_id= -11118&atid=460288, the Actions File Tracker. - -New, improved default.action files may occasionally be made available based on -your feedback. These will be announced on the ijbswa-announce list and -available from our the files section of our project page. - -------------------------------------------------------------------------------- - -6.2.2. Reporting Bugs - -Please report all bugs through our bug tracker: http://sourceforge.net/tracker -/?group_id=11118&atid=111118. - -Before doing so, please make sure that the bug has not already been submitted -and observe the additional hints at the top of the submit form. If already -submitted, please feel free to add any info to the original report that might -help to solve the issue. - -Please try to verify that it is a Privoxy bug, and not a browser or site bug or -documented behaviour that just happens to be different than what you expected. -If unsure, try toggling off Privoxy, and see if the problem persists. - -If you are using your own custom configuration, please try the stock configs to -see if the problem is configuration related. If you're having problems with a -feature that is disabled by default, please ask around on the mailing list if -others can reproduce the problem. - -If you aren't using the latest Privoxy version, the bug may have been found and -fixed in the meantime. We would appreciate if you could take the time to -upgrade to the latest version (or even the latest CVS snapshot) and verify that -your bug still exists. - -Please be sure to provide the following information: - - * The exact Privoxy version you are using (if you got the source from CVS, - please also provide the source code revisions as shown in http:// - config.privoxy.org/show-version). - - * The operating system and versions you run Privoxy on, (e.g. Windows XP - SP2), if you are using a Unix flavor, sending the output of "uname -a" - should do, in case of GNU/Linux, please also name the distribution. + * The operating system and versions you run Privoxy on, e.g. Windows XP SP2. * The name, platform, and version of the browser you were using (e.g. Internet Explorer v5.5 for Mac). @@ -234,7 +165,7 @@ Please be sure to provide the following information: * Whether your version of Privoxy is one supplied by the Privoxy developers via SourceForge, or if you got your copy somewhere else. - * Whether you are using Privoxy in tandem with another proxy such as Tor. If + * Whether you are using Privoxy together with another proxy such as Tor. If so, please temporary disable the other proxy to see if the symptoms change. * Whether you are using a personal firewall product. If so, does Privoxy work @@ -243,7 +174,8 @@ Please be sure to provide the following information: * Any other pertinent information to help identify the problem such as config or log file excerpts (yes, you should have log file entries for each action taken). To get a meaningful logfile, please make sure that the logfile - directive is being used and the following debug options are enabled: + directive is being used and the following debug options are enabled (all of + them): debug 1 # Log the destination for each request Privoxy let through. See also debug 1024. debug 2 # show each connection status @@ -265,6 +197,11 @@ Please be sure to provide the following information: debug 32768 # log all data read from the network + It's easy for us to ignore log messages that aren't relevant but missing + log messages may make it impossible to investigate a problem. If you aren't + sure which of the debug directives are relevant, please just enable all of + them and let us worry about it. + Note that Privoxy log files may contain sensitive information so please don't submit any logfiles you didn't read first. You can mask sensitive information as long as it's clear that you removed something. @@ -291,7 +228,74 @@ understanding actions, and action debugging. ------------------------------------------------------------------------------- -6.3. Request New Features +6.2. Get Support + +For casual users, our support forum at SourceForge is probably best suited: +http://sourceforge.net/tracker/?group_id=11118&atid=211118 + +All users are of course welcome to discuss their issues on the users mailing +list, where the developers also hang around. + +Please don't send private support requests to individual Privoxy developers, +either use the mailing lists or the support trackers. + +If you have to contact a Privoxy developer directly for other reasons, please +send a real mail and do not bother with SourceForge's messaging system. Answers +to SourceForge messages are usually bounced by SourceForge's mail server in +which case the developer wasted time writing a response you don't get. From +your point of view it will look like your message has been completely ignored, +so this is frustrating for all parties involved. + +Note that the Privoxy mailing lists are moderated. Posts from unsubscribed +addresses have to be accepted manually by a moderator. This may cause a delay +of several days and if you use a subject that doesn't clearly mention Privoxy +or one of its features, your message may be accidentally discarded as spam. + +If you aren't subscribed, you should therefore spend a few seconds to come up +with a proper subject. Additionally you should make it clear that you want to +get CC'd. Otherwise some responses will be directed to the mailing list only, +and you won't see them. + +------------------------------------------------------------------------------- + +6.3. Reporting Problems + +"Problems" for our purposes, come in two forms: + + * Configuration issues, such as ads that slip through, or sites that don't + function properly due to one Privoxy "action" or another being turned "on". + + * "Bugs" in the programming code that makes up Privoxy, such as that might + cause a crash. + +------------------------------------------------------------------------------- + +6.3.1. Reporting Ads or Other Configuration Problems + +Please send feedback on ads that slipped through, innocent images that were +blocked, sites that don't work properly, and other configuration related +problem of default.action file, to http://sourceforge.net/tracker/?group_id= +11118&atid=460288, the Actions File Tracker. + +New, improved default.action files may occasionally be made available based on +your feedback. These will be announced on the ijbswa-announce list and +available from our the files section of our project page. + +------------------------------------------------------------------------------- + +6.3.2. Reporting Bugs + +Please report all bugs through our bug tracker: http://sourceforge.net/tracker +/?group_id=11118&atid=111118. + +Before doing so, please make sure that the bug has not already been submitted +and observe the additional hints at the top of the submit form. If already +submitted, please feel free to add any info to the original report that might +help to solve the issue. + +------------------------------------------------------------------------------- + +6.4. Request New Features You are welcome to submit ideas on new features or other proposals for improvement through our feature request tracker at http://sourceforge.net/ @@ -299,7 +303,7 @@ tracker/?atid=361118&group_id=11118. ------------------------------------------------------------------------------- -6.4. Mailing Lists +6.5. Mailing Lists If you prefer to communicate through email, instead of using a web interface, feel free to use one of the mailing lists. To discuss issues that haven't been diff --git a/doc/webserver/developer-manual/index.html b/doc/webserver/developer-manual/index.html index 3b8b4753..604226cb 100644 --- a/doc/webserver/developer-manual/index.html +++ b/doc/webserver/developer-manual/index.html @@ -20,12 +20,12 @@

Copyright © 2001-2012 by Copyright © 2001-2013 by Privoxy Developers

-

$Id: developer-manual.sgml,v 2.53 2013/02/26 - 15:09:35 fabiankeil Exp $

+

$Id: developer-manual.sgml,v 2.57 2013/03/01 + 17:44:24 fabiankeil Exp $

diff --git a/doc/webserver/faq/contact.html b/doc/webserver/faq/contact.html index e8d9cf6c..a5615e5e 100644 --- a/doc/webserver/faq/contact.html +++ b/doc/webserver/faq/contact.html @@ -219,7 +219,7 @@ target="_top">users mailing list, where the developers also hang around.

-

Please don't sent private support requests to individual Privoxy +

Please don't send private support requests to individual Privoxy developers, either use the mailing lists or the support trackers.

If you have to contact a Privoxy developer directly for other diff --git a/doc/webserver/faq/index.html b/doc/webserver/faq/index.html index 0015aac0..dbb28c13 100644 --- a/doc/webserver/faq/index.html +++ b/doc/webserver/faq/index.html @@ -22,7 +22,7 @@ 2001-2011 by Privoxy Developers

-

$Id: faq.sgml,v 2.91 2013/02/26 15:09:35 fabiankeil +

$Id: faq.sgml,v 2.92 2013/03/01 17:44:24 fabiankeil Exp $

diff --git a/doc/webserver/man-page/privoxy-man-page.html b/doc/webserver/man-page/privoxy-man-page.html index dd70bfe5..219e390b 100644 --- a/doc/webserver/man-page/privoxy-man-page.html +++ b/doc/webserver/man-page/privoxy-man-page.html @@ -8,7 +8,7 @@

PRIVOXY

Section: (1)
- Updated: 06 Januar 2013
+ Updated: 02 March 2013
Index
  @@ -207,9 +207,6 @@

NOTES

-

This is a beta version of Privoxy. Not all features are well - tested.

-

Please see the User Manual on how to contact the developers, for feature requests, reporting problems, and other questions.  

@@ -237,15 +234,14 @@ Shortcut: http://p.p/

https://sourceforge.net/tracker/?group_id=11118&atid=460288, + "https://sourceforge.net/tracker/?group_id=11118">https://sourceforge.net/tracker/?group_id=11118&atid=460288, to submit ``misses'' and other configuration related suggestions to the developers.  

DEVELOPMENT TEAM

  Fabian Keil, lead developer
- David Schmidt, developer
-
+ David Schmidt
  Hal Burgiss
  Lee Rian
  Roland Rosenfeld
@@ -269,14 +265,10 @@
   it under the terms of the GNU General Public License, version 2, as
   published by the Free Software Foundation.

 
-  
This program is distributed in the hope that it will be useful, but
+  
Privoxy 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 details.

-
-  
You should have received a copy of the GNU GPL along with this
-  program; if not, write to the Free Software Foundation, Inc. 51 Franklin
-  Street, Fifth Floor Boston, MA 02110-1301 USA

+  or FITNESS FOR A PARTICULAR PURPOSE. See the license for
+  details.

   

    
 
@@ -317,6 +309,6 @@
   
   

   This document was created by man2html, using the manual pages.

-  Time: 18:35:36 GMT, January 06, 2013
+  Time: 14:21:31 GMT, March 02, 2013
 
 
diff --git a/doc/webserver/user-manual/actions-file.html b/doc/webserver/user-manual/actions-file.html
index c1a6cb33..faa5e629 100644
--- a/doc/webserver/user-manual/actions-file.html
+++ b/doc/webserver/user-manual/actions-file.html
@@ -117,7 +117,7 @@
         in default.action are:

 
         

-          
+          
 
           
Table 1. Default Configurations

 
@@ -314,7 +314,7 @@
     actions.

 
     

-      
8.1. Finding the Right
+      
8.1. Finding the Right
       Mix

 
       
Note that some actions, like
@@ -339,7 +339,7 @@
     

 
     

-      
8.2. How to
+      
8.2. How to
       Edit

 
       
The easiest way to edit the actions files is with a browser by using
@@ -529,7 +529,7 @@
       

 
       

-        
8.4.1. The Domain
+        
8.4.1. The Domain
         Pattern

 
         
The matching of the domain part offers some flexible options: if
@@ -634,7 +634,7 @@
       

 
       

-        
8.4.2. The Path
+        
8.4.2. The Path
         Pattern

 
         
Privoxy uses 
                   
                     
-+filter{js-events}           # Kill all JS event bindings and timers (Radically destructive! Only for extra nasty sites).
++filter{js-events}           # Kill JavaScript event bindings and timers (Radically destructive! Only for extra nasty sites).
 

                   
                 
@@ -2280,7 +2280,7 @@ problem-host.example.com
                 
                   
                     
-+filter{refresh-tags}        # Kill automatic refresh tags (for dial-on-demand setups).
++filter{refresh-tags}        # Kill automatic refresh tags if refresh time is larger than 9 seconds.
 

                   
                 
@@ -2293,7 +2293,7 @@ problem-host.example.com
                 
                   
                     
-+filter{unsolicited-popups}  # Disable only unsolicited pop-up windows. Useful if your browser lacks this ability.
++filter{unsolicited-popups}  # Disable only unsolicited pop-up windows.
 

                   
                 
@@ -2305,7 +2305,7 @@ problem-host.example.com
                 
                   
                     
-+filter{all-popups}          # Kill all popups in JavaScript and HTML. Useful if your browser lacks this ability.
++filter{all-popups}          # Kill all popups in JavaScript and HTML.
 

                   
                 
@@ -2401,6 +2401,18 @@ problem-host.example.com
                 
               
 
+              

+
+              
+                
+                  
+                
+              

+                    
++filter{iframes}             # Removes all detected iframes. Should only be enabled for individual sites.
+

+                  

+
               

 
@@ -4324,7 +4336,7 @@ example.org/instance-that-is-delivered-as-xml-but-is-not
       

 
       

-        
8.5.35.
+        
8.5.35.
         Summary

 
         
Note that many of these actions have the potential to cause a page
@@ -4483,7 +4495,7 @@ example.org/instance-that-is-delivered-as-xml-but-is-not
       together:

 
       

-        
8.7.1.
+        
8.7.1.
         match-all.action

 
         
Remember all actions
@@ -4532,7 +4544,7 @@ example.org/instance-that-is-delivered-as-xml-but-is-not
       

 
       

-        
8.7.2.
+        
8.7.2.
         default.action

 
         
If you aren't a developer, there's no need for you to edit the
@@ -4875,7 +4887,7 @@ wiki.
       

 
       

-        
8.7.3.
+        
8.7.3.
         user.action

 
         
So far we are painting with a broad brush by setting general
diff --git a/doc/webserver/user-manual/appendix.html b/doc/webserver/user-manual/appendix.html
index a99d71d1..5a07a155 100644
--- a/doc/webserver/user-manual/appendix.html
+++ b/doc/webserver/user-manual/appendix.html
@@ -293,7 +293,7 @@
     

 
     

-      
14.2. Privoxy's
+      
14.2. Privoxy's
       Internal Pages

 
       
Since Privoxy proxies each
@@ -313,7 +313,7 @@
-

    Privoxy Menu

- 
-
+

    Privoxy Menu

diff --git a/doc/webserver/user-manual/contact.html b/doc/webserver/user-manual/contact.html index 40f8fd9a..87b96447 100644 --- a/doc/webserver/user-manual/contact.html +++ b/doc/webserver/user-manual/contact.html @@ -219,7 +219,7 @@ target="_top">users mailing list, where the developers also hang around.

-

Please don't sent private support requests to individual Privoxy +

Please don't send private support requests to individual Privoxy developers, either use the mailing lists or the support trackers.

If you have to contact a Privoxy developer directly for other diff --git a/doc/webserver/user-manual/filter-file.html b/doc/webserver/user-manual/filter-file.html index a0c89922..a9aac417 100644 --- a/doc/webserver/user-manual/filter-file.html +++ b/doc/webserver/user-manual/filter-file.html @@ -151,7 +151,7 @@ FILTER: foo Replace all "foo" with "bar" started.

-

9.1. Filter File +

9.1. Filter File Tutorial

Now, let's complete our "foo" content diff --git a/doc/webserver/user-manual/index.html b/doc/webserver/user-manual/index.html index 462fe446..95276124 100644 --- a/doc/webserver/user-manual/index.html +++ b/doc/webserver/user-manual/index.html @@ -23,7 +23,7 @@ 2001-2013 by Privoxy Developers

-

$Id: user-manual.sgml,v 2.169 2013/02/26 15:10:49 +

$Id: user-manual.sgml,v 2.173 2013/03/01 17:44:24 fabiankeil Exp $

@@ -173,7 +173,7 @@
-
6.1. Controlling Privoxy +
6.1. Controlling Privoxy with Your Web Browser
6.2. Configuration @@ -342,10 +342,10 @@
-
8.1. Finding the Right +
8.1. Finding the Right Mix
-
8.2. How to Edit
+
8.2. How to Edit
8.3. How Actions are Applied to Requests
@@ -355,10 +355,10 @@
-
8.4.1. The Domain +
8.4.1. The Domain Pattern
-
8.4.2. The Path +
8.4.2. The Path Pattern
8.4.3. The Tag @@ -472,7 +472,7 @@ "actions-file.html#SET-IMAGE-BLOCKER">set-image-blocker
8.5.35. Summary
+ "actions-file.html#AEN4795">Summary
@@ -484,13 +484,13 @@
8.7.1. match-all.action
+ "actions-file.html#AEN4859">match-all.action
8.7.2. default.action
+ "actions-file.html#AEN4881">default.action
8.7.3. user.action
+ "actions-file.html#AEN4994">user.action
@@ -500,7 +500,7 @@
-
9.1. Filter File +
9.1. Filter File Tutorial
9.2. The @@ -564,7 +564,7 @@
14.1. Regular Expressions
-
14.2. Privoxy's Internal +
14.2. Privoxy's Internal Pages
diff --git a/doc/webserver/user-manual/quickstart.html b/doc/webserver/user-manual/quickstart.html index 99765628..13d9b237 100644 --- a/doc/webserver/user-manual/quickstart.html +++ b/doc/webserver/user-manual/quickstart.html @@ -343,7 +343,7 @@ "GUIBUTTON">Edit":

- +

Figure 1. Actions Files in Use

diff --git a/doc/webserver/user-manual/startup.html b/doc/webserver/user-manual/startup.html index 05bfa585..664c2272 100644 --- a/doc/webserver/user-manual/startup.html +++ b/doc/webserver/user-manual/startup.html @@ -55,7 +55,7 @@ protocols.

- +

Figure 2. Proxy Configuration Showing Mozilla/Netscape HTTP and HTTPS (SSL) Settings

@@ -112,7 +112,7 @@ only HTTP and HTTPS (SSL)!

- +

Figure 3. Proxy Configuration Showing Internet Explorer HTTP and HTTPS (Secure) Settings

diff --git a/doc/webserver/user-manual/whatsnew.html b/doc/webserver/user-manual/whatsnew.html index 6ee59b86..937f248a 100644 --- a/doc/webserver/user-manual/whatsnew.html +++ b/doc/webserver/user-manual/whatsnew.html @@ -41,14 +41,23 @@

3. What's New in this Release

-

Privoxy 3.0.21 is UNRELEASED. The - changes since 3.0.20 beta are:

+

Privoxy 3.0.21 stable is a bug-fix + release for Privoxy 3.0.20 beta. It also addresses a security issue that + affects all previous Privoxy versions (on some platforms). The changes + since 3.0.20 beta are:

  • Bug fixes:

      +
    • +

      On POSIX-like platforms, network sockets with file descriptor + values above FD_SETSIZE are properly rejected. Previously they + could cause memory corruption in configurations that allowed the + limit to be reached.

      +
      • +

    • Compiles on OS/2 again now that unistd.h is only included on platforms that have it.

      @@ -74,6 +83,11 @@

      Added an LSB info block to the generic start script. Based on a patch from Natxo Asenjo.

      • + +
    • +

      The max-client-connections default has been changed to 128 + which should be more than enough for most setups.

      +