From 23be303a582b85ccac7592d0135f0beb9cf170f6 Mon Sep 17 00:00:00 2001 From: Fabian Keil Date: Sun, 21 Oct 2012 13:03:09 +0000 Subject: [PATCH] Rebuild documentation for the new config directives in 3.0.20 --- doc/webserver/developer-manual/coding.html | 168 ++++++++---------- doc/webserver/developer-manual/copyright.html | 29 ++- doc/webserver/developer-manual/cvs.html | 19 +- .../developer-manual/documentation.html | 24 ++- doc/webserver/developer-manual/index.html | 29 ++- .../developer-manual/newrelease.html | 159 ++++++++++++----- doc/webserver/developer-manual/seealso.html | 20 --- doc/webserver/faq/configuration.html | 14 +- doc/webserver/faq/copyright.html | 29 ++- doc/webserver/faq/general.html | 62 ++++--- doc/webserver/faq/index.html | 50 +++--- doc/webserver/faq/installation.html | 13 +- doc/webserver/faq/misc.html | 40 ++--- doc/webserver/faq/trouble.html | 4 +- doc/webserver/index.html | 32 +--- doc/webserver/privoxy-index.html | 30 +--- doc/webserver/user-manual/actions-file.html | 47 +++-- doc/webserver/user-manual/appendix.html | 32 ++-- doc/webserver/user-manual/config.html | 151 +++++++++++++--- doc/webserver/user-manual/configuration.html | 22 ++- doc/webserver/user-manual/contact.html | 4 +- doc/webserver/user-manual/copyright.html | 39 ++-- doc/webserver/user-manual/filter-file.html | 10 +- doc/webserver/user-manual/index.html | 60 ++++--- doc/webserver/user-manual/installation.html | 99 ++++++++--- doc/webserver/user-manual/introduction.html | 26 ++- doc/webserver/user-manual/quickstart.html | 6 +- doc/webserver/user-manual/seealso.html | 24 +-- doc/webserver/user-manual/startup.html | 8 +- doc/webserver/user-manual/templates.html | 4 +- doc/webserver/user-manual/whatsnew.html | 4 +- 31 files changed, 704 insertions(+), 554 deletions(-) diff --git a/doc/webserver/developer-manual/coding.html b/doc/webserver/developer-manual/coding.html index 0855d86f..19bc35e3 100644 --- a/doc/webserver/developer-manual/coding.html +++ b/doc/webserver/developer-manual/coding.html @@ -71,8 +71,8 @@ because a person can read code does not mean they will understand why or what is being done. A reader may spend a lot more time figuring out what is going on when a simple comment or explanation would have - prevented the extra research. Please help your brother IJB'ers - out!

+ prevented the extra research. Please help your fellow Privoxy + developers out!

The comments will also help justify the intent of the code. If the comment describes something different than what the code is doing @@ -85,13 +85,13 @@

 /* if page size greater than 1k ... */
-if ( page_length() > 1024 )
+if (page_length() > 1024)
 {
     ... "block" the page up ...
 }
 
 /* if page size is small, send it in blocks */
-if ( page_length() > 1024 )
+if (page_length() > 1024)
 {
     ... "block" the page up ...
 }
@@ -127,20 +127,20 @@ is actually being done.
 /*********************************************************************
  * This will stand out clearly in your code!
  *********************************************************************/
-if ( this_variable == that_variable )
+if (this_variable == that_variable)
 {
    do_something_very_important();
 }
 
 
 /* unfortunately, this may not */
-if ( this_variable == that_variable )
+if (this_variable == that_variable)
 {
    do_something_very_important();
 }
 
 
-if ( this_variable == that_variable ) /* this may not either */
+if (this_variable == that_variable) /* this may not either */
 {
    do_something_very_important();
 }
@@ -182,12 +182,12 @@ if ( this_variable == that_variable ) /* this may not either */
  * This will stand out clearly in your code,
  * But the second example won't.
  *********************************************************************/
-if ( this_variable == this_variable )
+if (this_variable == this_variable)
 {
    do_something_very_important();
 }
 
-if ( this_variable == this_variable ) /*can you see me?*/
+if (this_variable == this_variable) /*can you see me?*/
 {
    do_something_very_important(); /*not easily*/
 }
@@ -199,7 +199,7 @@ if ( this_variable == this_variable ) /*can you see me?*/
 int urls_read     = 0;     /* # of urls read + rejected */
 int urls_rejected = 0;     /* # of urls rejected */
 
-if ( 1 == X )
+if (1 == X)
 {
    do_something_very_important();
 }
@@ -281,7 +281,7 @@ short do_something_very_important(
           
             
               
-if ( 1 == X )
+if (1 == X)
 {
    do_something_very_important();
    ...some long list of commands...
@@ -289,11 +289,11 @@ if ( 1 == X )
 
 or:
 
-if ( 1 == X )
+if (1 == X)
 {
    do_something_very_important();
    ...some long list of commands...
-} /* -END- if ( 1 == X ) */
+} /* -END- if (1 == X) */
 
@@ -362,7 +362,7 @@ int msiis5hack = 0; int msIis5Hack = 0;
-int load_some_file( struct client_state *csp )
+int load_some_file(struct client_state *csp)
 
@@ -375,8 +375,8 @@ int load_some_file( struct client_state *csp )
-int loadsomefile( struct client_state *csp )
-int loadSomeFile( struct client_state *csp )
+int loadsomefile(struct client_state *csp)
+int loadSomeFile(struct client_state *csp)
 
@@ -400,8 +400,8 @@ int loadSomeFile( struct client_state *csp )
-(.h) extern int load_aclfile( struct client_state *csp );
-(.c) int load_aclfile( struct client_state *csp )
+(.h) extern int load_aclfile(struct client_state *csp);
+(.c) int load_aclfile(struct client_state *csp)
 
@@ -414,9 +414,9 @@ int loadSomeFile( struct client_state *csp )
-(.h) extern int load_aclfile( struct client_state * ); or
+(.h) extern int load_aclfile(struct client_state *); or
 (.h) extern int load_aclfile();
-(.c) int load_aclfile( struct client_state *csp )
+(.c) int load_aclfile(struct client_state *csp)
 
@@ -440,7 +440,7 @@ int loadSomeFile( struct client_state *csp )
-(enumeration) : enum Boolean { FALSE, TRUE };
+(enumeration) : enum Boolean {FALSE, TRUE};
 (#define) : #define DEFAULT_SIZE 100;
 
@@ -535,7 +535,7 @@ int loadSomeFile( struct client_state *csp )
-if ( this == that )
+if (this == that)
 {
    ...
 }
@@ -547,11 +547,11 @@ if ( this == that )
         

Instead of:

-

if ( this == that ) { ... }

+

if (this == that) { ... }

or

-

if ( this == that ) { ... }

+

if (this == that) { ... }

Note: In the special case that the if-statement is inside a loop, and it is @@ -569,12 +569,12 @@ if ( this == that )

-while ( more lines are read )
+while (more lines are read)
 {
    /* Please document what is/is not a comment line here */
-   if ( it's a comment ) continue;
+   if (it's a comment) continue;
 
-   do_something( line );
+   do_something(line);
 }
 
@@ -599,7 +599,7 @@ while ( more lines are read )
-if ( this == that )
+if (this == that)
 {
    do_something();
    do_something_else();
@@ -612,11 +612,11 @@ if ( this == that )
         

Instead of:

-

if ( this == that ) do_something(); do_something_else();

+

if (this == that) do_something(); do_something_else();

or

-

if ( this == that ) do_something();

+

if (this == that) do_something();

Note: The first example in "Instead of" will execute in a manner other than @@ -635,7 +635,7 @@ if ( this == that )

-structure->flag = ( condition );
+structure->flag = (condition);
 
@@ -644,7 +644,7 @@ structure->flag = ( condition );

Instead of:

-

if ( condition ) { structure->flag = 1; } else { +

if (condition) { structure->flag = 1; } else { structure->flag = 0; }

Note: The @@ -674,10 +674,6 @@ int first_value = 0; int some_value = 0; int another_value = 0; int this_variable = 0; - -if ( this_variable == this_variable ) - -first_value = old_value + ( ( some_value - another_value ) - whatever )

@@ -729,14 +725,14 @@ function_name(); int function1( ... ) { ...code... - return( ret_code ); + return(ret_code); -} /* -END- function1 */ +} /* -END- function1 */ int function2( ... ) { -} /* -END- function2 */ +} /* -END- function2 */
@@ -745,7 +741,7 @@ int function2( ... )

Instead of:

-

int function1( ... ) { ...code... return( ret_code ); } int +

int function1( ... ) { ...code... return(ret_code); } int function2( ... ) { }

Note: Use 1 @@ -787,16 +783,16 @@ static const char * const url_code_map[256] = int function1( ... ) { - if ( 1 ) + if (1) { - return( ALWAYS_TRUE ); + return ALWAYS_TRUE; } else { - return( HOW_DID_YOU_GET_HERE ); + return HOW_DID_YOU_GET_HERE; } - return( NEVER_GETS_HERE ); + return NEVER_GETS_HERE; }

@@ -902,7 +898,7 @@ is_web_page_blank();
-for ( size_t cnt = 0; cnt < block_list_length(); cnt++ )
+for (size_t cnt = 0; cnt < block_list_length(); cnt++)
 {
    ....
 }
@@ -932,7 +928,7 @@ for ( size_t cnt = 0; cnt < block_list_length(); cnt++ )
               
 size_t len = block_list_length();
 
-for ( size_t cnt = 0; cnt < len; cnt++ )
+for (size_t cnt = 0; cnt < len; cnt++)
 {
    ....
 }
@@ -957,10 +953,10 @@ for ( size_t cnt = 0; cnt < len; cnt++ )
         

This allows a developer to define a const pointer and call your function. If your function does not have the const keyword, we may not be able to use your function. Consider strcmp, if it were defined - as: extern int strcmp( char *s1, char *s2 );

+ as: extern int strcmp(char *s1, char *s2);

-

I could then not use it to compare argv's in main: int main( int - argc, const char *argv[] ) { strcmp( argv[0], "privoxy" ); }

+

I could then not use it to compare argv's in main: int main(int + argc, const char *argv[]) { strcmp(argv[0], "privoxy"); }

Both these pointers are *const*! If the c runtime library maintainers do it, we should too.

@@ -975,11 +971,11 @@ for ( size_t cnt = 0; cnt < len; cnt++ )

Most structures cannot fit onto a normal stack entry (i.e. they are not 4 bytes or less). Aka, a function declaration like: int - load_aclfile( struct client_state csp )

+ load_aclfile(struct client_state csp)

would not work. So, to be consistent, we should declare all - prototypes with "pass by value": int load_aclfile( struct - client_state *csp )

+ prototypes with "pass by value": int load_aclfile(struct client_state + *csp)

@@ -1161,22 +1157,22 @@ extern file_list *xyz;
-switch( hash_string( cmd ) )
+switch (hash_string(cmd))
 {
-   case hash_actions_file :
+   case hash_actions_file:
       ... code ...
       break;
 
-   case hash_confdir :
+   case hash_confdir:
       ... code ...
       break;
 
-   default :
+   default:
       log_error( ... );
       ... anomaly code goes here ...
       continue; / break; / exit( 1 ); / etc ...
 
-} /* end switch( hash_string( cmd ) ) */
+} /* end switch (hash_string(cmd)) */
 
@@ -1223,24 +1219,7 @@ switch( hash_string( cmd ) )
-

4.7.4. Use 'long' or 'short' - Instead of 'int'

- -

Explanation:

- -

On 32-bit platforms, int usually has the range of long. On 16-bit - platforms, int has the range of short.

- -

Status: - open-to-debate. In the case of most FSF projects (including - X/GNU-Emacs), there are typedefs to int4, int8, int16, (or - equivalence ... I forget the exact typedefs now). Should we add these - to IJB now that we have a "configure" script?

-
- -
-

4.7.5. Don't mix size_t and +

4.7.4. Don't mix size_t and other types

-

4.7.6. Declare each variable +

4.7.5. Declare each variable and struct on its own line.

-

4.7.7. Use malloc/zalloc +

4.7.6. Use malloc/zalloc sparingly

-

4.7.8. The Programmer Who +

4.7.7. The Programmer Who Uses 'malloc' is Responsible for Ensuring 'free'

-int load_re_filterfile( struct client_state *csp ) { ... }
-static void unload_re_filterfile( void *f ) { ... }
+int load_re_filterfile(struct client_state *csp) { ... }
+static void unload_re_filterfile(void *f) { ... }
 
@@ -1364,7 +1343,7 @@ static void unload_re_filterfile( void *f ) { ... }

-

4.7.9. Add loaders to the +

4.7.8. Add loaders to the `file_list' structure and in order

-

4.7.10. "Uncertain" new code - and/or changes to existing code, use FIXME or XXX

+

4.7.9. "Uncertain" new code + and/or changes to existing code, use XXX

Explanation:

@@ -1390,19 +1369,18 @@ static void unload_re_filterfile( void *f ) { ... }

If you have enough confidence in new code or confidence in your changes, but are not *quite* sure of the repercussions, add this:

-

/* FIXME: this code has a logic error on platform XYZ, * - attempting to fix */ #ifdef PLATFORM ...changed code here... - #endif

+

/* XXX: this code has a logic error on platform XYZ, * attempting + to fix */ #ifdef PLATFORM ...changed code here... #endif

or:

-

/* FIXME: I think the original author really meant this... */ +

/* XXX: I think the original author really meant this... */ ...changed code here...

or:

-

/* FIXME: new code that *may* break something else... */ ...new - code here...

+

/* XXX: new code that *may* break something else... */ ...new code + here...

Note: If you make it clear that this may or may not be a "good thing (tm)", it @@ -1422,10 +1400,10 @@ static void unload_re_filterfile( void *f ) { ... }

-const char FILENAME_rcs[] = "$Id$";
+const char FILENAME_rcs[] = "$I<!-- Break CVS Substitution -->d$";
 /*********************************************************************
  *
- * File        :  $Source$
+ * File        :  $S<!-- Break CVS Substitution -->ource$
  *
  * Purpose     :  (Fill me in with a good description!)
  *
@@ -1485,10 +1463,10 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
             
 #ifndef _FILENAME_H
 #define _FILENAME_H
-#define FILENAME_H_VERSION "$Id$"
+#define FILENAME_H_VERSION "$I<!-- Break CVS Substitution -->d$"
 /*********************************************************************
  *
- * File        :  $Source$
+ * File        :  $S<!-- Break CVS Substitution -->ource$
  *
  * Purpose     :  (Fill me in with a good description!)
  *
@@ -1567,10 +1545,10 @@ extern const char FILENAME_h_rcs[];
  * Returns     :  0 => Ok, everything else is an error.
  *
  *********************************************************************/
-int FUNCTION_NAME( void *param1, const char *x )
+int FUNCTION_NAME(void *param1, const char *x)
 {
    ...
-   return( 0 );
+   return 0;
 
 }
 
diff --git a/doc/webserver/developer-manual/copyright.html b/doc/webserver/developer-manual/copyright.html index ec5c4d2b..c8241a8f 100644 --- a/doc/webserver/developer-manual/copyright.html +++ b/doc/webserver/developer-manual/copyright.html @@ -50,7 +50,7 @@ "CITETITLE">GNU General Public License
.

-

9.1. License

+

9.1. License

Privoxy is free software; you can redistribute it and/or modify it under the terms of the

-

9.2. History

+

9.2. History

-

A long time ago, there was the Internet Junkbuster, by Anonymous Coders and - Junkbusters - Corporation. This saved many users a lot of pain in the early days - of web advertising and user tracking.

+

A long time ago, there was the Internet + Junkbuster, by Anonymous Coders and Junkbusters Corporation. + This saved many users a lot of pain in the early days of web + advertising and user tracking.

But the web, its protocols and standards, and with it, the techniques for forcing ads on users, give up autonomy over their browsing, and for tracking them, keeps evolving. Unfortunately, the Internet Junkbuster did not. Version - 2.0.2, published in 1998, was (and is) the last official release available from Junkbusters Corporation. Fortunately, it had been - released under the GNU GPL, which allowed further development by others.

+ 2.0.2, published in 1998, was the last official release, available from + Junkbusters Corporation. Fortunately, it had been released under the + GNU GPL, which allowed further development by others.

So Stefan Waldherr started maintaining an improved version of the software, to which eventually a number of people contributed patches. @@ -115,6 +110,10 @@

The result of this is Privoxy, whose first stable version, 3.0, was released August, 2002.

+ +

As of 2012 the Junkbusters Corporation's website + (http://www.junkbusters.com/) has been shut down, but Privoxy is still + actively maintained.

diff --git a/doc/webserver/developer-manual/cvs.html b/doc/webserver/developer-manual/cvs.html index 0f4226ca..f455e0a4 100644 --- a/doc/webserver/developer-manual/cvs.html +++ b/doc/webserver/developer-manual/cvs.html @@ -71,20 +71,6 @@ "_top">http://ijbswa.cvs.sourceforge.net/ijbswa/, which might help with visualizing how these pieces fit together.

-

Branches are used to fork a sub-development path from the main - trunk. Within the current module where the - sources are, there is always at least one "branch" from the main trunk devoted to a stable release - series. The main trunk is where active development takes place for the - next stable series (e.g. 3.2.x). So just prior to each stable series - (e.g. 3.0.x), a branch is created just for stable series releases (e.g. - 3.0.0 -> 3.0.1 -> 3.0.2, etc). Once the initial stable release of - any stable branch has taken place, this branch is only used for bugfixes, which - have had prior testing before being committed to CVS. (See Version Numbers below for details - on versioning.)

-

At one time there were two distinct branches: stable and unstable. The more drastic changes were to be in the unstable branch. These branches have now been merged to minimize time and effort of @@ -97,9 +83,8 @@

The source tree is the heart of every software project. Every effort must be made to ensure that it is readable, compilable and consistent - at all times. There are differing guidelines for the stable branch and - the main development trunk, and we ask anyone with CVS access to - strictly adhere to the following guidelines:

+ at all times. We expect anyone with CVS access to strictly adhere to + the following guidelines:

Basic Guidelines, for all branches:

diff --git a/doc/webserver/developer-manual/documentation.html b/doc/webserver/developer-manual/documentation.html index 7c6895ef..9471cf6c 100644 --- a/doc/webserver/developer-manual/documentation.html +++ b/doc/webserver/developer-manual/documentation.html @@ -79,16 +79,14 @@

Packagers are encouraged to include this documentation. For those without the ability to build the docs locally, text versions of each are kept in CVS. HTML versions are also being kept in CVS under doc/webserver/*. And PDF version are kept in doc/pdf/*.

+ "FILENAME">doc/webserver/*.

Formal documents are built with the Makefile targets of make dok, or alternately make redhat-dok. If you have problems, try both. - The build process uses the document SGML sources in doc/source/*/* to update all text files in - doc/text/ and to update all HTML - documents in doc/webserver/.

+ "COMPUTEROUTPUT">make dok. The build process uses the document + SGML sources in doc/source/*/* to + update all text files in doc/text/ + and to update all HTML documents in doc/webserver/.

Documentation writers should please make sure documents build successfully before committing to CVS, if possible.

@@ -98,9 +96,7 @@
  1. First, build the docs by running make - dok (or alternately make - redhat-dok). For PDF docs, do make dok-pdf.

    + dok.

  2. @@ -312,7 +308,7 @@
  3. Our documents are available in differing formats. Right now, - they are just plain text, HTML, and PDF, but others are always a + they are just plain text and/or HTML, but others are always a future possibility. Be careful with URLs (<ulink>), and avoid this mistake:

    @@ -337,7 +333,7 @@
-

3.3. Privoxy Custom +

3.3. Privoxy Custom Entities

Privoxy documentation is using a @@ -388,7 +384,7 @@ p-version: the Privoxy version string, e.g. - "3.0.19". + "3.0.20". diff --git a/doc/webserver/developer-manual/index.html b/doc/webserver/developer-manual/index.html index cb1fc2fa..2d72c1bf 100644 --- a/doc/webserver/developer-manual/index.html +++ b/doc/webserver/developer-manual/index.html @@ -22,8 +22,8 @@ 2001-2009 by Privoxy Developers

-

$Id: developer-manual.sgml,v 2.38 2011/12/26 - 17:05:40 fabiankeil Exp $

+

$Id: developer-manual.sgml,v 2.51 2012/06/19 + 12:48:04 fabiankeil Exp $

@@ -37,7 +37,7 @@ entirely correct. As always, patches are welcome.

Please note that this document is constantly evolving. This copy - represents the state at the release of version 3.0.19. You can find + represents the state at the release of version 3.0.20. You can find the latest version of the this manual at http://www.privoxy.org/developer-manual/. Please see @@ -84,7 +84,7 @@

3.2. Privoxy Documentation Style
-
3.3. Privoxy Custom +
3.3. Privoxy Custom Entities
@@ -220,26 +220,23 @@
4.7.3. Try to avoid falling through cases in a switch statement.
-
4.7.4. Use 'long' or 'short' - Instead of 'int'
- -
4.7.5. Don't mix size_t and +
4.7.4. Don't mix size_t and other types
-
4.7.6. Declare each variable +
4.7.5. Declare each variable and struct on its own line.
-
4.7.7. Use malloc/zalloc +
4.7.6. Use malloc/zalloc sparingly
-
4.7.8. The Programmer Who Uses +
4.7.7. The Programmer Who Uses 'malloc' is Responsible for Ensuring 'free'
-
4.7.9. Add loaders to the +
4.7.8. Add loaders to the `file_list' structure and in order
-
4.7.10. "Uncertain" new code - and/or changes to existing code, use FIXME or XXX
+
4.7.9. "Uncertain" new code + and/or changes to existing code, use XXX
@@ -357,9 +354,9 @@
-
9.1. License
+
9.1. License
-
9.2. History
+
9.2. History
diff --git a/doc/webserver/developer-manual/newrelease.html b/doc/webserver/developer-manual/newrelease.html index af9aae3b..8597fbe0 100644 --- a/doc/webserver/developer-manual/newrelease.html +++ b/doc/webserver/developer-manual/newrelease.html @@ -738,7 +738,7 @@
-  debchange -v 3.0.19-stable-1 "New upstream version"
+  debchange -v 3.0.20-UNRELEASED-1 "New upstream version"
 
@@ -757,7 +757,7 @@

This will create ../privoxy_3.0.19-stable-1_i386.deb which can be + "FILENAME">../privoxy_3.0.20-UNRELEASED-1_i386.deb which can be uploaded. To upload the package to Sourceforge, simply issue

@@ -777,59 +777,134 @@

First, make sure that you have freshly exported the right version into an empty - directory. (See "Building and releasing packages" above). - Then get the Mac OS X setup module:

+ directory. (See "Building and releasing packages" + above).

-
- - + +
-
+        

There are three modules available in the CVS repository for use on + Mac OS X, though technically only two of them generate a release (the + other can be used to install from source).

+ +
+

6.3.8.1. OSXPackageBuilder + module

+ +

The OSXPackageBuilder module generates OS X installer packages + supporting all Macs running OS X 10.4 and above. Obtain it from CVS + as follows into a folder parallel to the exported privoxy + source:

+ + + + + +
+
+  cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co OSXPackageBuilder
+
+
+ +

The module contains complete instructions on its usage in the + file OS X Package Builder HOWTO.txt.

+ +

Once the package(s) have been generated, you can then upload + them directly to the Files section of the Sourceforge project in + the Macintosh (OS X) folder. Each new version release of Privoxy + should have a new subfolder created in which to store its files. + Please ensure that the folder contains a readme file that makes it + clear which package is for whichversion of OS X.

+
+ +
+

6.3.8.2. osxsetup module + (DEPRECATED)

+ +

This module is + deprecated since the installer it generates places all Privoxy + files in one folder in a non-standard location, and supports only + Intel Macs running OS X 10.6 or higher.

+ +

Check out the module from CVS as follows into a folder parallel + to the exported privoxy source:

+ + + + - -
+
   cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup
 
-
+
-

Then run:

+

Then run:

- - - + +
-
+          
+            
+              
-          
-        
+
   cd osxsetup
   build
 
-
+
-

This will run autoheader, autoconf and configure as - well as make. Finally, it will copy over - the necessary files to the ./osxsetup/files directory for further - processing by PackageMaker.

+

This will run autoheader, autoconf and configure as + well as make. Finally, it will copy over + the necessary files to the ./osxsetup/files directory for further + processing by PackageMaker.

-

Bring up PackageMaker with the PrivoxyPackage.pmsp definition - file, modify the package name to match the release, and hit the - "Create package" button. If you specify ./Privoxy.pkg as the output - package name, you can then create the distributable zip file with the - command:

+

Bring up PackageMaker with the PrivoxyPackage.pmsp definition + file, modify the package name to match the release, and hit the + "Create package" button. If you specify ./Privoxy.pkg as the output + package name, you can then create the distributable zip file with + the command:

- - - + +
-
+          
+            
+              
-          
-        
+
   zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
 
-
+
+ +

You can then upload this file directly to the Files section of + the Sourceforge project in the Macintosh (OS X) folder. Each new + version release of Privoxy should have a new subfolder created in + which to store its files. Please ensure that the folder contains a + readme file that makes it clear which version(s) of OS X the + package supports.

+
+ +
+

6.3.8.3. macsetup module

+ +

The macsetup module is ideal if you wish to build and install + Privoxy from source on a single machine.

+ +

Check out the module from CVS as follows into a folder parallel + to the exported privoxy source:

+ + + + + +
+
+  cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co macsetup
+
+
-

You can then upload privoxyosx_setup_x.y.z.zip anonymously to uploads.sourceforge.net/incoming, create a release - for it, and you're done. Use the release notes and Change Log from - the source tarball package.

+

The module contains complete instructions on its usage in its + README file. The end result will be the + exported version of Privoxy installed on the build machine.

+
@@ -1015,7 +1090,7 @@ 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. 3.0.19 (beta).

+ "emphasis">3.0.20 (beta).

Now just follow the prompts. Be sure to add any appropriate Release notes. You should see your freshly uploaded packages in - - - - - - -
http://www.junkbusters.com/ht/en/cookies.html, an - explanation how cookies are used to track web users.
- - - - - - - -
http://www.junkbusters.com/ijb.html, the original - Internet Junkbuster.
- diff --git a/doc/webserver/faq/configuration.html b/doc/webserver/faq/configuration.html index 3e9d7036..523e2c0b 100644 --- a/doc/webserver/faq/configuration.html +++ b/doc/webserver/faq/configuration.html @@ -42,7 +42,7 @@ Configuration
-

3.1. What exactly is an +

3.1. What exactly is an "actions" file?

Privoxy utilizes the concept of @@ -88,7 +88,7 @@

-

3.3. How are actions +

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

Actions files are just text files in a special syntax and can be @@ -106,7 +106,7 @@

-

3.15. I see some images +

3.15. I see some images being replaced with text instead of the checkerboard image. Why and how do I get rid of this?

diff --git a/doc/webserver/faq/copyright.html b/doc/webserver/faq/copyright.html index 5d53a4da..53d62c07 100644 --- a/doc/webserver/faq/copyright.html +++ b/doc/webserver/faq/copyright.html @@ -55,7 +55,7 @@ "APPLICATION">Privoxy.

-

7.1. License

+

7.1. License

Privoxy is free software; you can redistribute it and/or modify it under the terms of the

-

7.2. History

+

7.2. History

-

A long time ago, there was the Internet Junkbuster, by Anonymous Coders and - Junkbusters - Corporation. This saved many users a lot of pain in the early days - of web advertising and user tracking.

+

A long time ago, there was the Internet + Junkbuster, by Anonymous Coders and Junkbusters Corporation. + This saved many users a lot of pain in the early days of web + advertising and user tracking.

But the web, its protocols and standards, and with it, the techniques for forcing ads on users, give up autonomy over their browsing, and for tracking them, keeps evolving. Unfortunately, the Internet Junkbuster did not. Version - 2.0.2, published in 1998, was (and is) the last official release available from Junkbusters Corporation. Fortunately, it had been - released under the GNU GPL, which allowed further development by others.

+ 2.0.2, published in 1998, was the last official release, available from + Junkbusters Corporation. Fortunately, it had been released under the + GNU GPL, which allowed further development by others.

So Stefan Waldherr started maintaining an improved version of the software, to which eventually a number of people contributed patches. @@ -120,6 +115,10 @@

The result of this is Privoxy, whose first stable version, 3.0, was released August, 2002.

+ +

As of 2012 the Junkbusters Corporation's website + (http://www.junkbusters.com/) has been shut down, but Privoxy is still + actively maintained.

diff --git a/doc/webserver/faq/general.html b/doc/webserver/faq/general.html index dae3e32e..be0a9fb3 100644 --- a/doc/webserver/faq/general.html +++ b/doc/webserver/faq/general.html @@ -127,24 +127,19 @@

1.5. What is this new version of "Junkbuster"?

-

A long time ago, there was the Internet Junkbuster, by Anonymous Coders and - Junkbusters - Corporation. This saved many users a lot of pain in the early days - of web advertising and user tracking.

+

A long time ago, there was the Internet + Junkbuster, by Anonymous Coders and Junkbusters Corporation. + This saved many users a lot of pain in the early days of web + advertising and user tracking.

But the web, its protocols and standards, and with it, the techniques for forcing ads on users, give up autonomy over their browsing, and for tracking them, keeps evolving. Unfortunately, the Internet Junkbuster did not. Version - 2.0.2, published in 1998, was (and is) the last official release available from Junkbusters Corporation. Fortunately, it had been - released under the GNU GPL, which allowed further development by others.

+ 2.0.2, published in 1998, was the last official release, available from + Junkbusters Corporation. Fortunately, it had been released under the + GNU GPL, which allowed further development by others.

So Stefan Waldherr started maintaining an improved version of the software, to which eventually a number of people contributed patches. @@ -164,30 +159,33 @@

The result of this is Privoxy, whose first stable version, 3.0, was released August, 2002.

+ +

As of 2012 the Junkbusters Corporation's website + (http://www.junkbusters.com/) has been shut down, but Privoxy is still + actively maintained.

-

1.6. Why 1.6. Why "Privoxy"? Why change the name from Junkbuster at all?

-

Though outdated, Junkbusters Corporation continues to offer their original - version of the Internet Junkbuster, so - publishing our Junkbuster-derived - software under the same name led to confusion.

+

Though outdated, Junkbusters Corporation continued to offer their + original version of the Internet + Junkbuster for a while, so publishing our Junkbuster-derived software under the same name + would have led to confusion.

-

There are also potential legal complications from our use of the - Junkbuster name, which is a registered - trademark of Junkbusters Corporation. There are, however, no objections - from Junkbusters Corporation to the Privoxy project itself, and they, in fact, still - share our ideals and goals.

+

There were also potential legal reasons not to use the Junkbuster name, as it was (and maybe still is) a + registered trademark of Junkbusters Corporation. There were, however, + no objections from Junkbusters Corporation to the Privoxy project itself, and they, in fact, shared + our ideals and goals.

-

The developers also believed that there are so many improvements - over the original code, that it was time to make a clean break from the - past and make a name in their own right.

+

The Privoxy developers also believed that there were so many + improvements over the original code, that it was time to make a clean + break from the past and make a name in their own right.

Privoxy is the "Privacy Enhancing @@ -204,7 +202,7 @@ differ from the old Junkbuster?

Privoxy picks up where Junkbuster left off. The new Junkbuster left off. Privoxy still blocks ads and banners, still manages cookies, and still helps protect your privacy. But, most of @@ -331,7 +329,7 @@

-

1.9. Can Privoxy make +

1.9. Can Privoxy make mistakes? This does not sound very scientific.

Actually, it's a black art ;-) And yes, it is always possible to @@ -349,7 +347,7 @@

-

1.10. Will I have to +

1.10. Will I have to configure Privoxy before I can use it?

That depends on your expectations. The default installation should diff --git a/doc/webserver/faq/index.html b/doc/webserver/faq/index.html index 3e400145..d7d10deb 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.85 2011/12/26 17:05:40 fabiankeil +

$Id: faq.sgml,v 2.89 2012/06/19 12:49:48 fabiankeil Exp $

@@ -66,7 +66,7 @@

Please note that this document is a work in progress. This copy - represents the state at the release of version 3.0.19. You can find + represents the state at the release of version 3.0.20. You can find the latest version of the document at http://www.privoxy.org/faq/. Please see the 1.5. What is this new version of "Junkbuster"? -

1.6. Why 1.6. Why "Privoxy"? Why change the name from Junkbuster at all?
@@ -110,10 +110,10 @@
1.8. How does Privoxy know what is an ad, and what is not?
-
1.9. Can Privoxy make mistakes? +
1.9. Can Privoxy make mistakes? This does not sound very scientific.
-
1.10. Will I have to configure +
1.10. Will I have to configure Privoxy before I can use it?
1.11. Can Privoxy run as a server @@ -182,17 +182,17 @@
-
3.1. What exactly is an +
3.1. What exactly is an "actions" file?
3.2. The "actions" concept confuses me. Please list some of these "actions".
-
3.3. How are actions +
3.3. How are actions files configured? What is the easiest way to do this?
-
3.4. There are several +
3.4. There are several different "actions" files. What are the differences?
@@ -217,21 +217,21 @@ change the configuration with a browser? Does that not raise security issues? -
3.11. What is the +
3.11. What is the default.filter file? What is a "filter"?
3.12. How can I set up Privoxy to act as a proxy for my LAN?
-
3.13. Instead of ads, now +
3.13. Instead of ads, now I get a checkerboard pattern. I don't want to see anything.
-
3.14. Why would anybody +
3.14. Why would anybody want to see a checkerboard pattern?
-
3.15. I see some images +
3.15. I see some images being replaced with text instead of the checkerboard image. Why and how do I get rid of this?
@@ -292,7 +292,7 @@
-
4.1. How much does Privoxy slow my +
4.1. How much does Privoxy slow my browsing down? This has to add extra time to browsing.
4.2. I notice considerable @@ -313,32 +313,32 @@
4.7. How can I hide my IP address?
-
4.8. Can Privoxy guarantee I am +
4.8. Can Privoxy guarantee I am anonymous?
-
4.9. A test site says I am not +
4.9. A test site says I am not using a Proxy.
4.10. How do I use Privoxy together with Tor?
-
4.11. Might some things break +
4.11. Might some things break because header information or content is being altered?
-
4.12. Can Privoxy act as a +
4.12. Can Privoxy act as a "caching" proxy to speed up web browsing?
-
4.13. What about as a firewall? +
4.13. What about as a firewall? Can Privoxy protect me?
-
4.14. I have large empty spaces / +
4.14. I have large empty spaces / a checkerboard pattern now where ads used to be. Why?
-
4.15. How can Privoxy filter +
4.15. How can Privoxy filter Secure (HTTPS) URLs?
-
4.16. Privoxy runs as a +
4.16. Privoxy runs as a "server". How secure is it? Do I need to take any special precautions?
@@ -387,14 +387,14 @@
-
5.1. I cannot connect to any +
5.1. I cannot connect to any websites. Or, I am getting "connection refused" message with every web page. Why?
5.2. Why am I getting a 503 Error (WSAECONNREFUSED) on every page?
-
5.3. I just added a new rule, +
5.3. I just added a new rule, but the steenkin ad is still getting through. How?
5.4. One of my favorite sites @@ -510,9 +510,9 @@
-
7.1. License
+
7.1. License
-
7.2. History
+
7.2. History
diff --git a/doc/webserver/faq/installation.html b/doc/webserver/faq/installation.html index c53b2f33..e7db35a4 100644 --- a/doc/webserver/faq/installation.html +++ b/doc/webserver/faq/installation.html @@ -61,10 +61,15 @@ systems are supported?

At present, Privoxy is known to run - on Windows(95, 98, ME, 2000, XP, Vista), GNU/Linux (RedHat, SuSE, - Debian, Fedora, Gentoo, Slackware and others), Mac OSX, OS/2, AmigaOS, - FreeBSD, NetBSD, OpenBSD, Solaris, and various other flavors of - Unix.

+ on Windows 95 and later versions (98, ME, 2000, XP, Vista, Windows 7 + etc.), GNU/Linux (RedHat, SuSE, Debian, Fedora, Gentoo, Slackware and + others), Mac OS X, OS/2, Haiku, DragonFly, FreeBSD, NetBSD, OpenBSD, + Solaris, and various other flavors of Unix.

+ +

Privoxy used to work on AmigaOS and + QNX, too, but the code currently isn't maintained and its status + unknown. It might no longer compile, but getting it working again + shouldn't be too hard.

But any operating system that runs TCP/IP, can conceivably take advantage of Privoxy in a networked diff --git a/doc/webserver/faq/misc.html b/doc/webserver/faq/misc.html index 6ff52fde..ebf30b27 100644 --- a/doc/webserver/faq/misc.html +++ b/doc/webserver/faq/misc.html @@ -41,7 +41,7 @@

4. Miscellaneous

-

4.8. Can Privoxy +

4.8. Can Privoxy guarantee I am anonymous?

No. Your chances of remaining anonymous are improved, but unless you @@ -246,7 +246,7 @@

-

4.9. A test site says I +

4.9. A test site says I am not using a Proxy.

Good! Actually, they are probably testing for some other kinds of @@ -353,7 +353,7 @@

Save the modified configuration file and open http://config.privoxy.org/show-status/ in your browser, + "_top">http://config.privoxy.org/show-status in your browser, confirm that Privoxy has reloaded its configuration and that there are no other forward lines, unless you know that you need them. If everything looks good, refer to

-

4.11. Might some things +

4.11. Might some things break because header information or content is being altered?

Definitely. It is common for sites to use browser type, browser @@ -409,7 +409,7 @@

-

4.13. What about as a +

4.13. What about as a firewall? Can Privoxy protect me?

Not in the way you mean, or in the way some firewall vendors claim @@ -436,7 +436,7 @@

-

4.14. I have large empty +

4.14. I have large empty spaces / a checkerboard pattern now where ads used to be. Why?

It is technically possible to eliminate banners and ads in a way @@ -464,7 +464,7 @@

-

4.15. How can Privoxy +

4.15. How can Privoxy filter Secure (HTTPS) URLs?

Since secure HTTP connections are encrypted SSL sessions between @@ -498,7 +498,7 @@

- - - - - - -
http://www.junkbusters.com/ht/en/cookies.html, - an explanation how cookies are used to track web users.
- - - - - - - -
http://www.junkbusters.com/ijb.html, the original - Internet Junkbuster.
- diff --git a/doc/webserver/faq/trouble.html b/doc/webserver/faq/trouble.html index 38b3fe95..2d8ae473 100644 --- a/doc/webserver/faq/trouble.html +++ b/doc/webserver/faq/trouble.html @@ -44,7 +44,7 @@ Troubleshooting
-

5.3. I just added a +

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

If the ad had been displayed before you added its URL, it will diff --git a/doc/webserver/index.html b/doc/webserver/index.html index e417d9da..394c9591 100644 --- a/doc/webserver/index.html +++ b/doc/webserver/index.html @@ -6,34 +6,10 @@ Privoxy - Home Page - - - - - - - - - - - - - - - - - - - - - - - -

- +

Privoxy is a non-caching web proxy with advanced filtering capabilities for enhancing privacy, modifying web page data and @@ -76,7 +52,7 @@

The most recent release is 3.0.19 (stable).

+ "_top">3.0.20 (UNRELEASED).


@@ -168,10 +144,10 @@

-

+

- +
diff --git a/doc/webserver/privoxy-index.html b/doc/webserver/privoxy-index.html index 1b23af01..eb9ea2fc 100644 --- a/doc/webserver/privoxy-index.html +++ b/doc/webserver/privoxy-index.html @@ -6,34 +6,10 @@ Privoxy - The Privacy Enhancing Proxy - - - - - - - - - - - - - - - - - - - - - - - - Privoxy - The Privacy Enhancing Proxy -

Project Index Page v3.0.19

+

Project Index Page v3.0.20

- +

Privoxy is a non-caching web proxy with advanced filtering capabilities for enhancing privacy, modifying web page data and @@ -168,7 +144,7 @@


-

+

Copyright © 2001-2010 by Privoxy Developers

diff --git a/doc/webserver/user-manual/actions-file.html b/doc/webserver/user-manual/actions-file.html index 9e8e95e6..3c39d976 100644 --- a/doc/webserver/user-manual/actions-file.html +++ b/doc/webserver/user-manual/actions-file.html @@ -6,7 +6,7 @@ Actions Files - + @@ -21,7 +21,7 @@
- + @@ -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 @@

+
Privoxy 3.0.19 User ManualPrivoxy 3.0.20 User Manual
+ + + + @@ -3773,6 +3795,9 @@ nasty-banner-server.example.com/junk.cgi\?output=trash provided as parameter, or derived by applying a single pcrs command to the original URL.

+

The syntax for pcrs commands is documented in the filter file section.

+

This action will be ignored if you use it together with block. It can be combined @@ -4217,7 +4242,7 @@ example.org/instance-that-is-delivered-as-xml-but-is-not

-

8.5.34. +

8.5.34. Summary

Note that many of these actions have the potential to cause a page @@ -4376,7 +4401,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 @@ -4425,7 +4450,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 @@ -4768,7 +4793,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 e3bf012b..6872b219 100644 --- a/doc/webserver/user-manual/appendix.html +++ b/doc/webserver/user-manual/appendix.html @@ -6,7 +6,7 @@ Appendix - + @@ -19,7 +19,7 @@

+
+# Tag all requests with the Range header set
+{+client-header-tagger{range-requests}}
+/
+
+# Disable filtering for the tagged requests.
+#
+# With filtering enabled Privoxy would remove the Range headers
+# to be able to filter the whole response. The downside is that
+# it prevents clients from resuming downloads or skipping over
+# parts of multimedia files.
+{-filter -deanimate-gifs}
+TAG:^RANGE-REQUEST$
+
 
- + @@ -293,7 +293,7 @@
-

14.2. Privoxy's +

14.2. Privoxy's Internal Pages

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

Privoxy 3.0.19 User ManualPrivoxy 3.0.20 User Manual
- + @@ -685,8 +685,7 @@

Your logfile will grow indefinitely, and you will probably want to periodically remove it. On Unix systems, you can do this with a cron job (see "man - cron"). For Red Hat based Linux distributions, a - logrotate script has been included.

+ cron").

Any log files must be writable by whatever user Privoxy is being run as (on Unix, default @@ -843,6 +842,7 @@ debug 4096 # Startup banner and warnings. debug 8192 # Non-fatal errors debug 32768 # log all data read from the network + debug 65536 # Log the applying actions

@@ -1082,10 +1082,10 @@ Internet and/or the local network. Be aware that some GNU/Linux distributions modify that behaviour without updating the documentation. Check for non-standard patches if your - Privoxyversion behaves + Privoxy version behaves differently.

-

If you configure Privoxyto +

If you configure Privoxy to be reachable from the network, consider using access control lists (ACL's, see below), and/or a firewall.

@@ -1096,12 +1096,6 @@ "config.html#ENABLE-EDIT-ACTIONS">enable-edit-actions and enable-remote-toggle

- -

With the exception noted above, listening on multiple - addresses is currently not supported by Privoxy directly. It can be done on most - operating systems by letting a packet filter redirect request - for certain addresses to Privoxy, though.

Example:
@@ -2429,7 +2423,7 @@

Several users have reported this as a Privoxy bug, so the default value has been reduced. Consider increasing it to 300 seconds or even more if you think your browser can handle it. - If your browser appears to be hanging it can't.

+ If your browser appears to be hanging, it probably can't.

Examples:
@@ -2441,9 +2435,71 @@ +
+

7.6.5. tolerate-pipelining

+ +
+
+
Specifies:
+ +
+

Whether or not pipelined requests should be served.

+
+ +
Type of value:
+ +
+

0 or 1.

+
+ +
Default value:
+ +
+

None

+
+ +
Effect if unset:
+ +
+

If Privoxy receives more than one request at once, it + terminates the client connection after serving the first + one.

+
+ +
Notes:
+ +
+

Privoxy currently doesn't + pipeline outgoing requests, thus allowing pipelining on the + client connection is not guaranteed to improve the + performance.

+ +

By default Privoxy tries to + discourage clients from pipelining by discarding aggressively + pipelined requests, which forces the client to resend them + through a new connection.

+ +

This option lets Privoxy + tolerate pipelining. Whether or not that improves performance + mainly depends on the client configuration.

+ +

This options is new and should be considered + experimental.

+
+ +
Examples:
+ +
+

tolerate-pipelining 1

+
+
+
+
+

7.6.5. default-server-timeout

+ "DEFAULT-SERVER-TIMEOUT">7.6.6. default-server-timeout
@@ -2516,7 +2572,7 @@

7.6.6. connection-sharing

+ "CONNECTION-SHARING">7.6.7. connection-sharing
@@ -2609,7 +2665,7 @@
-

7.6.7. +

7.6.8. socket-timeout

@@ -2658,7 +2714,7 @@

7.6.8. max-client-connections

+ "MAX-CLIENT-CONNECTIONS">7.6.9. max-client-connections

@@ -2737,7 +2793,7 @@

7.6.9. + "HANDLE-AS-EMPTY-DOC-RETURNS-OK">7.6.10. handle-as-empty-doc-returns-ok

@@ -2797,7 +2853,7 @@

7.6.10. enable-compression

+ "ENABLE-COMPRESSION">7.6.11. enable-compression
@@ -2855,7 +2911,7 @@

7.6.11. compression-level

+ "COMPRESSION-LEVEL">7.6.12. compression-level
@@ -2919,6 +2975,56 @@
+ +
+

7.6.13. client-header-order

+ +
+
+
Specifies:
+ +
+

The order in which client headers are sorted before + forwarding them.

+
+ +
Type of value:
+ +
+

Client header names delimited by + spaces or tabs

+
+ +
Default value:
+ +
+

None

+
+ +
Notes:
+ +
+

By default Privoxy leaves + the client headers in the order they were sent by the client. + Headers are modified in-place, new headers are added at the end + of the already existing headers.

+ +

The header order can be used to fingerprint client requests + independently of other headers like the User-Agent.

+ +

This directive allows to sort the headers differently to + better mimic a different User-Agent. Client headers will be + emitted in the order given, headers whose name isn't explicitly + specified are added at the end.

+ +

Note that sorting headers in an uncommon way will make + fingerprinting actually easier. Encrypted headers are not + affected by this directive.

+
+
+
+
@@ -2940,8 +3046,9 @@ "LOG-MESSAGES">

If "log-messages" is set to 1, - Privoxy will log messages to the - console window:

+ Privoxy copy log messages to the + console window. The log detail depends on the debug directive.

  log-messages 1
diff --git a/doc/webserver/user-manual/configuration.html b/doc/webserver/user-manual/configuration.html index 8dd2b8fa..1a68756c 100644 --- a/doc/webserver/user-manual/configuration.html +++ b/doc/webserver/user-manual/configuration.html @@ -6,7 +6,7 @@ Privoxy Configuration - + @@ -20,7 +20,7 @@

Privoxy 3.0.19 User ManualPrivoxy 3.0.20 User Manual
- + @@ -46,7 +46,7 @@ controlled easily with a web browser.

-

6.1. Controlling +

6.1. Controlling Privoxy with Your Web Browser

Privoxy's user interface can be @@ -63,8 +63,8 @@ -

    Privoxy Menu

+

    Privoxy Menu

 
@@ -104,7 +104,7 @@
@@ -147,7 +147,9 @@

For Unix, *BSD and Linux, all configuration files are located in /etc/privoxy/ by default. For MS Windows, OS/2, and AmigaOS these are all in the same directory as the - Privoxy executable.

+ Privoxy executable. The name and + number of configuration files has changed from previous versions, and + is subject to change as development progresses.

The installed defaults provide a reasonable starting point, though some settings may be aggressive by some standards. For the time being, @@ -236,6 +238,12 @@ "QUOTE">"wake up" requests must obviously be sent to the old listening address.

+ +

While under development, the configuration content is subject to + change. The below documentation may not be accurate by the time you + read this. Also, what constitutes a "default" setting, may change, so please check all your + configuration files on important issues.

diff --git a/doc/webserver/user-manual/contact.html b/doc/webserver/user-manual/contact.html index a1109c01..96e35e1c 100644 --- a/doc/webserver/user-manual/contact.html +++ b/doc/webserver/user-manual/contact.html @@ -7,7 +7,7 @@ Requests - +
- + diff --git a/doc/webserver/user-manual/copyright.html b/doc/webserver/user-manual/copyright.html index ad62f17d..017c14cb 100644 --- a/doc/webserver/user-manual/copyright.html +++ b/doc/webserver/user-manual/copyright.html @@ -6,7 +6,7 @@ Privoxy Copyright, License and History - + @@ -22,7 +22,7 @@
Privoxy 3.0.19 User ManualPrivoxy 3.0.20 User Manual
-         ▪  Documentation
Privoxy 3.0.19 User ManualPrivoxy 3.0.20 User Manual
- + @@ -51,7 +51,7 @@ "CITETITLE">GNU General Public License.

-

12.1. License

+

12.1. License

Privoxy is free software; you can redistribute it and/or modify it under the terms of the

12.2. History

-

A long time ago, there was the Internet Junkbuster, by Anonymous Coders and - Junkbusters - Corporation. This saved many users a lot of pain in the early days - of web advertising and user tracking.

+

A long time ago, there was the Internet + Junkbuster, by Anonymous Coders and Junkbusters Corporation. + This saved many users a lot of pain in the early days of web + advertising and user tracking.

But the web, its protocols and standards, and with it, the techniques for forcing ads on users, give up autonomy over their browsing, and for tracking them, keeps evolving. Unfortunately, the Internet Junkbuster did not. Version - 2.0.2, published in 1998, was (and is) the last official release available from Junkbusters Corporation. Fortunately, it had been - released under the GNU GPL, which allowed further development by others.

+ 2.0.2, published in 1998, was the last official release, available from + Junkbusters Corporation. Fortunately, it had been released under the + GNU GPL, which allowed further development by others.

So Stefan Waldherr started maintaining an improved version of the software, to which eventually a number of people contributed patches. @@ -116,6 +111,10 @@

The result of this is Privoxy, whose first stable version, 3.0, was released August, 2002.

+ +

As of 2012 the Junkbusters Corporation's website + (http://www.junkbusters.com/) has been shut down, but Privoxy is still + actively maintained.

@@ -128,7 +127,8 @@  David Schmidt, developer
 Hal Burgiss
 Lee Rian
-  Roland Rosenfeld

+  Roland Rosenfeld
+  Ian Silvester

Former Privoxy Team Members:

@@ -180,6 +180,7 @@  Markus Elfring
 Dean Gaudet
 Stephen Gildea
+  Lizik Grelier
 Daniel Griscom
 Felix Gröbert
 Jeff H.
@@ -191,7 +192,10 @@  Stefan Huehner
 Peter Hyman
 Derek Jennings
+  Andrew Jones
+  Julien Joubert
 Petr Kadlec
+  Steven Kolins
 David Laight
 Bert van Leeuwen
 Don Libes
@@ -211,6 +215,7 @@  Roberto Ragusa
 Félix Rauch
 Maynard Riley
+  Andreas Rutkauskas
 Chung-chieh Shan
 Spinor S.
 Bart Schelstraete
diff --git a/doc/webserver/user-manual/filter-file.html b/doc/webserver/user-manual/filter-file.html index 5fa167cc..7da48b66 100644 --- a/doc/webserver/user-manual/filter-file.html +++ b/doc/webserver/user-manual/filter-file.html @@ -6,7 +6,7 @@ Filter Files - + @@ -20,7 +20,7 @@
Privoxy 3.0.19 User ManualPrivoxy 3.0.20 User Manual
- + @@ -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 @@ -508,8 +508,8 @@ s* industry[ -]leading \ wherever you would also use the cookie crunch actions.

-
refresh - tags
+
refresh-tags

Disable any refresh tags if the interval is greater than nine diff --git a/doc/webserver/user-manual/index.html b/doc/webserver/user-manual/index.html index 88f67986..c249bffd 100644 --- a/doc/webserver/user-manual/index.html +++ b/doc/webserver/user-manual/index.html @@ -3,7 +3,7 @@ - Privoxy 3.0.19 User Manual + Privoxy 3.0.20 User Manual @@ -16,14 +16,14 @@ "#840084" alink="#0000FF">

-

Privoxy 3.0.19 User +

Privoxy 3.0.20 User Manual

Copyright © 2001-2011 by Privoxy Developers

-

$Id: user-manual.sgml,v 2.146 2011/12/26 17:05:40 +

$Id: user-manual.sgml,v 2.150 2012/09/26 15:20:54 fabiankeil Exp $

@@ -116,12 +116,20 @@ OS X
2.1.7. AmigaOS
+ "installation.html#OS-X-INSTALL-FROM-PACKAGE">Installation + from ready-built package
2.1.8. FreeBSD
+ "installation.html#OS-X-INSTALL-FROM-SOURCE">Installation + from source
2.1.9. AmigaOS
+ +
2.1.10. FreeBSD
+ +
2.1.11. Gentoo

@@ -185,7 +193,7 @@
-
6.1. Controlling Privoxy +
6.1. Controlling Privoxy with Your Web Browser
6.2. Configuration @@ -317,25 +325,31 @@ "config.html#KEEP-ALIVE-TIMEOUT">keep-alive-timeout
7.6.5. default-server-timeout
+ "config.html#TOLERATE-PIPELINING">tolerate-pipelining
7.6.6. connection-sharing
+ "config.html#DEFAULT-SERVER-TIMEOUT">default-server-timeout
7.6.7. socket-timeout
+ "config.html#CONNECTION-SHARING">connection-sharing
7.6.8. max-client-connections
+ "config.html#SOCKET-TIMEOUT">socket-timeout
7.6.9. handle-as-empty-doc-returns-ok
+ "config.html#MAX-CLIENT-CONNECTIONS">max-client-connections
7.6.10. enable-compression
+ "config.html#HANDLE-AS-EMPTY-DOC-RETURNS-OK">handle-as-empty-doc-returns-ok
7.6.11. enable-compression
+ +
7.6.12. compression-level
+ +
7.6.13. client-header-order
@@ -348,10 +362,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
@@ -361,10 +375,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 @@ -475,7 +489,7 @@ "actions-file.html#SET-IMAGE-BLOCKER">set-image-blocker
8.5.34. Summary
+ "actions-file.html#AEN4785">Summary
@@ -487,13 +501,13 @@
8.7.1. match-all.action
+ "actions-file.html#AEN4849">match-all.action
8.7.2. default.action
+ "actions-file.html#AEN4871">default.action
8.7.3. user.action
+ "actions-file.html#AEN4984">user.action
@@ -503,7 +517,7 @@
-
9.1. Filter File +
9.1. Filter File Tutorial
9.2. The @@ -547,7 +561,7 @@
-
12.1. License
+
12.1. License
12.2. History
@@ -564,7 +578,7 @@
14.1. Regular Expressions
-
14.2. Privoxy's Internal +
14.2. Privoxy's Internal Pages
diff --git a/doc/webserver/user-manual/installation.html b/doc/webserver/user-manual/installation.html index ad3e77dc..0620ee11 100644 --- a/doc/webserver/user-manual/installation.html +++ b/doc/webserver/user-manual/installation.html @@ -6,7 +6,7 @@ Installation - + @@ -20,7 +20,7 @@

Privoxy 3.0.19 User ManualPrivoxy 3.0.20 User Manual
- + @@ -65,7 +65,7 @@ "INSTALLATION-PACK-RPM">2.1.1. Red Hat and Fedora RPMs

RPMs can be installed with rpm -Uvh - privoxy-3.0.19-1.rpm, and will use , and will use /etc/privoxy for the location of configuration files.

@@ -77,7 +77,7 @@

If you have problems with failed dependencies, try rebuilding the SRC RPM: rpm --rebuild - privoxy-3.0.19-1.src.rpm. This will use your locally installed + privoxy-3.0.20-1.src.rpm. This will use your locally installed libraries and RPM version.

Also note that if you have a 2.1.6. Mac OS X -

Unzip the downloaded file (you can either double-click on the zip - file icon from the Finder, or from the desktop if you downloaded it - there). Then, double-click on the package installer icon and follow - the installation process.

+

Installation instructions for the OS X platform depend upon + whether you downloaded a ready-built installation package (.pkg or + .mpkg) or have downloaded the source code.

+ + +
+

2.1.7. Installation from ready-built + package

+ +

The downloaded file will either be a .pkg (for OS X 10.5 upwards) + or a bzipped .mpkg file (for OS X 10.4). The former can be + double-clicked as is and the installation will start; double-clicking + the latter will unzip the .mpkg file which can then be double-clicked + to commence the installation.

+ +

The privoxy service will automatically start after a successful + installation (and thereafter every time your computer starts up) + however you will need to configure your web browser(s) to use it. To + do so, configure them to use a proxy for HTTP and HTTPS at the + address 127.0.0.1:8118.

+ +

To prevent the privoxy service from automatically starting when + your computer starts up, remove or rename the file /Library/LaunchDaemons/org.ijbswa.privoxy.plist (on OS + X 10.5 and higher) or the folder named /Library/StartupItems/Privoxy (on OS X 10.4 + 'Tiger').

+ +

To manually start or stop the privoxy service, use the scripts + startPrivoxy.sh and stopPrivoxy.sh supplied in /Applications/Privoxy. + They must be run from an administrator account, using sudo.

+ +

To uninstall, run /Applications/Privoxy/uninstall.command as sudo + from an administrator account.

+
+ +
+

2.1.8. Installation from source

+ +

To build and install the Privoxy source code on OS X you will need + to obtain the macsetup module from the Privoxy Sourceforge CVS + repository (refer to Sourceforge help for details of how to set up a + CVS client to have read-only access to the repository). This module + contains scripts that leverage the usual open-source tools (available + as part of Apple's free of charge Xcode distribution or via the usual + open-source software package managers for OS X (MacPorts, Homebrew, + Fink etc.) to build and then install the privoxy binary and + associated files. The macsetup module's README file contains complete + instructions for its use.

The privoxy service will automatically start after a successful - installation (in addition to every time your computer starts up). To - prevent the privoxy service from automatically starting when your - computer starts up, remove or rename the folder named /Library/StartupItems/Privoxy.

+ installation (and thereafter every time your computer starts up) + however you will need to configure your web browser(s) to use it. To + do so, configure them to use a proxy for HTTP and HTTPS at the + address 127.0.0.1:8118.

+ +

To prevent the privoxy service from automatically starting when + your computer starts up, remove or rename the file /Library/LaunchDaemons/org.ijbswa.privoxy.plist (on OS + X 10.5 and higher) or the folder named /Library/StartupItems/Privoxy (on OS X 10.4 + 'Tiger').

To manually start or stop the privoxy service, use the Privoxy - Utility for Mac OS X. This application controls the privoxy service - (e.g. starting and stopping the service as well as uninstalling the - software).

+ Utility for Mac OS X (also part of the macsetup module). This + application can start and stop the privoxy service and display its + log and configuration files.

+ +

To uninstall, run the macsetup module's uninstall.sh as sudo from + an administrator account.

2.1.7. AmigaOS

+ "INSTALLATION-AMIGA">2.1.9. AmigaOS

Copy and then unpack the lha archive to a suitable location. All necessary files will be installed into @@ -205,7 +262,7 @@

2.1.8. FreeBSD

+ "INSTALLATION-TBZ">2.1.10. FreeBSD

Privoxy is part of FreeBSD's Ports Collection, you can build and install it with cd /usr/ports/www/privoxy; make @@ -224,7 +281,7 @@

2.1.9. Gentoo

+ "INSTALLATTION-GENTOO">2.1.11. Gentoo

Gentoo source packages (Ebuilds) for Privoxy are contained in the Gentoo Portage Tree @@ -239,7 +296,7 @@

Configuration files are in /etc/privoxy, the documentation is in /usr/share/doc/privoxy-3.0.19 and the Log directory + "FILENAME">/usr/share/doc/privoxy-3.0.20 and the Log directory is in /var/log/privoxy.

@@ -274,8 +331,8 @@
diff --git a/doc/webserver/user-manual/introduction.html b/doc/webserver/user-manual/introduction.html index 342f04e5..5ef20cae 100644 --- a/doc/webserver/user-manual/introduction.html +++ b/doc/webserver/user-manual/introduction.html @@ -6,8 +6,8 @@ Introduction - - + + @@ -20,7 +20,7 @@
Privoxy 3.0.19 User ManualPrivoxy 3.0.20 User Manual
- tar xzvf privoxy-3.0.19-stable-src.tar.gz
- cd privoxy-3.0.19-stable
+ tar xzvf privoxy-3.0.20-beta-src.tar.gz
+ cd privoxy-3.0.20-beta
 
- + @@ -40,8 +40,18 @@

1. Introduction

-

This documentation is included with the current stable version of - Privoxy, v.3.0.19.

+

This documentation is included with the current UNRELEASED version of + Privoxy, v.3.0.20, 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 a new version is currently nearing + completion, and includes significant changes and enhancements over + earlier versions.

+ +

Since this is a UNRELEASED version, not all new features are well + tested. This documentation may be slightly out of sync as a result + (especially with CVS sources). And there may be bugs, though hopefully not many!

1.1. @@ -50,8 +60,8 @@

In addition to the core features of ad blocking and cookie management, Privoxy provides many - supplemental features, that give the end-user more control, more - privacy and more freedom:

+ supplemental features, some of them currently under development, that + give the end-user more control, more privacy and more freedom:

  • @@ -157,7 +167,7 @@

- diff --git a/doc/webserver/user-manual/quickstart.html b/doc/webserver/user-manual/quickstart.html index da782cb6..ac19c4dc 100644 --- a/doc/webserver/user-manual/quickstart.html +++ b/doc/webserver/user-manual/quickstart.html @@ -6,7 +6,7 @@ Quickstart to Using Privoxy - + @@ -21,7 +21,7 @@
Privoxy 3.0.19 User ManualPrivoxy 3.0.20 User Manual
Privoxy 3.0.19 User + Privoxy 3.0.20 User Manual  
- + @@ -343,7 +343,7 @@ "GUIBUTTON">Edit":

- +

Figure 1. Actions Files in Use

diff --git a/doc/webserver/user-manual/seealso.html b/doc/webserver/user-manual/seealso.html index cb5db4c1..60c1d2bb 100644 --- a/doc/webserver/user-manual/seealso.html +++ b/doc/webserver/user-manual/seealso.html @@ -6,7 +6,7 @@ See Also - + @@ -21,7 +21,7 @@
Privoxy 3.0.19 User ManualPrivoxy 3.0.20 User Manual
- + @@ -109,26 +109,6 @@
Privoxy 3.0.19 User ManualPrivoxy 3.0.20 User Manual
- - - - - - -
http://www.junkbusters.com/ht/en/cookies.html, an - explanation how cookies are used to track web users.
- - - - - - - -
http://www.junkbusters.com/ijb.html, the original - Internet Junkbuster.
- diff --git a/doc/webserver/user-manual/startup.html b/doc/webserver/user-manual/startup.html index 8d14e4c0..e935cbd0 100644 --- a/doc/webserver/user-manual/startup.html +++ b/doc/webserver/user-manual/startup.html @@ -6,7 +6,7 @@ Starting Privoxy - + @@ -21,7 +21,7 @@
- + @@ -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/templates.html b/doc/webserver/user-manual/templates.html index 6aab5529..28724081 100644 --- a/doc/webserver/user-manual/templates.html +++ b/doc/webserver/user-manual/templates.html @@ -6,7 +6,7 @@ Privoxy's Template Files - +
- + diff --git a/doc/webserver/user-manual/whatsnew.html b/doc/webserver/user-manual/whatsnew.html index d12d16be..32f4bc35 100644 --- a/doc/webserver/user-manual/whatsnew.html +++ b/doc/webserver/user-manual/whatsnew.html @@ -6,7 +6,7 @@ What's New in this Release - + @@ -21,7 +21,7 @@
Privoxy 3.0.19 User ManualPrivoxy 3.0.20 User Manual
Privoxy 3.0.19 User ManualPrivoxy 3.0.20 User Manual
- + -- 2.39.2
Privoxy 3.0.19 User ManualPrivoxy 3.0.20 User Manual