Copyright © 2001, 2002 by Privoxy Developers
-$Id: developer-manual.sgml,v 1.46.2.6 2002/08/10 11:40:25 oes Exp $
-
+$Id: developer-manual.sgml,v 1.46.2.8 2002/08/17 00:16:10 hal9 Exp $
The developer manual provides guidance on coding, testing, packaging,
documentation and other issues of importance to those involved with Privoxy
join the team.
Please note that this document is constantly evolving. This copy represents the
-state at the release of version 2.9.20. You can find the latest version of the
+state at the release of version 3.0.0. You can find the latest version of the
this manual at http://www.privoxy.org/developer-manual/. Please see the Contact
section on how to contact the developers.
-------------------------------------------------------------------------------
+
Table of Contents
1. Introduction
- 1.1. Quickstart to Privoxy Development
+ 1.1. Quickstart to Privoxy Development
2. The CVS Repository
+
2.1. Access to CVS
2.2. CVS Commit Guideline
2.3. Discussing Changes First
-
3. Documentation Guidelines
+
3.1. Quickstart to Docbook and SGML
3.2. Privoxy Documentation Style
3.3. Privoxy Custom Entities
-
4. Coding Guidelines
+
4.1. Introduction
4.2. Using Comments
+
4.2.1. Comment, Comment, Comment
4.2.2. Use blocks for comments
4.2.3. Keep Comments on their own line
4.2.6. Comment at the end of braces if the content is more than one
screen length
-
4.3. Naming Conventions
+
4.3.1. Variable Names
4.3.2. Function Names
4.3.3. Header file prototypes
4.3.4. Enumerations, and #defines
4.3.5. Constants
-
4.4. Using Space
+
4.4.1. Put braces on a line by themselves.
4.4.2. ALL control statements should have a block
4.4.3. Do not belabor/blow-up boolean expressions
4.4.6. Make the last brace of a function stand out
4.4.7. Use 3 character indentions
-
4.5. Initializing
- 4.5.1. Initialize all variables
+ 4.5.1. Initialize all variables
4.6. Functions
+
4.6.1. Name functions that return a boolean as a question.
4.6.2. Always specify a return type for a function.
4.6.3. Minimize function calls when iterating by using variables
4.6.9. Where Possible, Use Forward Struct Declaration Instead of
Includes
-
4.7. General Coding Practices
+
4.7.1. Turn on warnings
4.7.2. Provide a default case for all switch statements
4.7.3. Try to avoid falling through cases in a switch statement.
4.7.9. Add loaders to the `file_list' structure and in order
4.7.10. "Uncertain" new code and/or changes to existing code, use FIXME
-
4.8. Addendum: Template for files and function comment blocks:
-
5. Testing Guidelines
+
5.1. Testplan for releases
5.2. Test reports
-
6. Releasing a New Version
+
6.1. Version numbers
6.2. Before the Release: Freeze
6.3. Building and Releasing the Packages
+
6.3.1. Note on Privoxy Packaging
6.3.2. Source Tarball
6.3.3. SuSE, Conectiva or Red Hat RPM
6.3.11. Amiga OS
6.3.12. AIX
-
6.4. Uploading and Releasing Your Package
6.5. After the Release
-
7. Update the Webserver
8. Contacting the developers, Bug Reporting and Feature Requests
+
8.1. Get Support
8.2. Report Bugs
8.3. Request New Features
8.4. Report Ads or Other Actions-Related Problems
8.5. Other
-
9. Privoxy Copyright, License and History
+
9.1. License
9.2. History
-
10. See also
1. Introduction
One does not have to be a programmer to contribute. Packaging, testing, and
porting, are all important jobs as well.
+
-------------------------------------------------------------------------------
1.1. Quickstart to Privoxy Development
For the time being (read, this section is under construction), please refer to
the extensive comments in the source code.
+
-------------------------------------------------------------------------------
2. The CVS Repository
If you intend to help us with programming, documentation or packaging you will
need write access to our holy grail, the CVS repository. Please read this
chapter completely before accessing via CVS.
+
-------------------------------------------------------------------------------
2.1. Access to CVS
for your operating system. For historical reasons, the CVS server is called
cvs.ijbswa.sourceforge.net, the repository is called ijbswa, and the source
tree module is called current.
+
-------------------------------------------------------------------------------
2.2. CVS Commit Guideline
therefore ask anyone with CVS access to strictly adhere to the following
guidelines:
- * Never (read: never, ever) be tempted to commit that small change without
+ * Never (read: never, ever) be tempted to commit that small change without
testing it thoroughly first. When we're close to a public release, ask a
fellow developer to review your changes.
- * Your commit message should give a concise overview of what you changed (no
+ * Your commit message should give a concise overview of what you changed (no
big details) and why you changed it Just check previous messages for good
examples.
- * Don't use the same message on multiple files, unless it equally applies to
+ * Don't use the same message on multiple files, unless it equally applies to
all those files.
- * If your changes span multiple files, and the code won't recompile unless
+ * If your changes span multiple files, and the code won't recompile unless
all changes are committed (e.g. when changing the signature of a function),
then commit all files one after another, without long delays in between. If
necessary, prepare the commit messages in advance.
- * Before changing things on CVS, make sure that your changes are in line with
+ * Before changing things on CVS, make sure that your changes are in line with
the team's general consensus on what should be done (see below).
- * Don't commit into the stable branch, unless immediately before a new
+ * Don't commit into the stable branch, unless immediately before a new
release. (See Version Numbers below for details.) Collect your changes on
the patches tracker instead.
-
-------------------------------------------------------------------------------
+
2.3. Discussing Changes First
We don't have a too formal policy on this, just use common sense. Hints: If it
5. ..a major redesign of some part of the code: ask the list
-
Note that near a major public release, we get a bit more cautious - if unsure,
it doesn't hurt to ask first. There is always the possibility to submit a patch
to the patches tracker instead.
+
-------------------------------------------------------------------------------
3. Documentation Guidelines
generated files! Also, the Privoxy index.html (and a variation on this file,
privoxy-index.html, meant for inclusion with doc packages), are maintained as
SGML as well. DO NOT edit these directly. Edit the SGML source, or contact
-someone involved in the documentation (at present Stefan and Hal).
+someone involved in the documentation (at present Hal).
config requires some special handling. The reason it is maintained this way is
so that the extensive comments in the file mirror those in user-manual. But the
How do you update the webserver (i.e. the pages on privoxy.org)?
1. First, build the docs by running make dok (or alternately make redhat-dok).
+ For PDF docs, do make dok-pdf.
2. Run make webserver which copies all files from doc/webserver to the
sourceforge webserver via scp.
-
Finished docs should be occasionally submitted to CVS (doc/webserver/*/*.html)
so that those without the ability to build them locally, have access to them if
needed. This is especially important just prior to a new release! Please do
this after the $VERSION and other release specific data in configure.in has
been updated (this is done just prior to a new release).
+
-------------------------------------------------------------------------------
3.1. Quickstart to Docbook and SGML
You might also find "Writing Documentation Using DocBook - A Crash Course"
useful.
+
-------------------------------------------------------------------------------
3.2. Privoxy Documentation Style
Here it is:
- * All tags should be lower case.
+ * All tags should be lower case.
- * Tags delimiting a block of text (even small blocks) should be on their own
+ * Tags delimiting a block of text (even small blocks) should be on their own
line. Like:
- <para>
- Some text goes here.
- </para>
-
+ <para>
+ Some text goes here.
+ </para>
+
+
Tags marking individual words, or few words, should be in-line:
- Just to <emphasis>emphasize</emphasis>, some text goes here.
-
+ Just to <emphasis>emphasize</emphasis>, some text goes here.
+
- * Tags should be nested and step indented for block text like: (except
+ * Tags should be nested and step indented for block text like: (except
in-line tags)
- <para>
- <itemizedlist>
- <para>
- <listitem>
- Some text goes here in our list example.
- </listitem>
- </para>
- </itemizedlist>
- </para>
-
+ <para>
+ <itemizedlist>
+ <para>
+ <listitem>
+ Some text goes here in our list example.
+ </listitem>
+ </para>
+ </itemizedlist>
+ </para>
+
+
This makes it easier to find the text amongst the tags ;-)
- * Use white space to separate logical divisions within a document, like
+
+ * Use white space to separate logical divisions within a document, like
between sections. Running everything together consistently makes it harder
to read and work on.
- * Do not hesitate to make comments. Comments can either use the <comment>
+ * Do not hesitate to make comments. Comments can either use the <comment>
element, or the <!-- --> style comment familiar from HTML. (Note in Docbook
v4.x <comment> is replaced by <remark>.)
- * We have an international audience. Refrain from slang, or English
+ * We have an international audience. Refrain from slang, or English
idiosyncrasies (too many to list :). Humor also does not translate well
sometimes.
- * Try to keep overall line lengths in source files to 80 characters or less
+ * Try to keep overall line lengths in source files to 80 characters or less
for obvious reasons. This is not always possible, with lengthy URLs for
instance.
- * Our documents are available in differing formats. Right now, they are just
- plain text, and HTML, but PDF, and others is always a future possibility.
-
Be careful with URLs (<ulink>), and avoid this mistake:
+ * Our documents are available in differing formats. Right now, they are just
+ plain text, TML, and PDF, but others are always a future possibility. Be
+ careful with URLs (<ulink>), and avoid this mistake:
My favorite site is <ulink url="http://example.com">here</ulink>.
My favorite site is <ulink url="http://example.com">example.com</ulink>.
- * All documents should be spell checked occasionally. aspell can check SGML
+ * All documents should be spell checked occasionally. aspell can check SGML
with the -H option. (ispell I think too.)
-
-------------------------------------------------------------------------------
+
3.3. Privoxy Custom Entities
Privoxy documentation is using a number of customized "entities" to facilitate
re-setting with each release (done by the Makefile). A sampling of custom
entities are listed below. See any of the main docs for examples.
- * Re- "boilerplate" text entities are defined like:
+ * Re- "boilerplate" text entities are defined like:
<!entity supported SYSTEM "supported.sgml">
semi-colon), and the contents will be dumped into the finished doc at that
point.
- * Commonly used "internal entities":
+ * Commonly used "internal entities":
- p-version: the Privoxy version string, e.g. "2.9.20".
+ p-version: the Privoxy version string, e.g. "3.0.0".
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").
p-stable: just the opposite.
p-text: this doc is only generated as text.
-
-
There are others in various places that are defined for a specific purpose.
Read the source!
+
-------------------------------------------------------------------------------
4. Coding Guidelines
And that of course comes back to us as individuals. If we can increase our
development and product efficiencies then we can solve more of the request for
changes/improvements and in general feel good about ourselves. ;->
+
-------------------------------------------------------------------------------
4.2. Using Comments
programming error is occurring.
Example:
+
/* if page size greater than 1k ... */
if ( PageLength() > 1024 )
{
This demonstrates 2 cases of "what not to do". The first is a
"syntax comment". The second is a comment that does not fit what
is actually being done.
+
-------------------------------------------------------------------------------
4.2.2. Use blocks for comments
surrounding the code with a clear, definable pattern.
Example:
+
/*********************************************************************
* This will stand out clearly in your code!
*********************************************************************/
If you are trying to add a small logic comment and do not wish to "disrupt" the
flow of the code, feel free to use a 1 line comment which is NOT on the same
line as the code.
+
-------------------------------------------------------------------------------
4.2.3. Keep Comments on their own line
used to comment parameters.
Example:
+
/*********************************************************************
* This will stand out clearly in your code,
* But the second example won't.
...code here...
} /* -END- DoSomethingVeryImportant */
+
-------------------------------------------------------------------------------
4.2.4. Comment each logical step
Most "for", "while", "do", etc... loops _probably_ need a comment. After all,
these are usually major logic containers.
+
-------------------------------------------------------------------------------
4.2.5. Comment All Functions Thoroughly
function for the problem at hand. As a result of such benefits, all functions
should contain the information presented in the addendum section of this
document.
+
-------------------------------------------------------------------------------
4.2.6. Comment at the end of braces if the content is more than one screen
use following a closing brace: } /* -END- if() or while () or etc... */
Example:
+
if ( 1 == X )
{
DoSomethingVeryImportant();
DoSomethingVeryImportant();
...some long list of commands...
} /* -END- if ( 1 == X ) */
+
-------------------------------------------------------------------------------
4.3. Naming Conventions
port Privoxy to C++.
Example:
+
int ms_iis5_hack = 0;
Instead of:
int msiis5hack = 0; int msIis5Hack = 0;
+
-------------------------------------------------------------------------------
4.3.2. Function Names
port Privoxy to C++.
Example:
+
int load_some_file( struct client_state *csp )
Instead of:
int loadsomefile( struct client_state *csp )
int loadSomeFile( struct client_state *csp )
+
-------------------------------------------------------------------------------
4.3.3. Header file prototypes
the same parameter name in the header file that you use in the c file.
Example:
+
(.h) extern int load_aclfile( struct client_state *csp );
(.c) int load_aclfile( struct client_state *csp )
Instead of:
+
(.h) extern int load_aclfile( struct client_state * ); or
(.h) extern int load_aclfile();
(.c) int load_aclfile( struct client_state *csp )
+
-------------------------------------------------------------------------------
4.3.4. Enumerations, and #defines
and system headers.)
Example:
+
(enumeration) : enum Boolean { FALSE, TRUE };
(#define) : #define DEFAULT_SIZE 100;
description.
Example:
+
#define FEATURE_FORCE 1
#ifdef FEATURE_FORCE
#define FORCE_PREFIX blah
#endif /* def FEATURE_FORCE */
+
-------------------------------------------------------------------------------
4.3.5. Constants
terminate a name with an underscore.
Example:
+
#define USE_IMAGE_LIST 1
Instead of:
#define USE_IMAGE_LIST_ 1 or
#define use_image_list 1 or
#define UseImageList 1
+
-------------------------------------------------------------------------------
4.4. Using Space
block.
Example:
+
if ( this == that )
{
...
Status: developer-discretion.
Example exception:
+
while ( more lines are read )
{
/* Please document what is/is not a comment line here */
do_something( line );
}
+
-------------------------------------------------------------------------------
4.4.2. ALL control statements should have a block
to error. All control statements should have a block defined.
Example:
+
if ( this == that )
{
DoSomething();
that which the developer desired (per indentation). Using code braces would
have prevented this "feature". The "explanation" and "exception" from the point
above also applies.
+
-------------------------------------------------------------------------------
4.4.3. Do not belabor/blow-up boolean expressions
Example:
+
structure->flag = ( condition );
Instead of:
Note: The former is readable and concise. The later is wordy and inefficient.
Please assume that any developer new to the project has at least a "good"
knowledge of C/C++. (Hope I do not offend by that last comment ... 8-)
+
-------------------------------------------------------------------------------
4.4.4. Use white space freely because it is free
in the next guideline.
Example:
+
int firstValue = 0;
int someValue = 0;
int anotherValue = 0;
if ( thisVariable == thatVariable )
firstValue = oldValue + ( ( someValue - anotherValue ) - whatever )
+
-------------------------------------------------------------------------------
4.4.5. Don't use white space around structure operators
variable/function name is not as clear.
Example:
+
aStruct->aMember;
aStruct.aMember;
FunctionName();
Instead of: aStruct -> aMember; aStruct . aMember; FunctionName ();
+
-------------------------------------------------------------------------------
4.4.6. Make the last brace of a function stand out
Example:
+
int function1( ... )
{
...code...
Status: developer-discretion on the number of blank lines. Enforced is the end
of function comments.
+
-------------------------------------------------------------------------------
4.4.7. Use 3 character indentions
your code through a filter such as "expand -t3" before checking in your code.
Example:
+
static const char * const url_code_map[256] =
{
NULL, ...
return( NEVER_GETS_HERE );
}
+
-------------------------------------------------------------------------------
4.5. Initializing
accidentally using an unassigned variable.
Example:
+
short anShort = 0;
float aFloat = 0;
struct *ptr = NULL;
Status: developer-discretion if and only if the variable is assigned a value
"shortly after" declaration.
+
-------------------------------------------------------------------------------
4.6. Functions
true or false statement
Example:
+
ShouldWeBlockThis();
ContainsAnImage();
IsWebPageBlank();
+
-------------------------------------------------------------------------------
4.6.2. Always specify a return type for a function.
The default return for a function is an int. To avoid ambiguity, create a
return for a function when the return has a purpose, and create a void return
type if the function does not need to return anything.
+
-------------------------------------------------------------------------------
4.6.3. Minimize function calls when iterating by using variables
the code is easy to understand:
Example:
+
for ( size_t cnt = 0; cnt < blockListLength(); cnt ++ )
{
....
variable, and evaluate using the variable.
Example:
+
size_t len = blockListLength();
for ( size_t cnt = 0; cnt < len; cnt ++ )
Exceptions: if the value of blockListLength() *may* change or could *
potentially* change, then you must code the function call in the for/while
loop.
+
-------------------------------------------------------------------------------
4.6.4. Pass and Return by Const Reference
Both these pointers are *const*! If the c runtime library maintainers do it, we
should too.
+
-------------------------------------------------------------------------------
4.6.5. Pass and Return by Value
would not work. So, to be consistent, we should declare all prototypes with
"pass by value": int load_aclfile( struct client_state *csp )
+
-------------------------------------------------------------------------------
4.6.6. Names of include files
other header files.
Example:
+
#include <iostream.h> /* This is not a local include */
#include "config.h" /* This IS a local include */
Note: Please! do not add "-I." to the Makefile without a _very_ good reason.
This duplicates the #include "file.h" behavior.
+
-------------------------------------------------------------------------------
4.6.7. Provide multiple inclusion protection
to "_", and make it uppercase.
Example:
+
#ifndef PROJECT_H_INCLUDED
#define PROJECT_H_INCLUDED
...
#endif /* ndef PROJECT_H_INCLUDED */
+
-------------------------------------------------------------------------------
4.6.8. Use `extern "C"` when appropriate
of our code.
Example:
+
#ifdef __cplusplus
extern "C"
{
#ifdef __cplusplus
}
#endif /* def __cplusplus */
+
-------------------------------------------------------------------------------
4.6.9. Where Possible, Use Forward Struct Declaration Instead of Includes
excess header files may cause needless compiles.
Example:
+
/*********************************************************************
* We're avoiding an include statement here!
*********************************************************************/
however, the header file is unnecessary.
Status: Use with discretion.
+
-------------------------------------------------------------------------------
4.7. General Coding Practices
Compiler warnings are meant to help you find bugs. You should turn on as many
as possible. With GCC, the switch is "-Wall". Try and fix as many warnings as
possible.
+
-------------------------------------------------------------------------------
4.7.2. Provide a default case for all switch statements
statement.
Example:
+
switch( hash_string( cmd ) )
{
case hash_actions_file :
stream (as in load_config). Or it may really be an ABEND condition.
Status: Programmer discretion is advised.
+
-------------------------------------------------------------------------------
4.7.3. Try to avoid falling through cases in a switch statement.
If you choose to allow fall through, you should comment both the fact of the
fall through and reason why you felt it was necessary.
+
-------------------------------------------------------------------------------
4.7.4. Use 'long' or 'short' Instead of 'int'
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 other types
size_t against another variable of a different type (or even against a
constant) without casting one of the values. Try to avoid using size_t if you
can.
+
-------------------------------------------------------------------------------
4.7.6. Declare each variable and struct on its own line.
It can be tempting to declare a series of variables all on one line. Don't.
Example:
+
long a = 0;
long b = 0;
long c = 0;
good comment on their functions.
Status: developer-discretion.
+
-------------------------------------------------------------------------------
4.7.7. Use malloc/zalloc sparingly
the context of one function call.
Example:
+
If a function creates a struct and stores a pointer to it in a
list, then it should definitely be allocated via `malloc'.
+
-------------------------------------------------------------------------------
4.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring 'free'
function to accommodate this.
Example:
+
int load_re_filterfile( struct client_state *csp ) { ... }
static void unload_re_filterfile( void *f ) { ... }
Status: developer-discretion. The "main" use of this standard is for allocating
and freeing data structures (complex or nested).
+
-------------------------------------------------------------------------------
4.7.9. Add loaders to the `file_list' structure and in order
Note: It may appear that the alpha order is broken in places by POPUP tests
coming before PCRS tests. But since POPUPs can also be referred to as
KILLPOPUPs, it is clear that it should come first.
+
-------------------------------------------------------------------------------
4.7.10. "Uncertain" new code and/or changes to existing code, use FIXME
Note: If you make it clear that this may or may not be a "good thing (tm)", it
will be easier to identify and include in the project (or conversely exclude
from the project).
+
-------------------------------------------------------------------------------
4.8. Addendum: Template for files and function comment blocks:
Example for file comments:
-const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.46.2.6 2002/08/10 11:40: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.46.2.8 2002/08/17 00:16:10 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
can.
Example for file header comments:
-#ifndef _FILENAME_H
-#define _FILENAME_H
-#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.46.2.6 2002/08/10 11:40: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.46.2.8 2002/08/17 00:16:10 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:
+
/*********************************************************************
*
* Function : FUNCTION_NAME
Note: If we all follow this practice, we should be able to parse our code to
create a "self-documenting" web page.
+
-------------------------------------------------------------------------------
5. Testing Guidelines
To be filled.
+
-------------------------------------------------------------------------------
5.1. Testplan for releases
2. Remove any file that was left over. This includes (but is not limited to)
- + /var/log/privoxy
+ + /var/log/privoxy
- + /etc/privoxy
+ + /etc/privoxy
- + /usr/sbin/privoxy
+ + /usr/sbin/privoxy
- + /etc/init.d/privoxy
+ + /etc/init.d/privoxy
- + /usr/doc/privoxy*
+ + /usr/doc/privoxy*
-
3. Install the rpm. Any error messages?
4. start,stop,status Privoxy with the specific script (e.g. /etc/rc.d/init/
6. Remove the rpm. Any error messages? All files removed?
-
-------------------------------------------------------------------------------
+
5.2. Test reports
Please submit test reports only with the test form at sourceforge. Three simple
steps:
- * Select category: the distribution you test on.
+ * Select category: the distribution you test on.
- * Select group: the version of Privoxy that we are about to release.
+ * Select group: the version of Privoxy that we are about to release.
- * Fill the Summary and Detailed Description with something intelligent (keep
+ * Fill the Summary and Detailed Description with something intelligent (keep
it short and precise).
-
Do not mail to the mailing list (we cannot keep track on issues there).
+
-------------------------------------------------------------------------------
6. Releasing a New Version
The following programs are required to follow this process: ncftpput (ncftp),
scp, ssh (ssh), gmake (GNU's version of make), autoconf, cvs.
+
-------------------------------------------------------------------------------
6.1. Version numbers
version numbers consist of three numbers, separated by dots, like in X.Y.Z,
where:
- * X, the version major, is rarely ever changed. It is increased by one if
+ * X, the version major, is rarely ever changed. It is increased by one if
turning a development branch into stable substantially changes the
- functionality, user interface or configuration syntax. Majors 1 and 2 were
+ functionality, user interface or configuration syntax. Majors 1 and 2 were
Junkbuster, and 3 will be the first stable Privoxy release.
- * Y, the version minor, represents the branch within the major version. At
+ * Y, the version minor, represents the branch within the major version. At
any point in time, there are two branches being maintained: The stable
branch, with an even minor, say, 2N, in which no functionality is being
added and only bug-fixes are made, and 2N+1, the development branch, in
up (i.e. no longer maintained), the former development branch 2N+1 becomes
the new stable branch 2N+2, and a new development branch 2N+3 is opened.
- * Z, the point or sub version, represents a release of the software within a
+ * Z, the point or sub version, represents a release of the software within a
branch. It is therefore incremented immediately before each code freeze. In
development branches, only the even point versions correspond to actual
releases, while the odd ones denote the evolving state of the sources on
distinguished from released versions. The point version is reset to zero
when the minor changes.
-
-------------------------------------------------------------------------------
+
6.2. Before the Release: Freeze
The following must be done by one of the developers prior to each new release.
- * Make sure that everybody who has worked on the code in the last couple of
+ * Make sure that everybody who has worked on the code in the last couple of
days has had a chance to yell "no!" in case they have pending changes/fixes
in their pipelines. Announce the freeze so that nobody will interfere with
last minute changes.
- * Increment the version number (point from odd to even in development
+ * Increment the version number (point from odd to even in development
branches!) in configure.in. (RPM spec files will need to be incremented as
well.)
- * If default.action has changed since last release (i.e. software release or
+ * If default.action has changed since last release (i.e. software release or
standalone actions file release), bump up its version info to A.B in this
line:
Then change the version info in doc/webserver/actions/index.php, line:
'$required_actions_file_version = "A.B";'
- * All documentation should be rebuild after the version bump. Finished docs
+ * All documentation should be rebuild after the version bump. Finished docs
should be then be committed to CVS (for those without the ability to build
these). Some docs may require rather obscure processing tools. config, the
man page (and the html version of the man page), and the PDF docs fall in
this category. REAMDE, the man page, AUTHORS, and config should all also be
- committed to CVS for other packageers. The formal docs should be uploaded
- to the webserver. See the Section "Updating the webserver" in this manual
- for details.
-
- * All developers should look at the ChangeLog and make sure noteworthy
+ committed to CVS for other packagers. The formal docs should be uploaded to
+ the webserver. See the Section "Updating the webserver" in this manual for
+ details.
+
+ * The User Manual is also used for context sensitive help for the CGI editor.
+ This is version sensitive, so that the user will get appropriate help for
+ his/her release. So with each release a fresh version should be uploaded to
+ the webserver (this is in addition to the main User Manual link from the
+ main page since we need to keep manuals for various versions available).
+ The CGI pages will link to something like http://privoxy.org/$(VERSION)/
+ user-manual/. This will need to be updated for each new release. There is
+ no Makefile target for this at this time!!! It needs to be done manually.
+
+ * All developers should look at the ChangeLog and make sure noteworthy
changes are referenced.
- * Commit all files that were changed in the above steps!
+ * Commit all files that were changed in the above steps!
- * Tag all files in CVS with the version number with "cvs tag v_X_Y_Z". Don't
+ * Tag all files in CVS with the version number with "cvs tag v_X_Y_Z". Don't
use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
- * If the release was in a development branch, increase the point version from
+ * If the release was in a development branch, increase the point version from
even to odd (X.Y.(Z+1)) again in configure.in and commit your change.
- * On the webserver, copy the user manual to a new top-level directory called
+ * On the webserver, copy the user manual to a new top-level directory called
X.Y.Z. This ensures that help links from the CGI pages, which have the
version as a prefix, will go into the right version of the manual. If this
is a development branch release, also symlink X.Y.(Z-1) to X.Y.Z and X.Y.
(Z+1) to . (i.e. dot).
-
-------------------------------------------------------------------------------
+
6.3. Building and Releasing the Packages
Now the individual packages can be built and released. Note that for GPL
Please find additional instructions for the source tarball and the individual
platform dependent binary packages below. And details on the Sourceforge
release process below that.
+
-------------------------------------------------------------------------------
6.3.1. Note on Privoxy Packaging
Please keep these general guidelines in mind when putting together your
package. These apply to all platforms!
- * Privoxy requires write access to: all *.action files, all logfiles, and the
+ * Privoxy requires write access to: all *.action files, all logfiles, and the
trust file. You will need to determine the best way to do this for your
platform.
- * Please include up to date documentation. At a bare minimum:
+ * Please include up to date documentation. At a bare minimum:
LICENSE (top-level directory)
directory with privoxy-index.html, (i.e. one level up from the manual
directories).
- * user.action is designed for local preferences. Make sure this does not get
+ * user.action is designed for local preferences. Make sure this does not get
overwritten!
- * Other configuration files should be installed as the new defaults, but all
+ * Other configuration files should be installed as the new defaults, but all
previously installed configuration files should be preserved as backups.
This is just good manners :-)
- * Please check platform specific notes in this doc, if you haven't done
+ * Please check platform specific notes in this doc, if you haven't done
"Privoxy" packaging before for other platform specific issues. Conversely,
please add any notes that you know are important for your platform (or
contact one of the doc maintainers to do this if you can't).
- * Packagers should do a "clean" install of their package after building it.
+ * Packagers should do a "clean" install of their package after building it.
So any previous installs should be removed first to ensure the integrity of
the newly built package. Then run the package for a while to make sure
there are no obvious problems, before uploading.
-
-------------------------------------------------------------------------------
+
6.3.2. Source Tarball
First, make sure that you have freshly exported the right version into an empty
Go to the displayed URL and release the file publicly on Sourceforge. For the
change log field, use the relevant section of the ChangeLog file.
+
-------------------------------------------------------------------------------
6.3.3. SuSE, Conectiva or Red Hat RPM
where rpm_packagerev is the RPM release number as determined above. Go to the
displayed URL and release the file publicly on Sourceforge. Use the release
notes and change log from the source tarball package.
+
-------------------------------------------------------------------------------
6.3.4. OS/2
Upload this 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.
+
-------------------------------------------------------------------------------
6.3.5. Solaris
on the Sourceforge machine (no ncftpput). You now have to manually upload the
archive to Sourceforge's ftp server and release the file publicly. Use the
release notes and Change Log from the source tarball package.
+
-------------------------------------------------------------------------------
6.3.6. Windows
Now you can manually rename privoxy_setup.exe to privoxy_setup_X_Y_Z.exe, and
upload it to SourceForge. When releasing the package on SourceForge, use the
release notes and Change Log from the source tarball package.
+
-------------------------------------------------------------------------------
6.3.7. Debian
directory. (See "Building and releasing packages" above). Then add a log entry
to debian/changelog, if it is not already there, for example by running:
- debchange -v 2.9.20-beta-1 "New upstream version"
+ debchange -v 3.0.0-stable-1 "New upstream version"
Then, run:
dpkg-buildpackage -rfakeroot -us -uc -b
-This will create ../privoxy_2.9.20-beta-1_i386.deb which can be uploaded. To
+This will create ../privoxy_3.0.0-stable-1_i386.deb which can be uploaded. To
upload the package to Sourceforge, simply issue
make debian-upload
+
-------------------------------------------------------------------------------
6.3.8. Mac OSX
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.
+
-------------------------------------------------------------------------------
6.3.9. FreeBSD
on the Sourceforge machine (no ncftpput). You now have to manually upload the
archive to Sourceforge's ftp server and release the file publicly. Use the
release notes and Change Log from the source tarball package.
+
-------------------------------------------------------------------------------
6.3.10. HP-UX 11
autoheader && autoconf && ./configure
Then do FIXME.
+
-------------------------------------------------------------------------------
6.3.11. Amiga OS
autoheader && autoconf && ./configure
Then do FIXME.
+
-------------------------------------------------------------------------------
6.3.12. AIX
the Sourceforge machine (no ncftpput). You now have to manually upload the
archive to Sourceforge's ftp server and release the file publicly. Use the
release notes and Change Log from the source tarball package.
+
-------------------------------------------------------------------------------
6.4. Uploading and Releasing Your Package
After the package is ready, it is time to upload it to SourceForge, and go
through the release steps. The upload is done via FTP:
- * Upload to: ftp://upload.sourceforge.net/incoming
+ * Upload to: ftp://upload.sourceforge.net/incoming
- * user: anonymous
+ * user: anonymous
- * password: ijbswa-developers@lists.sourceforge.net
+ * password: ijbswa-developers@lists.sourceforge.net
-
Or use the make targets as described above.
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.20 (beta).
+3.0.0 (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
-Release". Check the appropriate box(es). Remember at each step to hit the
+Release". Check the appropriate box(es). Remember at each step to hit the
"Refresh/Submit" buttons! You should now see your file(s) listed in Step 3.
Fill out the forms with the appropriate information for your platform, being
sure to hit "Update" for each file. If anyone is monitoring your platform,
If you have made errors, or need to make changes, you can go through
essentially the same steps, but select Edit Release, instead of Add Release.
+
-------------------------------------------------------------------------------
6.5. After the Release
When all (or: most of the) packages have been uploaded and made available, send
an email to the announce mailing list, Subject: "Version X.Y.Z available for
download". Be sure to include the download location, the release notes and the
-change log.
+Changelog. Also, post an updated News item on the project page Sourceforge, and
+update the Home page and docs linked from the Home page (see below).
+
-------------------------------------------------------------------------------
7. Update the Webserver
-When updating the webserver, please follow these steps to make sure that no
-broken links, inconsistent contents or permission problems will occur:
+The webserver should be updated at least with each stable release. When
+updating, please follow these steps to make sure that no broken links,
+inconsistent contents or permission problems will occur (as it has many times
+in the past!):
-If you have changed anything in the documentation source SGML files, do:
+If you have changed anything in the stable-branch documentation source SGML
+files, do:
- make dok # (or make redhat-dok if make dok doesn't work for you)
+ make dok dok-pdf # (or 'make redhat-dok dok-pdf' if 'make dok' doesn't work for you)
That will generate doc/webserver/user-manual, doc/webserver/developer-manual,
-doc/webserver/faq and doc/webserver/index.html automatically.
+doc/webserver/faq, doc/pdf/*.pdf and doc/webserver/index.html automatically.
-If you changed the manual page source, generate doc/webserver/man-page/
+If you changed the manual page sources, generate doc/webserver/man-page/
privoxy-man-page.html by running "make man". (This is a separate target due to
-dependencies on some obscure perl scripts. See comments in GNUmakefile.)
+dependencies on some obscure perl scripts [now in CVS, but not well tested].
+See comments in GNUmakefile.)
If you want to add new files to the webserver, create them locally in the doc/
webserver/* directory (or create new directories under doc/webserver).
-Next, commit any changes from the above steps to CVS. All set? Then do
+Next, commit any changes from the above steps to CVS. All set? If these are
+docs in the stable branch, then do:
make webserver
and directories there are group writable.
Please do NOT use any other means of transferring files to the webserver to
-avoid permission problems.
+avoid permission problems. Also, please do not upload docs from development
+branches or versions. The publicly posted docs should be in sync with the last
+official release.
+
-------------------------------------------------------------------------------
8. Contacting the developers, Bug Reporting and Feature Requests
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:
+
-------------------------------------------------------------------------------
8.1. Get Support
All users are of course welcome to discuss their issues on the users mailing
list, where the developers also hang around.
+
-------------------------------------------------------------------------------
8.2. Report Bugs
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 your
bug, but this is not required for reporting.
+
-------------------------------------------------------------------------------
8.3. 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/
tracker/?atid=361118&group_id=11118.
+
-------------------------------------------------------------------------------
8.4. Report Ads or Other Actions-Related Problems
New, improved default.action files will 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.
+
-------------------------------------------------------------------------------
8.5. Other
welcome on the developers list! You can find an overview of all Privoxy-related
mailing lists, including list archives, at: http://sourceforge.net/mail/?
group_id=11118.
+
-------------------------------------------------------------------------------
9. Privoxy Copyright, License and History
Some source code is based on code Copyright © 1997 by Anonymous Coders and
Junkbusters, Inc. and licensed under the GNU General Public License.
+
-------------------------------------------------------------------------------
9.1. License
You should have received a copy of the GNU General Public License along with
this program; if not, write to the
- Free Software
- Foundation, Inc. 59 Temple Place - Suite 330
- Boston, MA 02111-1307
- USA
+ Free Software
+ Foundation, Inc. 59 Temple Place - Suite 330
+ Boston, MA 02111-1307
+ USA
+
-------------------------------------------------------------------------------
9.2. History
inside out, upside down, and then reassembled it, adding many new features
along the way.
-The result of this is Privoxy, whose first stable release, 3.0, is due late
-summer or early fall 2002.
+The result of this is Privoxy, whose first stable release, 3.0, was released
+August, 2002.
+
-------------------------------------------------------------------------------
10. See also
http://www.privoxy.org/actions/, to submit "misses" to the developers.
+http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/contrib/, cool and fun
+ideas from Privoxy users.
+
http://www.junkbusters.com/ht/en/cookies.html, an explanation how cookies are
used to track web users.
Copyright © 2001, 2002 by Privoxy Developers
-$Id: faq.sgml,v 1.61.2.15 2002/08/10 11:34:22 oes Exp $
-
+$Id: faq.sgml,v 1.61.2.18 2002/08/14 16:39:37 hal9 Exp $
This FAQ gives quick answers to frequently asked questions about Privoxy. It
can't and doesn't replace the User Manual.
Privoxy is based on Internet Junkbuster (tm).
Please note that this document is constantly evolving. This copy represents the
-state at the release of version 2.9.20. You can find the latest version of the
+state at the release of version 3.0.0. You can find the latest version of the
document at http://www.privoxy.org/faq/. Please see the Contact section if you
want to contact the developers.
-------------------------------------------------------------------------------
+
Table of Contents
1. General Information
+
1.1. What is this new version of Privoxy?
1.2. Why "Privoxy"? Why a name change at all?
1.3. How does Privoxy differ from the old Junkbuster?
at all?
1.8. Is there is a license or fee? What about a warranty? Registration?
1.9. I would like to help you, what do I do?
+
1.9.1. Money Money Money
1.9.2. Software
1.9.3. You want to work with us?
-
-
-
2. Installation
+
2.1. Which browsers are supported by Privoxy?
2.2. Which operating systems are supported?
2.3. Can I install Privoxy over Junkbuster?
2.6. I just installed Privoxy, and nothing is happening. All the ads are
there. What's wrong?
-
3. Configuration
+
3.1. Where can I get updated Actions Files?
3.2. Can I use my old config files?
3.3. What is an "actions" file?
- 3.4. The "actions" concept confuses me. Please list some of these "actions"
- .
+ 3.4. The "actions" concept confuses me. Please list some of these
+ "actions".
3.5. How are actions files configured? What is the easiest way to do this?
3.6. There are several different "actions" files. What are the differences?
3.7. How can I make my Yahoo/Hotmail/GMX account work?
checkerboard image. Why and how do I get rid of this?
3.15. Can Privoxy run as a service on Win2K/NT?
3.16. How can I make Privoxy work with other proxies like Squid?
- 3.17. Can Privoxy run as a "transparent" proxy?
-
+ 3.17. Can I just set Privoxy to use port 80 and thus avoid individual
+ browser configuration?
+ 3.18. Can Privoxy run as a "transparent" proxy?
4. Miscellaneous
+
4.1. How much does Privoxy slow my browsing down? This has to add extra
time to browsing.
4.2. I noticed considerable delays in page requests compared to the old
special precautions?
4.14. How can I temporarily disable Privoxy?
4.15. When "disabled" is Privoxy totally out of the picture?
- 4.16. Where can I find more information about Privoxy and related issues?
-
+ 4.16. My logs show Privoxy "crunches" ads, but also its own CGI pages. What
+ is a "crunch"?
+ 4.17. Can Privoxy effect files that I download from a webserver? FTP
+ server?
+ 4.18. Where can I find more information about Privoxy and related issues?
5. Troubleshooting
+
5.1. I just upgraded and am getting "connection refused" with every web
page?
5.2. I just added a new rule, but the steenkin ad is still getting through.
5.4. After installing Privoxy, I have to log in every time I start IE. What
gives?
5.5. I cannot connect to any FTP sites. Privoxy seems to be blocking me.
- 5.6. In Mac OSX, I can't configure Microsoft Internet Explorer to use
+ 5.6. In Mac OSX, I can't configure Microsoft Internet Explorer to use
Privoxy as the HTTP proxy.
5.7. In Mac OSX, I dragged the Privoxy folder to the trash in order to
uninstall it. Now the finder tells me I don't have sufficient
privileges to empty the trash.
-
+ 5.8. I get a completely blank page at one site. "View Source" shows only:
+ <html><body></body></html>.
6. Contacting the developers, Bug Reporting and Feature Requests
+
6.1. Get Support
6.2. Report Bugs
6.3. Request New Features
6.4. Report Ads or Other Actions-Related Problems
6.5. Other
-
7. Privoxy Copyright, License and History
+
7.1. License
7.2. History
-
-
1. General Information
1.1. What is this new version of Privoxy?
inside out, upside down, and then reassembled it, adding many new features
along the way.
-The result of this is Privoxy, whose first stable release, 3.0, is due late
-summer or early fall 2002.
+The result of this is Privoxy, whose first stable release, 3.0, was released
+August, 2002.
+
-------------------------------------------------------------------------------
1.2. Why "Privoxy"? Why a name change at all?
Privoxy is the "Privacy Enhancing Proxy". Also, its content modification and
junk suppression allow you to browse your "private edition" of the web.
-Junkbusters Corporation continues to offer their original version of the
+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.
-There are also potential legal complications from the continued use of the
+There are also potential legal complications from the continued 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.
The developers also believed that there are so many changes from the original
code, that it was time to make a clean break from the past and make a name in
-their own right, especially now with the pending release of version 3.0.
+their own right.
+
-------------------------------------------------------------------------------
1.3. How does Privoxy differ from the old Junkbuster?
have been added, all in the same vein.
The configuration has changed significantly as well. This is something that
-users will notice right off the bat if upgrading from Junkbuster 2.0.x. The
-"blocklist" "cookielist", "imagelist" and much more has been combined into the
+users will notice right off the bat if upgrading from Junkbuster 2.0.x. The
+"blocklist" "cookielist", "imagelist" and much more has been combined into the
"actions" files, with a completely different syntax. See the note to upgraders
for details.
Privoxy's new features include:
- * Integrated browser based configuration and control utility at http://
+ * Integrated browser based configuration and control utility at http://
config.privoxy.org/ (shortcut: http://p.p/). Browser-based tracing of rule
and filter effects. Remote toggling.
- * Web page content filtering (removes banners based on size, invisible
+ * Web page content filtering (removes banners based on size, invisible
"web-bugs", JavaScript and HTML annoyances, pop-up windows, etc.)
- * Modularized configuration that allows for standard settings and user
+ * Modularized configuration that allows for standard settings and user
settings to reside in separate files, so that installing updated actions
files won't overwrite individual user settings.
- * HTTP/1.1 compliant (but not all optional 1.1 features are supported).
+ * HTTP/1.1 compliant (but not all optional 1.1 features are supported).
- * Support for Perl Compatible Regular Expressions in the configuration files,
+ * Support for Perl Compatible Regular Expressions in the configuration files,
and generally a more sophisticated and flexible configuration syntax over
previous versions.
- * Improved cookie management features (e.g. session based cookies).
+ * Improved cookie management features (e.g. session based cookies).
- * GIF de-animation.
+ * GIF de-animation.
- * Bypass many click-tracking scripts (avoids script redirection).
+ * Bypass many click-tracking scripts (avoids script redirection).
- * Multi-threaded (POSIX and native threads).
+ * Multi-threaded (POSIX and native threads).
- * User-customizable HTML templates for all proxy-generated pages (e.g.
+ * User-customizable HTML templates for all proxy-generated pages (e.g.
"blocked" page).
- * Auto-detection and re-reading of config file changes.
+ * Auto-detection and re-reading of config file changes.
- * Improved signal handling, and a true daemon mode (Unix).
+ * Improved signal handling, and a true daemon mode (Unix).
- * Every feature now controllable on a per-site or per-location basis,
+ * Every feature now controllable on a per-site or per-location basis,
configuration more powerful and versatile over-all.
- * Many smaller new features added, limitations and bugs removed, and security
+ * Many smaller new features added, limitations and bugs removed, and security
holes fixed.
-
-------------------------------------------------------------------------------
+
1.4. What is a "proxy"? How does Privoxy work?
A web proxy is a service, based on a software such as Privoxy, that clients
leaking, as well as inbound junk. It uses a variety of techniques to do this,
all of which are under your control via the various configuration files and
options.
+
-------------------------------------------------------------------------------
1.5. How does Privoxy know what is an ad, and what is not?
Both of this involves a certain amount of guesswork and is, of course, freely
configurable.
+
-------------------------------------------------------------------------------
1.6. Can Privoxy make mistakes? This does not sound very scientific.
flexible, and includes tools to help identify these types of situations so they
can be addressed as needed, allowing you to customize your installation. (See
the Troubleshooting section below.)
+
-------------------------------------------------------------------------------
1.7. My browser does the same things as Privoxy. Why should I use Privoxy at
In addition, a proxy is good choice if you use multiple browsers, or have a LAN
with multiple computers. This way all the configuration is in one place, and
you don't have to maintain a similar configuration for possibly many browsers.
+
-------------------------------------------------------------------------------
1.8. Is there is a license or fee? What about a warranty? Registration?
copyright. Or the LICENSE file that should be included.
There is no warranty of any kind, expressed, implied or otherwise. That is
-something that would cost real money ;-) There is no registration either.
+something that would cost real money ;-) There is no registration either.
Privoxy really is free in every respect!
+
-------------------------------------------------------------------------------
1.9. I would like to help you, what do I do?
buying software to test Privoxy with, and, of course, for regular world-wide
get-togethers (hahaha). If you enjoy the software and feel like helping us with
a donation, just drop us a note.
+
-------------------------------------------------------------------------------
1.9.2. Software
product, you might consider supplying us with a copy or license. We can't,
however, guarantee that we will fix all potential compatibility issues as a
result.
+
-------------------------------------------------------------------------------
1.9.3. You want to work with us?
Once we have added you to the team, you'll have write access to the CVS
repository, and together we'll find a suitable task for you.
+
-------------------------------------------------------------------------------
2. Installation
all browsers. Direct browser support is not necessary since Privoxy runs as a
separate application and talks to the browser in the standardized HTTP
protocol, just like a web server does.
+
-------------------------------------------------------------------------------
2.2. Which operating systems are supported?
(RedHat, SuSE, Debian, Conectiva, Gentoo), Mac OSX, OS/2, AmigaOS, BeOS,
FreeBSD, NetBSD, Solaris, and many more flavors of Unix.
-But any operating system that runs TCP/IP, can conceivably take advantage of
+But any operating system that runs TCP/IP, can conceivably take advantage of
Privoxy in a networked situation where Privoxy would run as a server on a LAN
gateway. Then only the "gateway" needs to be running one of the above operating
systems.
Source code is freely available, so porting to other operating systems is
always a possibility.
+
-------------------------------------------------------------------------------
2.3. Can I install Privoxy over Junkbuster?
installation chapter in the user manual for details.
Note: Some installers may automatically un-install Junkbuster, if present!
+
-------------------------------------------------------------------------------
2.4. I just installed Privoxy. Is there anything special I have to do now?
proxy address and port number in the appropriate configuration area for the
browser. See below. You should also flush your browser's memory and disk cache
to get rid of any cached junk items.
+
-------------------------------------------------------------------------------
2.5. What is the proxy address of Privoxy?
(unless you have Privoxy to run on a different port with the listen-address
config option).
-When configuring your browser's proxy settings you typically enter the word
-"localhost" or the IP address "127.0.0.1" in the boxes next to "HTTP" and
+When configuring your browser's proxy settings you typically enter the word
+"localhost" or the IP address "127.0.0.1" in the boxes next to "HTTP" and
"Secure" (HTTPS) and then the number "8118" for "port". This tells your browser
to send all web requests to Privoxy instead of directly to the Internet.
Privoxy can also be used to proxy for a Local Area Network. In this case, your
would enter either the IP address of the LAN host where Privoxy is running, or
-the equivalent hostname. Port assignment would be same as above. Note that
+the equivalent hostname. Port assignment would be same as above. Note that
Privoxy doesn't listen on any LAN interfaces by default.
Privoxy does not currently handle protocols such as FTP, SMTP, IM, IRC, ICQ, or
other Internet protocols.
+
-------------------------------------------------------------------------------
2.6. I just installed Privoxy, and nothing is happening. All the ads are there.
browser is not set up to use your Privoxy installation. If you receive anything
else (probably nothing at all), it could either be that the browser is not set
up correctly, or that Privoxy is not running at all. Check the log file.
+
-------------------------------------------------------------------------------
3. Configuration
Based on your feedback and the continuing development, updated actions files
will be made available on the files section of our project page.
-If you wish to receive an email notification whenever we release updates of
+If you wish to receive an email notification whenever we release updates of
Privoxy or the actions file, subscribe to our announce mailing list,
ijbswa-announce@lists.sourceforge.net.
+
-------------------------------------------------------------------------------
3.2. Can I use my old config files?
pattern syntax has changed! Even configuration files from the 2.9.x versions
will need to be adapted, as configuration syntax has been very much in flow in
the 2.9.x series.
+
-------------------------------------------------------------------------------
3.3. What is an "actions" file?
cookies as one of your default actions, but need to accept cookies from a given
site, you would need to define an exception for this site in one of your
actions files, preferably in user.action
+
-------------------------------------------------------------------------------
3.4. The "actions" concept confuses me. Please list some of these "actions".
For a comprehensive discussion of the actions concept, please refer to the
actions file chapter in the user manual. It includes a list of all actions and
an actions file tutorial to get you started.
+
-------------------------------------------------------------------------------
3.5. 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 edited with a
-text editor. The probably easiest way is to access Privoxy's user interface
+text editor. But probably the easiest way is to access Privoxy's user interface
with your web browser at http://config.privoxy.org/ (Shortcut: http://p.p/) and
then select "View & change the current configuration" from the menu.
+
-------------------------------------------------------------------------------
3.6. There are several different "actions" files. What are the differences?
Earlier versions included three different versions of the default.action file.
The new scheme allows for greater flexibility of local configuration, and for
browser based selection of pre-defined "aggressiveness" levels.
+
-------------------------------------------------------------------------------
3.7. How can I make my Yahoo/Hotmail/GMX account work?
#
{ -crunch-incoming-cookies -crunch-outgoing-cookies -session-cookies-only }
.login.yahoo.com
+
-------------------------------------------------------------------------------
3.8. What's the difference between the "Cautious", "Medium" and "Advanced"
configuration:
Table 1. Default Configurations
-+-------------------+------------------+-------------------+------------------+
+
++-----------------------------------------------------------------------------+
|Feature |Cautious |Intermadiate |Advanced |
-+-------------------+------------------+-------------------+------------------+
+|-------------------+------------------+-------------------+------------------|
|Ad-blocking by URL |yes |yes |yes |
-+-------------------+------------------+-------------------+------------------+
+|-------------------+------------------+-------------------+------------------|
|Ad-filtering by |yes |yes |yes |
|size | | | |
-+-------------------+------------------+-------------------+------------------+
+|-------------------+------------------+-------------------+------------------|
|GIF de-animation |no |yes |yes |
-+-------------------+------------------+-------------------+------------------+
+|-------------------+------------------+-------------------+------------------|
|Referer forging |no |yes |yes |
-+-------------------+------------------+-------------------+------------------+
+|-------------------+------------------+-------------------+------------------|
|Cookie handling |none |session-only |kill |
-+-------------------+------------------+-------------------+------------------+
+|-------------------+------------------+-------------------+------------------|
|Pop-up killing |no |yes |yes |
-+-------------------+------------------+-------------------+------------------+
+|-------------------+------------------+-------------------+------------------|
|Fast redirects |no |no |yes |
-+-------------------+------------------+-------------------+------------------+
+|-------------------+------------------+-------------------+------------------|
|HTML taming |yes |yes |yes |
-+-------------------+------------------+-------------------+------------------+
+|-------------------+------------------+-------------------+------------------|
|JavaScript taming |yes |yes |yes |
-+-------------------+------------------+-------------------+------------------+
+|-------------------+------------------+-------------------+------------------|
|Web-bug killing |yes |yes |yes |
-+-------------------+------------------+-------------------+------------------+
+|-------------------+------------------+-------------------+------------------|
|Fun text |no |no |yes |
|replacements | | | |
-+-------------------+------------------+-------------------+------------------+
+|-------------------+------------------+-------------------+------------------|
|Image tag |no |no |yes |
|reordering | | | |
-+-------------------+------------------+-------------------+------------------+
+|-------------------+------------------+-------------------+------------------|
|Ad-filtering by |no |no |yes |
|link | | | |
-+-------------------+------------------+-------------------+------------------+
++-----------------------------------------------------------------------------+
Where the defaults are likely to break some sites, exceptions for known popular
"problem" sites are included, but in general, the more aggressive your default
settings are, the more exceptions you will have to make later. See the user
manual for a more deatiled discussion.
+
-------------------------------------------------------------------------------
3.9. Why can I change the configuration with a browser? Does that not raise
security issues?
It may seem strange that regular users can edit the config files with their
-browsers, although the whole /etc/privoxy hierarchy belongs to the user
+browsers, although the whole /etc/privoxy hierarchy belongs to the user
"privoxy", with only 644 permissions.
When you use the browser-based editor, Privoxy itself is writing to the config
setting "enable-edit-actions 0" and "enable-remote-toggle 0" in the main
configuration file.
-Note that in the default configuration, only local users (i.e. those on
+Note that in the default configuration, only local users (i.e. those on
"localhost") can connect to Privoxy, so this is not (normally) a security
problem.
+
-------------------------------------------------------------------------------
3.10. What is the default.filter file? What is a "filter"?
Presently, there is no GUI editor option for this part of the configuration,
but you can disable/enable the various pre-defined filters of the included
default.filter file with the web-based actions file editor.
+
-------------------------------------------------------------------------------
3.11. How can I set up Privoxy to act as a proxy for my LAN?
If you run Privoxy on a LAN with untrusted users, we recommend that you
double-check the access control and security options!
+
-------------------------------------------------------------------------------
3.12. Instead of ads, now I get a checkerboard pattern. I don't want to see
this choice only has effect for images which are blocked as images, i.e. whose
URLs match both a handle-as-image and block action.
-If you want to see nothing, then change the set-image-blocker action to "blank"
-. This can be done by editing the default.action file, or trough the web-based
-actions file editor.
+If you want to see nothing, then change the set-image-blocker action to
+"blank". This can be done by editing the default.action file, or trough the
+web-based actions file editor.
+
-------------------------------------------------------------------------------
3.13. Why would anybody want to see a checkerboard pattern?
shows you that and where images were blocked, which can be very helpful in case
some navigation aid or otherwise innocent image was erraneously blocked. Some
people might also enjoy seeing how many banners they don't have to see..
+
-------------------------------------------------------------------------------
3.14. I see some images being replaced by a text instead of the checkerboard
page. After changing the rule and un-blocking the HTML documents, the browser
will try to load the actual banner images and the usual image blocking will
(hopefully!) kick in.
+
-------------------------------------------------------------------------------
3.15. Can Privoxy run as a service on Win2K/NT?
There is a pending feature request for this functionality. See the discussion
at http://sourceforge.net/tracker/?func=detail&atid=361118&aid=485617&group_id=
11118, for details, and a sample configuration.
+
-------------------------------------------------------------------------------
3.16. How can I make Privoxy work with other proxies like Squid?
This can be done and is often useful to combine the benefits of Privoxy with
those of a caching proxy. See the forwarding chapter in the user manual which
describes how to do this.
+
-------------------------------------------------------------------------------
-3.17. Can Privoxy run as a "transparent" proxy?
+3.17. Can I just set Privoxy to use port 80 and thus avoid individual browser
+configuration?
+
+No, its more complicated than that. This only works with special kinds of
+proxies known as "transparent" proxies (see below).
+
+-------------------------------------------------------------------------------
+
+3.18. 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
Chaining Privoxy behind another proxy that has this ability should work though.
See the forwarding chapter in the user manual. As a transparent proxy to be
used for chaining we recommend Transproxy (http://www.transproxy.nlc.net.au/).
+
-------------------------------------------------------------------------------
4. Miscellaneous
"Filtering" content via the filter or deanimate-gifs actions may cause a
perceived slowdown, since the entire document needs to be buffered before
displaying. See below.
+
-------------------------------------------------------------------------------
4.2. I noticed considerable delays in page requests compared to the old
noticeable on slow dialup connections.
Filtering is automatically disabled for inappropriate MIME types.
+
-------------------------------------------------------------------------------
4.3. What are "http://config.privoxy.org/" and "http://p.p/"?
Note that the built-in URLs from earlier versions of Junkbuster / Privoxy,
http://example.com/show-proxy-args and http://i.j.b/, are no longer supported.
If you still use such an old version, you should really consider upgrading to
-2.9.20.
+3.0.0.
+
-------------------------------------------------------------------------------
4.4. Do you still maintain the blocklists?
No. The patterns for blocking now reside (among other things) in the actions
files, which are actively maintained instead. See next question ...
+
-------------------------------------------------------------------------------
4.5. How can I submit new ads?
Yes, absolutely! Please see the Contact section for how to do that. Please note
that you (technically) need the latest Privoxy version for this to work.
+
-------------------------------------------------------------------------------
4.6. How can I hide my IP address?
There is, however, even in the single-machine case the possibility to make the
server believe that your machine is in fact a shared proxy serving a whole big
LAN, and we are looking into that.
+
-------------------------------------------------------------------------------
4.7. Can Privoxy guarantee I am anonymous?
that might occur. The professionally paranoid prefer browsers available as
source code, because anticipating their behavior is easier. Trust the source,
Luke!
+
-------------------------------------------------------------------------------
4.8. Might some things break because header information or content is being
If you have problems with a site, you will have to adjust your configuration
accordingly. Cookies are probably the most likely adjustment that may be
required, but by no means the only one.
+
-------------------------------------------------------------------------------
4.9. Can Privoxy act as a "caching" proxy to speed up web browsing?
No, it does not have this ability at all. You want something like Squid for
this. And, yes, before you ask, Privoxy can co-exist with other kinds of
proxies like Squid. See the forwarding chapter in the user manual for details.
+
-------------------------------------------------------------------------------
4.10. What about as a firewall? Can Privoxy protect me?
Not in the way you mean, or in the way a true firewall can. Privoxy can help
protect your privacy, but not protect you from intrusion attempts. It is, of
course, perfectly possible and recommended to use both.
+
-------------------------------------------------------------------------------
4.11. I have large empty spaces / a checkerboard pattern now where ads used to
So we won't support this in the default configuration, but you can of course
define appropriate filters yourself.
+
-------------------------------------------------------------------------------
4.12. How can Privoxy filter Secure (HTTPS) URLs?
Since secure HTTP connections are encrypted SSL sessions between your browser
-and the secure site, and are meant to be reliably secure, there is little that
+and the secure site, and are meant to be reliably secure, there is little that
Privoxy can do but hand the raw gibberish data though from one end to the other
unprocessed.
banners to be placed in an encrypted page come unencrypted nonetheless for
efficiency reasons, which exposes them to the full power of Privoxy's ad
blocking.
+
-------------------------------------------------------------------------------
4.13. Privoxy runs as a "server". How secure is it? Do I need to take any
special precautions?
-There are no known exploits that might affect Privoxy. On Unix-like systems,
+There are no known exploits that might affect Privoxy. On Unix-like systems,
Privoxy can run as a non-privileged user, which is how we recommend it be run.
Also, by default Privoxy only listens to requests from "localhost" only. The
server aspect of Privoxy is not itself directly exposed to the Internet in this
configuration, but Privoxy will not listen on any external interfaces. ACLs can
be defined in addition, and using a firewall is always good too. Better safe
than sorry.
+
-------------------------------------------------------------------------------
4.14. How can I temporarily disable Privoxy?
The easiest way is to access Privoxy with your browser by using the remote
toggle URL: http://config.privoxy.org/toggle. See the Bookmarklets section of
the User Manual for an easy way to access this feature.
+
-------------------------------------------------------------------------------
4.15. When "disabled" is Privoxy totally out of the picture?
acting as a proxy, but just not doing any of the things that Privoxy would
normally be expected to do. It is still a "middle-man" in the interaction
between your browser and web sites.
+
+-------------------------------------------------------------------------------
+
+4.16. My logs show Privoxy "crunches" ads, but also its own CGI pages. What is
+a "crunch"?
+
+A "crunch" simply means Privoxy intercepted something, nothing more. Often this
+is indeed ads or banners, but Privoxy uses the same mechanism for trapping
+requests for its own internal pages. For instance, a request for Privoxy's
+configuration page at: http://config.privoxy.org, is intercepted (i.e. it does
+not go out to the 'net), and the familiar CGI configuration is returned to the
+browser, and the log consequently will show a "crunch".
+
+-------------------------------------------------------------------------------
+
+4.17. Can Privoxy effect files that I download from a webserver? FTP server?
+
+From the webserver's perspective, there is no difference between viewing a
+document (i.e. a page), and downloading a file. The same is true of Privoxy. If
+there is a match for a block pattern, it will still be blocked, and of course
+this is obvious. Filtering is potentially more of a concern since the results
+are not always so obvious.
+
+Privoxy knows the differences in files according to the "Document Type" as
+reported by the webserver. If this is reported accurately (e.g. "application/
+zip" for a zip archive), then Privoxy knows to ignore these where appropriate.
+It is possible, however, that documents that are of an unknown type (generally
+assumed to be "text/plain") will be filtered, as will those that might be
+incorrectly reported by the webserver. If such a file is a downloaded file that
+is intended to be saved to disk, then any content that might have been altered
+by filtering, will be saved too, for these (probably very rare) cases.
+
+Privoxy does not do FTP at all, only HTTP protocols.
+
-------------------------------------------------------------------------------
-4.16. Where can I find more information about Privoxy and related issues?
+4.18. Where can I find more information about Privoxy and related issues?
Other references and sites of interest to Privoxy users:
http://www.privoxy.org/actions/, to submit "misses" to the developers.
+http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/contrib/, cool and fun
+ideas from Privoxy users.
+
http://www.junkbusters.com/ht/en/cookies.html, an explanation how cookies are
used to track web users.
http://www.privoxy.org/developer-manual/, the Privoxy developer manual.
-------------------------------------------------------------------------------
+
5. Troubleshooting
5.1. I just upgraded and am getting "connection refused" with every web page?
which uses port 8000. If you haven't, you need to change your browser to the
new port number, or alternately change the listen-address option in Privoxy's
main configuration file.
+
-------------------------------------------------------------------------------
5.2. I just added a new rule, but the steenkin ad is still getting through.
If this doesn't help, you probably have an error in the rule you applied. Try
pasting the full URL of the offending ad into http://config.privoxy.org/
show-url-info and see if it really matches your new rule.
+
-------------------------------------------------------------------------------
5.3. One of my favorite sites does not work with Privoxy. What can I do?
Troubleshooting actions is discussed in more detail in the user-manual appendix
. There is also an actions tutorial.
+
-------------------------------------------------------------------------------
5.4. After installing Privoxy, I have to log in every time I start IE. What
Just set and save the password again and all should be OK.
[Thanks to Ray Griffith for this submission.]
+
-------------------------------------------------------------------------------
5.5. I cannot connect to any FTP sites. Privoxy seems to be blocking me.
Privoxy cannot act as a proxy for FTP traffic, so do not configure your browser
to use Privoxy as an FTP proxy. The same is true for any protocol other than
HTTP or HTTPS.
+
-------------------------------------------------------------------------------
5.6. In Mac OSX, I can't configure Microsoft Internet Explorer to use Privoxy
tab. Ensure the "Web Proxy (HTTP)" checkbox is checked and enter 127.0.0.1 in
the entry field. Enter 8118 in the Port field. The next time you start IE, it
should reflect these values.
+
-------------------------------------------------------------------------------
5.7. In Mac OSX, I dragged the Privoxy folder to the trash in order to
uninstall it. Now the finder tells me I don't have sufficient privileges to
empty the trash.
-Just dragging the Privoxy folder to the trash is not enough to delete it.
+Just dragging the Privoxy folder to the trash is not enough to delete it.
Privoxy supplies an uninstall.command file that takes care of these details.
Open the trash, drag the uninstall.command file out of the trash and
double-click on it. You will be prompted for confirmation and the
The trash may still appear full after this command; emptying the trash from the
desktop should make it appear empty again.
+
+-------------------------------------------------------------------------------
+
+5.8. I get a completely blank page at one site. "View Source" shows only:
+<html><body></body></html>.
+
+This is often the result of a webserver using PHP that mishandles the request
+Privoxy sends to not compress the content (a PHP bug).
+
+In a default configuration, Privoxy requests all data be sent "uncompressed".
+This is required for the page filtering and other magic to work. In some rare
+cases, the browser and webserver miscommunicate and the result is a totally
+blank page. The suggested work around is to selectively turn off this feature
+for sites that exhibit such behavior. Example section for user.action:
+
+ # Make exceptions for ill-behaved sites:
+ #
+ {-prevent-compression}
+ .example.com
+
-------------------------------------------------------------------------------
6. Contacting the developers, Bug Reporting and Feature Requests
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:
+
-------------------------------------------------------------------------------
6.1. Get Support
All users are of course welcome to discuss their issues on the users mailing
list, where the developers also hang around.
+
-------------------------------------------------------------------------------
6.2. Report Bugs
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 your
bug, but this is not required for reporting.
+
-------------------------------------------------------------------------------
6.3. 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/
tracker/?atid=361118&group_id=11118.
+
-------------------------------------------------------------------------------
6.4. Report Ads or Other Actions-Related Problems
New, improved default.action files will 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.5. Other
welcome on the developers list! You can find an overview of all Privoxy-related
mailing lists, including list archives, at: http://sourceforge.net/mail/?
group_id=11118.
+
-------------------------------------------------------------------------------
7. Privoxy Copyright, License and History
Portions of this document are "borrowed" from the original Junkbuster (tm) FAQ,
and modified as appropriate for Privoxy.
+
-------------------------------------------------------------------------------
7.1. License
You should have received a copy of the GNU General Public License along with
this program; if not, write to the
- Free Software
- Foundation, Inc. 59 Temple Place - Suite 330
- Boston, MA 02111-1307
- USA
+ Free Software
+ Foundation, Inc. 59 Temple Place - Suite 330
+ Boston, MA 02111-1307
+ USA
+
-------------------------------------------------------------------------------
7.2. History
inside out, upside down, and then reassembled it, adding many new features
along the way.
-The result of this is Privoxy, whose first stable release, 3.0, is due late
-summer or early fall 2002.
+The result of this is Privoxy, whose first stable release, 3.0, was released
+August, 2002.
+
-Privoxy 2.9.20 User Manual
+Privoxy 3.0.0 User Manual
Copyright © 2001, 2002 by Privoxy Developers
-$Id: user-manual.sgml,v 1.123.2.16 2002/08/09 19:20:54 david__schmidt Exp $
-
+$Id: user-manual.sgml,v 1.123.2.18 2002/08/22 23:47:58 hal9 Exp $
The User Manual gives users information on how to install, configure and use
Privoxy.
user-manual/. Please see the Contact section on how to contact the developers.
-------------------------------------------------------------------------------
+
Table of Contents
1. Introduction
- 1.1. Features
+ 1.1. Features
2. Installation
+
2.1. Binary Packages
+
2.1.1. Red Hat, SuSE and Conectiva RPMs
2.1.2. Debian
2.1.3. Windows
2.1.7. AmigaOS
2.1.8. Gentoo
-
2.2. Building from Source
2.3. Keeping your Installation Up-to-Date
-
3. Note to Upgraders
4. Quickstart to Using Privoxy
- 4.1. Quickstart to Ad Blocking
+ 4.1. Quickstart to Ad Blocking
5. Starting Privoxy
+
5.1. Red Hat and Conectiva
5.2. Debian
5.3. SuSE
5.9. Gentoo
5.10. Command Line Options
-
6. Privoxy Configuration
+
6.1. Controlling Privoxy with Your Web Browser
6.2. Configuration Files Overview
-
7. The Main Configuration File
+
7.1. Configuration and Log File Locations
+
7.1.1. confdir
7.1.2. logdir
7.1.3. actionsfile
7.1.6. jarfile
7.1.7. trustfile
-
7.2. Local Set-up Documentation
+
7.2.1. user-manual
7.2.2. trust-info-url
7.2.3. admin-address
7.2.4. proxy-info-url
-
7.3. Debugging
+
7.3.1. debug
7.3.2. single-threaded
-
7.4. Access Control and Security
+
7.4.1. listen-address
7.4.2. toggle
7.4.3. enable-remote-toggle
7.4.5. ACLs: permit-access and deny-access
7.4.6. buffer-limit
-
7.5. Forwarding
+
7.5.1. forward
7.5.2. forward-socks4 and forward-socks4a
7.5.3. Advanced Forwarding Examples
-
7.6. Windows GUI Options
-
8. Actions Files
+
8.1. Finding the Right Mix
8.2. How to Edit
8.3. How Actions are Applied to URLs
8.4. Patterns
- 22
+
8.4.1. The Domain Pattern
8.4.2. The Path Pattern
-
8.5. Actions
+
8.5.1. add-header
8.5.2. block
8.5.3. crunch-incoming-cookies
8.5.20. set-image-blocker
8.5.21. Summary
-
8.6. Aliases
8.7. Actions Files Tutorial
+
8.7.1. default.action
8.7.2. user.action
-
-
-
9. The Filter File
- 9.1. Filter File Tutorial
+ 9.1. Filter File Tutorial
10. Templates
11. Contacting the Developers, Bug Reporting and Feature Requests
+
11.1. Get Support
11.2. Report Bugs
11.3. Request New Features
11.4. Report Ads or Other Actions-Related Problems
11.5. Other
-
12. Privoxy Copyright, License and History
+
12.1. License
12.2. History
12.3. Authors
-
13. See Also
14. Appendix
+
14.1. Regular Expressions
14.2. Privoxy's Internal Pages
- 14.2.1. Bookmarklets
+ 14.2.1. Bookmarklets
14.3. Chain of Events
14.4. Anatomy of an Action
-
-
1. Introduction
-This documentation is included with the current beta version of Privoxy,
-v.2.9.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 version 3.0 is currently nearing
-completion, and includes many significant changes and enhancements over earlier
-versions. The target release date for stable v3.0 is "soon" ;-).
+This documentation is included with the current stable version of Privoxy,
+v.3.0.0.
-Since this is a beta 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. Features
In addition to Internet Junkbuster's traditional features of ad and banner
-blocking and cookie management, Privoxy provides new features, some of them
-currently under development:
+blocking and cookie management, Privoxy provides new features:
- * Integrated browser based configuration and control utility at http://
+ * Integrated browser based configuration and control utility at http://
config.privoxy.org/ (shortcut: http://p.p/). Browser-based tracing of rule
and filter effects. Remote toggling.
- * Web page content filtering (removes banners based on size, invisible
+ * Web page content filtering (removes banners based on size, invisible
"web-bugs", JavaScript and HTML annoyances, pop-up windows, etc.)
- * Modularized configuration that allows for standard settings and user
+ * Modularized configuration that allows for standard settings and user
settings to reside in separate files, so that installing updated actions
files won't overwrite individual user settings.
- * HTTP/1.1 compliant (but not all optional 1.1 features are supported).
+ * HTTP/1.1 compliant (but not all optional 1.1 features are supported).
- * Support for Perl Compatible Regular Expressions in the configuration files,
+ * Support for Perl Compatible Regular Expressions in the configuration files,
and generally a more sophisticated and flexible configuration syntax over
previous versions.
- * Improved cookie management features (e.g. session based cookies).
+ * Improved cookie management features (e.g. session based cookies).
- * GIF de-animation.
+ * GIF de-animation.
- * Bypass many click-tracking scripts (avoids script redirection).
+ * Bypass many click-tracking scripts (avoids script redirection).
- * Multi-threaded (POSIX and native threads).
+ * Multi-threaded (POSIX and native threads).
- * User-customizable HTML templates for all proxy-generated pages (e.g.
+ * User-customizable HTML templates for all proxy-generated pages (e.g.
"blocked" page).
- * Auto-detection and re-reading of config file changes.
+ * Auto-detection and re-reading of config file changes.
- * Improved signal handling, and a true daemon mode (Unix).
+ * Improved signal handling, and a true daemon mode (Unix).
- * Every feature now controllable on a per-site or per-location basis,
+ * Every feature now controllable on a per-site or per-location basis,
configuration more powerful and versatile over-all.
- * Many smaller new features added, limitations and bugs removed, and security
+ * Many smaller new features added, limitations and bugs removed, and security
holes fixed.
-
-------------------------------------------------------------------------------
+
2. Installation
Privoxy is available both in convenient pre-compiled packages for a wide range
of their installation procedure. (See below for your platform). In any case be
sure to backup your old configuration if it is valuable to you. See the note to
upgraders section below.
+
-------------------------------------------------------------------------------
2.1. Binary Packages
How to install the binary packages depends on your operating system:
+
-------------------------------------------------------------------------------
2.1.1. Red Hat, SuSE and Conectiva RPMs
-RPMs can be installed with rpm -Uvh privoxy-2.9.20-1.rpm, and will use /etc/
+RPMs can be installed with rpm -Uvh privoxy-3.0.0-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.
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.20-1.src.rpm. This will use your locally installed
+--rebuild privoxy-3.0.0-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
to remove it first, because the packages conflict. Otherwise, RPM will try to
remove Junkbuster automatically, before installing Privoxy.
+
-------------------------------------------------------------------------------
2.1.2. Debian
-DEBs can be installed with dpkg -i privoxy_2.9.20-1.deb, and will use /etc/
+DEBs can be installed with dpkg -i privoxy_3.0.0-1.deb, and will use /etc/
privoxy for the location of configuration files.
+
-------------------------------------------------------------------------------
2.1.3. Windows
Just double-click the installer, which will guide you through the installation
process. You will find the configuration files in the same directory as you
installed Privoxy in. We do not use the registry of Windows.
+
-------------------------------------------------------------------------------
2.1.4. Solaris, NetBSD, FreeBSD, HP-UX
Create a new directory, cd to it, then unzip and untar the archive. For the
most part, you'll have to figure out where things go.
+
-------------------------------------------------------------------------------
2.1.5. OS/2
The directory you choose to install Privoxy into will contain all of the
configuration files.
+
-------------------------------------------------------------------------------
2.1.6. Mac OSX
You will be prompted for the administrator password.
+
-------------------------------------------------------------------------------
2.1.7. AmigaOS
Copy and then unpack the lha archive to a suitable location. All necessary
files will be installed into Privoxy directory, including all configuration and
log files. To uninstall, just remove this directory.
+
-------------------------------------------------------------------------------
2.1.8. Gentoo
latest version.
Configuration files are in /etc/privoxy, the documentation is in /usr/share/doc
-/privoxy-2.9.20 and the Log directory is in /var/log/privoxy.
+/privoxy-3.0.0 and the Log directory is in /var/log/privoxy.
+
-------------------------------------------------------------------------------
2.2. Building from Source
When building from a source tarball (either release version or nightly CVS
tarball), first unpack the source:
- tar xzvf privoxy-2.9.20-beta-src* [.tgz or .tar.gz]
- cd privoxy-2.9.20-beta
+ tar xzvf privoxy-3.0.0-src* [.tgz or .tar.gz]
+ cd privoxy-3.0.0
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
make -n install # (to see where all the files will go)
make install # (to really install)
++-----------------------------------------------------------------------------+
+| Warning |
+|-----------------------------------------------------------------------------|
+|The "make install" target is temporary quite broken! It is recommended to use|
+|a binary package, or do a source build, and manually install the components. |
+|Sorry. |
++-----------------------------------------------------------------------------+
+
If you have gnu make, you can have the first four steps automatically done for
you by just typing:
For more detailed instructions on how to build Redhat and SuSE RPMs, Windows
self-extracting installers, building on platforms with special requirements
etc, please consult the developer manual.
+
-------------------------------------------------------------------------------
2.3. Keeping your Installation Up-to-Date
versions of both the main actions file (as a separate package) and the software
itself (including the actions file) available for download.
-If you wish to receive an email notification whenever we release updates of
+If you wish to receive an email notification whenever we release updates of
Privoxy or the actions file, subscribe to our announce mailing list,
ijbswa-announce@lists.sourceforge.net.
the latest default.action file we strongly recommend that you use user.action
for your customization of Privoxy. See the Chapter on actions files for
details.
+
-------------------------------------------------------------------------------
3. Note to Upgraders
A quick list of things to be aware of before upgrading:
- * The default listening port is now 8118 due to a conflict with another
+ * The default listening port is now 8118 due to a conflict with another
service (NAS).
- * Some installers may remove earlier versions completely. Save any important
+ * Some installers may remove earlier versions completely. Save any important
configuration files!
- * Privoxy is controllable with a web browser at the special URL: http://
+ * Privoxy is controllable with a web browser at the special URL: http://
config.privoxy.org/ (Shortcut: http://p.p/). Many aspects of configuration
can be done here, including temporarily disabling Privoxy.
- * The primary configuration files for cookie management, ad and banner
+ * The primary configuration files for cookie management, ad and banner
blocking, and many other aspects of Privoxy configuration are the actions
files. It is strongly recommended to become familiar with the new actions
concept below, before modifying these files. Locally defined rules should
go into user.action.
- * Some installers may not automatically start Privoxy after installation.
+ * Some installers may not automatically start Privoxy after installation.
-
-------------------------------------------------------------------------------
+
4. Quickstart to Using Privoxy
- * If upgrading, from versions before 2.9.16, please back up any configuration
+ * If upgrading, from versions before 2.9.16, please back up any configuration
files. See the Note to Upgraders Section.
- * Install Privoxy. See the Installation Section below for platform specific
+ * Install Privoxy. See the Installation Section below for platform specific
information.
- * Advanced users and those who want to offer Privoxy service to more than
+ * Advanced users and those who want to offer Privoxy service to more than
just their local machine should check the main config file, especially the
security-relevant options. These are off by default.
- * Start Privoxy, if the installation program has not done this already (may
+ * Start Privoxy, if the installation program has not done this already (may
vary according to platform). See the section Starting Privoxy.
- * Set your browser to use Privoxy as HTTP and HTTPS proxy by setting the
+ * Set your browser to use Privoxy as HTTP and HTTPS proxy by setting the
proxy configuration for address of 127.0.0.1 and port 8118. (Junkbuster and
- earlier versions of Privoxy used port 8000.) See the section Starting
+ earlier versions of Privoxy used port 8000.) See the section Starting
Privoxy below for more details on this.
- * Flush your browser's disk and memory caches, to remove any cached ad
+ * Flush your browser's disk and memory caches, to remove any cached ad
images.
- * A default installation should provide a reasonable starting point for most.
+ * A default installation should provide a reasonable starting point for most.
There will undoubtedly be occasions where you will want to adjust the
configuration, but that can be dealt with as the need arises. Little to no
initial configuration is required in most cases.
See the Configuration section for more configuration options, and how to
customize your installation.
- * If you experience ads that slipped through, innocent images that are
+ * If you experience ads that slipped through, innocent images that are
blocked, or otherwise feel the need to fine-tune Privoxy's behaviour, take
a look at the actions files. As a quick start, you might find the richly
commented examples helpful. You can also view and edit the actions files
through the web-based user interface. The Appendix "Anatomy of an Action"
has hints how to debug actions that "misbehave".
- * Please see the section Contacting the Developers on how to report bugs or
+ * Please see the section Contacting the Developers on how to report bugs or
problems with websites or to get help.
- * Now enjoy surfing with enhanced comfort and privacy!
+ * Now enjoy surfing with enhanced comfort and privacy!
-
-------------------------------------------------------------------------------
+
4.1. Quickstart to Ad Blocking
Ad blocking is but one of Privoxy's array of features. Many of these features
The actions we need to know about for ad blocking are: block, handle-as-image,
and set-image-blocker:
- * block - this action stops any contact between your browser and any URL
+ * block - this action stops any contact between your browser and any URL
patterns that match this action's configuration. It can be used for
blocking ads, but also anything that is determined to be unwanted. By
- itself, it simply stops any communication with the remote server and sends
+ itself, it simply stops any communication with the remote server and sends
Privoxy's own built-in BLOCKED page instead to let you now what has
happened.
- * handle-as-image - tells Privoxy to treat this URL as an image. Privoxy's
+ * handle-as-image - tells Privoxy to treat this URL as an image. Privoxy's
default configuration already does this for all common image types (e.g.
GIF), but there are many situations where this is not so easy to determine.
So we'll force it in these cases. This is particularly important for ad
limitations to this though. For instance, you can't just brute-force an
image substitution for an entire HTML page in most situations.
- * set-image-blocker - tells Privoxy what to display in place of an ad image
+ * set-image-blocker - tells Privoxy what to display in place of an ad image
that has hit a block rule. For this to come into play, the URL must match a
block action somewhere in the configuration, and, it must also match an
handle-as-image action.
The configuration options on what to display instead of the ad are:
- pattern - a checkerboard pattern, so that an ad replacement is obvious.
+ pattern - a checkerboard pattern, so that an ad replacement is obvious.
This is the default.
- blank - A very small empty GIF image is displayed. This is the so-called
+ blank - A very small empty GIF image is displayed. This is the so-called
"invisible" configuration option.
- http://<URL> - A redirect to any image anywhere of the user's choosing
+ http://<URL> - A redirect to any image anywhere of the user's choosing
(advanced usage).
-
-
The quickest way to adjust any of these settings is with your browser through
the special Privoxy editor at http://config.privoxy.org/show-status (shortcut:
http://p.p/show-status). This is an internal page, and does not require
A quick and simple step by step example:
- * Right click on the ad image to be blocked, then select "Copy Link Location"
+ * Right click on the ad image to be blocked, then select "Copy Link Location"
from the pop-up menu.
- * Set your browser to http://config.privoxy.org/show-status
+ * Set your browser to http://config.privoxy.org/show-status
- * Find user.action in the top section, and click on "Edit":
+ * Find user.action in the top section, and click on "Edit":
Figure 1. Actions Files in Use
- [ Screenshot of Actions Files in Use ]
+ [files-in-u]
- * You should have a section with only block listed under "Actions:". If not,
+ * You should have a section with only block listed under "Actions:". If not,
click a "Insert new section below" button, and in the new section that just
appeared, click the Edit button right under the word "Actions:". This will
- bring up a list of all actions. Find block near the top, and click in the
+ bring up a list of all actions. Find block near the top, and click in the
"Enabled" column, then "Submit" just below the list.
- * Now, in the block actions section, click the "Add" button, and paste the
+ * Now, in the block actions section, click the "Add" button, and paste the
URL the browser got from "Copy Link Location". Remove the http:// at the
beginning of the URL. Then, click "Submit" (or "OK" if in a pop-up window).
- * Now go back to the original page, and press SHIFT-Reload (or flush all
+ * Now go back to the original page, and press SHIFT-Reload (or flush all
browser caches). The image should be gone now.
-
This is a very crude and simple example. There might be good reasons to use a
wildcard pattern match to include potentially similar images from the same
site. For a more extensive explanation of "patterns", and the entire actions
For advanced users who want to hand edit their config files, you might want to
now go to the Actions Files Tutorial. The ideas explained therein also apply to
the web-based editor.
+
-------------------------------------------------------------------------------
5. Starting Privoxy
Figure 2. Proxy Configuration (Mozilla)
-[ Screenshot of Mozilla Proxy Configuration ]
+[proxy_setu]
With Netscape (and Mozilla), this can be set under:
- Edit
- |_
- Preferences
- |_
- Advanced
- |_
- Proxies
- |_
- HTTP Proxy
+ Edit
+ |_
+ Preferences
+ |_
+ Advanced
+ |_
+ Proxies
+ |_
+ HTTP Proxy
For Internet Explorer:
- Tools
- |_
- Internet Properties
- |_
- Connections
- |_
- LAN Settings
+ Tools
+ |_
+ Internet Properties
+ |_
+ Connections
+ |_
+ LAN Settings
Then, check "Use Proxy" and fill in the appropriate info (Address: 127.0.0.1,
Port: 8118). Include HTTPS (SSL), if you want HTTPS proxy support too.
used on the command line. If no configuration file is specified on the command
line, Privoxy will look for a file named config in the current directory.
Except on Win32 where it will try config.txt.
+
-------------------------------------------------------------------------------
5.1. Red Hat and Conectiva
file.
# /etc/rc.d/init.d/privoxy start
+
-------------------------------------------------------------------------------
5.2. Debian
will use the file /etc/privoxy/config as its main configuration file.
# /etc/init.d/privoxy start
+
-------------------------------------------------------------------------------
5.3. SuSE
configuration file. Note that SuSE starts Privoxy upon booting your PC.
# rcprivoxy start
+
-------------------------------------------------------------------------------
5.4. Windows
Click on the Privoxy Icon to start Privoxy. If no configuration file is
specified on the command line, Privoxy will look for a file named config.txt.
Note that Windows will automatically start Privoxy upon booting you PC.
+
-------------------------------------------------------------------------------
5.5. Solaris, NetBSD, FreeBSD, HP-UX and others
Example Unix startup command:
# /usr/sbin/privoxy /etc/privoxy/config
+
-------------------------------------------------------------------------------
5.6. OS/2
During installation, Privoxy is configured to start automatically when the
system restarts. You can start it manually by double-clicking on the Privoxy
icon in the Privoxy folder.
+
-------------------------------------------------------------------------------
5.7. Mac OSX
You will be prompted for the administrator password.
+
-------------------------------------------------------------------------------
5.8. AmigaOS
or as startup action (Miami and MiamiDx). Privoxy will automatically quit when
you quit your TCP/IP stack (just ignore the harmless warning your TCP/IP stack
may display that Privoxy is still running).
+
-------------------------------------------------------------------------------
5.9. Gentoo
rc-update add privoxy default
+
-------------------------------------------------------------------------------
5.10. Command Line Options
Privoxy may be invoked with the following command-line options:
- * --version
+ * --version
Print version info and exit. Unix only.
- * --help
+ * --help
Print short usage info and exit. Unix only.
- * --no-daemon
+ * --no-daemon
Don't become a daemon, i.e. don't fork and become process group leader, and
don't detach from controlling tty. Unix only.
- * --pidfile FILE
+ * --pidfile FILE
On startup, write the process ID to FILE. Delete the FILE on exit. Failure
to create or delete the FILE is non-fatal. If no FILE option is given, no
PID file will be used. Unix only.
- * --user USER[.GROUP]
+ * --user USER[.GROUP]
After (optionally) writing the PID file, assume the user ID of USER, and if
included the GID of GROUP. Exit if the privileges are not sufficient to do
so. Unix only.
- * configfile
+ * configfile
If no configfile is included on the command line, Privoxy will look for a
file named "config" in the current directory (except on Win32 where it will
look for "config.txt" instead). Specify full path to avoid confusion. If no
config file is found, Privoxy will fail to start.
-
-------------------------------------------------------------------------------
+
6. Privoxy Configuration
All Privoxy configuration is stored in text files. These files can be edited
with a text editor. Many important aspects of Privoxy can also be controlled
easily with a web browser.
+
-------------------------------------------------------------------------------
6.1. Controlling Privoxy with Your Web Browser
Privoxy's user interface can be reached through the special URL http://
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
+
+ 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
+ ? Documentation
+
This should be self-explanatory. Note the first item leads to an editor for the
actions files, which is where the ad, banner, cookie, and URL blocking magic is
proxy in this case, but all manipulation is disabled, i.e. Privoxy acts like a
normal forwarding proxy. There is even a toggle Bookmarklet offered, so that
you can toggle Privoxy with one click from your browser.
+
-------------------------------------------------------------------------------
6.2. Configuration Files Overview
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. The name and number of configuration files
-has changed from previous versions, and is subject to change as development
-progresses.
+directory as the Privoxy executable.
The installed defaults provide a reasonable starting point, though some
settings may be aggressive by some standards. For the time being, the principle
configuration files are:
- * The main configuration file is named config on Linux, Unix, BSD, OS/2, and
+ * The main configuration file is named config on Linux, Unix, BSD, OS/2, and
AmigaOS and config.txt on Windows. This is a required file.
- * default.action (the main actions file) is used to define which "actions"
+ * default.action (the main actions file) is used to define which "actions"
relating to banner-blocking, images, pop-ups, content modification, cookie
handling etc should be applied by default. It also defines many exceptions
- (both positive and negative) from this default set of actions that enable
+ (both positive and negative) from this default set of actions that enable
Privoxy to selectively eliminate the junk, and only the junk, on as many
websites as possible.
config.privoxy.org/show-status (Shortcut: http://p.p/show-status) for the
various actions files.
- * default.filter (the filter file) can be used to re-write the raw page
+ * default.filter (the filter file) can be used to re-write the raw page
content, including viewable text as well as embedded HTML and JavaScript,
and whatever else lurks on any given web page. The filtering jobs are only
pre-defined here; whether to apply them or not is up to the actions files.
-
All files use the "#" character to denote a comment (the rest of the line will
be ignored) and understand line continuation through placing a backslash ("\")
as the very last character in a line. If the # is preceded by a backslash, it
effect. When changing the listening address of Privoxy, these "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.
-------------------------------------------------------------------------------
7. The Main Configuration File
followed by a list of values, all separated by whitespace (any number of spaces
or tabs). For example:
- confdir /etc/privoxy
+ confdir /etc/privoxy
Assigns the value /etc/privoxy to the option confdir and thus indicates that
the configuration directory is named "/etc/privoxy/".
The main config file controls all aspects of Privoxy's operation that are not
location dependent (i.e. they apply universally, no matter where you may be
surfing).
+
-------------------------------------------------------------------------------
7.1. Configuration and Log File Locations
Privoxy can (and normally does) use a number of other files for additional
-configuration, help and logging. This section of the configuration file tells
+configuration, help and logging. This section of the configuration file tells
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 and actions files.
+
-------------------------------------------------------------------------------
7.1.1. confdir
Specifies:
+
The directory where the other configuration files are located
Type of value:
+
Path name
Default value:
+
/etc/privoxy (Unix) or Privoxy installation dir (Windows)
Effect if unset:
+
Mandatory
Notes:
+
No trailing "/", please
When development goes modular and multi-user, the blocker, filter, and
where the HTML templates for CGI output reside (e.g. Privoxy's 404 error
page).
-
-------------------------------------------------------------------------------
+
7.1.2. logdir
Specifies:
+
The directory where all logging takes place (i.e. where logfile and jarfile
are located)
Type of value:
+
Path name
Default value:
+
/var/log/privoxy (Unix) or Privoxy installation dir (Windows)
Effect if unset:
+
Mandatory
Notes:
+
No trailing "/", please
-
-------------------------------------------------------------------------------
+
7.1.3. actionsfile
Specifies:
+
The actions file(s) to use
Type of value:
+
File name, relative to confdir, without the .action suffix
Default values:
- standard # Internal purposes, no editing recommended
- default # Main actions file
- user # User customizations
+ standard # Internal purposes, no editing recommended
+
+ default # Main actions file
+
+ user # User customizations
Effect if unset:
+
No actions are taken at all. Simple neutral proxying.
Notes:
+
Multiple actionsfile lines are permitted, and are in fact recommended!
The default values include standard.action, which is used for internal
for ad blocking, cookie management, privacy considerations, etc. There is
no point in using Privoxy without at least one actions file.
-
-------------------------------------------------------------------------------
+
7.1.4. filterfile
Specifies:
+
The filter file to use
Type of value:
+
File name, relative to confdir
Default value:
+
default.filter (Unix) or default.filter.txt (Windows)
Effect if unset:
+
No textual content filtering takes place, i.e. all +filter{name} actions in
the actions files are turned neutral.
Notes:
+
The filter file contains content modification rules that use regular
expressions. These rules permit powerful changes on the content of Web
pages, e.g., you could disable your favorite JavaScript annoyances,
- re-write the actual displayed text, or just have some fun replacing
+ re-write the actual displayed text, or just have some fun replacing
"Microsoft" with "MicroSuck" wherever it appears on a Web page.
The +filter{name} actions rely on the relevant filter (name) to be defined
handy filters for common problems is included in the distribution. See the
section on the filter action for a list.
-
-------------------------------------------------------------------------------
+
7.1.5. logfile
Specifies:
+
The log file to use
Type of value:
+
File name, relative to logdir
Default value:
+
logfile (Unix) or privoxy.log (Windows)
Effect if unset:
+
No log file is used, all log messages go to the console (STDERR).
Notes:
+
The windows version will additionally log to the console.
The logfile is where all logging and error messages are written. The level
Any log files must be writable by whatever user Privoxy is being run as
(default on UNIX, user id is "privoxy").
-
-------------------------------------------------------------------------------
+
7.1.6. jarfile
Specifies:
+
The file to store intercepted cookies in
Type of value:
+
File name, relative to logdir
Default value:
+
jarfile (Unix) or privoxy.jar (Windows)
Effect if unset:
+
Intercepted cookies are not stored at all.
Notes:
+
The jarfile may grow to ridiculous sizes over time.
-
-------------------------------------------------------------------------------
+
7.1.7. trustfile
Specifies:
+
The trust file to use
Type of value:
+
File name, relative to confdir
Default value:
+
Unset (commented out). When activated: trust (Unix) or trust.txt (Windows)
Effect if unset:
+
The whole trust mechanism is turned off.
Notes:
+
The trust mechanism is an experimental feature for building white-lists and
should be used with care. It is NOT recommended for the casual user.
If you use + operator in the trust file, it may grow considerably over
time.
-
-------------------------------------------------------------------------------
+
7.2. Local Set-up Documentation
If you intend to operate Privoxy for more users than 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.
+
-------------------------------------------------------------------------------
7.2.1. user-manual
Specifies:
+
Location of the Privoxy User Manual.
Type of value:
+
A fully qualified URI
Default value:
+
Unset
Effect if unset:
+
http://www.privoxy.org/version/user-manual/ will be used, where version is
the Privoxy version.
Notes:
+
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 probably want to set this to a locally installed
Unix, in local filesystem:
- user-manual file:///usr/share/doc/privoxy-2.9.20/user-manual/
+ user-manual file:///usr/share/doc/privoxy-3.0.0/user-manual/
Any platform, on local webserver (called "local-webserver"):
- user-manual http://local-webserver/privoxy-user-manual/
+ 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. |
+-----------------------------------------------------------------+
-
-------------------------------------------------------------------------------
+
7.2.2. trust-info-url
Specifies:
+
A URL to be displayed in the error page that users will see if access to an
untrusted page is denied.
Type of value:
+
URL
Default value:
+
Two example URL are provided
Effect if unset:
+
No links are displayed on the "untrusted" error page.
Notes:
+
The value of this option only matters if the experimental trust mechanism
has been activated. (See trustfile above.)
locked out from the information on why they were locked out in the first
place!
-
-------------------------------------------------------------------------------
+
7.2.3. admin-address
Specifies:
+
An email address to reach the proxy administrator.
Type of value:
+
Email address
Default value:
+
Unset
Effect if unset:
+
No email address is displayed on error pages and the CGI user interface.
Notes:
+
If both admin-address and proxy-info-url are unset, the whole "Local
Privoxy Support" box on all generated pages will not be shown.
-
-------------------------------------------------------------------------------
+
7.2.4. proxy-info-url
Specifies:
+
A URL to documentation about the local Privoxy setup, configuration or
policies.
Type of value:
+
URL
Default value:
+
Unset
Effect if unset:
+
No link to local documentation is displayed on error pages and the CGI user
interface.
Notes:
+
If both admin-address and proxy-info-url are unset, the whole "Local
Privoxy Support" box on all generated pages will not be shown.
This URL shouldn't be blocked ;-)
-
-------------------------------------------------------------------------------
+
7.3. Debugging
These options are mainly useful when tracing a problem. Note that you might
also want to invoke Privoxy with the --no-daemon command line option when
debugging.
+
-------------------------------------------------------------------------------
7.3.1. debug
Specifies:
+
Key values that determine what information gets logged to the logfile.
Type of value:
+
Integer values
Default value:
+
12289 (i.e.: URLs plus informational and warning messages)
Effect if unset:
+
Nothing gets logged.
Notes:
+
The available debug levels are:
debug 1 # show each GET/POST/CONNECT request
If you want to use CLF (Common Log Format), you should set "debug 512" ONLY
and not enable anything else.
-
-------------------------------------------------------------------------------
+
7.3.2. single-threaded
Specifies:
+
Whether to run only one server thread
Type of value:
+
None
Default value:
+
Unset
Effect if unset:
+
Multi-threaded (or, where unavailable: forked) operation, i.e. the ability
to serve multiple requests simultaneously.
Notes:
+
This option is only there for debug purposes and you should never need to
use it. It will drastically reduce performance.
-
-------------------------------------------------------------------------------
+
7.4. Access Control and Security
-This section of the config file controls the security-relevant aspects of
+This section of the config file controls the security-relevant aspects of
Privoxy's configuration.
+
-------------------------------------------------------------------------------
7.4.1. listen-address
Specifies:
+
The IP address and TCP port on which Privoxy will listen for client
requests.
Type of value:
+
[IP-Address]:Port
Default value:
+
127.0.0.1:8118
Effect if unset:
+
Bind to 127.0.0.1 (localhost), port 8118. This is suitable and recommended
for home users who run Privoxy on the same machine as their browser.
Notes:
+
You will need to configure your browser(s) to this proxy address and port.
If you already have another service running on port 8118, or if you want to
enable-edit-actions and enable-remote-toggle options!
Example:
+
Suppose you are running Privoxy on a machine which has the address
192.168.0.1 on your local private network (192.168.0.0) and has another
outside connection with a different address. You want it to serve requests
listen-address 192.168.0.1:8118
-
-------------------------------------------------------------------------------
+
7.4.2. toggle
Specifies:
+
Initial state of "toggle" status
Type of value:
+
1 or 0
Default value:
+
1
Effect if unset:
+
Act as if toggled on
Notes:
+
If set to 0, Privoxy will start in "toggled off" mode, i.e. behave like a
normal, content-neutral proxy where all ad blocking, filtering, etc are
disabled. See enable-remote-toggle below. This is not really useful
The windows version will only display the toggle icon in the system tray if
this option is present.
-
-------------------------------------------------------------------------------
+
7.4.3. enable-remote-toggle
Specifies:
+
Whether or not the web-based toggle feature may be used
Type of value:
+
0 or 1
Default value:
+
1
Effect if unset:
+
The web-based toggle feature is disabled.
Notes:
+
When toggled off, Privoxy acts like a normal, content-neutral proxy, i.e.
it acts as if none of the actions applied to any URL.
Note that you must have compiled Privoxy with support for this feature,
otherwise this option has no effect.
-
-------------------------------------------------------------------------------
+
7.4.4. enable-edit-actions
Specifies:
+
Whether or not the web-based actions file editor may be used
Type of value:
+
0 or 1
Default value:
+
1
Effect if unset:
+
The web-based actions file editor is disabled.
Notes:
+
For the time being, access to the editor can not be controlled separately
by "ACLs" or HTTP authentication, so that everybody who can access Privoxy
(see "ACLs" and listen-address above) can modify its configuration for all
Note that you must have compiled Privoxy with support for this feature,
otherwise this option has no effect.
-
-------------------------------------------------------------------------------
+
7.4.5. ACLs: permit-access and deny-access
Specifies:
+
Who can access what.
Type of value:
+
src_addr[/src_masklen] [dst_addr[/dst_masklen]]
Where src_addr and dst_addr are IP addresses in dotted decimal notation or
optional.
Default value:
+
Unset
Effect if unset:
+
Don't restrict access further than implied by listen-address
Notes:
+
Access controls are included at the request of ISPs and systems
administrators, and are not usually needed by individual users. For a
typical home user, it will normally suffice to ensure that Privoxy only
sites.
Examples:
+
Explicitly define the default behavior if no ACL and listen-address are
set: "localhost" is OK. The absence of a dst_addr implies that all
destination addresses are OK:
permit-access 192.168.45.64/26
deny-access 192.168.45.73 www.dirty-stuff.example.com
-
-------------------------------------------------------------------------------
+
7.4.6. buffer-limit
Specifies:
+
Maximum size of the buffer for content filtering.
Type of value:
+
Size in Kbytes
Default value:
+
4096
Effect if unset:
+
Use a 4MB (4096 KB) limit.
Notes:
+
For content filtering, i.e. the +filter and +deanimate-gif actions, it is
necessary that Privoxy buffers the entire document body. This can be
potentially dangerous, since a server could just keep sending data
When a document buffer size reaches the buffer-limit, it is flushed to the
client unfiltered and no further attempt to filter the rest of the document
is made. Remember that there may be multiple threads running, which might
- require up to buffer-limit Kbytes each, unless you have enabled
+ require up to buffer-limit Kbytes each, unless you have enabled
"single-threaded" above.
-
-------------------------------------------------------------------------------
+
7.5. Forwarding
This feature allows routing of HTTP requests through a chain of multiple
Also specified here are SOCKS proxies. Privoxy supports the SOCKS 4 and SOCKS
4A protocols.
+
-------------------------------------------------------------------------------
7.5.1. forward
Specifies:
+
To which parent HTTP proxy specific requests should be routed.
Type of value:
+
target_pattern http_parent[:port]
where target_pattern is a URL pattern that specifies to which requests
forwarding".
Default value:
+
Unset
Effect if unset:
+
Don't use parent HTTP proxies.
Notes:
+
If http_parent is ".", then requests are not forwarded to another HTTP
proxy but are made directly to the web servers.
wins.
Examples:
+
Everything goes to an example anonymizing proxy, except SSL on port 443
(which it doesn't handle):
forward / caching-proxy.example-isp.net:8000
forward .example-isp.net .
-
-------------------------------------------------------------------------------
+
7.5.2. forward-socks4 and forward-socks4a
Specifies:
+
Through which SOCKS proxy (and to which parent HTTP proxy) specific
requests should be routed.
Type of value:
+
target_pattern socks_proxy[:port] http_parent[:port]
where target_pattern is a URL pattern that specifies to which requests
to 64535
Default value:
+
Unset
Effect if unset:
+
Don't use SOCKS proxies.
Notes:
+
Multiple lines are OK, they are checked in sequence, and the last match
wins.
a SOCKS proxy.
Examples:
+
From the company example.com, direct connections are made to all "internal"
domains, but everything outbound goes through their ISP's proxy by way of
example.com's corporate SOCKS 4A gateway to the Internet.
forward-socks4 / socks-gw.example.com:1080 .
-
-------------------------------------------------------------------------------
+
7.5.3. Advanced Forwarding Examples
If you have links to multiple ISPs that provide various special content only to
forward / .
forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010
+
-------------------------------------------------------------------------------
7.6. Windows GUI Options
Privoxy has a number of options specific to the Windows GUI interface:
-
-If "activity-animation" is set to 1, the Privoxy icon will animate when
+If "activity-animation" is set to 1, the Privoxy icon will animate when
"Privoxy" is active. To turn off, set to 0.
- activity-animation 1
-
-
+ activity-animation 1
+
If "log-messages" is set to 1, Privoxy will log messages to the console window:
- log-messages 1
-
-
+ log-messages 1
+
If "log-buffer-size" is set to 1, the size of the log buffer, i.e. the amount
of memory used for the log messages displayed in the console window, will be
Warning: Setting this to 0 will result in the buffer to grow infinitely and eat
up all your memory!
- log-buffer-size 1
-
-
+ log-buffer-size 1
+
log-max-lines is the maximum number of lines held in the log buffer. See above.
- log-max-lines 200
-
-
+ log-max-lines 200
+
If "log-highlight-messages" is set to 1, Privoxy will highlight portions of the
log messages with a bold-faced font:
- log-highlight-messages 1
-
-
+ log-highlight-messages 1
+
The font used in the console window:
- log-font-name Comic Sans MS
-
-
+ log-font-name Comic Sans MS
+
Font size used in the console window:
- log-font-size 8
-
-
+ log-font-size 8
+
"show-on-task-bar" controls whether or not Privoxy will appear as a button on
the Task bar when minimized:
- show-on-task-bar 0
-
-
+ show-on-task-bar 0
+
If "close-button-minimizes" is set to 1, the Windows close button will minimize
Privoxy instead of closing the program (close with the exit option on the File
menu).
- close-button-minimizes 1
-
-
+ close-button-minimizes 1
+
The "hide-console" option is specific to the MS-Win console version of Privoxy.
If this option is used, Privoxy will disconnect from and hide the command
console.
- #hide-console
-
+ #hide-console
+
+
-------------------------------------------------------------------------------
8. Actions Files
thereof). There are three such files included with Privoxy (as of version
2.9.15), with differing purposes:
- * default.action - is the primary action file that sets the initial values
+ * default.action - is the primary action file that sets the initial values
for all actions. It is intended to provide a base level of functionality
for Privoxy's array of features. So it is a set of broad rules that should
work reasonably well for users everywhere. This is the file that the
developers are keeping updated, and making available to users.
- * user.action - is intended to be for local site preferences and exceptions.
+ * user.action - is intended to be for local site preferences and exceptions.
As an example, if your ISP or your bank has specific requirements, and need
special handling, this kind of thing should go here. This file will not be
upgraded.
- * standard.action - is used by the web based editor, to set various
+ * standard.action - is used by the web based editor, to set various
pre-defined sets of rules for the default actions section in
default.action. These have increasing levels of aggressiveness and have no
influence on your browsing unless you select them explicitly in the editor.
It is not recommend to edit this file.
-
The list of actions files to be used are defined in the main configuration
file, and are processed in the order they are defined. The content of these can
all be viewed and edited from http://config.privoxy.org/show-status.
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.
+
-------------------------------------------------------------------------------
8.1. Finding the Right Mix
some sites unusable that rely on these techniques to work properly. Finding the
right mix of actions is not always easy and certainly a matter of personal
taste. In general, it can be said that the more "aggressive" your default
-settings (in the top section of the actions file) are, the more exceptions for
+settings (in the top section of the actions file) are, the more exceptions for
"trusted" sites you will have to make later. If, for example, you want to kill
popup windows per default, you'll have to make exceptions from that rule for
sites that you regularly use and that require popups for actually useful
things. There just are too many variables, and sites are constantly changing.
Sooner or later you will want to change the rules (and read this chapter again
:).
+
-------------------------------------------------------------------------------
8.2. How to Edit
If you prefer plain text editing to GUIs, you can of course also directly edit
the the actions files. Look at default.action which is richly commented.
+
-------------------------------------------------------------------------------
8.3. How Actions are Applied to URLs
config.privoxy.org/show-url-info.
More detail on this is provided in the Appendix, Anatomy of an Action.
+
-------------------------------------------------------------------------------
8.4. Patterns
<path> are optional. (This is why the pattern / matches all URLs).
www.example.com/
+
is a domain-only pattern and will match any request to www.example.com,
regardless of which document on that server is requested.
www.example.com
+
means exactly the same. For domain-only patterns, the trailing / may be
omitted.
www.example.com/index.html
+
matches only the single document /index.html on www.example.com.
/index.html
+
matches the document /index.html, regardless of the domain, i.e. on any web
server.
index.html
+
matches nothing, since it would be interpreted as a domain name and there
is no top-level domain called .html.
-
-------------------------------------------------------------------------------
+
8.4.1. The Domain Pattern
The matching of the domain part offers some flexible options: if the domain
starts or ends with a dot, it becomes unanchored at that end. For example:
.example.com
+
matches any domain that ENDS in .example.com
www.
+
matches any domain that STARTS with www.
.example.
+
matches any domain that CONTAINS .example. (Correctly speaking: It matches
any FQDN that contains example as a domain.)
-
Additionally, there are wild-cards that you can use in the domain names
themselves. They work pretty similar to shell wild-cards: "*" stands for zero
or more arbitrary characters, "?" stands for any single character, you can
mixed:
ad*.example.com
- matches "adserver.example.com", "ads.example.com", etc but not
+
+ matches "adserver.example.com", "ads.example.com", etc but not
"sfads.example.com"
*ad*.example.com
+
matches all of the above, and then some.
.?pix.com
+
matches www.ipix.com, pictures.epix.com, a.b.c.d.e.upix.com etc.
www[1-9a-ez].example.c*
+
matches www1.example.com, www4.example.cc, wwwd.example.cy,
wwwz.example.com etc., but not wwww.example.com.
-
-------------------------------------------------------------------------------
+
8.4.2. The Path Pattern
Privoxy uses Perl compatible regular expressions (through the PCRE library) for
you can switch to case sensitive at any point in the pattern by using the "(?
-i)" switch: www.example.com/(?-i)PaTtErN.* will match only documents whose
path starts with PaTtErN in exactly this capitalization.
+
-------------------------------------------------------------------------------
8.5. Actions
There are three classes of actions:
- * Boolean, i.e the action can only be "enabled" or "disabled". Syntax:
+ * Boolean, i.e the action can only be "enabled" or "disabled". Syntax:
+name # enable action name
-name # disable action name
Example: +block
- * Parameterized, where some value is required in order to enable this type of
+ * Parameterized, where some value is required in order to enable this type of
action. Syntax:
+name{param} # enable action and set parameter to param,
Example: +hide-user-agent{ Mozilla 1.0 }
- * Multi-value. These look exactly like parameterized actions, but they behave
+ * 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
Examples: +add-header{X-Fun-Header: Some text} and +filter{html-annoyances}
-
If nothing is specified in any actions file, no "actions" are taken. So in this
case Privoxy would just be a normal, non-blocking, non-anonymizing proxy. You
must specifically enable the privacy and blocking features you need (although
more than one pattern and thus more than one set of actions!
The list of valid Privoxy actions are:
+
-------------------------------------------------------------------------------
8.5.1. add-header
Typical use:
+
Confuse log analysis, custom applications
Effect:
+
Sends a user defined HTTP header to the web server.
Type:
+
Multi-value.
Parameter:
+
Any string value is possible. Validity of the defined HTTP headers is not
checked. It is recommended that you use the "X-" prefix for custom headers.
Notes:
+
This action may be specified multiple times, in order to define multiple
headers. This is rarely needed for the typical user. If you don't know what
"HTTP headers" are, you definitely don't need to worry about this one.
Example usage:
+
+add-header{X-User-Tracking: sucks}
-
-------------------------------------------------------------------------------
+
8.5.2. block
Typical use:
+
Block ads or other obnoxious content
Effect:
+
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.
Type:
+
Boolean.
Parameter:
+
N/A
Notes:
+
Privoxy sends a special "BLOCKED" page for requests to blocked pages. This
page contains links to find out why the request was blocked, and a
click-through to the blocked content (the latter only if compiled with the
determined by its parameter, if not, the standard checkerboard pattern is
sent.
- It is important to understand this process, in order to understand how
+ It is important to understand this process, in order to understand how
Privoxy deals with ads and other unwanted content.
The filter action can perform a very similar task, by "blocking" banner
the two.
Example usage (section):
+
{+block} # Block and replace with "blocked" page
.nasty-stuff.example.com
.ad.doubleclick.net
.ads.r.us
-
-------------------------------------------------------------------------------
+
8.5.3. crunch-incoming-cookies
Typical use:
+
Prevent the web server from setting any cookies on your system
Effect:
+
Deletes any "Set-Cookie:" HTTP headers from server replies.
Type:
+
Boolean.
Parameter:
+
N/A
Notes:
+
This action is only concerned with incoming cookies. For outgoing cookies,
use crunch-outgoing-cookies. Use both to disable cookies completely.
from being set.
Example usage:
+
+crunch-incoming-cookies
-
-------------------------------------------------------------------------------
+
8.5.4. crunch-outgoing-cookies
Typical use:
+
Prevent the web server from reading any cookies from your system
Effect:
+
Deletes any "Cookie:" HTTP headers from client requests.
Type:
+
Boolean.
Parameter:
+
N/A
Notes:
+
This action is only concerned with outgoing cookies. For incoming cookies,
use crunch-incoming-cookies. Use both to disable cookies completely.
from being read.
Example usage:
+
+crunch-outgoing-cookies
-
-------------------------------------------------------------------------------
+
8.5.5. deanimate-gifs
Typical use:
+
Stop those annoying, distracting animated GIF images.
Effect:
+
De-animate GIF animations, i.e. reduce them to their first or last image.
Type:
+
Parameterized.
Parameter:
+
"last" or "first"
Notes:
+
This will also shrink the images considerably (in bytes, not pixels!). If
the option "first" is given, the first frame of the animation is used as
the replacement. If "last" is given, the last frame of the animation is
a GIF.
Example usage:
+
+deanimate-gifs{last}
-
-------------------------------------------------------------------------------
+
8.5.6. downgrade-http-version
Typical use:
+
Work around (very rare) problems with HTTP/1.1
Effect:
+
Downgrades HTTP/1.1 client requests and server replies to HTTP/1.0.
Type:
+
Boolean.
Parameter:
+
N/A
Notes:
+
This is a left-over from the time when Privoxy didn't support important
HTTP/1.1 features well. It is left here for the unlikely case that you
experience HTTP/1.1 related problems with some server out there. Not all
might need this action.
Example usage (section):
+
{+downgrade-http-version}
problem-host.example.com
-
-------------------------------------------------------------------------------
+
8.5.7. fast-redirects
Typical use:
+
Fool some click-tracking scripts and speed up indirect links
Effect:
+
Cut off all but the last valid URL from requests.
Type:
+
Boolean.
Parameter:
+
N/A
Notes:
+
Many sites, like yahoo.com, don't just link to other sites. Instead, they
will link to some script on their own servers, giving the destination as a
parameter, which will then redirect you to the final target. URLs resulting
Some sites just don't work without it.
Example usage:
+
{+fast-redirects}
-
-------------------------------------------------------------------------------
+
8.5.8. filter
Typical use:
+
Get rid of HTML and JavaScript annoyances, banner advertisements (by size),
do fun text replacements, etc.
Effect:
+
Text documents, including HTML and JavaScript, to which this action
applies, are filtered on-the-fly through the specified regular expression
based substitutions.
Type:
+
Parameterized.
Parameter:
+
The name of a filter, as defined in the filter file (typically
default.filter, set by the filterfile option in the config file). Filtering
can be completely disabled without the use of parameters.
Notes:
+
For your convenience, there are a number of pre-defined filters available
in the distribution filter file that you can use. See the examples below
for a list.
welcome!
Example usage (with filters from the distribution default.filter file):
+
+filter{html-annoyances} # Get rid of particularly annoying HTML abuse.
+filter{js-annoyances} # Get rid of particularly annoying JavaScript abuse
+filter{js-events} # Kill all JS event bindings (Radically destructive! Only for extra nasty sites)
-
-------------------------------------------------------------------------------
+
8.5.9. handle-as-image
Typical use:
+
Mark URLs as belonging to images (so they'll be replaced by images if they
get blocked)
Effect:
+
This action alone doesn't do anything noticeable. It just marks URLs as
images. If the block action also applies, the presence or absence of this
mark decides whether an HTML "blocked" page, or a replacement image (as
substitute for the blocked content.
Type:
+
Boolean.
Parameter:
+
N/A
Notes:
+
The below generic example section is actually part of default.action. It
marks all URLs with well-known image file name extensions as images and
should be left intact.
replace the ad frame with an image, but lead to error messages.
Example usage (sections):
+
# Generic image extensions:
#
{+handle-as-image}
# Banner source! Who cares if they also have non-image content?
ad.doubleclick.net
-
-------------------------------------------------------------------------------
+
8.5.10. hide-forwarded-for-headers
Typical use:
+
Improve privacy by hiding the true source of the request
Effect:
+
Deletes any existing "X-Forwarded-for:" HTTP header from client requests,
and prevents adding a new one.
Type:
+
Boolean.
Parameter:
+
N/A
Notes:
+
It is fairly safe to leave this on.
This action is scheduled for improvement: It should be able to generate
like requests from a pool of different users sharing the same proxy.
Example usage:
+
+hide-forwarded-for-headers
-
-------------------------------------------------------------------------------
+
8.5.11. hide-from-header
Typical use:
+
Keep your (old and ill) browser from telling web servers your email address
Effect:
+
Deletes any existing "From:" HTTP header, or replaces it with the specified
string.
Type:
+
Parameterized.
Parameter:
+
Keyword: "block", or any user defined value.
Notes:
+
The keyword "block" will completely remove the header (not to be confused
with the block action).
headers anymore.
Example usage:
+
+hide-from-header{block}
+
or
+
+hide-from-header{spam-me-senseless@sittingduck.example.com}
-
-------------------------------------------------------------------------------
+
8.5.12. hide-referrer
Typical use:
+
Conceal which link you followed to get to a particular site
Effect:
+
Deletes the "Referer:" (sic) HTTP header from the client request, or
replaces it with a forged one.
Type:
+
Parameterized.
Parameter:
- + "block" to delete the header completely.
+
+ + "block" to delete the header completely.
- + "forge" to pretend to be coming from the homepage of the server we are
+ + "forge" to pretend to be coming from the homepage of the server we are
talking to.
- + Any other string to set a user defined referrer.
+ + Any other string to set a user defined referrer.
-
Notes:
+
"forge" is the preferred option here, since some servers will not send
images back otherwise, in an attempt to prevent their valuable content from
being embedded elsewhere (and hence, without being surrounded by their
to be spelled as "referer".)
Example usage:
+
+hide-referrer{forge}
+
or
+
+hide-referrer{http://www.yahoo.com/}
-
-------------------------------------------------------------------------------
+
8.5.13. hide-user-agent
Typical use:
+
Conceal your type of browser and client operating system
Effect:
+
Replaces the value of the "User-Agent:" HTTP header in client requests with
the specified value.
Type:
+
Parameterized.
Parameter:
+
Any user-defined string.
Notes:
+
+-----------------------------------------------------------------+
| Warning |
- +-----------------------------------------------------------------+
+ |-----------------------------------------------------------------|
|This breaks many web sites that depend on looking at this header |
|in order to customize their content for different browsers |
|(which, by the way, is NOT a smart way to do that!). |
This action is scheduled for improvement.
Example usage:
+
+hide-user-agent{Netscape 6.1 (X11; I; Linux 2.4.18 i686)}
-
-------------------------------------------------------------------------------
+
8.5.14. kill-popups
Typical use:
+
Eliminate those annoying pop-up windows
Effect:
+
While loading the document, replace JavaScript code that opens pop-up
windows with (syntactically neutral) dummy code on the fly.
Type:
+
Boolean.
Parameter:
+
N/A
Notes:
+
This action is easily confused with the built-in, hardwired filter action,
but there are important differences: For kill-popups, the document need not
be buffered, so it can be incrementally rendered while downloading. But
filter{js-annoyances} instead.
Example usage:
+
+kill-popups
-
-------------------------------------------------------------------------------
+
8.5.15. limit-connect
Typical use:
+
Prevent abuse of Privoxy as a TCP proxy relay
Effect:
+
Specifies to which ports HTTP CONNECT requests are allowable.
Type:
+
Parameterized.
Parameter:
+
A comma-separated list of ports or port ranges (the latter using dashes,
with the minimum defaulting to 0 and the maximum to 65K).
Notes:
+
By default, i.e. if no limit-connect action applies, Privoxy only allows
HTTP CONNECT requests to port 443 (the standard, secure HTTPS port). Use
limit-connect if more fine-grained control is desired for some or all
destinations.
- The CONNECT methods exists in HTTP to allow access to secure websites (
- "https://" URLs) through proxies. It works very simply: the proxy connects
+ The CONNECT methods exists in HTTP to allow access to secure websites
+ ("https://" URLs) through proxies. It works very simply: the proxy connects
to the server on the specified port, and then short-circuits its
connections to the client and to the remote server. This can be a big
security hole, since CONNECT-enabled proxies can be abused as TCP relays
change this one, since the default is already very restrictive.
Example usages:
+
+limit-connect{443} # This is the default and need not be specified.
+limit-connect{80,443} # Ports 80 and 443 are OK.
+limit-connect{-3, 7, 20-100, 500-} # Ports less than 3, 7, 20 to 100 and above 500 are OK.
+limit-connect{-} # All ports are OK (gaping security hole!)
-
-------------------------------------------------------------------------------
+
8.5.16. prevent-compression
Typical use:
+
Ensure that servers send the content uncompressed, so it can be passed
through filters
Effect:
+
Adds a header to the request that asks for uncompressed transfer.
Type:
+
Boolean.
Parameter:
+
N/A
Notes:
+
More and more websites send their content compressed by default, which is
generally a good idea and saves bandwidth. But for the filter,
deanimate-gifs and kill-popups actions to work, Privoxy needs access to the
those sites. See the example for how to do that.
Example usage (sections):
+
# Set default:
#
{+prevent-compression}
www.debianhelp.org
www.pclinuxonline.com
-
-------------------------------------------------------------------------------
+
8.5.17. send-vanilla-wafer
Typical use:
+
Feed log analysis scripts with useless data.
Effect:
+
Sends a cookie with each request stating that you do not accept any
copyright on cookies sent to you, and asking the site operator not to track
you.
Type:
+
Boolean.
Parameter:
+
N/A
Notes:
+
The vanilla wafer is a (relatively) unique header and could conceivably be
used to track you.
This action is rarely used and not enabled in the default configuration.
Example usage:
+
+send-vanilla-wafer
-
-------------------------------------------------------------------------------
+
8.5.18. send-wafer
Typical use:
+
Send custom cookies or feed log analysis scripts with even more useless
data.
Effect:
+
Sends a custom, user-defined cookie with each request.
Type:
+
Multi-value.
Parameter:
+
A string of the form "name=value".
Notes:
+
Being multi-valued, multiple instances of this action can apply to the same
request, resulting in multiple cookies being sent.
This action is rarely used and not enabled in the default configuration.
Example usage (section):
+
{+send-wafer{UsingPrivoxy=true}}
my-internal-testing-server.void
-
-------------------------------------------------------------------------------
+
8.5.19. session-cookies-only
Typical use:
+
Allow only temporary "session" cookies (for the current browser session
only).
Effect:
+
Deletes the "expires" field from "Set-Cookie:" server headers. Most
browsers will not store such cookies permanently and forget them in between
sessions.
Type:
+
Boolean.
Parameter:
+
N/A
Notes:
+
This is less strict than crunch-incoming-cookies / crunch-outgoing-cookies
and allows you to browse websites that insist or rely on setting cookies,
without compromising your privacy too badly.
crunch-incoming-cookies or crunch-outgoing-cookies. If you do, cookies will
be plainly killed.
- Note that it is up to the browser how it handles such cookies without an
+ Note that it is up to the browser how it handles such cookies without an
"expires" field. If you use an exotic browser, you might want to try it out
to be sure.
Example usage:
+
+session-cookies-only
-
-------------------------------------------------------------------------------
+
8.5.20. set-image-blocker
Typical use:
+
Choose the replacement for blocked images
Effect:
+
This action alone doesn't do anything noticeable. If both block and
handle-as-image also apply, i.e. if the request is to be blocked as an
image, then the parameter of this action decides what will be sent as a
replacement.
Type:
+
Parameterized.
Parameter:
- + "pattern" to send a built-in checkerboard pattern image. The image is
+
+ + "pattern" to send a built-in checkerboard pattern image. The image is
visually decent, scales very well, and makes it obvious where banners
were busted.
- + "blank" to send a built-in transparent image. This makes banners
+ + "blank" to send a built-in transparent image. This makes banners
disappear completely, but makes it hard to detect where Privoxy has
- blocked images on a given page and complicates troubleshooting if
+ blocked images on a given page and complicates troubleshooting if
Privoxy has blocked innocent images, like navigation icons.
- + "target-url" to send a redirect to target-url. You can redirect to any
+ + "target-url" to send a redirect to target-url. You can redirect to any
image anywhere, even in your local filesystem (via "file:///" URL).
A good application of redirects is to use special Privoxy-built-in
but enables your browser to cache the replacement image, instead of
requesting it over and over again.
-
Notes:
+
The URLs for the built-in images are "http://config.privoxy.org/
send-banner?type=type", where type is either "blank" or "pattern".
image.
Example usage:
+
Built-in pattern:
+set-image-blocker{pattern}
+set-image-blocker{http://config.privoxy.org/send-banner?type=pattern}
-
-------------------------------------------------------------------------------
+
8.5.21. Summary
Note that many of these actions have the potential to cause a page to
designer may choose to design his site, and what HTTP header content, and other
criteria, he may depend on. There is no way to have hard and fast rules for all
sites. See the Appendix for a brief example on troubleshooting actions.
+
-------------------------------------------------------------------------------
8.6. Aliases
Custom "actions", known to Privoxy as "aliases", can be defined by combining
other actions. These can in turn be invoked just like the built-in actions.
Currently, an alias name can contain any character except space, tab, "=", "{"
-and "}", but we strongly recommend that you only use "a" to "z", "0" to "9",
+and "}", but we strongly recommend that you only use "a" to "z", "0" to "9",
"+", and "-". Alias names are not case sensitive, and are not required to start
with a "+" or "-" sign, since they are merely textually expanded.
built-in web-based action file editor honors aliases when reading the actions
files, but it expands them before writing. So the effects of your aliases are
of course preserved, but the aliases themselves are lost when you edit sections
-that use aliases with it. This is likely to change in future versions of
+that use aliases with it. This is likely to change in future versions of
Privoxy.
Now let's define some aliases...
Aliases like "shop" and "fragile" are often used for "problem" sites that
require some actions to be disabled in order to function properly.
+
-------------------------------------------------------------------------------
8.7. Actions Files Tutorial
organized, how actions are specified and applied to URLs, how patterns work,
and how to define and use aliases. Now, let's look at an example default.action
and user.action file and see how all these pieces come together:
+
-------------------------------------------------------------------------------
8.7.1. default.action
.hitbox.com
You wouldn't believe how many advertisers actually call their banner servers
-ads.company.com, or call the directory in which the banners are stored simply
+ads.company.com, or call the directory in which the banners are stored simply
"banners". So the above generic patterns are surprisingly effective.
But being very generic, they necessarily also catch URLs that we don't want to
The actual default.action is of course more comprehensive, but we hope this
example made clear how it works.
+
-------------------------------------------------------------------------------
8.7.2. user.action
.osdn.net
Note that allow-ads has been aliased to -block -filter{banners-by-size} above.
+
-------------------------------------------------------------------------------
9. The Filter File
Appendix on regular expressions, and see the Perl manual for the s///
operator's syntax and Perl-style regular expressions in general. The below
examples might also help to get you started.
+
-------------------------------------------------------------------------------
9.1. Filter File Tutorial
only the exact string "document.referrer". The dot needed to be escaped, i.e.
preceded by a backslash, to take away its special meaning as a joker, and make
it just a regular dot. So far, the meaning is: Match from the start of the
-first <script> tag in a the page, up to, and including, the text
+first <script> tag in a the page, up to, and including, the text
"document.referrer", if both are present in the page (and appear in that
order).
option says that the match may span multiple lines in the page, and the g
option again means that the substitution is global.
-So, to summarize, the pattern means: Match all scripts that contain the text
+So, to summarize, the pattern means: Match all scripts that contain the text
"document.referrer". Remember the parts of the script from (and including) the
start tag up to (and excluding) the string "document.referrer" as $1, and the
part following that string, up to and including the closing tag, as $2.
s/(<body [^>]*)onunload(.*>)/$1never$2/iU
Including the OnUnload event binding in the HTML DOM was a CRIME. When I close
-a browser window, I want it to close and die. Basta. This job replaces the
+a browser window, I want it to close and die. Basta. This job replaces the
"onunload" attribute in "<body>" tags with the dummy word never. Note that the
i option makes the pattern matching case-insensitive. Also note that ungreedy
matching alone doesn't always guarantee a minimal match: In the first
s/microsoft(?!\.com)/MicroSuck/ig
Note the (?!\.com) part (a so-called negative lookahead) in the job's pattern,
-which means: Don't match, if the string ".com" appears directly following
+which means: Don't match, if the string ".com" appears directly following
"microsoft" in the page. This prevents links to microsoft.com from being
trashed, while still replacing the word everywhere else.
liberal use of (non-interpreted!) whitespace for nicer formatting.
You get the idea?
+
-------------------------------------------------------------------------------
10. Templates
All templates refer to a style located at http://config.privoxy.org/
send-stylesheet. This is, of course, locally served by Privoxy and the source
for it can be found and edited in the cgi-style.css template.
+
-------------------------------------------------------------------------------
11. Contacting the Developers, Bug Reporting and Feature Requests
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:
+
-------------------------------------------------------------------------------
11.1. Get Support
All users are of course welcome to discuss their issues on the users mailing
list, where the developers also hang around.
+
-------------------------------------------------------------------------------
11.2. Report Bugs
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 your
bug, but this is not required for reporting.
+
-------------------------------------------------------------------------------
11.3. 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/
tracker/?atid=361118&group_id=11118.
+
-------------------------------------------------------------------------------
11.4. Report Ads or Other Actions-Related Problems
New, improved default.action files will 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.
+
-------------------------------------------------------------------------------
11.5. Other
welcome on the developers list! You can find an overview of all Privoxy-related
mailing lists, including list archives, at: http://sourceforge.net/mail/?
group_id=11118.
+
-------------------------------------------------------------------------------
12. Privoxy Copyright, License and History
Some source code is based on code Copyright © 1997 by Anonymous Coders and
Junkbusters, Inc. and licensed under the GNU General Public License.
+
-------------------------------------------------------------------------------
12.1. License
You should have received a copy of the GNU General Public License along with
this program; if not, write to the
- Free Software
- Foundation, Inc. 59 Temple Place - Suite 330
- Boston, MA 02111-1307
- USA
+ Free Software
+ Foundation, Inc. 59 Temple Place - Suite 330
+ Boston, MA 02111-1307
+ USA
+
-------------------------------------------------------------------------------
12.2. History
inside out, upside down, and then reassembled it, adding many new features
along the way.
-The result of this is Privoxy, whose first stable release, 3.0, is due late
-summer or early fall 2002.
+The result of this is Privoxy, whose first stable release, 3.0, was released
+August, 2002.
+
-------------------------------------------------------------------------------
12.3. Authors
Current Project Developers:
- Jon Foster
- Andreas Oesterhelt
- Stefan Waldherr
-
- Thomas Steudten
- Rodney Stromlund
+ Jon Foster
+ Andreas Oesterhelt
+ Stefan Waldherr
+
+ Thomas Steudten
+ Rodney Stromlund
Current Project Contributors:
- Rodrigo Barbosa (RPM specfiles)
- Moritz Barsnick
- Hal Burgiss (docs)
- Alexander Lazic
- Gábor Lipták
- Guy
- Haroon Rafique
- Roland Rosenfeld
- Georg Sauthoff
- David Schmidt (OS/2, Mac OSX ports)
- Joerg Strohmayer
- Sarantis Paskalis
+ Rodrigo Barbosa (RPM specfiles)
+ Moritz Barsnick
+ Hal Burgiss (docs)
+ Karsten Hopp (Red Hat)
+ Alexander Lazic
+ Gábor Lipták
+ Guy
+ Haroon Rafique
+ Roland Rosenfeld (Debian)
+ Georg Sauthoff (Gentoo)
+ David Schmidt (OS/2, Mac OSX ports)
+ Joerg Strohmayer (Amiga)
+ Sarantis Paskalis
Based in part on code originally developed by:
- Junkbusters Corp.
- Anonymous Coders
+ Junkbusters Corp.
+ Anonymous Coders
Thanks to the many people who have tested Privoxy, reported bugs, or made
suggestions. These include (in alphabetical order):
- Ken Arromdee
- Devin Bayer
- Reiner Buehl
- Andrew J. Caines
- Clifford Caoile
- Michael T. Davis
- Peter E
- Aaron Hamid
- Magnus Holmgren
- Paul Lieverse
- Roberto Ragusa
- Maynard Riley
- Bart Schelstraete
- Darren Wiebe
- jwz
+ Ken Arromdee
+ Devin Bayer
+ Reiner Buehl
+ Andrew J. Caines
+ Clifford Caoile
+ Michael T. Davis
+ Peter E
+ Aaron Hamid
+ Magnus Holmgren
+ Daniel Leite
+ Paul Lieverse
+ Roberto Ragusa
+ Maynard Riley
+ Bart Schelstraete
+ Darren Wiebe
+ jwz
+
-------------------------------------------------------------------------------
13. See Also
http://www.privoxy.org/actions/, to submit "misses" to the developers.
+http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/contrib/, cool and fun
+ideas from Privoxy users.
+
http://www.junkbusters.com/ht/en/cookies.html, an explanation how cookies are
used to track web users.
http://www.privoxy.org/developer-manual/, the Privoxy developer manual.
-------------------------------------------------------------------------------
+
14. Appendix
14.1. Regular Expressions
\ - The "escape" character denotes that the following character should be taken
literally. This is used where one of the special characters (e.g. ".") needs to
-be taken literally and not as a special meta-character. Example: "example\.com"
-, makes sure the period is recognized only as a period (and not expanded to its
-meta-character meaning of any single character).
+be taken literally and not as a special meta-character. Example: "example
+\.com", makes sure the period is recognized only as a period (and not expanded
+to its meta-character meaning of any single character).
[] - Characters enclosed in brackets will be matched if any of the enclosed
characters are encountered. For instance, "[0-9]" matches any numeric digit
"/(this|that) example/" uses grouping and the bar character and would match
either "this example" or "that example", and nothing else.
-These are just some of the ones you are likely to use when matching URLs with
+These are just some of the ones you are likely to use when matching URLs with
Privoxy, and is a long way from a definitive list. This is enough to get us
started with a few simple examples which may be more illuminating:
|" means "or". We have two of those. For instance, "(ing|ements?)", can expand
to match either "ing" OR "ements?". What is being done here, is an attempt at
matching as many variations of "advertisement", and similar, as possible. So
-this would expand to match just "adv", or "advert", or "adverts", or
+this would expand to match just "adv", or "advert", or "adverts", or
"advertising", or "advertisement", or "advertisements". You get the idea. But
it would not match "advertizements" (with a "z"). We could fix that by changing
our regular expression to: "/.*/adv((er)?ts?|erti(s|z)(ing|ements?))?/", which
would then match either spelling.
/.*/advert[0-9]+\.(gif|jpe?g) - Again another path statement with forward
-slashes. Anything in the square brackets "[]" can be matched. This is using
+slashes. Anything in the square brackets "[]" can be matched. This is using
"0-9" as a shorthand expression to mean any digit one through nine. It is the
same as saying "0123456789". So any digit matches. The "+" means one or more of
the preceding expression must be included. The preceding expression here is
more digits, and a "." (which is now a literal, and not a special character,
since it is escaped with "\"), and lastly either "gif", or "jpeg", or "jpg".
Some possible matches would include: "//advert1.jpg", "/nasty/ads/
-advert1234.gif", "/banners/from/hell/advert99.jpg". It would not match
+advert1234.gif", "/banners/from/hell/advert99.jpg". It would not match
"advert1.gif" (no leading slash), or "/adverts232.jpg" (the expression does not
include an "s"), or "/advert1.jsp" ("jsp" is not in the expression anywhere).
For information on regular expression based substitutions and their
applications in filters, please see the filter file tutorial in this manual.
+
-------------------------------------------------------------------------------
14.2. Privoxy's Internal Pages
Of course, Privoxy must be running to access these. If not, you will get a
friendly error message. Internet access is not necessary either.
- * Privoxy main page:
+ * Privoxy main page:
-
http://config.privoxy.org/
-
There is a shortcut: http://p.p/ (But it doesn't provide a fall-back to a
real page, in case the request is not sent through Privoxy)
- * Show information about the current configuration, including viewing and
+ * Show information about the current configuration, including viewing and
editing of actions files:
-
http://config.privoxy.org/show-status
+ * Show the source code version numbers:
- * Show the source code version numbers:
-
-
http://config.privoxy.org/show-version
+ * Show the browser's request headers:
- * Show the browser's request headers:
-
-
http://config.privoxy.org/show-request
+ * Show which actions apply to a URL and why:
- * Show which actions apply to a URL and why:
-
-
http://config.privoxy.org/show-url-info
-
- * Toggle Privoxy on or off. In this case, "Privoxy" continues to run, but
+ * Toggle Privoxy on or off. In this case, "Privoxy" continues to run, but
only as a pass-through proxy, with no actions taking place:
-
http://config.privoxy.org/toggle
-
Short cuts. Turn off, then on:
-
http://config.privoxy.org/toggle?set=disable
-
-
http://config.privoxy.org/toggle?set=enable
-
-
These may be bookmarked for quick reference. See next.
+
-------------------------------------------------------------------------------
14.2.1. Bookmarklets
bar (IE) or the "Personal Toolbar" (Netscape), and run them with a single
click.
- * Privoxy - Enable
+ * Privoxy - Enable
- * Privoxy - Disable
+ * Privoxy - Disable
- * Privoxy - Toggle Privoxy (Toggles between enabled and disabled)
+ * Privoxy - Toggle Privoxy (Toggles between enabled and disabled)
- * Privoxy- View Status
+ * Privoxy- View Status
- * Privoxy - Submit Actions File Feedback
+ * Privoxy - Submit Actions File Feedback
- * Privoxy - Why?
+ * Privoxy - Why?
-
Credit: The site which gave us the general idea for these bookmarklets is
www.bookmarklets.com. They have more information about bookmarklets.
+
-------------------------------------------------------------------------------
14.3. Chain of Events
Let's take a quick look at the basic sequence of events when a web page is
requested by your browser and Privoxy is on duty:
- * First, your web browser requests a web page. The browser knows to send the
+ * First, your web browser requests a web page. The browser knows to send the
request to Privoxy, which will in turn, relay the request to the remote web
server after passing the following tests:
- * Privoxy traps any request for its own internal CGI pages (e.g http://p.p/)
+ * Privoxy traps any request for its own internal CGI pages (e.g http://p.p/)
and sends the CGI page back to the browser.
- * Next, Privoxy checks to see if the URL matches any "+block" patterns. If
+ * Next, Privoxy checks to see if the URL matches any "+block" patterns. If
so, the URL is then blocked, and the remote web server will not be
contacted. "+handle-as-image" is then checked and if it does not match, an
HTML "BLOCKED" page is sent back. Otherwise, if it does match, an image is
returned. The type of image depends on the setting of "+set-image-blocker"
(blank, checkerboard pattern, or an HTTP redirect to an image elsewhere).
- * Untrusted URLs are blocked. If URLs are being added to the trust file, then
+ * Untrusted URLs are blocked. If URLs are being added to the trust file, then
that is done.
- * If the URL pattern matches the "+fast-redirects" action, it is then
+ * If the URL pattern matches the "+fast-redirects" action, it is then
processed. Unwanted parts of the requested URL are stripped.
- * Now the rest of the client browser's request headers are processed. If any
+ * Now the rest of the client browser's request headers are processed. If any
of these match any of the relevant actions (e.g. "+hide-user-agent", etc.),
headers are suppressed or forged as determined by these actions and their
parameters.
- * Now the web server starts sending its response back (i.e. typically a web
+ * Now the web server starts sending its response back (i.e. typically a web
page and related data).
- * First, the server headers are read and processed to determine, among other
+ * First, the server headers are read and processed to determine, among other
things, the MIME type (document type) and encoding. The headers are then
- filtered as deterimined by the "+crunch-incoming-cookies",
+ filtered as determined by the "+crunch-incoming-cookies",
"+session-cookies-only", and "+downgrade-http-version" actions.
- * If the "+kill-popups" action applies, and it is an HTML or JavaScript
+ * If the "+kill-popups" action applies, and it is an HTML or JavaScript
document, the popup-code in the response is filtered on-the-fly as it is
received.
- * If a "+filter" or "+deanimate-gifs" action applies (and the document type
+ * If a "+filter" or "+deanimate-gifs" action applies (and the document type
fits the action), the rest of the page is read into memory (up to a
configurable limit). Then the filter rules (from default.filter) are
processed against the buffered content. Filters are applied in the order
If neither "+filter" or "+deanimate-gifs" matches, then Privoxy passes the
raw data through to the client browser as it becomes available.
- * As the browser receives the now (probably filtered) page content, it reads
+ * As the browser receives the now (probably filtered) page content, it reads
and then requests any URLs that may be embedded within the page source,
e.g. ad images, stylesheets, JavaScript, other HTML documents (e.g.
frames), sounds, etc. For each of these objects, the browser issues a new
request. And each such request is in turn processed as above. Note that a
complex web page may have many such embedded URLs.
-
-------------------------------------------------------------------------------
+
14.4. Anatomy of an Action
The way Privoxy applies actions and filters to any given URL can be complex,
But we can define additional actions that would be exceptions to these general
rules, and then list specific URLs (or patterns) that these exceptions would
-apply to. Last match wins. Just below this then are two explicit matches for
+apply to. Last match wins. Just below this then are two explicit matches for
".google.com". The first is negating our previous cookie setting, which was for
"+session-cookies-only" (i.e. not persistent). So we will allow persistent
cookies for google. The second turns off any "+fast-redirects" action, allowing
-this to take place unmolested. Note that there is a leading dot here --
+this to take place unmolested. Note that there is a leading dot here --
".google.com". This will match any hosts and sub-domains, in the google.com
domain also, such as "www.google.com". So, apparently, we have these two
-actions defined somewhere in the lower part of our default.action file, and
+actions defined somewhere in the lower part of our default.action file, and
"google.com" is referenced somewhere in these latter sections.
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
+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:
the first section is causing the problem. This would require some guesswork,
and maybe a little trial and error to isolate the offending rule. One likely
cause would be one of the "{+filter}" actions. These tend to be harder to
-troubleshoot. Try adding the URL for the site to one of aliases that turn off
+troubleshoot. Try adding the URL for the site to one of aliases that turn off
"+filter":
{shop}
resort for problem sites. Remember to flush caches! If this still does not
work, you will have to go through the remaining actions one by one to find
which one(s) is causing the problem.
+
>Coding Guidelines</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
TITLE="Privoxy Developer Manual"
HREF="index.html"><LINK
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="bottom"
><A
HREF="documentation.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="testing.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="CODING"
->4. Coding Guidelines</A
-></H1
+NAME="CODING">4. Coding Guidelines</H1
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
-NAME="S1"
->4.1. Introduction</A
-></H2
+NAME="S1">4.1. Introduction</H2
><P
>This set of standards is designed to make our lives easier. It is
developed with the simple goal of helping us keep the "new and improved
><H2
CLASS="SECT2"
><A
-NAME="S2"
->4.2. Using Comments</A
-></H2
+NAME="S2">4.2. Using Comments</H2
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
-NAME="S3"
->4.2.1. Comment, Comment, Comment</A
-></H3
+NAME="S3">4.2.1. Comment, Comment, Comment</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>Comment as much as possible without commenting the obvious.
If the comment describes something different than what the code
is doing then maybe a programming error is occurring.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
><H3
CLASS="SECT3"
><A
-NAME="S4"
->4.2.2. Use blocks for comments</A
-></H3
+NAME="S4">4.2.2. Use blocks for comments</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>Comments can help or they can clutter. They help when they
and the code. Block identifiers do, by surrounding the code
with a clear, definable pattern.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
></TR
></TABLE
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Exception:</I
+></SPAN
></P
><P
>If you are trying to add a small logic comment and do not
><H3
CLASS="SECT3"
><A
-NAME="S5"
->4.2.3. Keep Comments on their own line</A
-></H3
+NAME="S5">4.2.3. Keep Comments on their own line</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>It goes back to the question of readability. If the comment
at the end of closing braces, when used to comment
parameters.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
><H3
CLASS="SECT3"
><A
-NAME="S6"
->4.2.4. Comment each logical step</A
-></H3
+NAME="S6">4.2.4. Comment each logical step</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>Logical steps should be commented to help others follow the
><H3
CLASS="SECT3"
><A
-NAME="S7"
->4.2.5. Comment All Functions Thoroughly</A
-></H3
+NAME="S7">4.2.5. Comment All Functions Thoroughly</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>A reader of the code should be able to look at the comments
><H3
CLASS="SECT3"
><A
-NAME="S8"
->4.2.6. Comment at the end of braces if the
- content is more than one screen length</A
-></H3
+NAME="S8">4.2.6. Comment at the end of braces if the
+ content is more than one screen length</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>Each closing brace should be followed on the same line by a
>use following a closing brace: } /* -END- if() or while ()
or etc... */</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
><H2
CLASS="SECT2"
><A
-NAME="S9"
->4.3. Naming Conventions</A
-></H2
+NAME="S9">4.3. Naming Conventions</H2
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
-NAME="S10"
->4.3.1. Variable Names</A
-></H3
+NAME="S10">4.3.1. Variable Names</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>Use all lowercase, and separate words via an underscore
template, class, true, false, ...). This is in case we ever
decide to port Privoxy to C++.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
></TR
></TABLE
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Instead of:</I
+></SPAN
></P
><P
><TABLE
><H3
CLASS="SECT3"
><A
-NAME="S11"
->4.3.2. Function Names</A
-></H3
+NAME="S11">4.3.2. Function Names</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>Use all lowercase, and separate words via an underscore
template, class, true, false, ...). This is in case we ever
decide to port Privoxy to C++.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
></TR
></TABLE
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Instead of:</I
+></SPAN
></P
><P
><TABLE
><H3
CLASS="SECT3"
><A
-NAME="S12"
->4.3.3. Header file prototypes</A
-></H3
+NAME="S12">4.3.3. Header file prototypes</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>Use a descriptive parameter name in the function prototype
in header files. Use the same parameter name in the header file
that you use in the c file.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
></TR
></TABLE
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Instead of:</I
+></SPAN
>
<TABLE
BORDER="0"
><H3
CLASS="SECT3"
><A
-NAME="S13"
->4.3.4. Enumerations, and #defines</A
-></H3
+NAME="S13">4.3.4. Enumerations, and #defines</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>Use all capital letters, with underscores between words. Do
not start an identifier with an underscore. (ANSI C reserves
these for use by the compiler and system headers.)</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
></TR
></TABLE
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Note:</I
+></SPAN
> We have a standard naming scheme for #defines
that toggle a feature in the preprocessor: FEATURE_>, where
> is a short (preferably 1 or 2 word) description.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
><H3
CLASS="SECT3"
><A
-NAME="S14"
->4.3.5. Constants</A
-></H3
+NAME="S14">4.3.5. Constants</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>Spell common words out entirely (do not remove vowels).</P
>Use underscore (_) to separate adjacent acronyms and
abbreviations. Never terminate a name with an underscore.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
></TR
></TABLE
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Instead of:</I
+></SPAN
></P
><P
><TABLE
><H2
CLASS="SECT2"
><A
-NAME="S15"
->4.4. Using Space</A
-></H2
+NAME="S15">4.4. Using Space</H2
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
-NAME="S16"
->4.4.1. Put braces on a line by themselves.</A
-></H3
+NAME="S16">4.4.1. Put braces on a line by themselves.</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>The brace needs to be on a line all by itself, not at the
easier to identify the opening and closing braces for a
block.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
></TR
></TABLE
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Instead of:</I
+></SPAN
></P
><P
>if ( this == that ) { ... }</P
><P
>if ( this == that ) { ... }</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Note:</I
+></SPAN
> In the special case that the if-statement is
inside a loop, and it is trivial, i.e. it tests for a
condition that is obvious from the purpose of the block,
one-liners as above may optically preserve the loop structure
and make it easier to read.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Status:</I
+></SPAN
> developer-discretion.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example exception:</I
+></SPAN
></P
><TABLE
BORDER="0"
><H3
CLASS="SECT3"
><A
-NAME="S17"
->4.4.2. ALL control statements should have a
- block</A
-></H3
+NAME="S17">4.4.2. ALL control statements should have a
+ block</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>Using braces to make a block will make your code more
readable and less prone to error. All control statements should
have a block defined.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
></TR
></TABLE
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Instead of:</I
+></SPAN
></P
><P
>if ( this == that ) DoSomething(); DoSomethingElse();</P
><P
>if ( this == that ) DoSomething();</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Note:</I
+></SPAN
> The first example in "Instead of" will execute
in a manner other than that which the developer desired (per
indentation). Using code braces would have prevented this
><H3
CLASS="SECT3"
><A
-NAME="S18"
->4.4.3. Do not belabor/blow-up boolean
- expressions</A
-></H3
+NAME="S18">4.4.3. Do not belabor/blow-up boolean
+ expressions</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
></TR
></TABLE
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Instead of:</I
+></SPAN
></P
><P
>if ( condition ) { structure->flag = 1; } else {
structure->flag = 0; }</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Note:</I
+></SPAN
> The former is readable and concise. The later
is wordy and inefficient. Please assume that any developer new
to the project has at least a "good" knowledge of C/C++. (Hope
><H3
CLASS="SECT3"
><A
-NAME="S19"
->4.4.4. Use white space freely because it is
- free</A
-></H3
+NAME="S19">4.4.4. Use white space freely because it is
+ free</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>Make it readable. The notable exception to using white space
freely is listed in the next guideline.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
><H3
CLASS="SECT3"
><A
-NAME="S20"
->4.4.5. Don't use white space around structure
- operators</A
-></H3
+NAME="S20">4.4.5. Don't use white space around structure
+ operators</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>- structure pointer operator ( "->" ) - member operator (
connection between the object and variable/function name is not
as clear.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
></TR
></TABLE
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Instead of:</I
+></SPAN
> aStruct -> aMember; aStruct . aMember;
FunctionName ();</P
></DIV
><H3
CLASS="SECT3"
><A
-NAME="S21"
->4.4.6. Make the last brace of a function stand
- out</A
-></H3
+NAME="S21">4.4.6. Make the last brace of a function stand
+ out</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
></TR
></TABLE
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Instead of:</I
+></SPAN
></P
><P
>int function1( ... ) { ...code... return( retCode ); } int
function2( ... ) { }</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Note:</I
+></SPAN
> Use 1 blank line before the closing brace and 2
lines afterward. This makes the end of function standout to
the most casual viewer. Although function comments help
"do" loops, and long if {} statements too. After all whitespace
is free!</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Status:</I
+></SPAN
> developer-discretion on the number of blank
lines. Enforced is the end of function comments.</P
></DIV
><H3
CLASS="SECT3"
><A
-NAME="S22"
->4.4.7. Use 3 character indentions</A
-></H3
+NAME="S22">4.4.7. Use 3 character indentions</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>If some use 8 character TABs and some use 3 character TABs,
only. If you like to use TABs, pass your code through a filter
such as "expand -t3" before checking in your code.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
><H2
CLASS="SECT2"
><A
-NAME="S23"
->4.5. Initializing</A
-></H2
+NAME="S23">4.5. Initializing</H2
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
-NAME="S24"
->4.5.1. Initialize all variables</A
-></H3
+NAME="S24">4.5.1. Initialize all variables</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>Do not assume that the variables declared will not be used
the code. Remove the chance of accidentally using an unassigned
variable.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
></TR
></TABLE
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Note:</I
+></SPAN
> It is much easier to debug a SIGSEGV if the
message says you are trying to access memory address 00000000
and not 129FA012; or arrayPtr[20] causes a SIGSEV vs.
arrayPtr[0].</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Status:</I
+></SPAN
> developer-discretion if and only if the
variable is assigned a value "shortly after" declaration.</P
></DIV
><H2
CLASS="SECT2"
><A
-NAME="S25"
->4.6. Functions</A
-></H2
+NAME="S25">4.6. Functions</H2
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
-NAME="S26"
->4.6.1. Name functions that return a boolean as a
- question.</A
-></H3
+NAME="S26">4.6.1. Name functions that return a boolean as a
+ question.</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>Value should be phrased as a question that would logically
be answered as a true or false statement</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
><H3
CLASS="SECT3"
><A
-NAME="S27"
->4.6.2. Always specify a return type for a
- function.</A
-></H3
+NAME="S27">4.6.2. Always specify a return type for a
+ function.</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>The default return for a function is an int. To avoid
><H3
CLASS="SECT3"
><A
-NAME="S28"
->4.6.3. Minimize function calls when iterating by
- using variables</A
-></H3
+NAME="S28">4.6.3. Minimize function calls when iterating by
+ using variables</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>It is easy to write the following code, and a clear argument
can be made that the code is easy to understand:</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
></TR
></TABLE
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Note:</I
+></SPAN
> Unfortunately, this makes a function call for
each and every iteration. This increases the overhead in the
program, because the compiler has to look up the function each
assign the value to a variable, and evaluate using the
variable.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
></TR
></TABLE
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Exceptions:</I
+></SPAN
> if the value of blockListLength() *may*
change or could *potentially* change, then you must code the
function call in the for/while loop.</P
><H3
CLASS="SECT3"
><A
-NAME="S29"
->4.6.4. Pass and Return by Const Reference</A
-></H3
+NAME="S29">4.6.4. Pass and Return by Const Reference</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>This allows a developer to define a const pointer and call
><H3
CLASS="SECT3"
><A
-NAME="S30"
->4.6.5. Pass and Return by Value</A
-></H3
+NAME="S30">4.6.5. Pass and Return by Value</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>Most structures cannot fit onto a normal stack entry (i.e.
><H3
CLASS="SECT3"
><A
-NAME="S31"
->4.6.6. Names of include files</A
-></H3
+NAME="S31">4.6.6. Names of include files</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>Your include statements should contain the file name without
partial path to distinguish their header files from system or
other header files.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
></TR
></TABLE
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Exception:</I
+></SPAN
></P
><P
><TABLE
></TABLE
></P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Note:</I
+></SPAN
> Please! do not add "-I." to the Makefile
without a _very_ good reason. This duplicates the #include
"file.h" behavior.</P
><H3
CLASS="SECT3"
><A
-NAME="S32"
->4.6.7. Provide multiple inclusion
- protection</A
-></H3
+NAME="S32">4.6.7. Provide multiple inclusion
+ protection</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>Prevents compiler and linker errors resulting from
with your file name, with "." Changed to "_", and make it
uppercase.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
><H3
CLASS="SECT3"
><A
-NAME="S33"
->4.6.8. Use `extern "C"` when appropriate</A
-></H3
+NAME="S33">4.6.8. Use `extern "C"` when appropriate</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>If our headers are included from C++, they must declare our
functions as `extern "C"`. This has no cost in C, but increases
the potential re-usability of our code.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
><H3
CLASS="SECT3"
><A
-NAME="S34"
->4.6.9. Where Possible, Use Forward Struct
- Declaration Instead of Includes</A
-></H3
+NAME="S34">4.6.9. Where Possible, Use Forward Struct
+ Declaration Instead of Includes</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>Useful in headers that include pointers to other struct's.
Modifications to excess header files may cause needless
compiles.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
></TR
></TABLE
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Note:</I
+></SPAN
> If you declare "file_list xyz;" (without the
pointer), then including the proper header file is necessary.
If you only want to prototype a pointer, however, the header
file is unnecessary.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Status:</I
+></SPAN
> Use with discretion.</P
></DIV
></DIV
><H2
CLASS="SECT2"
><A
-NAME="S35"
->4.7. General Coding Practices</A
-></H2
+NAME="S35">4.7. General Coding Practices</H2
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
-NAME="S36"
->4.7.1. Turn on warnings</A
-></H3
+NAME="S36">4.7.1. Turn on warnings</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation</I
+></SPAN
></P
><P
>Compiler warnings are meant to help you find bugs. You
><H3
CLASS="SECT3"
><A
-NAME="S37"
->4.7.2. Provide a default case for all switch
- statements</A
-></H3
+NAME="S37">4.7.2. Provide a default case for all switch
+ statements</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>What you think is guaranteed is never really guaranteed. The
someday will be passed. So, to protect yourself from the
unknown, always have a default step in a switch statement.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
></TR
></TABLE
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Note:</I
+></SPAN
> If you already have a default condition, you
are obviously exempt from this point. Of note, most of the
WIN32 code calls `DefWindowProc' after the switch statement.
This API call *should* be included in a default statement.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Another Note:</I
+></SPAN
> This is not so much a readability issue
as a robust programming issue. The "anomaly code goes here" may
be no more than a print to the STDERR stream (as in
load_config). Or it may really be an ABEND condition.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Status:</I
+></SPAN
> Programmer discretion is advised.</P
></DIV
><DIV
><H3
CLASS="SECT3"
><A
-NAME="S38"
->4.7.3. Try to avoid falling through cases in a
- switch statement.</A
-></H3
+NAME="S38">4.7.3. Try to avoid falling through cases in a
+ switch statement.</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>In general, you will want to have a 'break' statement within
><H3
CLASS="SECT3"
><A
-NAME="S39"
->4.7.4. Use 'long' or 'short' Instead of
- 'int'</A
-></H3
+NAME="S39">4.7.4. Use 'long' or 'short' Instead of
+ 'int'</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>On 32-bit platforms, int usually has the range of long. On
16-bit platforms, int has the range of short.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Status:</I
+></SPAN
> 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
><H3
CLASS="SECT3"
><A
-NAME="S40"
->4.7.5. Don't mix size_t and other types</A
-></H3
+NAME="S40">4.7.5. Don't mix size_t and other types</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>The type of size_t varies across platforms. Do not make
><H3
CLASS="SECT3"
><A
-NAME="S41"
->4.7.6. Declare each variable and struct on its
- own line.</A
-></H3
+NAME="S41">4.7.6. Declare each variable and struct on its
+ own line.</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>It can be tempting to declare a series of variables all on
one line. Don't.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
></TR
></TABLE
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Instead of:</I
+></SPAN
></P
><P
>long a, b, c;</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
> - there is more room for comments on the
individual variables - easier to add new variables without
messing up the original ones - when searching on a variable to
find its type, there is less clutter to "visually"
eliminate</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Exceptions:</I
+></SPAN
> when you want to declare a bunch of loop
variables or other trivial variables; feel free to declare them
on 1 line. You should, although, provide a good comment on
their functions.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Status:</I
+></SPAN
> developer-discretion.</P
></DIV
><DIV
><H3
CLASS="SECT3"
><A
-NAME="S42"
->4.7.7. Use malloc/zalloc sparingly</A
-></H3
+NAME="S42">4.7.7. Use malloc/zalloc sparingly</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>Create a local struct (on the stack) if the variable will
>Only "malloc" a struct (on the heap) if the variable's life
will extend beyond the context of one function call.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
><H3
CLASS="SECT3"
><A
-NAME="S43"
->4.7.8. The Programmer Who Uses 'malloc' is
- Responsible for Ensuring 'free'</A
-></H3
+NAME="S43">4.7.8. The Programmer Who Uses 'malloc' is
+ Responsible for Ensuring 'free'</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>If you have to "malloc" an instance, you are responsible for
"good thing (tm)". You may need to offer a
free/unload/destructor type function to accommodate this.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example:</I
+></SPAN
></P
><TABLE
BORDER="0"
></TR
></TABLE
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Exceptions:</I
+></SPAN
></P
><P
>The developer cannot be expected to provide `free'ing
functions for C run-time library functions ... such as
`strdup'.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Status:</I
+></SPAN
> developer-discretion. The "main" use of this
standard is for allocating and freeing data structures (complex
or nested).</P
><H3
CLASS="SECT3"
><A
-NAME="S44"
->4.7.9. Add loaders to the `file_list' structure
- and in order</A
-></H3
+NAME="S44">4.7.9. Add loaders to the `file_list' structure
+ and in order</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>I have ordered all of the "blocker" file code to be in alpha
order. It is easier to add/read new blockers when you expect a
certain order.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Note:</I
+></SPAN
> It may appear that the alpha order is broken in
places by POPUP tests coming before PCRS tests. But since
POPUPs can also be referred to as KILLPOPUPs, it is clear that
><H3
CLASS="SECT3"
><A
-NAME="S45"
->4.7.10. "Uncertain" new code and/or changes to
- existing code, use FIXME</A
-></H3
+NAME="S45">4.7.10. "Uncertain" new code and/or changes to
+ existing code, use FIXME</H3
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Explanation:</I
+></SPAN
></P
><P
>If you have enough confidence in new code or confidence in
>/* FIXME: new code that *may* break something else... */
...new code here...</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Note:</I
+></SPAN
> If you make it clear that this may or may not
be a "good thing (tm)", it will be easier to identify and
include in the project (or conversely exclude from the
><H2
CLASS="SECT2"
><A
-NAME="S46"
->4.8. Addendum: Template for files and function
- comment blocks:</A
-></H2
+NAME="S46">4.8. Addendum: Template for files and function
+ comment blocks:</H2
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example for file comments:</I
+></SPAN
></P
><TABLE
BORDER="0"
><TD
><PRE
CLASS="PROGRAMLISTING"
->const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.46.2.6 2002/08/10 11:40:25 oes Exp $";
+>const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.46.2.8 2002/08/17 00:16:10 hal9 Exp $";
/*********************************************************************
*
* File : $Source$
></TR
></TABLE
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Note:</I
+></SPAN
> 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 change the "Copyright" section
to represent the rights you wish to maintain.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Note:</I
+></SPAN
> The formfeed character that is present right
after the comment flower box is handy for (X|GNU)Emacs users to
skip the verbiage and get to the heart of the code (via
`forward-page' and `backward-page'). Please include it if you
can.</P
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example for file header comments:</I
+></SPAN
></P
><TABLE
BORDER="0"
CLASS="PROGRAMLISTING"
>#ifndef _FILENAME_H
#define _FILENAME_H
-#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.46.2.6 2002/08/10 11:40:25 oes Exp $"
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.46.2.8 2002/08/17 00:16:10 hal9 Exp $"
/*********************************************************************
*
* File : $Source$
></TR
></TABLE
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Example for function comments:</I
+></SPAN
></P
><TABLE
BORDER="0"
></TR
></TABLE
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Note:</I
+></SPAN
> If we all follow this practice, we should be
able to parse our code to create a "self-documenting" web
page.</P
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="documentation.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="testing.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>Contacting the developers, Bug Reporting and Feature Requests</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
TITLE="Privoxy Developer Manual"
HREF="index.html"><LINK
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="bottom"
><A
HREF="webserver-update.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="copyright.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="CONTACT"
->8. Contacting the developers, Bug Reporting and Feature Requests</A
-></H1
+NAME="CONTACT">8. Contacting the developers, Bug Reporting and Feature Requests</H1
><P
> We value your feedback. In fact, we rely on it to improve
<SPAN
><H2
CLASS="SECT2"
><A
-NAME="CONTACT-SUPPORT"
->8.1. Get Support</A
-></H2
+NAME="CONTACT-SUPPORT">8.1. Get Support</H2
><P
> For casual users, our support forum at
<A
><H2
CLASS="SECT2"
><A
-NAME="CONTACT-BUGS"
->8.2. Report Bugs</A
-></H2
+NAME="CONTACT-BUGS">8.2. Report Bugs</H2
><P
-> Please report all bugs <I
+> Please report all bugs <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>only</I
+></SPAN
> through our
bug tracker:
<A
><H2
CLASS="SECT2"
><A
-NAME="CONTACT-FEATURE"
->8.3. Request New Features</A
-></H2
+NAME="CONTACT-FEATURE">8.3. Request New Features</H2
><P
> You are welcome to submit ideas on new features or other proposals
for improvement through our feature request tracker at
><H2
CLASS="SECT2"
><A
-NAME="CONTACT-ADS"
->8.4. Report Ads or Other Actions-Related Problems</A
-></H2
+NAME="CONTACT-ADS">8.4. Report Ads or Other Actions-Related Problems</H2
><P
> Please send feedback on ads that slipped through, innocent images that were blocked,
and any other problems relating to the <TT
><H2
CLASS="SECT2"
><A
-NAME="CONTACT-OTHER"
->8.5. Other</A
-></H2
+NAME="CONTACT-OTHER">8.5. Other</H2
><P
>For any other issues, feel free to use the mailing lists. Technically interested users
and people who wish to contribute to the project are also welcome on the developers list!
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="webserver-update.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="copyright.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>Privoxy Copyright, License and History</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
TITLE="Privoxy Developer Manual"
HREF="index.html"><LINK
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="bottom"
><A
HREF="contact.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="seealso.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="COPYRIGHT"
->9. Privoxy Copyright, License and History</A
-></H1
+NAME="COPYRIGHT">9. Privoxy Copyright, License and History</H1
><P
> Copyright © 2001, 2002 by Privoxy Developers <TT
CLASS="EMAIL"
><H2
CLASS="SECT2"
><A
-NAME="AEN1149"
->9.1. License</A
-></H2
+NAME="AEN1156">9.1. License</H2
><P
> <SPAN
CLASS="APPLICATION"
><H2
CLASS="SECT2"
><A
-NAME="AEN1165"
->9.2. History</A
-></H2
+NAME="AEN1172">9.2. History</H2
><P
> In the beginning, there was the
<A
CLASS="APPLICATION"
>Privoxy</SPAN
>, whose first
- stable release, 3.0, is due late summer or early fall 2002.
+ stable release, 3.0, was released August, 2002.
</P
></DIV
></DIV
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="contact.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="seealso.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>The CVS Repository</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
TITLE="Privoxy Developer Manual"
HREF="index.html"><LINK
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="bottom"
><A
HREF="introduction.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="documentation.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="CVS"
->2. The CVS Repository</A
-></H1
+NAME="CVS">2. The CVS Repository</H1
><P
> If you intend to help us with programming, documentation or packaging
you will need write access to our holy grail, the CVS repository.
><H2
CLASS="SECT2"
><A
-NAME="CVSACCESS"
->2.1. Access to CVS</A
-></H2
+NAME="CVSACCESS">2.1. Access to CVS</H2
><P
> The project's CVS repository is hosted on
<A
><H2
CLASS="SECT2"
><A
-NAME="CVSCOMMIT"
->2.2. CVS Commit Guideline</A
-></H2
+NAME="CVSCOMMIT">2.2. CVS Commit Guideline</H2
><P
> 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
><UL
><LI
><P
-> Never (read: <I
+> Never (read: <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>never, ever</I
+></SPAN
>) be tempted to commit
that small change without testing it thoroughly first. When we're
close to a public release, ask a fellow developer to review your
></LI
><LI
><P
-> Your commit message should give a concise overview of <I
+> Your commit message should give a concise overview of <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>what you
changed</I
-> (no big details) and <I
+></SPAN
+> (no big details) and <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>why you changed it</I
+></SPAN
>
Just check previous messages for good examples.
</P
><H2
CLASS="SECT2"
><A
-NAME="CVSWHENASK"
->2.3. Discussing Changes First</A
-></H2
+NAME="CVSWHENASK">2.3. Discussing Changes First</H2
><P
> We don't have a too formal policy on this, just use common sense. Hints: If it is..
<P
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="introduction.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="documentation.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>Documentation Guidelines</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
TITLE="Privoxy Developer Manual"
HREF="index.html"><LINK
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="bottom"
><A
HREF="cvs.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="coding.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="DOCUMENTATION"
->3. Documentation Guidelines</A
-></H1
+NAME="DOCUMENTATION">3. Documentation Guidelines</H1
><P
> All formal documents are maintained in Docbook SGML and located in the
<TT
>privoxy-index.html</TT
>,
meant for inclusion with doc packages), are maintained as SGML as well.
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>DO NOT edit these directly</I
+></SPAN
>. Edit the SGML source, or
- contact someone involved in the documentation (at present Stefan and
- Hal).
+ contact someone involved in the documentation (at present Hal).
</P
><P
> <TT
CLASS="FILENAME"
>config</TT
>.
-
</P
><P
> Other, less formal documents (e.g. <TT
CLASS="COMPUTEROUTPUT"
>make
redhat-dok</TT
->).
+>). For PDF docs, do <TT
+CLASS="COMPUTEROUTPUT"
+>make
+ dok-pdf</TT
+>.
</P
></LI
><LI
>) so that those without
the ability to build them locally, have access to them if needed.
This is especially important just prior to a new release! Please
- do this <I
+ do this <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>after</I
+></SPAN
> the <TT
CLASS="LITERAL"
>$VERSION</TT
><H2
CLASS="SECT2"
><A
-NAME="SGML"
->3.1. Quickstart to Docbook and SGML</A
-></H2
+NAME="SGML">3.1. Quickstart to Docbook and SGML</H2
><P
> If you are not familiar with SGML, it is a markup language similar to HTML.
Actually, not a mark up language per se, but a language used to define
><TBODY
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
><para></para></I
+></SPAN
>, paragraph delimiter. Most
text needs to be within paragraph elements (there are some exceptions).
</TD
></TR
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
><emphasis></emphasis></I
+></SPAN
>, the stylesheets
make this italics.
</TD
></TR
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
><filename></filename></I
+></SPAN
>, files and directories.
</TD
></TR
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
><command></command></I
+></SPAN
>, command examples.
</TD
></TR
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
><literallayout></literallayout></I
+></SPAN
>, like
<TT
CLASS="LITERAL"
></TR
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
><itemizedlist></itemizedlist></I
+></SPAN
>, list with bullets.
</TD
></TR
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
><listitem></listitem></I
+></SPAN
>, member of the above.
</TD
></TR
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
><screen></screen></I
+></SPAN
>, screen output, implies
<TT
CLASS="LITERAL"
></TR
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
><ulink url="example.com"></ulink></I
+></SPAN
>, like
HTML <TT
CLASS="LITERAL"
></TR
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
><quote></quote></I
+></SPAN
>, for, doh, quoting text.
</TD
></TR
><H2
CLASS="SECT2"
><A
-NAME="DOCSTYLE"
->3.2. <SPAN
+NAME="DOCSTYLE">3.2. <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> Documentation Style</A
-></H2
+> Documentation Style</H2
><P
> It will be easier if everyone follows a similar writing style. This
just makes it easier to read what someone else has written if it
></LI
><LI
><P
-> Tags delimiting a <I
+> Tags delimiting a <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>block</I
+></SPAN
> of text (even small
blocks) should be on their own line. Like:
<P
><LI
><P
> Our documents are available in differing formats. Right now, they
- are just plain text, and HTML, but PDF, and others is always a
+ are just plain text, TML, and PDF, but others are always a
future possibility. Be careful with URLs (<ulink>), and avoid
this mistake:
</P
><H2
CLASS="SECT2"
><A
-NAME="AEN221"
->3.3. Privoxy Custom Entities</A
-></H2
+NAME="AEN222">3.3. Privoxy Custom Entities</H2
><P
> <SPAN
CLASS="APPLICATION"
that is used by multiple docs. This way we can write something once, and use
it repeatedly without having to re-write the same content over and over again.
If editing such a file, keep in mind that it should be
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>generic</I
+></SPAN
>. That is the purpose; so it can be used in varying
contexts without additional modifications.
</P
><TBODY
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>p-version</I
+></SPAN
>: the <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
>
version string, e.g. <SPAN
CLASS="QUOTE"
->"2.9.20"</SPAN
+>"3.0.0"</SPAN
>.
</TD
></TR
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>p-status</I
+></SPAN
>: the project status, either
<SPAN
CLASS="QUOTE"
></TR
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>p-not-stable</I
+></SPAN
>: use to conditionally include
text in <SPAN
CLASS="QUOTE"
></TR
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>p-stable</I
+></SPAN
>: just the opposite.
</TD
></TR
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>p-text</I
+></SPAN
>: this doc is only generated as text.
</TD
></TR
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="cvs.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="coding.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>Privoxy Developer Manual</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="NEXT"
TITLE="Introduction"
HREF="introduction.html"><LINK
><H1
CLASS="TITLE"
><A
-NAME="AEN2"
->Privoxy Developer Manual</A
-></H1
+NAME="AEN2">Privoxy Developer Manual</H1
><P
CLASS="PUBDATE"
> <SUB
<BR></P
><P
CLASS="PUBDATE"
->$Id: developer-manual.sgml,v 1.46.2.6 2002/08/10 11:40:25 oes Exp $<BR></P
+>$Id: developer-manual.sgml,v 1.46.2.8 2002/08/17 00:16:10 hal9 Exp $<BR></P
><DIV
><DIV
CLASS="ABSTRACT"
><A
-NAME="AEN9"
-></A
-><P
+NAME="AEN9"><P
></P
><P
> The developer manual provides guidance on coding, testing, packaging, documentation
for anyone who wants to join the team.</P
><P
> Please note that this document is constantly evolving. This copy represents
- the state at the release of version 2.9.20.
+ the state at the release of version 3.0.0.
You can find the latest version of the this manual at <A
HREF="http://www.privoxy.org/developer-manual/"
TARGET="_top"
></DT
><DT
>3.3. <A
-HREF="documentation.html#AEN221"
+HREF="documentation.html#AEN222"
>Privoxy Custom Entities</A
></DT
></DL
><DL
><DT
>9.1. <A
-HREF="copyright.html#AEN1149"
+HREF="copyright.html#AEN1156"
>License</A
></DT
><DT
>9.2. <A
-HREF="copyright.html#AEN1165"
+HREF="copyright.html#AEN1172"
>History</A
></DT
></DL
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="introduction.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>Introduction</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
TITLE="Privoxy Developer Manual"
HREF="index.html"><LINK
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="bottom"
><A
HREF="index.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="cvs.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="INTRODUCTION"
->1. Introduction</A
-></H1
+NAME="INTRODUCTION">1. Introduction</H1
><P
> <SPAN
CLASS="APPLICATION"
><H2
CLASS="SECT2"
><A
-NAME="QUICKSTART"
->1.1. Quickstart to Privoxy Development</A
-></H2
+NAME="QUICKSTART">1.1. Quickstart to Privoxy Development</H2
><P
> You'll need an account on <A
HREF="http://sourceforge.net/"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="cvs.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>Releasing a New Version</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
TITLE="Privoxy Developer Manual"
HREF="index.html"><LINK
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="bottom"
><A
HREF="testing.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="webserver-update.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="NEWRELEASE"
->6. Releasing a New Version</A
-></H1
+NAME="NEWRELEASE">6. Releasing a New Version</H1
><P
> When we release versions of <SPAN
CLASS="APPLICATION"
><H2
CLASS="SECT2"
><A
-NAME="VERSIONNUMBERS"
->6.1. Version numbers</A
-></H2
+NAME="VERSIONNUMBERS">6.1. Version numbers</H2
><P
> First you need to determine which version number the release will have.
<SPAN
><H2
CLASS="SECT2"
><A
-NAME="BEFORERELEASE"
->6.2. Before the Release: Freeze</A
-></H2
+NAME="BEFORERELEASE">6.2. Before the Release: Freeze</H2
><P
-> The following <I
+> The following <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>must be done by one of the
developers</I
+></SPAN
> prior to each new release.
</P
><P
>,
the man page (and the html version of the man page), and the PDF docs
fall in this category. REAMDE, the man page, AUTHORS, and config
- should all also be committed to CVS for other packageers. The
+ should all also be committed to CVS for other packagers. The
formal docs should be uploaded to the webserver. See the
Section "Updating the webserver" in this manual for details.
</P
></LI
><LI
><P
+> The <I
+CLASS="CITETITLE"
+>User Manual</I
+> is also used for context
+ sensitive help for the CGI editor. This is version sensitive, so that
+ the user will get appropriate help for his/her release. So with
+ each release a fresh version should be uploaded to the webserver
+ (this is in addition to the main <I
+CLASS="CITETITLE"
+>User Manual</I
+>
+ link from the main page since we need to keep manuals for various
+ versions available). The CGI pages will link to something like
+ <TT
+CLASS="LITERAL"
+>http://privoxy.org/$(VERSION)/user-manual/</TT
+>. This
+ will need to be updated for each new release. There is no Makefile
+ target for this at this time!!! It needs to be done manually.
+ </P
+></LI
+><LI
+><P
> All developers should look at the <TT
CLASS="FILENAME"
>ChangeLog</TT
></LI
><LI
><P
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>Commit all files that were changed in the above steps!</I
+></SPAN
>
</P
></LI
><H2
CLASS="SECT2"
><A
-NAME="THERELEASE"
->6.3. Building and Releasing the Packages</A
-></H2
+NAME="THERELEASE">6.3. Building and Releasing the Packages</H2
><P
> Now the individual packages can be built and released. Note that for
GPL reasons the first package to be released is always the source tarball.
</P
><P
-> For <I
+> For <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>all</I
+></SPAN
> types of packages, including the source tarball,
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>you must make sure that you build from clean sources by exporting
the right version from CVS into an empty directory</I
+></SPAN
> (just press return when
asked for a password):
</P
>
</P
><P
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>Do NOT change</I
+></SPAN
> a single bit, including, but not limited to
version information after export from CVS. This is to make sure that
all release packages, and with them, all future bug reports, are based
><H3
CLASS="SECT3"
><A
-NAME="PACK-GUIDELINES"
->6.3.1. Note on Privoxy Packaging</A
-></H3
+NAME="PACK-GUIDELINES">6.3.1. Note on Privoxy Packaging</H3
><P
> Please keep these general guidelines in mind when putting together
- your package. These apply to <I
+ your package. These apply to <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>all</I
+></SPAN
> platforms!
</P
><P
> <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>requires</I
+></SPAN
>
write access to: all <TT
CLASS="FILENAME"
><H3
CLASS="SECT3"
><A
-NAME="NEWRELEASE-TARBALL"
->6.3.2. Source Tarball</A
-></H3
+NAME="NEWRELEASE-TARBALL">6.3.2. Source Tarball</H3
><P
-> First, <I
+> First, <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>make sure that you have freshly exported the right
version into an empty directory</I
+></SPAN
>. (See "Building and releasing
packages" above). Then run:
</P
><H3
CLASS="SECT3"
><A
-NAME="NEWRELEASE-RPM"
->6.3.3. SuSE, Conectiva or Red Hat RPM</A
-></H3
+NAME="NEWRELEASE-RPM">6.3.3. SuSE, Conectiva or Red Hat RPM</H3
><P
> In following text, replace <TT
CLASS="REPLACEABLE"
> for SuSE.
</P
><P
-> First, <I
+> First, <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>make sure that you have freshly exported the right
version into an empty directory</I
+></SPAN
>. (See "Building and releasing
packages" above).
</P
><H3
CLASS="SECT3"
><A
-NAME="NEWRELEASE-OS2"
->6.3.4. OS/2</A
-></H3
+NAME="NEWRELEASE-OS2">6.3.4. OS/2</H3
><P
-> First, <I
+> First, <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>make sure that you have freshly exported the right
version into an empty directory</I
+></SPAN
>. (See "Building and releasing
packages" above). Then get the OS/2 Setup module:
</P
><H3
CLASS="SECT3"
><A
-NAME="NEWRELEASE-SOLARIS"
->6.3.5. Solaris</A
-></H3
+NAME="NEWRELEASE-SOLARIS">6.3.5. Solaris</H3
><P
> Login to Sourceforge's compilefarm via ssh:
</P
</P
><P
> Choose the right operating system (not the Debian one).
- When logged in, <I
+ When logged in, <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>make sure that you have freshly exported the right
version into an empty directory</I
+></SPAN
>. (See "Building and releasing
packages" above). Then run:
</P
><H3
CLASS="SECT3"
><A
-NAME="NEWRELEASE-WINDOWS"
->6.3.6. Windows</A
-></H3
+NAME="NEWRELEASE-WINDOWS">6.3.6. Windows</H3
><P
> You should ensure you have the latest version of Cygwin (from
<A
Run the following commands from within a Cygwin bash shell.
</P
><P
-> First, <I
+> First, <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>make sure that you have freshly exported the right
version into an empty directory</I
+></SPAN
>. (See "Building and releasing
packages" above). Then get the Windows setup module:
</P
><H3
CLASS="SECT3"
><A
-NAME="NEWRELEASE-DEBIAN"
->6.3.7. Debian</A
-></H3
+NAME="NEWRELEASE-DEBIAN">6.3.7. Debian</H3
><P
-> First, <I
+> First, <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>make sure that you have freshly exported the
right version into an empty directory</I
+></SPAN
>. (See
"Building and releasing packages" above). Then add a log
entry to <TT
><TD
><PRE
CLASS="PROGRAMLISTING"
-> debchange -v 2.9.20-beta-1 "New upstream version"</PRE
+> debchange -v 3.0.0-stable-1 "New upstream version"</PRE
></TD
></TR
></TABLE
> This will create
<TT
CLASS="FILENAME"
->../privoxy_2.9.20-beta-1_i386.deb</TT
+>../privoxy_3.0.0-stable-1_i386.deb</TT
>
which can be uploaded. To upload the package to Sourceforge, simply
issue
><H3
CLASS="SECT3"
><A
-NAME="NEWRELEASE-MACOSX"
->6.3.8. Mac OSX</A
-></H3
+NAME="NEWRELEASE-MACOSX">6.3.8. Mac OSX</H3
><P
-> First, <I
+> First, <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>make sure that you have freshly exported the right
version into an empty directory</I
+></SPAN
>. (See "Building and releasing
packages" above). Then get the Mac OSX setup module:
</P
><H3
CLASS="SECT3"
><A
-NAME="NEWRELEASE-FREEBSD"
->6.3.9. FreeBSD</A
-></H3
+NAME="NEWRELEASE-FREEBSD">6.3.9. FreeBSD</H3
><P
> Login to Sourceforge's compile-farm via ssh:
</P
</P
><P
> Choose the right operating system.
- When logged in, <I
+ When logged in, <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>make sure that you have freshly exported the right
version into an empty directory</I
+></SPAN
>. (See "Building and releasing
packages" above). Then run:
</P
><H3
CLASS="SECT3"
><A
-NAME="NEWRELEASE-HPUX"
->6.3.10. HP-UX 11</A
-></H3
+NAME="NEWRELEASE-HPUX">6.3.10. HP-UX 11</H3
><P
-> First, <I
+> First, <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>make sure that you have freshly exported the right
version into an empty directory</I
+></SPAN
>. (See "Building and releasing
packages" above). Then run:
</P
><H3
CLASS="SECT3"
><A
-NAME="NEWRELEASE-AMIGA"
->6.3.11. Amiga OS</A
-></H3
+NAME="NEWRELEASE-AMIGA">6.3.11. Amiga OS</H3
><P
-> First, <I
+> First, <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>make sure that you have freshly exported the right
version into an empty directory</I
+></SPAN
>. (See "Building and releasing
packages" above). Then run:
</P
><H3
CLASS="SECT3"
><A
-NAME="NEWRELEASE-AIX"
->6.3.12. AIX</A
-></H3
+NAME="NEWRELEASE-AIX">6.3.12. AIX</H3
><P
> Login to Sourceforge's compilefarm via ssh:
</P
</P
><P
> Choose the right operating system.
- When logged in, <I
+ When logged in, <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>make sure that you have freshly exported the right
version into an empty directory</I
+></SPAN
>. (See "Building and releasing
packages" above). Then run:
</P
><H2
CLASS="SECT2"
><A
-NAME="RELEASING"
->6.4. Uploading and Releasing Your Package</A
-></H2
+NAME="RELEASING">6.4. Uploading and Releasing Your Package</H2
><P
> After the package is ready, it is time to upload it
to SourceForge, and go through the release steps. The upload
of <TT
CLASS="LITERAL"
>$VERSION ($CODE_STATUS)</TT
->, e.g. <I
+>, e.g. <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
->2.9.20
+>3.0.0
(beta)</I
+></SPAN
>.
</P
><P
><H2
CLASS="SECT2"
><A
-NAME="AFTERRELEASE"
->6.5. After the Release</A
-></H2
+NAME="AFTERRELEASE">6.5. After the Release</H2
><P
> When all (or: most of the) packages have been uploaded and made available,
send an email to the <A
TARGET="_top"
>download
location</A
->, the release notes and the change log.
+>, the release notes and the Changelog. Also, post an
+ updated News item on the project page Sourceforge, and update the Home
+ page and docs linked from the Home page (see below).
</P
></DIV
></DIV
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="testing.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="webserver-update.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>See also</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
TITLE="Privoxy Developer Manual"
HREF="index.html"><LINK
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="bottom"
><A
HREF="copyright.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
><H1
CLASS="SECT1"
><A
-NAME="SEEALSO"
->10. See also</A
-></H1
+NAME="SEEALSO">10. See also</H1
><P
> Other references and sites of interest to <SPAN
CLASS="APPLICATION"
><TR
><TD
> <A
+HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/contrib/"
+TARGET="_top"
+>http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/contrib/</A
+>, cool
+ and fun ideas from <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> users.
+ </TD
+></TR
+></TBODY
+></TABLE
+><P
+></P
+>
+ <P
+></P
+><TABLE
+BORDER="0"
+><TBODY
+><TR
+><TD
+> <A
HREF="http://www.junkbusters.com/ht/en/cookies.html"
TARGET="_top"
>http://www.junkbusters.com/ht/en/cookies.html</A
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="copyright.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
>Testing Guidelines</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
TITLE="Privoxy Developer Manual"
HREF="index.html"><LINK
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="bottom"
><A
HREF="coding.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="newrelease.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="TESTING"
->5. Testing Guidelines</A
-></H1
+NAME="TESTING">5. Testing Guidelines</H1
><P
>To be filled.</P
><DIV
><H2
CLASS="SECT2"
><A
-NAME="TESTING-PLAN"
->5.1. Testplan for releases</A
-></H2
+NAME="TESTING-PLAN">5.1. Testplan for releases</H2
><P
> Explain release numbers. major, minor. developer releases. etc.
><H2
CLASS="SECT2"
><A
-NAME="TESTING-REPORT"
->5.2. Test reports</A
-></H2
+NAME="TESTING-REPORT">5.2. Test reports</H2
><P
>Please submit test reports only with the <A
HREF="http://sourceforge.net/tracker/?func=add&group_id=11118&atid=395005"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="coding.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="newrelease.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>Update the Webserver</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
TITLE="Privoxy Developer Manual"
HREF="index.html"><LINK
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="bottom"
><A
HREF="newrelease.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="contact.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="WEBSERVER-UPDATE"
->7. Update the Webserver</A
-></H1
+NAME="WEBSERVER-UPDATE">7. Update the Webserver</H1
><P
-> When updating the webserver, please follow these steps to make
- sure that no broken links, inconsistent contents or permission
- problems will occur:
+> The webserver should be updated at least with each stable release. When
+ updating, please follow these steps to make sure that no broken links,
+ inconsistent contents or permission problems will occur (as it has many
+ times in the past!):
</P
><P
-> If you have changed anything in the documentation source SGML files,
- do:
+> If you have changed anything in the stable-branch documentation source
+ SGML files, do:
</P
><P
> <TABLE
><TD
><PRE
CLASS="PROGRAMLISTING"
-> make dok # (or make redhat-dok if make dok doesn't work for you)</PRE
+> make dok dok-pdf # (or 'make redhat-dok dok-pdf' if 'make dok' doesn't work for you)</PRE
></TD
></TR
></TABLE
<TT
CLASS="FILENAME"
>doc/webserver/faq</TT
+>,
+ <TT
+CLASS="FILENAME"
+>doc/pdf/*.pdf</TT
> and
<TT
CLASS="FILENAME"
> automatically.
</P
><P
-> If you changed the manual page source, generate
+> If you changed the manual page sources, generate
<TT
CLASS="FILENAME"
>doc/webserver/man-page/privoxy-man-page.html</TT
>make man</B
>"</SPAN
>. (This is
- a separate target due to dependencies on some obscure perl scripts.
- See comments in <TT
+ a separate target due to dependencies on some obscure perl scripts
+ [now in CVS, but not well tested]. See comments in <TT
CLASS="FILENAME"
>GNUmakefile</TT
>.)
>).
</P
><P
-> Next, commit any changes from the above steps to CVS. All set? Then do
+> Next, commit any changes from the above steps to CVS. All set?
+ If these are docs in the stable branch, then do:
</P
><P
> <TABLE
there are group writable.
</P
><P
-> Please do <I
+> Please do <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>NOT</I
+></SPAN
> use any other means of transferring
- files to the webserver to avoid permission problems.
+ files to the webserver to avoid permission problems. Also, please do not
+ upload docs from development branches or versions. The publicly posted
+ docs should be in sync with the last official release.
</P
></DIV
><DIV
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="newrelease.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="contact.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>Configuration</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
TITLE="Privoxy Frequently Asked Questions"
HREF="index.html"><LINK
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="bottom"
><A
HREF="installation.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="misc.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="CONFIGURATION"
->3. Configuration</A
-></H1
+NAME="CONFIGURATION">3. Configuration</H1
><DIV
CLASS="SECT2"
><H3
CLASS="SECT2"
><A
-NAME="GETUPDATES"
->3.1. Where can I get updated Actions Files?</A
-></H3
+NAME="GETUPDATES">3.1. Where can I get updated Actions Files?</H3
><P
> Based on your feedback and the continuing development, updated actions files will be
made available on the <A
><H3
CLASS="SECT2"
><A
-NAME="NEWCONFIG"
->3.2. Can I use my old config files?</A
-></H3
+NAME="NEWCONFIG">3.2. Can I use my old config files?</H3
><P
> The syntax, number, and purpose of configuration files has substantially
changed from <SPAN
><H3
CLASS="SECT2"
><A
-NAME="AEN266"
->3.3. What is an <SPAN
+NAME="AEN266">3.3. What is an <SPAN
CLASS="QUOTE"
>"actions"</SPAN
-> file?</A
-></H3
+> file?</H3
><P
> <A
HREF="../user-manual/actions-file.html"
><H3
CLASS="SECT2"
><A
-NAME="ACTIONSS"
->3.4. The <SPAN
+NAME="ACTIONSS">3.4. The <SPAN
CLASS="QUOTE"
>"actions"</SPAN
> concept confuses me. Please list
some of these <SPAN
CLASS="QUOTE"
>"actions"</SPAN
->.</A
-></H3
+>.</H3
><P
> For a comprehensive discussion of the actions concept, please refer
to the <A
><H3
CLASS="SECT2"
><A
-NAME="AEN285"
->3.5. How are actions files configured? What is the easiest
-way to do this?</A
-></H3
+NAME="AEN285">3.5. How are actions files configured? What is the easiest
+way to do this?</H3
><P
> Actions files are just text files in a special syntax and can be edited
- with a text editor. The probably easiest way is to access
+ with a text editor. But probably the easiest way is to access
<SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
><H3
CLASS="SECT2"
><A
-NAME="AEN293"
->3.6. There are several different <SPAN
+NAME="AEN293">3.6. There are several different <SPAN
CLASS="QUOTE"
>"actions"</SPAN
> files. What are
-the differences?</A
-></H3
+the differences?</H3
><P
> As of <SPAN
CLASS="APPLICATION"
><H3
CLASS="SECT2"
><A
-NAME="YAHOO"
->3.7. How can I make my Yahoo/Hotmail/GMX account work?</A
-></H3
+NAME="YAHOO">3.7. How can I make my Yahoo/Hotmail/GMX account work?</H3
><P
> The default configuration shouldn't impact the usability of any of these services.
It will, however, make all cookies temporary, so that your browser will forget your
><H3
CLASS="SECT2"
><A
-NAME="CONFIGFILES"
->3.8. What's the difference between the
+NAME="CONFIGFILES">3.8. What's the difference between the
<SPAN
CLASS="QUOTE"
>"Cautious"</SPAN
> and <SPAN
CLASS="QUOTE"
>"Advanced"</SPAN
-> defaults?</A
-></H3
+> defaults?</H3
><P
> Configuring <SPAN
CLASS="APPLICATION"
><DIV
CLASS="TABLE"
><A
-NAME="AEN328"
-></A
-><P
+NAME="AEN328"><P
><B
>Table 1. Default Configurations</B
></P
><H3
CLASS="SECT2"
><A
-NAME="BROWSECONFIG"
->3.9. Why can I change the configuration
-with a browser? Does that not raise security issues?</A
-></H3
+NAME="BROWSECONFIG">3.9. Why can I change the configuration
+with a browser? Does that not raise security issues?</H3
><P
> It may seem strange that regular users can edit the config files with their
browsers, although the whole <TT
><H3
CLASS="SECT2"
><A
-NAME="AEN431"
->3.10. What is the <TT
+NAME="AEN431">3.10. What is the <TT
CLASS="FILENAME"
>default.filter</TT
> file? What is a <SPAN
CLASS="QUOTE"
>"filter"</SPAN
->?</A
-></H3
+>?</H3
><P
> The <A
HREF="../user-manual/filter-file.html"
>default.filter</TT
></A
>
- file is where <I
+ file is where <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>filters</I
+></SPAN
> are defined, which can be used to modify or
- remove, web page content on the fly. Filters apply to <I
+ remove, web page content on the fly. Filters apply to <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>anything</I
+></SPAN
>
in the page source, including HTML tags, and JavaScript. Regular expressions are used
to accomplish this. There are a number of pre-defined filters to deal with common
><H3
CLASS="SECT2"
><A
-NAME="AEN447"
->3.11. How can I set up <SPAN
+NAME="AEN447">3.11. How can I set up <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
> to act as a proxy for my
- LAN?</A
-></H3
+ LAN?</H3
><P
> By default, <SPAN
CLASS="APPLICATION"
><H3
CLASS="SECT2"
><A
-NAME="AEN465"
->3.12. Instead of ads, now I get a checkerboard pattern. I don't want to see anything.</A
-></H3
+NAME="AEN465">3.12. Instead of ads, now I get a checkerboard pattern. I don't want to see anything.</H3
><P
> The replacement for blocked images can be controlled with the <A
HREF="../user-manual/actions-file.html#SET-IMAGE-BLOCKER"
>handle-as-image</A
></TT
>
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>and</I
+></SPAN
> <TT
CLASS="LITERAL"
><A
><H3
CLASS="SECT2"
><A
-NAME="AEN482"
->3.13. Why would anybody want to see a checkerboard pattern?</A
-></H3
+NAME="AEN482">3.13. Why would anybody want to see a checkerboard pattern?</H3
><P
> Remember that <A
HREF="general.html#WHATSANAD"
decent, but it shows you that and where images were blocked, which can be very
helpful in case some navigation aid or otherwise innocent image was
erraneously blocked. Some people might also enjoy seeing how many banners
- they <I
+ they <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>don't</I
+></SPAN
> have to see..</P
></DIV
><DIV
><H3
CLASS="SECT2"
><A
-NAME="AEN487"
->3.14. I see some images being replaced by a text
-instead of the checkerboard image. Why and how do I get rid of this?</A
-></H3
+NAME="AEN487">3.14. I see some images being replaced by a text
+instead of the checkerboard image. Why and how do I get rid of this?</H3
><P
> This happens when the banners are not embedded in the HTML code of the
page itself, but in separate HTML (sub)documents that are loaded into (i)frames
><H3
CLASS="SECT2"
><A
-NAME="SRVANY"
->3.15. Can <SPAN
+NAME="SRVANY">3.15. Can <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
> run as a service
-on Win2K/NT?</A
-></H3
+on Win2K/NT?</H3
><P
> Yes, it can run as a system service using <B
CLASS="COMMAND"
><H3
CLASS="SECT2"
><A
-NAME="OTHERPROXY"
->3.16. How can I make <SPAN
+NAME="OTHERPROXY">3.16. How can I make <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
> work with other
proxies like <SPAN
CLASS="APPLICATION"
>Squid</SPAN
->?</A
-></H3
+>?</H3
><P
> This can be done and is often useful to combine the benefits of
<SPAN
><H3
CLASS="SECT2"
><A
-NAME="TRANSPARENT"
->3.17. Can <SPAN
+NAME="PORT-80">3.17. Can I just set <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> to use port 80
+and thus avoid individual browser configuration?</H3
+><P
+> No, its more complicated than that. This only works with special kinds
+ of proxies known as <SPAN
+CLASS="QUOTE"
+>"transparent"</SPAN
+> proxies (see below).</P
+></DIV
+><DIV
+CLASS="SECT2"
+><H3
+CLASS="SECT2"
+><A
+NAME="TRANSPARENT">3.18. Can <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
> run as a <SPAN
CLASS="QUOTE"
>"transparent"</SPAN
-> proxy?</A
-></H3
+> proxy?</H3
><P
> No, <SPAN
CLASS="APPLICATION"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="installation.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="misc.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>Contacting the developers, Bug Reporting and Feature Requests</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
TITLE="Privoxy Frequently Asked Questions"
HREF="index.html"><LINK
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="bottom"
><A
HREF="trouble.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="copyright.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="CONTACT"
->6. Contacting the developers, Bug Reporting and Feature Requests</A
-></H1
+NAME="CONTACT">6. Contacting the developers, Bug Reporting and Feature Requests</H1
><P
> We value your feedback. In fact, we rely on it to improve
<SPAN
><H2
CLASS="SECT2"
><A
-NAME="CONTACT-SUPPORT"
->6.1. Get Support</A
-></H2
+NAME="CONTACT-SUPPORT">6.1. Get Support</H2
><P
> For casual users, our support forum at
<A
><H2
CLASS="SECT2"
><A
-NAME="CONTACT-BUGS"
->6.2. Report Bugs</A
-></H2
+NAME="CONTACT-BUGS">6.2. Report Bugs</H2
><P
-> Please report all bugs <I
+> Please report all bugs <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>only</I
+></SPAN
> through our
bug tracker:
<A
><H2
CLASS="SECT2"
><A
-NAME="CONTACT-FEATURE"
->6.3. Request New Features</A
-></H2
+NAME="CONTACT-FEATURE">6.3. Request New Features</H2
><P
> You are welcome to submit ideas on new features or other proposals
for improvement through our feature request tracker at
><H2
CLASS="SECT2"
><A
-NAME="CONTACT-ADS"
->6.4. Report Ads or Other Actions-Related Problems</A
-></H2
+NAME="CONTACT-ADS">6.4. Report Ads or Other Actions-Related Problems</H2
><P
> Please send feedback on ads that slipped through, innocent images that were blocked,
and any other problems relating to the <TT
><H2
CLASS="SECT2"
><A
-NAME="CONTACT-OTHER"
->6.5. Other</A
-></H2
+NAME="CONTACT-OTHER">6.5. Other</H2
><P
>For any other issues, feel free to use the mailing lists. Technically interested users
and people who wish to contribute to the project are also welcome on the developers list!
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="trouble.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="copyright.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>Privoxy Copyright, License and History</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
TITLE="Privoxy Frequently Asked Questions"
HREF="index.html"><LINK
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="bottom"
><A
HREF="contact.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
><H1
CLASS="SECT1"
><A
-NAME="COPYRIGHT"
->7. Privoxy Copyright, License and History</A
-></H1
+NAME="COPYRIGHT">7. Privoxy Copyright, License and History</H1
><P
> Copyright © 2001, 2002 by Privoxy Developers <TT
CLASS="EMAIL"
><H2
CLASS="SECT2"
><A
-NAME="AEN841"
->7.1. License</A
-></H2
+NAME="AEN891">7.1. License</H2
><P
> <SPAN
CLASS="APPLICATION"
><H2
CLASS="SECT2"
><A
-NAME="AEN857"
->7.2. History</A
-></H2
+NAME="AEN907">7.2. History</H2
><P
> In the beginning, there was the
<A
CLASS="APPLICATION"
>Privoxy</SPAN
>, whose first
- stable release, 3.0, is due late summer or early fall 2002.
+ stable release, 3.0, was released August, 2002.
</P
></DIV
></DIV
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="contact.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
>General Information</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
TITLE="Privoxy Frequently Asked Questions"
HREF="index.html"><LINK
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="bottom"
><A
HREF="index.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="installation.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="GENERAL"
->1. General Information</A
-></H1
+NAME="GENERAL">1. General Information</H1
><DIV
CLASS="SECT2"
><H3
CLASS="SECT2"
><A
-NAME="NEWJB"
->1.1. What is this new version of <SPAN
+NAME="NEWJB">1.1. What is this new version of <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
->?</A
-></H3
+>?</H3
><P
> In the beginning, there was the
<A
CLASS="APPLICATION"
>Privoxy</SPAN
>, whose first
- stable release, 3.0, is due late summer or early fall 2002.
+ stable release, 3.0, was released August, 2002.
</P
></DIV
><DIV
><H3
CLASS="SECT2"
><A
-NAME="AEN45"
->1.2. Why <SPAN
+NAME="AEN45">1.2. Why <SPAN
CLASS="QUOTE"
>"Privoxy"</SPAN
->? Why a name change at all?</A
-></H3
+>? Why a name change at all?</H3
><P
> <SPAN
CLASS="APPLICATION"
> is the
<SPAN
CLASS="QUOTE"
->"<I
+>"<SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>Privacy Enhancing Proxy</I
+></SPAN
>"</SPAN
>. Also, its content
modification and junk suppression allow you to browse your
<SPAN
CLASS="QUOTE"
->"<I
+>"<SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>private</I
+></SPAN
> edition"</SPAN
> of the web.</P
><P
><P
> The developers also believed that there are so many changes from the original
code, that it was time to make a clean break from the past and make
- a name in their own right, especially now with the pending
- release of version 3.0.</P
+ a name in their own right.</P
></DIV
><DIV
CLASS="SECT2"
><H3
CLASS="SECT2"
><A
-NAME="DIFFERS"
->1.3. How does <SPAN
+NAME="DIFFERS">1.3. How does <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
> differ
from the old <SPAN
CLASS="APPLICATION"
>Junkbuster?</SPAN
-></A
></H3
><P
> <SPAN
><H3
CLASS="SECT2"
><A
-NAME="PROXYMORON"
->1.4. What is a <SPAN
+NAME="PROXYMORON">1.4. What is a <SPAN
CLASS="QUOTE"
>"proxy"</SPAN
>? How does
<SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> work?</A
-></H3
+> work?</H3
><P
> A web proxy is a service, based on a software such as <SPAN
CLASS="APPLICATION"
><H3
CLASS="SECT2"
><A
-NAME="WHATSANAD"
->1.5. How does <SPAN
+NAME="WHATSANAD">1.5. How does <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
> know what is
-an ad, and what is not?</A
-></H3
+an ad, and what is not?</H3
><P
> <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
>'s approach to blocking ads is twofold:</P
><P
-> First, there are certain patterns in the <I
+> First, there are certain patterns in the <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>locations</I
+></SPAN
> (URLs)
of banner images. This applies to both the path (you wouldn't guess how many
web sites serve their banners from a directory called <SPAN
patterns</A
> to sort out and block the requests for banners.</P
><P
-> Second, banners tend to come in certain <I
+> Second, banners tend to come in certain <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>sizes</I
+></SPAN
>. But you
can't tell the size of an image by its URL without downloading it, and if you
do, it's too late to save bandwidth. Therefore, <SPAN
><H3
CLASS="SECT2"
><A
-NAME="AEN136"
->1.6. Can <SPAN
+NAME="AEN136">1.6. Can <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
> make mistakes?
-This does not sound very scientific.</A
-></H3
+This does not sound very scientific.</H3
><P
> Actually, it's a black art ;-) And yes, it is always possible to have a broad
rule accidentally block or change something by mistake. There is a good chance
><H3
CLASS="SECT2"
><A
-NAME="BROWSERS2"
->1.7. My browser does the same things as
+NAME="BROWSERS2">1.7. My browser does the same things as
<SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
<SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> at all?</A
-></H3
+> at all?</H3
><P
-> Modern browsers do indeed have <I
+> Modern browsers do indeed have <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>some</I
+></SPAN
> of the same
functionality as <SPAN
CLASS="APPLICATION"
><H3
CLASS="SECT2"
><A
-NAME="LICENSE"
->1.8. Is there is a license or fee? What about a
-warranty? Registration?</A
-></H3
+NAME="LICENSE">1.8. Is there is a license or fee? What about a
+warranty? Registration?</H3
><P
> <SPAN
CLASS="APPLICATION"
that should be included.
</P
><P
-> There is <I
+> There is <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>no warranty</I
+></SPAN
> of any kind, expressed, implied or otherwise.
That is something that would cost real money ;-) There is no registration either.
<SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> really is <I
+> really is <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>free</I
+></SPAN
>
in every respect!
</P
><H3
CLASS="SECT2"
><A
-NAME="JOINTEAM"
->1.9. I would like to help you, what do I do?</A
-></H3
+NAME="JOINTEAM">1.9. I would like to help you, what do I do?</H3
><DIV
CLASS="SECT3"
><H4
CLASS="SECT3"
><A
-NAME="JOINTEAM-MONEY"
->1.9.1. Money Money Money</A
-></H4
+NAME="JOINTEAM-MONEY">1.9.1. Money Money Money</H4
><P
> We, of course, welcome donations and could use money for domain registering,
buying software to test <SPAN
><H4
CLASS="SECT3"
><A
-NAME="JOINTEAM-SOFTWARE"
->1.9.2. Software</A
-></H4
+NAME="JOINTEAM-SOFTWARE">1.9.2. Software</H4
><P
> If you are a vendor of a web-related software like a browser, web server
or proxy, and would like us to ensure that <SPAN
><H4
CLASS="SECT3"
><A
-NAME="JOINTEAM-WORK"
->1.9.3. You want to work with us?</A
-></H4
+NAME="JOINTEAM-WORK">1.9.3. You want to work with us?</H4
><P
> Well, helping the team is always a good idea. We welcome new developers,
packaging gurus or documentation writers. Simply <A
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="installation.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>Privoxy Frequently Asked Questions</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="NEXT"
TITLE="General Information"
HREF="general.html"><LINK
><H1
CLASS="TITLE"
><A
-NAME="AEN2"
->Privoxy Frequently Asked Questions</A
-></H1
+NAME="AEN2">Privoxy Frequently Asked Questions</H1
><P
CLASS="PUBDATE"
> <SUB
><BR></P
><P
CLASS="PUBDATE"
->$Id: faq.sgml,v 1.61.2.15 2002/08/10 11:34:22 oes Exp $<BR></P
+>$Id: faq.sgml,v 1.61.2.18 2002/08/14 16:39:37 hal9 Exp $<BR></P
><DIV
><DIV
CLASS="ABSTRACT"
><A
-NAME="AEN9"
-></A
-><P
+NAME="AEN9"><P
></P
><P
> This FAQ gives quick answers to frequently asked questions about
>User Manual</I
></A
>.
+
</P
><P
> <SPAN
> (tm).</P
><P
> Please note that this document is constantly evolving. This copy represents
- the state at the release of version 2.9.20.
+ the state at the release of version 3.0.0.
You can find the latest version of the document at <A
HREF="http://www.privoxy.org/faq/"
TARGET="_top"
></DT
><DT
>3.17. <A
+HREF="configuration.html#PORT-80"
+>Can I just set <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> to use port 80
+and thus avoid individual browser configuration?</A
+></DT
+><DT
+>3.18. <A
HREF="configuration.html#TRANSPARENT"
>Can <SPAN
CLASS="APPLICATION"
><DL
><DT
>4.1. <A
-HREF="misc.html#AEN523"
+HREF="misc.html#AEN528"
>How much does <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
></DT
><DT
>4.7. <A
-HREF="misc.html#AEN583"
+HREF="misc.html#AEN588"
>Can <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
></DT
><DT
>4.8. <A
-HREF="misc.html#AEN594"
+HREF="misc.html#AEN599"
>Might some things break because header information or
content is being altered?</A
></DT
><DT
>4.9. <A
-HREF="misc.html#AEN605"
+HREF="misc.html#AEN610"
>Can <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
></DT
><DT
>4.10. <A
-HREF="misc.html#AEN615"
+HREF="misc.html#AEN620"
>What about as a firewall? Can <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
></DT
><DT
>4.11. <A
-HREF="misc.html#AEN621"
+HREF="misc.html#AEN626"
>I have large empty spaces / a checkerboard pattern now where
ads used to be. Why?</A
></DT
><DT
>4.12. <A
-HREF="misc.html#AEN626"
+HREF="misc.html#AEN631"
>How can <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
></DT
><DT
>4.13. <A
-HREF="misc.html#AEN637"
+HREF="misc.html#AEN642"
><SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
></DT
><DT
>4.16. <A
+HREF="misc.html#CRUNCH"
+>My logs show <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> <SPAN
+CLASS="QUOTE"
+>"crunches"</SPAN
+>
+ads, but also its own CGI pages. What is a <SPAN
+CLASS="QUOTE"
+>"crunch"</SPAN
+>?</A
+></DT
+><DT
+>4.17. <A
+HREF="misc.html#DOWNLOADS"
+>Can <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> effect files that I download
+from a webserver? FTP server?</A
+></DT
+><DT
+>4.18. <A
HREF="misc.html#SEEALSO"
>Where can I find more information about <SPAN
CLASS="APPLICATION"
><DL
><DT
>5.1. <A
-HREF="trouble.html#AEN718"
+HREF="trouble.html#AEN755"
>I just upgraded and am getting <SPAN
CLASS="QUOTE"
>"connection refused"</SPAN
></DT
><DT
>5.2. <A
-HREF="trouble.html#AEN731"
+HREF="trouble.html#AEN768"
>I just added a new rule, but the steenkin ad is
still getting through. How?</A
></DT
uninstall it. Now the finder tells me I don't have sufficient privileges to
empty the trash.</A
></DT
+><DT
+>5.8. <A
+HREF="trouble.html#BLANKPAGE"
+>I get a completely blank page at one site. <SPAN
+CLASS="QUOTE"
+>"View Source"</SPAN
+>
+ shows only: <SPAN
+CLASS="MARKUP"
+><html><body></body></html></SPAN
+>.</A
+></DT
></DL
></DD
><DT
><DL
><DT
>7.1. <A
-HREF="copyright.html#AEN841"
+HREF="copyright.html#AEN891"
>License</A
></DT
><DT
>7.2. <A
-HREF="copyright.html#AEN857"
+HREF="copyright.html#AEN907"
>History</A
></DT
></DL
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="general.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>Installation</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
TITLE="Privoxy Frequently Asked Questions"
HREF="index.html"><LINK
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="bottom"
><A
HREF="general.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="configuration.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="INSTALLATION"
->2. Installation</A
-></H1
+NAME="INSTALLATION">2. Installation</H1
><DIV
CLASS="SECT2"
><H3
CLASS="SECT2"
><A
-NAME="WHICHBROWSERS"
->2.1. Which browsers are supported by <SPAN
+NAME="WHICHBROWSERS">2.1. Which browsers are supported by <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
->?</A
-></H3
+>?</H3
><P
> Any browser that can be configured to use a proxy, which
should be virtually all browsers. Direct browser support is not necessary
><H3
CLASS="SECT2"
><A
-NAME="WHICHOS"
->2.2. Which operating systems are supported?</A
-></H3
+NAME="WHICHOS">2.2. Which operating systems are supported?</H3
><P
> At present, <SPAN
CLASS="APPLICATION"
><H3
CLASS="SECT2"
><A
-NAME="NEWINSTALL"
->2.3. Can I install
+NAME="NEWINSTALL">2.3. Can I install
<SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
> over <SPAN
CLASS="APPLICATION"
>Junkbuster</SPAN
->?</A
-></H3
+>?</H3
><P
> We recommend you un-install <SPAN
CLASS="APPLICATION"
><H3
CLASS="SECT2"
><A
-NAME="AEN209"
->2.4. I just installed <SPAN
+NAME="AEN209">2.4. I just installed <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
>. Is there anything
-special I have to do now?</A
-></H3
+special I have to do now?</H3
><P
> All browsers must be told to use <SPAN
CLASS="APPLICATION"
><H3
CLASS="SECT2"
><A
-NAME="LOCALHOST"
->2.5. What is the proxy address of <SPAN
+NAME="LOCALHOST">2.5. What is the proxy address of <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
->?</A
-></H3
+>?</H3
><P
> If you set up the <SPAN
CLASS="APPLICATION"
><H3
CLASS="SECT2"
><A
-NAME="NOTHING"
->2.6. I just installed <SPAN
+NAME="NOTHING">2.6. I just installed <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
>, and nothing is happening.
-All the ads are there. What's wrong?</A
-></H3
+All the ads are there. What's wrong?</H3
><P
> Did you configure your browser to use <SPAN
CLASS="APPLICATION"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="general.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="configuration.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>Miscellaneous</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
TITLE="Privoxy Frequently Asked Questions"
HREF="index.html"><LINK
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="bottom"
><A
HREF="configuration.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="trouble.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="MISC"
->4. Miscellaneous</A
-></H1
+NAME="MISC">4. Miscellaneous</H1
><DIV
CLASS="SECT2"
><H3
CLASS="SECT2"
><A
-NAME="AEN523"
->4.1. How much does <SPAN
+NAME="AEN528">4.1. How much does <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
> slow my browsing down? This
-has to add extra time to browsing.</A
-></H3
+has to add extra time to browsing.</H3
><P
> It should not slow you down any in real terms, and may actually help
speed things up since ads, banners and other junk are not being displayed.
><H3
CLASS="SECT2"
><A
-NAME="LOADINGTIMES"
->4.2. I noticed considerable
-delays in page requests compared to the old Junkbuster. What's wrong?</A
-></H3
+NAME="LOADINGTIMES">4.2. I noticed considerable
+delays in page requests compared to the old Junkbuster. What's wrong?</H3
><P
> If you use any <TT
CLASS="LITERAL"
><H3
CLASS="SECT2"
><A
-NAME="CONFIGURL"
->4.3. What are "http://config.privoxy.org/" and
-"http://p.p/"?</A
-></H3
+NAME="CONFIGURL">4.3. What are "http://config.privoxy.org/" and
+"http://p.p/"?</H3
><P
> <A
HREF="http://config.privoxy.org/"
CLASS="APPLICATION"
>Privoxy</SPAN
> for the request,
- hence it could not be intercepted, and you have accessed the <I
+ hence it could not be intercepted, and you have accessed the <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>real</I
+></SPAN
>
web site at config.privoxy.org.</P
><P
>Privoxy</SPAN
>, http://example.com/show-proxy-args and http://i.j.b/,
are no longer supported. If you still use such an old version, you should really consider
- upgrading to 2.9.20.</P
+ upgrading to 3.0.0.</P
></DIV
><DIV
CLASS="SECT2"
><H3
CLASS="SECT2"
><A
-NAME="BLOCKLIST"
->4.4. Do you still maintain the blocklists?</A
-></H3
+NAME="BLOCKLIST">4.4. Do you still maintain the blocklists?</H3
><P
> No. The patterns for blocking now reside (among other things) in the <A
HREF="../user-manual/actions-file.html"
><H3
CLASS="SECT2"
><A
-NAME="NEWADS"
->4.5. How can I submit new ads?</A
-></H3
+NAME="NEWADS">4.5. How can I submit new ads?</H3
><P
>Yes, absolutely! Please see the <A
HREF="contact.html"
><H3
CLASS="SECT2"
><A
-NAME="IP"
->4.6. How can I hide my IP address?</A
-></H3
+NAME="IP">4.6. How can I hide my IP address?</H3
><P
> If you run both the browser and the proxy locally, you cannot hide your IP
address with <SPAN
><H3
CLASS="SECT2"
><A
-NAME="AEN583"
->4.7. Can <SPAN
+NAME="AEN588">4.7. Can <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> guarantee I am anonymous?</A
-></H3
+> guarantee I am anonymous?</H3
><P
> No. Your chances of remaining anonymous are greatly improved, but unless you
are an expert on Internet security it would be safest to assume that
CLASS="APPLICATION"
>Privoxy</SPAN
> can remove various information about you,
- and allows <I
+ and allows <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>you</I
+></SPAN
> more freedom to decide which sites
you can trust, and what details you want to reveal. But it's still possible
that web sites can find out who you are. Here's one way this can happen.</P
><H3
CLASS="SECT2"
><A
-NAME="AEN594"
->4.8. Might some things break because header information or
-content is being altered?</A
-></H3
+NAME="AEN599">4.8. Might some things break because header information or
+content is being altered?</H3
><P
> Definitely. More and more sites use HTTP header content to decide what to
display and how to display it. There is many ways that this can be handled,
><H3
CLASS="SECT2"
><A
-NAME="AEN605"
->4.9. Can <SPAN
+NAME="AEN610">4.9. Can <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
> act as a <SPAN
CLASS="QUOTE"
>"caching"</SPAN
> proxy to
-speed up web browsing?</A
-></H3
+speed up web browsing?</H3
><P
> No, it does not have this ability at all. You want something like
<A
><H3
CLASS="SECT2"
><A
-NAME="AEN615"
->4.10. What about as a firewall? Can <SPAN
+NAME="AEN620">4.10. What about as a firewall? Can <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> protect me?</A
-></H3
+> protect me?</H3
><P
> Not in the way you mean, or in the way a true firewall can.
<SPAN
>Privoxy</SPAN
> can help protect your privacy, but not
protect you from intrusion attempts. It is, of course, perfectly possible
- and recommended to use <I
+ and recommended to use <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>both</I
+></SPAN
>.</P
></DIV
><DIV
><H3
CLASS="SECT2"
><A
-NAME="AEN621"
->4.11. I have large empty spaces / a checkerboard pattern now where
-ads used to be. Why?</A
-></H3
+NAME="AEN626">4.11. I have large empty spaces / a checkerboard pattern now where
+ads used to be. Why?</H3
><P
> It would be technically possible eliminate the banners in a way that frees
their screen estate in many cases, by doing all banner blocking with filters,
><H3
CLASS="SECT2"
><A
-NAME="AEN626"
->4.12. How can <SPAN
+NAME="AEN631">4.12. How can <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> filter Secure (HTTPS) URLs?</A
-></H3
+> filter Secure (HTTPS) URLs?</H3
><P
> Since secure HTTP connections are encrypted SSL sessions between your browser
- and the secure site, and are meant to be reliably <I
+ and the secure site, and are meant to be reliably <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>secure</I
+></SPAN
>,
there is little that <SPAN
CLASS="APPLICATION"
><H3
CLASS="SECT2"
><A
-NAME="AEN637"
->4.13. <SPAN
+NAME="AEN642">4.13. <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
> runs as a <SPAN
CLASS="QUOTE"
>"server"</SPAN
>. How
-secure is it? Do I need to take any special precautions?</A
-></H3
+secure is it? Do I need to take any special precautions?</H3
><P
> There are no known exploits that might affect
<SPAN
><H3
CLASS="SECT2"
><A
-NAME="TURNOFF"
->4.14. How can I temporarily disable <SPAN
+NAME="TURNOFF">4.14. How can I temporarily disable <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
->?</A
-></H3
+>?</H3
><P
> The easiest way is to access <SPAN
CLASS="APPLICATION"
><H3
CLASS="SECT2"
><A
-NAME="REALLYOFF"
->4.15. When <SPAN
+NAME="REALLYOFF">4.15. When <SPAN
CLASS="QUOTE"
>"disabled"</SPAN
> is <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
> totally
-out of the picture?</A
-></H3
+out of the picture?</H3
><P
> No, this just means all filtering and actions are disabled.
<SPAN
><H3
CLASS="SECT2"
><A
-NAME="SEEALSO"
->4.16. Where can I find more information about <SPAN
+NAME="CRUNCH">4.16. My logs show <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> <SPAN
+CLASS="QUOTE"
+>"crunches"</SPAN
+>
+ads, but also its own CGI pages. What is a <SPAN
+CLASS="QUOTE"
+>"crunch"</SPAN
+>?</H3
+><P
+> A <SPAN
+CLASS="QUOTE"
+>"crunch"</SPAN
+> simply means <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> intercepted
+ <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>something</I
+></SPAN
+>, nothing more. Often this is indeed ads or
+ banners, but <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> uses the same mechanism for
+ trapping requests for its own internal pages. For instance, a request for
+ <SPAN
+CLASS="APPLICATION"
+>Privoxy's</SPAN
+> configuration page at: <A
+HREF="http://config.privoxy.org"
+TARGET="_top"
+>http://config.privoxy.org</A
+>, is
+ intercepted (i.e. it does not go out to the 'net), and the familiar CGI
+ configuration is returned to the browser, and the log consequently will show
+ a <SPAN
+CLASS="QUOTE"
+>"crunch"</SPAN
+>.</P
+></DIV
+><DIV
+CLASS="SECT2"
+><H3
+CLASS="SECT2"
+><A
+NAME="DOWNLOADS">4.17. Can <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> effect files that I download
+from a webserver? FTP server?</H3
+><P
+> From the webserver's perspective, there is no difference between
+ viewing a document (i.e. a page), and downloading a file. The same is true of
+ <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>. If there is a match for a <TT
+CLASS="LITERAL"
+><A
+HREF="../user-manual/actions-file.html#BLOCK"
+TARGET="_top"
+>block</A
+></TT
+> pattern,
+ it will still be blocked, and of course this is obvious. Filtering is
+ potentially more of a concern since the results are not always so obvious.</P
+><P
+> <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> knows the differences in files according
+ to the <SPAN
+CLASS="QUOTE"
+>"Document Type"</SPAN
+> as reported by the webserver. If this is
+ reported accurately (e.g. <SPAN
+CLASS="QUOTE"
+>"application/zip"</SPAN
+> for a zip archive),
+ then <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> knows to ignore these where
+ appropriate. It is possible, however, that documents that are of an unknown
+ type (generally assumed to be <SPAN
+CLASS="QUOTE"
+>"text/plain"</SPAN
+>) will be filtered, as
+ will those that might be incorrectly reported by the webserver. If such a
+ file is a downloaded file that is intended to be saved to disk, then any
+ content that might have been altered by filtering, will be saved too, for
+ these (probably very rare) cases.</P
+><P
+> <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> does not do FTP at all, only HTTP
+ protocols.</P
+></DIV
+><DIV
+CLASS="SECT2"
+><H3
+CLASS="SECT2"
+><A
+NAME="SEEALSO">4.18. Where can I find more information about <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
>
-and related issues?</A
-></H3
+and related issues?</H3
><P
> Other references and sites of interest to <SPAN
CLASS="APPLICATION"
><TR
><TD
> <A
+HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/contrib/"
+TARGET="_top"
+>http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/contrib/</A
+>, cool
+ and fun ideas from <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> users.
+ </TD
+></TR
+></TBODY
+></TABLE
+><P
+></P
+>
+ <P
+></P
+><TABLE
+BORDER="0"
+><TBODY
+><TR
+><TD
+> <A
HREF="http://www.junkbusters.com/ht/en/cookies.html"
TARGET="_top"
>http://www.junkbusters.com/ht/en/cookies.html</A
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="configuration.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="trouble.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>Troubleshooting</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
TITLE="Privoxy Frequently Asked Questions"
HREF="index.html"><LINK
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="bottom"
><A
HREF="misc.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="contact.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="TROUBLE"
->5. Troubleshooting</A
-></H1
+NAME="TROUBLE">5. Troubleshooting</H1
><DIV
CLASS="SECT2"
><H3
CLASS="SECT2"
><A
-NAME="AEN718"
->5.1. I just upgraded and am getting <SPAN
+NAME="AEN755">5.1. I just upgraded and am getting <SPAN
CLASS="QUOTE"
>"connection refused"</SPAN
>
-with every web page?</A
-></H3
+with every web page?</H3
><P
> Either <SPAN
CLASS="APPLICATION"
><H3
CLASS="SECT2"
><A
-NAME="AEN731"
->5.2. I just added a new rule, but the steenkin ad is
-still getting through. How?</A
-></H3
+NAME="AEN768">5.2. I just added a new rule, but the steenkin ad is
+still getting through. How?</H3
><P
> If the ad had been displayed before you added its URL, it will probably be
held in the browser's cache for some time, so it will be displayed without
><H3
CLASS="SECT2"
><A
-NAME="BADSITE"
->5.3. One of my favorite sites does not work with <SPAN
+NAME="BADSITE">5.3. One of my favorite sites does not work with <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
>.
-What can I do?</A
-></H3
+What can I do?</H3
><P
> First verify that it is indeed a <SPAN
CLASS="APPLICATION"
><H3
CLASS="SECT2"
><A
-NAME="DUN"
->5.4. After installing <SPAN
+NAME="DUN">5.4. After installing <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
>, I have to log in
-every time I start IE. What gives?</A
-></H3
+every time I start IE. What gives?</H3
><P
> This is a quirk that effects the installation of
<SPAN
><H3
CLASS="SECT2"
><A
-NAME="FTP"
->5.5. I cannot connect to any FTP sites. <SPAN
+NAME="FTP">5.5. I cannot connect to any FTP sites. <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
>
- seems to be blocking me.</A
-></H3
+ seems to be blocking me.</H3
><P
> <SPAN
CLASS="APPLICATION"
><H3
CLASS="SECT2"
><A
-NAME="OSXIE"
->5.6. In Mac OSX, I can't configure Microsoft Internet Explorer to use
+NAME="OSXIE">5.6. In Mac OSX, I can't configure Microsoft Internet Explorer to use
<SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> as the HTTP proxy.</A
-></H3
+> as the HTTP proxy.</H3
><P
> Microsoft Internet Explorer (in versions like 5.1) respects system-wide
network settings. In order to change the HTTP proxy, open System
><H3
CLASS="SECT2"
><A
-NAME="OSXUNINSTALL"
->5.7. In Mac OSX, I dragged the Privoxy folder to the trash in order to
+NAME="OSXUNINSTALL">5.7. In Mac OSX, I dragged the Privoxy folder to the trash in order to
uninstall it. Now the finder tells me I don't have sufficient privileges to
- empty the trash.</A
-></H3
+ empty the trash.</H3
><P
> Just dragging the <SPAN
CLASS="APPLICATION"
from the desktop should make it appear empty again.
</P
></DIV
+><DIV
+CLASS="SECT2"
+><H3
+CLASS="SECT2"
+><A
+NAME="BLANKPAGE">5.8. I get a completely blank page at one site. <SPAN
+CLASS="QUOTE"
+>"View Source"</SPAN
+>
+ shows only: <SPAN
+CLASS="MARKUP"
+><html><body></body></html></SPAN
+>.</H3
+><P
+> This is often the result of a webserver using
+ <SPAN
+CLASS="APPLICATION"
+>PHP</SPAN
+> that mishandles the request
+ <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> sends to not compress the content
+ (a <SPAN
+CLASS="APPLICATION"
+>PHP</SPAN
+> bug).
+ </P
+><P
+> In a default configuration, <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> requests all
+ data be sent <SPAN
+CLASS="QUOTE"
+>"uncompressed"</SPAN
+>. This is required for the page
+ filtering and other magic to work. In some rare cases, the browser and
+ webserver miscommunicate and the result is a totally blank page. The
+ suggested work around is to selectively turn off this feature for sites
+ that exhibit such behavior. Example section for <TT
+CLASS="FILENAME"
+>user.action</TT
+>:
+ </P
+><TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+> # Make exceptions for ill-behaved sites:
+ #
+ {-prevent-compression}
+ .example.com</PRE
+></TD
+></TR
+></TABLE
+></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="misc.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="contact.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>Privoxy - Home Page</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><META
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><META
NAME="KEYWORD"
CONTENT="privoxy"><META
NAME="KEYWORD"
><H1
CLASS="TITLE"
><A
-NAME="AEN2"
->Privoxy - Home Page</A
-></H1
+NAME="AEN2">Privoxy - Home Page</H1
><DIV
><DIV
CLASS="ABSTRACT"
><A
-NAME="AEN28"
-></A
-><P
+NAME="AEN28"><P
></P
><P
->
- </P
-><P
> <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
Junkbuster</SPAN
> (tm).</P
><P
-> The most recent release is 2.9.20 (beta).
+> The most recent release is 3.0.0 (stable).
</P
><P
></P
><HR></DIV
><DIV
CLASS="SECT1"
-><H2
+><H3
CLASS="SECT1"
><A
-NAME="DOWNLOAD"
->Download</A
-></H2
+NAME="DOWNLOAD">Download</H3
><P
> <P
></P
></DIV
><DIV
CLASS="SECT1"
-><HR><H2
+><HR><H3
CLASS="SECT1"
><A
-NAME="DOCS"
->Documentation</A
-></H2
+NAME="DOCS">Documentation</H3
><P
> <P
></P
><LI
><P
> <A
+HREF="pdf/privoxy-pdf-docs.zip"
+TARGET="_top"
+>The above docs as PDF in Zip archive</A
+>
+ </P
+></LI
+><LI
+><P
+> <A
HREF="man-page/privoxy-man-page.html"
TARGET="_top"
>Classic Man Page</A
></DIV
><DIV
CLASS="SECT1"
-><HR><H2
+><HR><H3
CLASS="SECT1"
><A
-NAME="MOREINFO"
->More information</A
-></H2
+NAME="MOREINFO">More information</H3
><P
> <P
></P
></DIV
><DIV
CLASS="SECT1"
-><HR><H1
+><HR><H2
CLASS="SECT1"
><A
-NAME="AEN91"
-></A
-></H1
+NAME="AEN92"></H2
><P
><DIV
CLASS="INFORMALTABLE"
><A
-NAME="AEN94"
-></A
-><P
+NAME="AEN95"><P
></P
><TABLE
BORDER="0"
NAME="AEN2">Privoxy - The Privacy Enhancing Proxy</H1
><H2
CLASS="SUBTITLE"
->Project Index Page v2.9.18</H2
+>Project Index Page v3.0.0</H2
><DIV
><DIV
CLASS="ABSTRACT"
NAME="AEN29"><P
></P
><P
->
- </P
-><P
> <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
><HR><H2
CLASS="SECT1"
><A
-NAME="AEN91"></H2
+NAME="AEN89"></H2
><P
> <SUB
> Copyright © 2001, 2002 by Privoxy Developers
>Actions Files</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
-TITLE="Privoxy 2.9.20 User Manual"
+TITLE="Privoxy 3.0.0 User Manual"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="The Main Configuration File"
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
><TH
COLSPAN="3"
ALIGN="center"
->Privoxy 2.9.20 User Manual</TH
+>Privoxy 3.0.0 User Manual</TH
></TR
><TR
><TD
VALIGN="bottom"
><A
HREF="config.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="filter-file.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="ACTIONS-FILE"
->8. Actions Files</A
-></H1
+NAME="ACTIONS-FILE">8. Actions Files</H1
><P
> The actions files are used to define what actions
<SPAN
CLASS="FILENAME"
>default.action</TT
>. These have increasing levels of
- aggressiveness <I
+ aggressiveness <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>and have no influence on your browsing unless
you select them explicitly in the editor</I
+></SPAN
>. It is not recommend
to edit this file.
</P
>alias section</A
> at the top of that file.
Then comes the default set of rules which will apply universally to all
- sites and pages (be <I
+ sites and pages (be <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>very careful</I
+></SPAN
> with using such a
universal set in <TT
CLASS="FILENAME"
><H2
CLASS="SECT2"
><A
-NAME="AEN1640"
->8.1. Finding the Right Mix</A
-></H2
+NAME="AEN1640">8.1. Finding the Right Mix</H2
><P
> Note that some <A
HREF="actions-file.html#ACTIONS"
><H2
CLASS="SECT2"
><A
-NAME="AEN1647"
->8.2. How to Edit</A
-></H2
+NAME="AEN1647">8.2. How to Edit</H2
><P
> The easiest way to edit the actions files is with a browser by
using our browser-based editor, which can be reached from <A
><H2
CLASS="SECT2"
><A
-NAME="ACTIONS-APPLY"
->8.3. How Actions are Applied to URLs</A
-></H2
+NAME="ACTIONS-APPLY">8.3. How Actions are Applied to URLs</H2
><P
> Actions files are divided into sections. There are special sections,
like the <SPAN
>block</A
> }</TT
>, resulting
- in <I
+ in <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>both</I
+></SPAN
> actions to apply.</P
><P
> You can trace this process for any given URL by visiting <A
><H2
CLASS="SECT2"
><A
-NAME="AF-PATTERNS"
->8.4. Patterns</A
-></H2
+NAME="AF-PATTERNS">8.4. Patterns</H2
><P
> Generally, a pattern has the form <TT
CLASS="LITERAL"
CLASS="LITERAL"
>/index.html</TT
>, regardless of the domain,
- i.e. on <I
+ i.e. on <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>any</I
+></SPAN
> web server.
</P
></DD
><H3
CLASS="SECT3"
><A
-NAME="AEN1711"
->8.4.1. The Domain Pattern</A
-></H3
+NAME="AEN1711">8.4.1. The Domain Pattern</H3
><P
> The matching of the domain part offers some flexible options: if the
domain starts or ends with a dot, it becomes unanchored at that end.
></DT
><DD
><P
-> matches any domain that <I
+> matches any domain that <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>ENDS</I
+></SPAN
> in
<TT
CLASS="LITERAL"
></DT
><DD
><P
-> matches any domain that <I
+> matches any domain that <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>STARTS</I
+></SPAN
> with
<TT
CLASS="LITERAL"
></DT
><DD
><P
-> matches any domain that <I
+> matches any domain that <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>CONTAINS</I
+></SPAN
> <TT
CLASS="LITERAL"
>.example.</TT
<TT
CLASS="LITERAL"
>wwwz.example.com</TT
-> etc., but <I
+> etc., but <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>not</I
+></SPAN
>
<TT
CLASS="LITERAL"
><H3
CLASS="SECT3"
><A
-NAME="AEN1773"
->8.4.2. The Path Pattern</A
-></H3
+NAME="AEN1773">8.4.2. The Path Pattern</H3
><P
> <SPAN
CLASS="APPLICATION"
> (regular expression speak
for the beginning of a line).</P
><P
-> Please also note that matching in the path is <I
+> Please also note that matching in the path is <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>CASE INSENSITIVE</I
+></SPAN
>
by default, but you can switch to case sensitive at any point in the pattern by using the
<SPAN
CLASS="LITERAL"
>PaTtErN</TT
> in
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>exactly</I
+></SPAN
> this capitalization.</P
></DIV
></DIV
><H2
CLASS="SECT2"
><A
-NAME="ACTIONS"
->8.5. Actions</A
-></H2
+NAME="ACTIONS">8.5. Actions</H2
><P
> All actions are disabled by default, until they are explicitly enabled
somewhere in an actions file. Actions are turned on if preceded with a
>
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, <I
+ same URL, but with different parameters, <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>all</I
+></SPAN
> the parameters
- from <I
+ from <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>all</I
+></SPAN
> 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:
><H4
CLASS="SECT3"
><A
-NAME="ADD-HEADER"
->8.5.1. add-header</A
-></H4
+NAME="ADD-HEADER">8.5.1. add-header</H4
><P
></P
><DIV
><H4
CLASS="SECT3"
><A
-NAME="BLOCK"
->8.5.2. block</A
-></H4
+NAME="BLOCK">8.5.2. block</H4
><P
></P
><DIV
</P
><P
>
- A very important exception occurs if <I
+ A very important exception occurs if <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>both</I
+></SPAN
>
<TT
CLASS="LITERAL"
><H4
CLASS="SECT3"
><A
-NAME="CRUNCH-INCOMING-COOKIES"
->8.5.3. crunch-incoming-cookies</A
-></H4
+NAME="CRUNCH-INCOMING-COOKIES">8.5.3. crunch-incoming-cookies</H4
><P
></P
><DIV
>Notes:</DT
><DD
><P
-> This action is only concerned with <I
+> This action is only concerned with <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>incoming</I
+></SPAN
> cookies. For
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>outgoing</I
+></SPAN
> cookies, use
<TT
CLASS="LITERAL"
>crunch-outgoing-cookies</A
></TT
>.
- Use <I
+ Use <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>both</I
+></SPAN
> to disable cookies completely.
</P
><P
-> It makes <I
+> It makes <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>no sense at all</I
+></SPAN
> to use this action in conjunction
with the <TT
CLASS="LITERAL"
><H4
CLASS="SECT3"
><A
-NAME="CRUNCH-OUTGOING-COOKIES"
->8.5.4. crunch-outgoing-cookies</A
-></H4
+NAME="CRUNCH-OUTGOING-COOKIES">8.5.4. crunch-outgoing-cookies</H4
><P
></P
><DIV
>Notes:</DT
><DD
><P
-> This action is only concerned with <I
+> This action is only concerned with <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>outgoing</I
+></SPAN
> cookies. For
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>incoming</I
+></SPAN
> cookies, use
<TT
CLASS="LITERAL"
>crunch-incoming-cookies</A
></TT
>.
- Use <I
+ Use <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>both</I
+></SPAN
> to disable cookies completely.
</P
><P
-> It makes <I
+> It makes <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>no sense at all</I
+></SPAN
> to use this action in conjunction
with the <TT
CLASS="LITERAL"
><H4
CLASS="SECT3"
><A
-NAME="DEANIMATE-GIFS"
->8.5.5. deanimate-gifs</A
-></H4
+NAME="DEANIMATE-GIFS">8.5.5. deanimate-gifs</H4
><P
></P
><DIV
><H4
CLASS="SECT3"
><A
-NAME="DOWNGRADE-HTTP-VERSION"
->8.5.6. downgrade-http-version</A
-></H4
+NAME="DOWNGRADE-HTTP-VERSION">8.5.6. downgrade-http-version</H4
><P
></P
><DIV
><H4
CLASS="SECT3"
><A
-NAME="FAST-REDIRECTS"
->8.5.7. fast-redirects</A
-></H4
+NAME="FAST-REDIRECTS">8.5.7. fast-redirects</H4
><P
></P
><DIV
will link to some script on their own servers, giving the destination as a
parameter, which will then redirect you to the final target. URLs
resulting from this scheme typically look like:
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>http://some.place/click-tracker.cgi?target=http://some.where.else</I
+></SPAN
>.
</P
><P
><H4
CLASS="SECT3"
><A
-NAME="FILTER"
->8.5.8. filter</A
-></H4
+NAME="FILTER">8.5.8. filter</H4
><P
></P
><DIV
><TD
><PRE
CLASS="SCREEN"
->+filter{banners-by-size} # Kill banners based on their size for this page (<I
+>+filter{banners-by-size} # Kill banners based on their size for this page (<SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>very</I
+></SPAN
> efficient!)</PRE
></TD
></TR
><TD
><PRE
CLASS="SCREEN"
->+filter{js-events} # Kill all JS event bindings (<I
+>+filter{js-events} # Kill all JS event bindings (<SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>Radically destructive!</I
+></SPAN
> Only for extra nasty sites) </PRE
></TD
></TR
><H4
CLASS="SECT3"
><A
-NAME="HANDLE-AS-IMAGE"
->8.5.9. handle-as-image</A
-></H4
+NAME="HANDLE-AS-IMAGE">8.5.9. handle-as-image</H4
><P
></P
><DIV
>Typical use:</DT
><DD
><P
->Mark URLs as belonging to images (so they'll be replaced by images <I
+>Mark URLs as belonging to images (so they'll be replaced by images <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>if they get blocked</I
+></SPAN
>)</P
></DD
><DT
HREF="actions-file.html#BLOCK"
>block</A
></TT
-> action <I
+> action <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>also applies</I
+></SPAN
>,
the presence or absence of this mark decides whether an HTML <SPAN
CLASS="QUOTE"
><H4
CLASS="SECT3"
><A
-NAME="HIDE-FORWARDED-FOR-HEADERS"
->8.5.10. hide-forwarded-for-headers</A
-></H4
+NAME="HIDE-FORWARDED-FOR-HEADERS">8.5.10. hide-forwarded-for-headers</H4
><P
></P
><DIV
><H4
CLASS="SECT3"
><A
-NAME="HIDE-FROM-HEADER"
->8.5.11. hide-from-header</A
-></H4
+NAME="HIDE-FROM-HEADER">8.5.11. hide-from-header</H4
><P
></P
><DIV
><H4
CLASS="SECT3"
><A
-NAME="HIDE-REFERRER"
->8.5.12. hide-referrer</A
-></H4
+NAME="HIDE-REFERRER">8.5.12. hide-referrer</H4
><A
NAME="HIDE-REFERER"
></A
> is the preferred option here, since some servers will
not send images back otherwise, in an attempt to prevent their valuable
content from being embedded elsewhere (and hence, without being surrounded
- by <I
+ by <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>their</I
+></SPAN
> banners).
</P
><P
><H4
CLASS="SECT3"
><A
-NAME="HIDE-USER-AGENT"
->8.5.13. hide-user-agent</A
-></H4
+NAME="HIDE-USER-AGENT">8.5.13. hide-user-agent</H4
><P
></P
><DIV
><P
> This breaks many web sites that depend on looking at this header in order
to customize their content for different browsers (which, by the
- way, is <I
+ way, is <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>NOT</I
+></SPAN
> a <A
HREF="http://www.javascriptkit.com/javaindex.shtml"
TARGET="_top"
CLASS="APPLICATION"
>Privoxy</SPAN
> is
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>not recommended</I
+></SPAN
>. In single-user, single-browser
setups, you might use it to delete your OS version information from
the headers, because it is an invitation to exploit known bugs for your
><H4
CLASS="SECT3"
><A
-NAME="KILL-POPUPS"
->8.5.14. kill-popups<A
+NAME="KILL-POPUPS">8.5.14. kill-popups<A
NAME="KILL-POPUP"
></A
-></A
></H4
><P
></P
>Privoxy</SPAN
>.
If the only kind of pop-ups that you want to kill are exit consoles (those
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>really nasty</I
+></SPAN
> windows that appear when you close an other
one), you might want to use
<TT
><H4
CLASS="SECT3"
><A
-NAME="LIMIT-CONNECT"
->8.5.15. limit-connect</A
-></H4
+NAME="LIMIT-CONNECT">8.5.15. limit-connect</H4
><P
></P
><DIV
><H4
CLASS="SECT3"
><A
-NAME="PREVENT-COMPRESSION"
->8.5.16. prevent-compression</A
-></H4
+NAME="PREVENT-COMPRESSION">8.5.16. prevent-compression</H4
><P
></P
><DIV
><H4
CLASS="SECT3"
><A
-NAME="SEND-VANILLA-WAFER"
->8.5.17. send-vanilla-wafer</A
-></H4
+NAME="SEND-VANILLA-WAFER">8.5.17. send-vanilla-wafer</H4
><P
></P
><DIV
><H4
CLASS="SECT3"
><A
-NAME="SEND-WAFER"
->8.5.18. send-wafer</A
-></H4
+NAME="SEND-WAFER">8.5.18. send-wafer</H4
><P
></P
><DIV
><H4
CLASS="SECT3"
><A
-NAME="SESSION-COOKIES-ONLY"
->8.5.19. session-cookies-only</A
-></H4
+NAME="SESSION-COOKIES-ONLY">8.5.19. session-cookies-only</H4
><P
></P
><DIV
> Allow only temporary <SPAN
CLASS="QUOTE"
>"session"</SPAN
-> cookies (for the current browser session <I
+> cookies (for the current browser session <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>only</I
+></SPAN
>).
</P
></DD
sites, and is the recommended setting.
</P
><P
-> It makes <I
+> It makes <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>no sense at all</I
+></SPAN
> to use <TT
CLASS="LITERAL"
>session-cookies-only</TT
><H4
CLASS="SECT3"
><A
-NAME="SET-IMAGE-BLOCKER"
->8.5.20. set-image-blocker</A
-></H4
+NAME="SET-IMAGE-BLOCKER">8.5.20. set-image-blocker</H4
><P
></P
><DIV
>Effect:</DT
><DD
><P
-> This action alone doesn't do anything noticeable. If <I
+> This action alone doesn't do anything noticeable. If <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>both</I
+></SPAN
>
<TT
CLASS="LITERAL"
HREF="actions-file.html#BLOCK"
>block</A
></TT
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>and</I
+></SPAN
> <TT
CLASS="LITERAL"
><A
HREF="actions-file.html#HANDLE-AS-IMAGE"
>handle-as-image</A
></TT
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>also</I
+></SPAN
>
apply, i.e. if the request is to be blocked as an image,
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>then</I
+></SPAN
> the parameter of this action decides what will be
sent as a replacement.
</P
> There is a third (advanced) type, called <SPAN
CLASS="QUOTE"
>"auto"</SPAN
->. It is <I
+>. It is <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>NOT</I
+></SPAN
> to be
used in <TT
CLASS="LITERAL"
><H3
CLASS="SECT3"
><A
-NAME="AEN2701"
->8.5.21. Summary</A
-></H3
+NAME="AEN2701">8.5.21. Summary</H3
><P
> Note that many of these actions have the potential to cause a page to
misbehave, possibly even not to display at all. There are many ways
><H2
CLASS="SECT2"
><A
-NAME="ALIASES"
->8.6. Aliases</A
-></H2
+NAME="ALIASES">8.6. Aliases</H2
><P
> Custom <SPAN
CLASS="QUOTE"
> and <SPAN
CLASS="QUOTE"
>"}"</SPAN
->, but we <I
+>, but we <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>strongly
recommend</I
+></SPAN
> that you only use <SPAN
CLASS="QUOTE"
>"a"</SPAN
> sign, since they are merely textually
expanded.</P
><P
-> Aliases can be used throughout the actions file, but they <I
+> Aliases can be used throughout the actions file, but they <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>must be
defined in a special section at the top of the file!</I
+></SPAN
>
And there can only be one such section per actions file. Each actions file may
have its own alias section, and the aliases defined in it are only visible
CLASS="QUOTE"
>"shop"</SPAN
>, you can later change your policy on shops in
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>one</I
+></SPAN
> place, and your changes will take effect everywhere
in the actions file where the <SPAN
CLASS="QUOTE"
><H2
CLASS="SECT2"
><A
-NAME="ACT-EXAMPLES"
->8.7. Actions Files Tutorial</A
-></H2
+NAME="ACT-EXAMPLES">8.7. Actions Files Tutorial</H2
><P
> The above chapters have shown <A
HREF="actions-file.html"
><H3
CLASS="SECT3"
><A
-NAME="AEN2753"
->8.7.1. default.action</A
-></H3
+NAME="AEN2753">8.7.1. default.action</H3
><P
>Every config file should start with a short comment stating its purpose:</P
><P
></P
><P
> Now come the regular sections, i.e. sets of actions, accompanied
- by URL patterns to which they apply. Remember <I
+ by URL patterns to which they apply. Remember <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>all actions
are disabled when matching starts</I
+></SPAN
>, so we have to explicitly
enable the ones we want.</P
><P
set of actions used in this <SPAN
CLASS="QUOTE"
>"default"</SPAN
-> section <I
+> section <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>will
be applied to all requests as a start</I
+></SPAN
>. It can be partly or
wholly overridden by later matches further down this file, or in user.action,
but it will still be largely responsible for your overall browsing
>"general policy"</SPAN
> that applies
universally and won't get any exceptions defined later. Other choices,
- like not blocking (which is <I
+ like not blocking (which is <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>understandably</I
+></SPAN
> the
default!) need exceptions, i.e. we need to specify explicitly what we
want to block in later sections.
CLASS="APPLICATION"
>Privoxy</SPAN
> knows which
- URLs belong to images, so that <I
+ URLs belong to images, so that <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>if</I
+></SPAN
> they are to
be blocked, a substitute image can be sent, rather than an HTML page.
Contacting the remote site to find out is not an option, since it
would destroy the loading time advantage of banner blocking, and it
- would feed the advertisers (in terms of money <I
+ would feed the advertisers (in terms of money <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>and</I
+></SPAN
>
information). We can mark any URL as an image with the <TT
CLASS="LITERAL"
><P
> And then there are known banner sources. They often use scripts to
generate the banners, so it won't be visible from the URL that the
- request is for an image. Hence we block them <I
+ request is for an image. Hence we block them <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>and</I
+></SPAN
>
mark them as images in one go, with the help of our
<TT
> e.g. catches
<SPAN
CLASS="QUOTE"
->"nasty-<I
+>"nasty-<SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>ads</I
+></SPAN
>.nasty-corp.com"</SPAN
> as intended,
but also <SPAN
CLASS="QUOTE"
->"downlo<I
+>"downlo<SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>ads</I
+></SPAN
>.sourcefroge.net"</SPAN
> or
<SPAN
CLASS="QUOTE"
->"<I
+>"<SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>ads</I
+></SPAN
>l.some-provider.net."</SPAN
> So here come some
well-known exceptions to the <TT
>-block</A
></TT
>
- applies, so (unless it matches <I
+ applies, so (unless it matches <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>again</I
+></SPAN
> further down) it ends up
with no <TT
CLASS="LITERAL"
>filter</A
></TT
>
- disables <I
+ disables <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>all</I
+></SPAN
> filters in one fell swoop!</P
><P
> <TABLE
><H3
CLASS="SECT3"
><A
-NAME="AEN2910"
->8.7.2. user.action</A
-></H3
+NAME="AEN2910">8.7.2. user.action</H3
><P
> So far we are painting with a broad brush by setting general policies,
which would be a reasonable starting point for many people. Now,
CLASS="FILENAME"
>user.action</TT
> is also a
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>safe</I
+></SPAN
> place for your personal settings, since
<TT
CLASS="FILENAME"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="config.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="filter-file.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>Appendix</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
-TITLE="Privoxy 2.9.20 User Manual"
+TITLE="Privoxy 3.0.0 User Manual"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="See Also"
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
><TH
COLSPAN="3"
ALIGN="center"
->Privoxy 2.9.20 User Manual</TH
+>Privoxy 3.0.0 User Manual</TH
></TR
><TR
><TD
VALIGN="bottom"
><A
HREF="seealso.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
><H1
CLASS="SECT1"
><A
-NAME="APPENDIX"
->14. Appendix</A
-></H1
+NAME="APPENDIX">14. Appendix</H1
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
-NAME="REGEX"
->14.1. Regular Expressions</A
-></H2
+NAME="REGEX">14.1. Regular Expressions</H2
><P
> <SPAN
CLASS="APPLICATION"
><TBODY
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>.</I
+></SPAN
> - Matches any single character, e.g. <SPAN
CLASS="QUOTE"
>"a"</SPAN
><TBODY
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>?</I
+></SPAN
> - The preceding character or expression is matched ZERO or ONE
times. Either/or.
</TD
><TBODY
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>+</I
+></SPAN
> - The preceding character or expression is matched ONE or MORE
times.
</TD
><TBODY
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>*</I
+></SPAN
> - The preceding character or expression is matched ZERO or MORE
times.
</TD
><TBODY
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>\</I
+></SPAN
> - The <SPAN
CLASS="QUOTE"
>"escape"</SPAN
><TBODY
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>[]</I
+></SPAN
> - Characters enclosed in brackets will be matched if
any of the enclosed characters are encountered. For instance, <SPAN
CLASS="QUOTE"
><TBODY
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>()</I
+></SPAN
> - parentheses are used to group a sub-expression,
or multiple sub-expressions.
</TD
><TBODY
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>|</I
+></SPAN
> - The <SPAN
CLASS="QUOTE"
>"bar"</SPAN
list. This is enough to get us started with a few simple examples which may
be more illuminating:</P
><P
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
><TT
CLASS="LITERAL"
>/.*/banners/.*</TT
></I
+></SPAN
> - A simple example
that uses the common combination of <SPAN
CLASS="QUOTE"
><P
> A now something a little more complex:</P
><P
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
><TT
CLASS="LITERAL"
>/.*/adv((er)?ts?|ertis(ing|ements?))?/</TT
></I
+></SPAN
> -
We have several literal forward slashes again (<SPAN
CLASS="QUOTE"
CLASS="QUOTE"
>".*"</SPAN
>, so we are matching against any conceivable sub-path, just so
- it matches our expression. The only true literal that <I
+ it matches our expression. The only true literal that <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>must
match</I
+></SPAN
> our pattern is <SPAN
CLASS="APPLICATION"
>adv</SPAN
CLASS="QUOTE"
>"ing"</SPAN
>
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>OR</I
+></SPAN
> <SPAN
CLASS="QUOTE"
>"ements?"</SPAN
>, which would then match
either spelling.</P
><P
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
><TT
CLASS="LITERAL"
>/.*/advert[0-9]+\.(gif|jpe?g)</TT
></I
+></SPAN
> - Again
another path statement with forward slashes. Anything in the square brackets
<SPAN
><H2
CLASS="SECT2"
><A
-NAME="AEN3465"
->14.2. <SPAN
+NAME="AEN3469">14.2. <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
->'s Internal Pages</A
-></H2
+>'s Internal Pages</H2
><P
> Since <SPAN
CLASS="APPLICATION"
Privoxy main page:
</P
><A
-NAME="AEN3480"
-></A
-><BLOCKQUOTE
+NAME="AEN3484"><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
>
editing of actions files:
</P
><A
-NAME="AEN3488"
-></A
-><BLOCKQUOTE
+NAME="AEN3492"><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
>
Show the source code version numbers:
</P
><A
-NAME="AEN3493"
-></A
-><BLOCKQUOTE
+NAME="AEN3497"><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
>
Show the browser's request headers:
</P
><A
-NAME="AEN3498"
-></A
-><BLOCKQUOTE
+NAME="AEN3502"><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
>
Show which actions apply to a URL and why:
</P
><A
-NAME="AEN3503"
-></A
-><BLOCKQUOTE
+NAME="AEN3507"><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
>
to run, but only as a pass-through proxy, with no actions taking place:
</P
><A
-NAME="AEN3509"
-></A
-><BLOCKQUOTE
+NAME="AEN3513"><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
>
> Short cuts. Turn off, then on:
</P
><A
-NAME="AEN3513"
-></A
-><BLOCKQUOTE
+NAME="AEN3517"><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
>
</P
></BLOCKQUOTE
><A
-NAME="AEN3516"
-></A
-><BLOCKQUOTE
+NAME="AEN3520"><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
>
><H3
CLASS="SECT3"
><A
-NAME="BOOKMARKLETS"
->14.2.1. Bookmarklets</A
-></H3
+NAME="BOOKMARKLETS">14.2.1. Bookmarklets</H3
><P
> Below are some <SPAN
CLASS="QUOTE"
><H2
CLASS="SECT2"
><A
-NAME="CHAIN"
->14.3. Chain of Events</A
-></H2
+NAME="CHAIN">14.3. Chain of Events</H2
><P
> Let's take a quick look at the basic sequence of events when a web page is
requested by your browser and <SPAN
><P
> First, the server headers are read and processed to determine, among other
things, the MIME type (document type) and encoding. The headers are then
- filtered as deterimined by the
+ filtered as determined by the
<A
HREF="actions-file.html#CRUNCH-INCOMING-COOKIES"
><SPAN
><H2
CLASS="SECT2"
><A
-NAME="ACTIONSANAT"
->14.4. Anatomy of an Action</A
-></H2
+NAME="ACTIONSANAT">14.4. Anatomy of an Action</H2
><P
> The way <SPAN
CLASS="APPLICATION"
>
to any given URL can be complex, and not always so
easy to understand what is happening. And sometimes we need to be able to
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>see</I
+></SPAN
> just what <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
></A
>
(i.e. not persistent). So we will allow persistent cookies for google. The
- second turns <I
+ second turns <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>off</I
+></SPAN
> any
<A
HREF="actions-file.html#FAST-REDIRECTS"
>"+block"</SPAN
></A
>
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>and</I
+></SPAN
> an
<A
HREF="actions-file.html#HANDLE-AS-IMAGE"
>"/ads"</SPAN
>! But
we did not want this at all! Now we see why we get the blank page. We could
- now add a new action below this that explicitly does <I
+ now add a new action below this that explicitly does <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>not</I
+></SPAN
>
block (<SPAN
CLASS="QUOTE"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="seealso.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
>The Main Configuration File</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
-TITLE="Privoxy 2.9.20 User Manual"
+TITLE="Privoxy 3.0.0 User Manual"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="Privoxy Configuration"
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
><TH
COLSPAN="3"
ALIGN="center"
->Privoxy 2.9.20 User Manual</TH
+>Privoxy 3.0.0 User Manual</TH
></TR
><TR
><TD
VALIGN="bottom"
><A
HREF="configuration.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="actions-file.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="CONFIG"
->7. The Main Configuration File</A
-></H1
+NAME="CONFIG">7. The Main Configuration File</H1
><P
> Again, the main configuration file is named <TT
CLASS="FILENAME"
CLASS="LITERAL"
> <P
CLASS="LITERALLAYOUT"
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>confdir /etc/privoxy</I
+></SPAN
></P
>
</TT
><H2
CLASS="SECT2"
><A
-NAME="CONF-LOG-LOC"
->7.1. Configuration and Log File Locations</A
-></H2
+NAME="CONF-LOG-LOC">7.1. Configuration and Log File Locations</H2
><P
> <SPAN
CLASS="APPLICATION"
><H4
CLASS="SECT3"
><A
-NAME="CONFDIR"
->7.1.1. confdir</A
-></H4
+NAME="CONFDIR">7.1.1. confdir</H4
><P
></P
><DIV
>Default value:</DT
><DD
><P
->/etc/privoxy (Unix) <I
+>/etc/privoxy (Unix) <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>or</I
+></SPAN
> <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
>Effect if unset:</DT
><DD
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Mandatory</I
+></SPAN
></P
></DD
><DT
><H4
CLASS="SECT3"
><A
-NAME="LOGDIR"
->7.1.2. logdir</A
-></H4
+NAME="LOGDIR">7.1.2. logdir</H4
><P
></P
><DIV
>Default value:</DT
><DD
><P
->/var/log/privoxy (Unix) <I
+>/var/log/privoxy (Unix) <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>or</I
+></SPAN
> <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
>Effect if unset:</DT
><DD
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Mandatory</I
+></SPAN
></P
></DD
><DT
><H4
CLASS="SECT3"
><A
-NAME="ACTIONSFILE"
->7.1.3. actionsfile</A
-></H4
+NAME="ACTIONSFILE">7.1.3. actionsfile</H4
><A
NAME="DEFAULT.ACTION"
></A
><H4
CLASS="SECT3"
><A
-NAME="FILTERFILE"
->7.1.4. filterfile</A
-></H4
+NAME="FILTERFILE">7.1.4. filterfile</H4
><A
NAME="DEFAULT.FILTER"
></A
>Default value:</DT
><DD
><P
->default.filter (Unix) <I
+>default.filter (Unix) <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>or</I
+></SPAN
> default.filter.txt (Windows)</P
></DD
><DT
><H4
CLASS="SECT3"
><A
-NAME="LOGFILE"
->7.1.5. logfile</A
-></H4
+NAME="LOGFILE">7.1.5. logfile</H4
><P
></P
><DIV
>Default value:</DT
><DD
><P
->logfile (Unix) <I
+>logfile (Unix) <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>or</I
+></SPAN
> privoxy.log (Windows)</P
></DD
><DT
><H4
CLASS="SECT3"
><A
-NAME="JARFILE"
->7.1.6. jarfile</A
-></H4
+NAME="JARFILE">7.1.6. jarfile</H4
><P
></P
><DIV
>Default value:</DT
><DD
><P
->jarfile (Unix) <I
+>jarfile (Unix) <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>or</I
+></SPAN
> privoxy.jar (Windows)</P
></DD
><DT
><H4
CLASS="SECT3"
><A
-NAME="TRUSTFILE"
->7.1.7. trustfile</A
-></H4
+NAME="TRUSTFILE">7.1.7. trustfile</H4
><P
></P
><DIV
>Default value:</DT
><DD
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Unset (commented out)</I
->. When activated: trust (Unix) <I
+></SPAN
+>. When activated: trust (Unix) <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>or</I
+></SPAN
> trust.txt (Windows)</P
></DD
><DT
><DD
><P
> The trust mechanism is an experimental feature for building white-lists and should
- be used with care. It is <I
+ be used with care. It is <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>NOT</I
+></SPAN
> recommended for the casual user.
</P
><P
><H2
CLASS="SECT2"
><A
-NAME="LOCAL-SET-UP"
->7.2. Local Set-up Documentation</A
-></H2
+NAME="LOCAL-SET-UP">7.2. Local Set-up Documentation</H2
><P
> If you intend to operate <SPAN
CLASS="APPLICATION"
><H4
CLASS="SECT3"
><A
-NAME="USER-MANUAL"
->7.2.1. user-manual</A
-></H4
+NAME="USER-MANUAL">7.2.1. user-manual</H4
><P
></P
><DIV
>Default value:</DT
><DD
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Unset</I
+></SPAN
></P
></DD
><DT
><TD
><PRE
CLASS="SCREEN"
->user-manual file:///usr/share/doc/privoxy-2.9.20/user-manual/</PRE
+>user-manual file:///usr/share/doc/privoxy-3.0.0/user-manual/</PRE
></TD
></TR
></TABLE
><TD
ALIGN="LEFT"
><P
-> If set, this option should be <I
+> If set, this option should be <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>the first option in the config
file</I
+></SPAN
>, because it is used while the config file is being read.
</P
></TD
><H4
CLASS="SECT3"
><A
-NAME="TRUST-INFO-URL"
->7.2.2. trust-info-url</A
-></H4
+NAME="TRUST-INFO-URL">7.2.2. trust-info-url</H4
><P
></P
><DIV
> The value of this option only matters if the experimental trust mechanism has been
activated. (See <A
HREF="config.html#TRUSTFILE"
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>trustfile</I
+></SPAN
></A
> above.)
</P
><H4
CLASS="SECT3"
><A
-NAME="ADMIN-ADDRESS"
->7.2.3. admin-address</A
-></H4
+NAME="ADMIN-ADDRESS">7.2.3. admin-address</H4
><P
></P
><DIV
>Default value:</DT
><DD
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Unset</I
+></SPAN
></P
></DD
><DT
><H4
CLASS="SECT3"
><A
-NAME="PROXY-INFO-URL"
->7.2.4. proxy-info-url</A
-></H4
+NAME="PROXY-INFO-URL">7.2.4. proxy-info-url</H4
><P
></P
><DIV
>Default value:</DT
><DD
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Unset</I
+></SPAN
></P
></DD
><DT
><H2
CLASS="SECT2"
><A
-NAME="DEBUGGING"
->7.3. Debugging</A
-></H2
+NAME="DEBUGGING">7.3. Debugging</H2
><P
> These options are mainly useful when tracing a problem.
Note that you might also want to invoke
><H4
CLASS="SECT3"
><A
-NAME="DEBUG"
->7.3.1. debug</A
-></H4
+NAME="DEBUG">7.3.1. debug</H4
><P
></P
><DIV
> Key values that determine what information gets logged to the
<A
HREF="config.html#LOGFILE"
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>logfile</I
+></SPAN
></A
>.
</P
</P
><P
> A debug level of 1 is informative because it will show you each request
- as it happens. <I
+ as it happens. <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>1, 4096 and 8192 are highly recommended</I
+></SPAN
>
so that you will notice when things go wrong. The other levels are probably
only of interest if you are hunting down a specific problem. They can produce
</P
><P
-> The reporting of <I
+> The reporting of <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>fatal</I
+></SPAN
> errors (i.e. ones which crash
<SPAN
CLASS="APPLICATION"
CLASS="QUOTE"
>"debug
512"</SPAN
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>ONLY</I
+></SPAN
> and not enable anything else.
</P
></DD
><H4
CLASS="SECT3"
><A
-NAME="SINGLE-THREADED"
->7.3.2. single-threaded</A
-></H4
+NAME="SINGLE-THREADED">7.3.2. single-threaded</H4
><P
></P
><DIV
>Type of value:</DT
><DD
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>None</I
+></SPAN
></P
></DD
><DT
>Default value:</DT
><DD
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Unset</I
+></SPAN
></P
></DD
><DT
><DD
><P
> This option is only there for debug purposes and you should never
- need to use it. <I
+ need to use it. <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>It will drastically reduce performance.</I
+></SPAN
>
</P
></DD
><H2
CLASS="SECT2"
><A
-NAME="ACCESS-CONTROL"
->7.4. Access Control and Security</A
-></H2
+NAME="ACCESS-CONTROL">7.4. Access Control and Security</H2
><P
> This section of the config file controls the security-relevant aspects
of <SPAN
><H4
CLASS="SECT3"
><A
-NAME="LISTEN-ADDRESS"
->7.4.1. listen-address</A
-></H4
+NAME="LISTEN-ADDRESS">7.4.1. listen-address</H4
><P
></P
><DIV
><H4
CLASS="SECT3"
><A
-NAME="TOGGLE"
->7.4.2. toggle</A
-></H4
+NAME="TOGGLE">7.4.2. toggle</H4
><P
></P
><DIV
><H4
CLASS="SECT3"
><A
-NAME="ENABLE-REMOTE-TOGGLE"
->7.4.3. enable-remote-toggle</A
-></H4
+NAME="ENABLE-REMOTE-TOGGLE">7.4.3. enable-remote-toggle</H4
><P
></P
><DIV
any URL.
</P
><P
-> For the time being, access to the toggle feature can <I
+> For the time being, access to the toggle feature can <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>not</I
+></SPAN
> be
controlled separately by <SPAN
CLASS="QUOTE"
CLASS="LITERAL"
>listen-address</TT
> above) can
- toggle it for all users. So this option is <I
+ toggle it for all users. So this option is <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>not recommended</I
+></SPAN
>
for multi-user environments with untrusted users.
</P
><H4
CLASS="SECT3"
><A
-NAME="ENABLE-EDIT-ACTIONS"
->7.4.4. enable-edit-actions</A
-></H4
+NAME="ENABLE-EDIT-ACTIONS">7.4.4. enable-edit-actions</H4
><P
></P
><DIV
>Notes:</DT
><DD
><P
-> For the time being, access to the editor can <I
+> For the time being, access to the editor can <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>not</I
+></SPAN
> be
controlled separately by <SPAN
CLASS="QUOTE"
CLASS="LITERAL"
>listen-address</TT
> above) can
- modify its configuration for all users. So this option is <I
+ modify its configuration for all users. So this option is <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>not
recommended</I
+></SPAN
> for multi-user environments with untrusted users.
</P
><P
><H4
CLASS="SECT3"
><A
-NAME="ACLS"
->7.4.5. ACLs: permit-access and deny-access</A
-></H4
+NAME="ACLS">7.4.5. ACLs: permit-access and deny-access</H4
><A
NAME="PERMIT-ACCESS"
></A
>Default value:</DT
><DD
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Unset</I
+></SPAN
></P
></DD
><DT
><DD
><P
> Access controls are included at the request of ISPs and systems
- administrators, and <I
+ administrators, and <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>are not usually needed by individual users</I
+></SPAN
>.
For a typical home user, it will normally suffice to ensure that
<SPAN
(127.0.0.1) or internal (home) network address by means of the
<A
HREF="config.html#LISTEN-ADDRESS"
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>listen-address</I
+></SPAN
></A
>
option.
>dst_addr</I
></TT
>
- that is examined is the address of the forwarder and <I
+ that is examined is the address of the forwarder and <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>NOT</I
+></SPAN
> the address
of the ultimate target. This is necessary because it may be impossible for the local
<SPAN
</P
><P
> You should prefer using IP addresses over DNS names, because the address lookups take
- time. All DNS names must resolve! You can <I
+ time. All DNS names must resolve! You can <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>not</I
+></SPAN
> use domain patterns
like <SPAN
CLASS="QUOTE"
>dst_addr</I
></TT
> implies that
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>all</I
+></SPAN
> destination addresses are OK:
</P
><P
><H4
CLASS="SECT3"
><A
-NAME="BUFFER-LIMIT"
->7.4.6. buffer-limit</A
-></H4
+NAME="BUFFER-LIMIT">7.4.6. buffer-limit</H4
><P
></P
><DIV
CLASS="LITERAL"
>buffer-limit</TT
> Kbytes
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>each</I
+></SPAN
>, unless you have enabled <SPAN
CLASS="QUOTE"
>"single-threaded"</SPAN
><H2
CLASS="SECT2"
><A
-NAME="FORWARDING"
->7.5. Forwarding</A
-></H2
+NAME="FORWARDING">7.5. Forwarding</H2
><P
> This feature allows routing of HTTP requests through a chain of
multiple proxies.
><H4
CLASS="SECT3"
><A
-NAME="FORWARD"
->7.5.1. forward</A
-></H4
+NAME="FORWARD">7.5.1. forward</H4
><P
></P
><DIV
>Default value:</DT
><DD
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Unset</I
+></SPAN
></P
></DD
><DT
><H4
CLASS="SECT3"
><A
-NAME="SOCKS"
->7.5.2. forward-socks4 and forward-socks4a</A
-></H4
+NAME="SOCKS">7.5.2. forward-socks4 and forward-socks4a</H4
><A
NAME="FORWARD-SOCKS4"
></A
>Default value:</DT
><DD
><P
+><SPAN
+CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Unset</I
+></SPAN
></P
></DD
><DT
><H4
CLASS="SECT3"
><A
-NAME="ADVANCED-FORWARDING-EXAMPLES"
->7.5.3. Advanced Forwarding Examples</A
-></H4
+NAME="ADVANCED-FORWARDING-EXAMPLES">7.5.3. Advanced Forwarding Examples</H4
><P
> If you have links to multiple ISPs that provide various special content
only to their subscribers, you can configure multiple <SPAN
>Privoxies</SPAN
>
which have connections to the respective ISPs to act as forwarders to each other, so that
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>your</I
+></SPAN
> users can see the internal content of all ISPs.</P
><P
> Assume that host-a has a PPP connection to isp-a.net. And host-b has a PPP connection to
><H2
CLASS="SECT2"
><A
-NAME="WINDOWS-GUI"
->7.6. Windows GUI Options</A
-></H2
+NAME="WINDOWS-GUI">7.6. Windows GUI Options</H2
><P
> <SPAN
CLASS="APPLICATION"
CLASS="LITERAL"
> <P
CLASS="LITERALLAYOUT"
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>activity-animation 1</I
+></SPAN
><br>
</P
>
CLASS="LITERAL"
> <P
CLASS="LITERALLAYOUT"
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>log-messages 1</I
+></SPAN
><br>
</P
>
CLASS="LITERAL"
> <P
CLASS="LITERALLAYOUT"
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>log-buffer-size 1</I
+></SPAN
><br>
</P
>
CLASS="LITERAL"
> <P
CLASS="LITERALLAYOUT"
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>log-max-lines 200</I
+></SPAN
><br>
</P
>
CLASS="LITERAL"
> <P
CLASS="LITERALLAYOUT"
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>log-highlight-messages 1</I
+></SPAN
><br>
</P
>
CLASS="LITERAL"
> <P
CLASS="LITERALLAYOUT"
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>log-font-name Comic Sans MS</I
+></SPAN
><br>
</P
>
CLASS="LITERAL"
> <P
CLASS="LITERALLAYOUT"
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>log-font-size 8</I
+></SPAN
><br>
</P
>
CLASS="LITERAL"
> <P
CLASS="LITERALLAYOUT"
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>show-on-task-bar 0</I
+></SPAN
><br>
</P
>
CLASS="LITERAL"
> <P
CLASS="LITERALLAYOUT"
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>close-button-minimizes 1</I
+></SPAN
><br>
</P
>
CLASS="LITERAL"
> <P
CLASS="LITERALLAYOUT"
-> #<I
+> #<SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>hide-console</I
+></SPAN
><br>
</P
>
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="configuration.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="actions-file.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>Privoxy Configuration</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
-TITLE="Privoxy 2.9.20 User Manual"
+TITLE="Privoxy 3.0.0 User Manual"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="Starting Privoxy"
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
><TH
COLSPAN="3"
ALIGN="center"
->Privoxy 2.9.20 User Manual</TH
+>Privoxy 3.0.0 User Manual</TH
></TR
><TR
><TD
VALIGN="bottom"
><A
HREF="startup.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="config.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="CONFIGURATION"
->6. <SPAN
+NAME="CONFIGURATION">6. <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> Configuration</A
-></H1
+> Configuration</H1
><P
> All <SPAN
CLASS="APPLICATION"
><H2
CLASS="SECT2"
><A
-NAME="AEN579"
->6.1. Controlling <SPAN
+NAME="AEN579">6.1. Controlling <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> with Your Web Browser</A
-></H2
+> with Your Web Browser</H2
><P
> <SPAN
CLASS="APPLICATION"
><TD
><PRE
CLASS="SCREEN"
-> <H3
+> <H2
CLASS="BRIDGEHEAD"
-> Privoxy Menu</H3
+><A
+NAME="AEN588"> Privoxy Menu</H2
><P
></P
><TABLE
>
</TD
></TR
+><TR
+><TD
+> ▪ <A
+HREF="http://www.privoxy.org/3.0.0/user-manual/"
+TARGET="_top"
+>Documentation</A
+>
+ </TD
+></TR
></TBODY
></TABLE
><P
><H2
CLASS="SECT2"
><A
-NAME="CONFOVERVIEW"
->6.2. Configuration Files Overview</A
-></H2
+NAME="CONFOVERVIEW">6.2. Configuration Files Overview</H2
><P
> For Unix, *BSD and Linux, all configuration files are located in
<TT
<SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> executable. The name
- and number of configuration files has changed from previous versions, and is
- subject to change as development progresses.</P
+> executable. </P
><P
> The installed defaults provide a reasonable starting point, though
some settings may be aggressive by some standards. For the time being, the
CLASS="QUOTE"
>"wake up"</SPAN
> requests
- must obviously be sent to the <I
+ must obviously be sent to the <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>old</I
+></SPAN
> listening address.</P
-><P
-> 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 <SPAN
-CLASS="QUOTE"
->"default"</SPAN
-> setting, may change, so
- please check all your configuration files on important issues.</P
></DIV
></DIV
><DIV
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="startup.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="config.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
Requests</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
-TITLE="Privoxy 2.9.20 User Manual"
+TITLE="Privoxy 3.0.0 User Manual"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="Templates"
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
><TH
COLSPAN="3"
ALIGN="center"
->Privoxy 2.9.20 User Manual</TH
+>Privoxy 3.0.0 User Manual</TH
></TR
><TR
><TD
VALIGN="bottom"
><A
HREF="templates.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="copyright.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="CONTACT"
->11. Contacting the Developers, Bug Reporting and Feature
-Requests</A
-></H1
+NAME="CONTACT">11. Contacting the Developers, Bug Reporting and Feature
+Requests</H1
><P
> We value your feedback. In fact, we rely on it to improve
<SPAN
><H2
CLASS="SECT2"
><A
-NAME="CONTACT-SUPPORT"
->11.1. Get Support</A
-></H2
+NAME="CONTACT-SUPPORT">11.1. Get Support</H2
><P
> For casual users, our support forum at
<A
><H2
CLASS="SECT2"
><A
-NAME="CONTACT-BUGS"
->11.2. Report Bugs</A
-></H2
+NAME="CONTACT-BUGS">11.2. Report Bugs</H2
><P
-> Please report all bugs <I
+> Please report all bugs <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>only</I
+></SPAN
> through our
bug tracker:
<A
><H2
CLASS="SECT2"
><A
-NAME="CONTACT-FEATURE"
->11.3. Request New Features</A
-></H2
+NAME="CONTACT-FEATURE">11.3. Request New Features</H2
><P
> You are welcome to submit ideas on new features or other proposals
for improvement through our feature request tracker at
><H2
CLASS="SECT2"
><A
-NAME="CONTACT-ADS"
->11.4. Report Ads or Other Actions-Related Problems</A
-></H2
+NAME="CONTACT-ADS">11.4. Report Ads or Other Actions-Related Problems</H2
><P
> Please send feedback on ads that slipped through, innocent images that were blocked,
and any other problems relating to the <TT
><H2
CLASS="SECT2"
><A
-NAME="CONTACT-OTHER"
->11.5. Other</A
-></H2
+NAME="CONTACT-OTHER">11.5. Other</H2
><P
>For any other issues, feel free to use the mailing lists. Technically interested users
and people who wish to contribute to the project are also welcome on the developers list!
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="templates.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="copyright.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>Privoxy Copyright, License and History</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
-TITLE="Privoxy 2.9.20 User Manual"
+TITLE="Privoxy 3.0.0 User Manual"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="Contacting the Developers, Bug Reporting and Feature
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
><TH
COLSPAN="3"
ALIGN="center"
->Privoxy 2.9.20 User Manual</TH
+>Privoxy 3.0.0 User Manual</TH
></TR
><TR
><TD
VALIGN="bottom"
><A
HREF="contact.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="seealso.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="COPYRIGHT"
->12. <SPAN
+NAME="COPYRIGHT">12. <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> Copyright, License and History</A
-></H1
+> Copyright, License and History</H1
><P
> Copyright © 2001, 2002 by Privoxy Developers <TT
CLASS="EMAIL"
><H2
CLASS="SECT2"
><A
-NAME="AEN3215"
->12.1. License</A
-></H2
+NAME="AEN3215">12.1. License</H2
><P
> <SPAN
CLASS="APPLICATION"
><H2
CLASS="SECT2"
><A
-NAME="HISTORY"
->12.2. History</A
-></H2
+NAME="HISTORY">12.2. History</H2
><P
> In the beginning, there was the
<A
CLASS="APPLICATION"
>Privoxy</SPAN
>, whose first
- stable release, 3.0, is due late summer or early fall 2002.
+ stable release, 3.0, was released August, 2002.
</P
></DIV
><DIV
><H2
CLASS="SECT2"
><A
-NAME="AUTHORS"
->12.3. Authors</A
-></H2
+NAME="AUTHORS">12.3. Authors</H2
><P
> Current Project Developers:</P
><P
> Rodrigo Barbosa (RPM specfiles)<br>
Moritz Barsnick<br>
Hal Burgiss (docs)<br>
+ Karsten Hopp (Red Hat)<br>
Alexander Lazic<br>
Gábor Lipták<br>
Guy<br>
Haroon Rafique<br>
- Roland Rosenfeld<br>
- Georg Sauthoff<br>
+ Roland Rosenfeld (Debian)<br>
+ Georg Sauthoff (Gentoo)<br>
David Schmidt (OS/2, Mac OSX ports)<br>
- Joerg Strohmayer<br>
+ Joerg Strohmayer (Amiga)<br>
Sarantis Paskalis</P
><P
> Based in part on code originally developed by:</P
Peter E<br>
Aaron Hamid<br>
Magnus Holmgren<br>
+ Daniel Leite<br>
Paul Lieverse<br>
Roberto Ragusa<br>
Maynard Riley<br>
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="contact.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="seealso.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>The Filter File</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
-TITLE="Privoxy 2.9.20 User Manual"
+TITLE="Privoxy 3.0.0 User Manual"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="Actions Files"
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
><TH
COLSPAN="3"
ALIGN="center"
->Privoxy 2.9.20 User Manual</TH
+>Privoxy 3.0.0 User Manual</TH
></TR
><TR
><TD
VALIGN="bottom"
><A
HREF="actions-file.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="templates.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="FILTER-FILE"
->9. The Filter File</A
-></H1
+NAME="FILTER-FILE">9. The Filter File</H1
><P
> All text substitutions that can be invoked through the
<TT
HREF="actions-file.html"
>actions files</A
>, the
- filter file is organized in sections, which are called <I
+ filter file is organized in sections, which are called <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>filters</I
+></SPAN
>
here. Each filter consists of a heading line, that starts with the
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>keyword</I
+></SPAN
> <TT
CLASS="LITERAL"
>FILTER:</TT
>, followed by
- the filter's <I
+ the filter's <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>name</I
+></SPAN
>, and a short (one line)
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>description</I
+></SPAN
> of what it does. Below that line
- come the <I
+ come the <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>jobs</I
+></SPAN
>, i.e. lines that define the actual
text substitutions. By convention, the name of a filter
- should describe what the filter <I
+ should describe what the filter <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>eliminates</I
+></SPAN
>. The
comment is used in the <A
HREF="http://config.privoxy.org/"
><H2
CLASS="SECT2"
><A
-NAME="AEN3013"
->9.1. Filter File Tutorial</A
-></H2
+NAME="AEN3013">9.1. Filter File Tutorial</H2
><P
> Now, let's complete our <SPAN
CLASS="QUOTE"
></TABLE
></P
><P
-> But wait! Didn't the comment say that <I
+> But wait! Didn't the comment say that <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>all</I
+></SPAN
> occurrences
of <SPAN
CLASS="QUOTE"
matches <SPAN
CLASS="QUOTE"
>"<script"</SPAN
->, followed by <I
+>, followed by <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>any</I
+></SPAN
> text, i.e.
it matches the whole page, from the start of the first <script> tag.</P
><P
CLASS="QUOTE"
>"document.referrer"</SPAN
>. The dot needed to
- be <I
+ be <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>escaped</I
+></SPAN
>, i.e. preceded by a backslash, to take away its
special meaning as a joker, and make it just a regular dot. So far, the meaning is:
Match from the start of the first <script> tag in a the page, up to, and including,
the text <SPAN
CLASS="QUOTE"
>"document.referrer"</SPAN
->, if <I
+>, if <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>both</I
+></SPAN
> are present
in the page (and appear in that order).</P
><P
text in between <SPAN
CLASS="QUOTE"
>"<script"</SPAN
-> and the <I
+> and the <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>first</I
+></SPAN
> occurrence
of <SPAN
CLASS="QUOTE"
CLASS="LITERAL"
>.*</TT
> will
- only span the text up to the <I
+ only span the text up to the <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>first</I
+></SPAN
> <SPAN
CLASS="QUOTE"
>"</script>"</SPAN
<TT
CLASS="LITERAL"
>"Not Your Business!"</TT
-> (<I
+> (<SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>including</I
+></SPAN
>
the quotation marks!), followed by the text remembered as <TT
CLASS="LITERAL"
> construct means: <SPAN
CLASS="QUOTE"
>"a single
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>or</I
+></SPAN
> a double quote"</SPAN
>. Finally, <TT
CLASS="LITERAL"
CLASS="LITERAL"
>$1</TT
> above,
- with the difference that in the <I
+ with the difference that in the <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>pattern</I
+></SPAN
>, a backslash indicates
- a backreference, whereas in the <I
+ a backreference, whereas in the <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>substitute</I
+></SPAN
>, it's the dollar.</P
><P
> So what does this job do? It replaces assignments of single- or double-quoted
TARGET="_top"
>OnUnload
event binding</A
-> in the HTML DOM was a <I
+> in the HTML DOM was a <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>CRIME</I
+></SPAN
>.
When I close a browser window, I want it to close and die. Basta.
This job replaces the <SPAN
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="actions-file.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="templates.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
<HTML
><HEAD
><TITLE
->Privoxy 2.9.20 User Manual</TITLE
+>Privoxy 3.0.0 User Manual</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="NEXT"
TITLE="Introduction"
HREF="introduction.html"><LINK
><H1
CLASS="TITLE"
><A
-NAME="AEN2"
->Privoxy 2.9.20 User Manual</A
-></H1
+NAME="AEN2">Privoxy 3.0.0 User Manual</H1
><P
CLASS="PUBDATE"
> <SUB
><BR></P
><P
CLASS="PUBDATE"
->$Id: user-manual.sgml,v 1.123.2.16 2002/08/09 19:20:54 david__schmidt Exp $<BR></P
+>$Id: user-manual.sgml,v 1.123.2.18 2002/08/22 23:47:58 hal9 Exp $<BR></P
><DIV
><DIV
CLASS="ABSTRACT"
><A
-NAME="AEN9"
-></A
-><P
+NAME="AEN9"><P
></P
><P
> The <I
><DD
><DL
><DT
->22<A
-HREF="actions-file.html#AEN1678"
-></A
-></DT
-><DT
>8.4.1. <A
HREF="actions-file.html#AEN1711"
>The Domain Pattern</A
></DT
><DT
>14.2. <A
-HREF="appendix.html#AEN3465"
+HREF="appendix.html#AEN3469"
><SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="introduction.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>Installation</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
-TITLE="Privoxy 2.9.20 User Manual"
+TITLE="Privoxy 3.0.0 User Manual"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="Introduction"
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
><TH
COLSPAN="3"
ALIGN="center"
->Privoxy 2.9.20 User Manual</TH
+>Privoxy 3.0.0 User Manual</TH
></TR
><TR
><TD
VALIGN="bottom"
><A
HREF="introduction.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="upgradersnote.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="INSTALLATION"
->2. Installation</A
-></H1
+NAME="INSTALLATION">2. Installation</H1
><P
> <SPAN
CLASS="APPLICATION"
> installation on your system, you
will need to remove it. On some platforms, this may be done for you as part
of their installation procedure. (See below for your platform). In any case
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>be sure to backup your old configuration if it is valuable to
you.</I
+></SPAN
> See the <A
HREF="upgradersnote.html"
>note to
><H2
CLASS="SECT2"
><A
-NAME="INSTALLATION-PACKAGES"
->2.1. Binary Packages</A
-></H2
+NAME="INSTALLATION-PACKAGES">2.1. Binary Packages</H2
><P
>How to install the binary packages depends on your operating system:</P
><DIV
><H3
CLASS="SECT3"
><A
-NAME="INSTALLATION-PACK-RPM"
->2.1.1. Red Hat, SuSE and Conectiva RPMs</A
-></H3
+NAME="INSTALLATION-PACK-RPM">2.1.1. Red Hat, SuSE and Conectiva RPMs</H3
><P
> RPMs can be installed with <TT
CLASS="LITERAL"
->rpm -Uvh privoxy-2.9.20-1.rpm</TT
+>rpm -Uvh privoxy-3.0.0-1.rpm</TT
>,
and will use <TT
CLASS="FILENAME"
CLASS="APPLICATION"
>Privoxy</SPAN
> will
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>not</I
+></SPAN
> be automatically started on system boot. You will
need to enable that using <B
CLASS="COMMAND"
> If you have problems with failed dependencies, try rebuilding the SRC RPM:
<TT
CLASS="LITERAL"
->rpm --rebuild privoxy-2.9.20-1.src.rpm</TT
+>rpm --rebuild privoxy-3.0.0-1.src.rpm</TT
>. This
will use your locally installed libraries and RPM version. </P
><P
><H3
CLASS="SECT3"
><A
-NAME="INSTALLATION-DEB"
->2.1.2. Debian</A
-></H3
+NAME="INSTALLATION-DEB">2.1.2. Debian</H3
><P
> DEBs can be installed with <TT
CLASS="LITERAL"
>dpkg -i
- privoxy_2.9.20-1.deb</TT
+ privoxy_3.0.0-1.deb</TT
>, and will use
<TT
CLASS="FILENAME"
><H3
CLASS="SECT3"
><A
-NAME="INSTALLATION-PACK-WIN"
->2.1.3. Windows</A
-></H3
+NAME="INSTALLATION-PACK-WIN">2.1.3. Windows</H3
><P
> Just double-click the installer, which will guide you through
the installation process. You will find the configuration files
><H3
CLASS="SECT3"
><A
-NAME="INSTALLATION-PACK-BINTGZ"
->2.1.4. Solaris, NetBSD, FreeBSD, HP-UX</A
-></H3
+NAME="INSTALLATION-PACK-BINTGZ">2.1.4. Solaris, NetBSD, FreeBSD, HP-UX</H3
><P
> Create a new directory, <TT
CLASS="LITERAL"
><H3
CLASS="SECT3"
><A
-NAME="INSTALLATION-OS2"
->2.1.5. OS/2</A
-></H3
+NAME="INSTALLATION-OS2">2.1.5. OS/2</H3
><P
> First, make sure that no previous installations of
<SPAN
><H3
CLASS="SECT3"
><A
-NAME="INSTALLATION-MAC"
->2.1.6. Mac OSX</A
-></H3
+NAME="INSTALLATION-MAC">2.1.6. Mac OSX</H3
><P
> Unzip the downloaded file (you can either double-click on the file
from the finder, or from the desktop if you downloaded it there).
><H3
CLASS="SECT3"
><A
-NAME="INSTALLATION-AMIGA"
->2.1.7. AmigaOS</A
-></H3
+NAME="INSTALLATION-AMIGA">2.1.7. AmigaOS</H3
><P
> Copy and then unpack the <TT
CLASS="FILENAME"
><H3
CLASS="SECT3"
><A
-NAME="INSTALLATTION-GENTOO"
->2.1.8. Gentoo</A
-></H3
+NAME="INSTALLATTION-GENTOO">2.1.8. Gentoo</H3
><P
> Gentoo source packages (Ebuilds) for <SPAN
CLASS="APPLICATION"
>, the
documentation is in <TT
CLASS="FILENAME"
->/usr/share/doc/privoxy-2.9.20</TT
+>/usr/share/doc/privoxy-3.0.0</TT
>
and the Log directory is in <TT
CLASS="FILENAME"
><H2
CLASS="SECT2"
><A
-NAME="INSTALLATION-SOURCE"
->2.2. Building from Source</A
-></H2
+NAME="INSTALLATION-SOURCE">2.2. Building from Source</H2
><P
> The most convenient way to obtain the <SPAN
CLASS="APPLICATION"
><TD
><PRE
CLASS="SCREEN"
-> tar xzvf privoxy-2.9.20-beta-src* [.tgz or .tar.gz]
- cd privoxy-2.9.20-beta</PRE
+> tar xzvf privoxy-3.0.0-src* [.tgz or .tar.gz]
+ cd privoxy-3.0.0</PRE
></TD
></TR
></TABLE
></TR
></TABLE
></P
+><DIV
+CLASS="WARNING"
+><P
+></P
+><TABLE
+CLASS="WARNING"
+BORDER="1"
+WIDTH="100%"
+><TR
+><TD
+ALIGN="CENTER"
+><B
+>Warning</B
+></TD
+></TR
+><TR
+><TD
+ALIGN="LEFT"
+><P
+>
+ The <SPAN
+CLASS="QUOTE"
+>"make install"</SPAN
+> target is temporary quite broken! It is
+ recommended to use a binary package, or do a source build, and manually
+ install the components. Sorry.
+ </P
+></TD
+></TR
+></TABLE
+></DIV
><P
> If you have gnu make, you can have the first four steps
automatically done for you by just typing:</P
><H2
CLASS="SECT2"
><A
-NAME="INSTALLATION-KEEPUPDATED"
->2.3. Keeping your Installation Up-to-Date</A
-></H2
+NAME="INSTALLATION-KEEPUPDATED">2.3. Keeping your Installation Up-to-Date</H2
><P
> As user feedback comes in and development continues, we will make updated versions
of both the main <A
to the latest <TT
CLASS="LITERAL"
>default.action</TT
-> file we <I
+> file we <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>strongly
recommend</I
+></SPAN
> that you use <TT
CLASS="LITERAL"
>user.action</TT
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="introduction.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="upgradersnote.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>Introduction</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
-TITLE="Privoxy 2.9.20 User Manual"
+TITLE="Privoxy 3.0.0 User Manual"
HREF="index.html"><LINK
REL="PREVIOUS"
-TITLE="Privoxy 2.9.20 User Manual"
+TITLE="Privoxy 3.0.0 User Manual"
HREF="index.html"><LINK
REL="NEXT"
TITLE="Installation"
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
><TH
COLSPAN="3"
ALIGN="center"
->Privoxy 2.9.20 User Manual</TH
+>Privoxy 3.0.0 User Manual</TH
></TR
><TR
><TD
VALIGN="bottom"
><A
HREF="index.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="installation.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="INTRODUCTION"
->1. Introduction</A
-></H1
+NAME="INTRODUCTION">1. Introduction</H1
><P
-> This documentation is included with the current beta version of
+> This documentation is included with the current stable version of
<SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
->, v.2.9.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 version 3.0 is currently nearing
- completion, and includes many significant changes and enhancements over
- earlier versions. The target release date for
- stable v3.0 is <SPAN
-CLASS="QUOTE"
->"soon"</SPAN
-> ;-).</P
-><P
-> Since this is a beta 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 <I
-CLASS="EMPHASIS"
->may be</I
-> bugs, though hopefully
- not many! </P
+>, v.3.0.0.</P
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
-NAME="FEATURES"
->1.1. Features</A
-></H2
+NAME="FEATURES">1.1. Features</H2
><P
> In addition to <SPAN
CLASS="APPLICATION"
<SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> provides new features,
- some of them currently under development:</P
+> provides new features:</P
><P
> <P
></P
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="installation.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
WIDTH="33%"
ALIGN="left"
VALIGN="top"
->Privoxy 2.9.20 User Manual</TD
+>Privoxy 3.0.0 User Manual</TD
><TD
WIDTH="34%"
ALIGN="center"
>Quickstart to Using Privoxy</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
-TITLE="Privoxy 2.9.20 User Manual"
+TITLE="Privoxy 3.0.0 User Manual"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="Note to Upgraders"
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
><TH
COLSPAN="3"
ALIGN="center"
->Privoxy 2.9.20 User Manual</TH
+>Privoxy 3.0.0 User Manual</TH
></TR
><TR
><TD
VALIGN="bottom"
><A
HREF="upgradersnote.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="startup.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="QUICKSTART"
->4. Quickstart to Using <SPAN
+NAME="QUICKSTART">4. Quickstart to Using <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-></A
></H1
><P
> <P
><H2
CLASS="SECT2"
><A
-NAME="QUICKSTART-AD-BLOCKING"
->4.1. Quickstart to Ad Blocking</A
-></H2
+NAME="QUICKSTART-AD-BLOCKING">4.1. Quickstart to Ad Blocking</H2
><P
> Ad blocking is but one of <SPAN
CLASS="APPLICATION"
>"problem"</SPAN
> sites, and to spend more time adjusting the
configuration to solve these unintended consequences. In short, there is
- not an easy way to eliminate <I
+ not an easy way to eliminate <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>all</I
+></SPAN
> ads. Either take
- the easy way and settle for <I
+ the easy way and settle for <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>most</I
+></SPAN
> ads blocked with the
default configuration, or jump in and tweak it for your personal surfing
habits and preferences.</P
>block</A
></TT
> action somewhere in the
- configuration, <I
+ configuration, <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>and</I
+></SPAN
>, it must also match an
<TT
CLASS="LITERAL"
><TBODY
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>pattern</I
+></SPAN
> - a checkerboard pattern, so that an ad
replacement is obvious. This is the default.
</TD
><TBODY
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>blank</I
+></SPAN
> - A very small empty GIF image is displayed.
This is the so-called <SPAN
CLASS="QUOTE"
><TBODY
><TR
><TD
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>http://<URL></I
+></SPAN
> - A redirect to any image anywhere
of the user's choosing (advanced usage).
</TD
> <DIV
CLASS="FIGURE"
><A
-NAME="AEN388"
-></A
-><P
+NAME="AEN388"><P
><B
>Figure 1. Actions Files in Use</B
></P
CLASS="MEDIAOBJECT"
><P
><IMG
-SRC="../images/files-in-use.jpg"
-ALT="[ Screenshot of Actions Files in Use ]"
-></IMG
-></P
+SRC="../images/files-in-use.jpg"></P
></DIV
></DIV
>
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="upgradersnote.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="startup.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>See Also</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
-TITLE="Privoxy 2.9.20 User Manual"
+TITLE="Privoxy 3.0.0 User Manual"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="Privoxy Copyright, License and History"
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
><TH
COLSPAN="3"
ALIGN="center"
->Privoxy 2.9.20 User Manual</TH
+>Privoxy 3.0.0 User Manual</TH
></TR
><TR
><TD
VALIGN="bottom"
><A
HREF="copyright.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="appendix.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="SEEALSO"
->13. See Also</A
-></H1
+NAME="SEEALSO">13. See Also</H1
><P
> Other references and sites of interest to <SPAN
CLASS="APPLICATION"
><TR
><TD
> <A
+HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/contrib/"
+TARGET="_top"
+>http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/contrib/</A
+>, cool
+ and fun ideas from <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> users.
+ </TD
+></TR
+></TBODY
+></TABLE
+><P
+></P
+>
+ <P
+></P
+><TABLE
+BORDER="0"
+><TBODY
+><TR
+><TD
+> <A
HREF="http://www.junkbusters.com/ht/en/cookies.html"
TARGET="_top"
>http://www.junkbusters.com/ht/en/cookies.html</A
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="copyright.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="appendix.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>Starting Privoxy</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
-TITLE="Privoxy 2.9.20 User Manual"
+TITLE="Privoxy 3.0.0 User Manual"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="Quickstart to Using Privoxy"
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
><TH
COLSPAN="3"
ALIGN="center"
->Privoxy 2.9.20 User Manual</TH
+>Privoxy 3.0.0 User Manual</TH
></TR
><TR
><TD
VALIGN="bottom"
><A
HREF="quickstart.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="configuration.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="STARTUP"
->5. Starting <SPAN
+NAME="STARTUP">5. Starting <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-></A
></H1
><P
> Before launching <SPAN
> <DIV
CLASS="FIGURE"
><A
-NAME="AEN439"
-></A
-><P
+NAME="AEN439"><P
><B
>Figure 2. Proxy Configuration (Mozilla)</B
></P
CLASS="MEDIAOBJECT"
><P
><IMG
-SRC="../images/proxy_setup.jpg"
-ALT="[ Screenshot of Mozilla Proxy Configuration ]"
-></IMG
-></P
+SRC="../images/proxy_setup.jpg"></P
></DIV
></DIV
>
><H2
CLASS="SECT2"
><A
-NAME="START-REDHAT"
->5.1. Red Hat and Conectiva</A
-></H2
+NAME="START-REDHAT">5.1. Red Hat and Conectiva</H2
><P
> We use a script. Note that Red Hat does not start Privoxy upon booting per
default. It will use the file <TT
><H2
CLASS="SECT2"
><A
-NAME="START-DEBIAN"
->5.2. Debian</A
-></H2
+NAME="START-DEBIAN">5.2. Debian</H2
><P
> We use a script. Note that Debian starts Privoxy upon booting per
default. It will use the file
><H2
CLASS="SECT2"
><A
-NAME="START-SUSE"
->5.3. SuSE</A
-></H2
+NAME="START-SUSE">5.3. SuSE</H2
><P
>We use a script. It will use the file <TT
CLASS="FILENAME"
><H2
CLASS="SECT2"
><A
-NAME="START-WINDOWS"
->5.4. Windows</A
-></H2
+NAME="START-WINDOWS">5.4. Windows</H2
><P
>Click on the Privoxy Icon to start Privoxy. If no configuration file is
specified on the command line, <SPAN
><H2
CLASS="SECT2"
><A
-NAME="START-UNICES"
->5.5. Solaris, NetBSD, FreeBSD, HP-UX and others</A
-></H2
+NAME="START-UNICES">5.5. Solaris, NetBSD, FreeBSD, HP-UX and others</H2
><P
>Example Unix startup command:</P
><P
><H2
CLASS="SECT2"
><A
-NAME="START-OS2"
->5.6. OS/2</A
-></H2
+NAME="START-OS2">5.6. OS/2</H2
><P
> During installation, <SPAN
CLASS="APPLICATION"
><H2
CLASS="SECT2"
><A
-NAME="START-MACOSX"
->5.7. Mac OSX</A
-></H2
+NAME="START-MACOSX">5.7. Mac OSX</H2
><P
> During installation, <SPAN
CLASS="APPLICATION"
><H2
CLASS="SECT2"
><A
-NAME="START-AMIGAOS"
->5.8. AmigaOS</A
-></H2
+NAME="START-AMIGAOS">5.8. AmigaOS</H2
><P
> Start <SPAN
CLASS="APPLICATION"
><H2
CLASS="SECT2"
><A
-NAME="START-GENTOO"
->5.9. Gentoo</A
-></H2
+NAME="START-GENTOO">5.9. Gentoo</H2
><P
> A script is again used. It will use the file <TT
CLASS="FILENAME"
><H2
CLASS="SECT2"
><A
-NAME="CMDOPTIONS"
->5.10. Command Line Options</A
-></H2
+NAME="CMDOPTIONS">5.10. Command Line Options</H2
><P
> <SPAN
CLASS="APPLICATION"
><UL
><LI
><P
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>--version</I
+></SPAN
>
</P
><P
></LI
><LI
><P
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>--help</I
+></SPAN
>
</P
><P
></LI
><LI
><P
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>--no-daemon</I
+></SPAN
>
</P
><P
></LI
><LI
><P
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>--pidfile FILE</I
+></SPAN
>
</P
><P
-> On startup, write the process ID to <I
+> On startup, write the process ID to <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>FILE</I
+></SPAN
>. Delete the
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>FILE</I
+></SPAN
> on exit. Failure to create or delete the
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>FILE</I
-> is non-fatal. If no <I
+></SPAN
+> is non-fatal. If no <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>FILE</I
+></SPAN
>
option is given, no PID file will be used. Unix only.
</P
></LI
><LI
><P
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>--user USER[.GROUP]</I
+></SPAN
>
</P
><P
> After (optionally) writing the PID file, assume the user ID of
- <I
+ <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>USER</I
+></SPAN
>, and if included the GID of GROUP. Exit if the
privileges are not sufficient to do so. Unix only.
</P
></LI
><LI
><P
-> <I
+> <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>configfile</I
+></SPAN
>
</P
><P
-> If no <I
+> If no <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>configfile</I
+></SPAN
> is included on the command line,
<SPAN
CLASS="APPLICATION"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="quickstart.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="configuration.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>Templates</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
-TITLE="Privoxy 2.9.20 User Manual"
+TITLE="Privoxy 3.0.0 User Manual"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="The Filter File"
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
><TH
COLSPAN="3"
ALIGN="center"
->Privoxy 2.9.20 User Manual</TH
+>Privoxy 3.0.0 User Manual</TH
></TR
><TR
><TD
VALIGN="bottom"
><A
HREF="filter-file.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="contact.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="TEMPLATES"
->10. Templates</A
-></H1
+NAME="TEMPLATES">10. Templates</H1
><P
> All <SPAN
CLASS="APPLICATION"
TARGET="_top"
>web-based
user interface</A
->, are generated from <I
+>, are generated from <SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>templates</I
+></SPAN
>.
(<SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
> fills at run time. You can
edit the templates with a normal text editor, should you want to customize them.
- (<I
+ (<SPAN
+CLASS="emphasis"
+><I
CLASS="EMPHASIS"
>Not recommended for the casual user</I
+></SPAN
>). Note that
just like in configuration files, lines starting with <TT
CLASS="LITERAL"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="filter-file.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="contact.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
>Note to Upgraders</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
REL="HOME"
-TITLE="Privoxy 2.9.20 User Manual"
+TITLE="Privoxy 3.0.0 User Manual"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="Installation"
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
><TH
COLSPAN="3"
ALIGN="center"
->Privoxy 2.9.20 User Manual</TH
+>Privoxy 3.0.0 User Manual</TH
></TR
><TR
><TD
VALIGN="bottom"
><A
HREF="installation.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="bottom"
><A
HREF="quickstart.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
><H1
CLASS="SECT1"
><A
-NAME="UPGRADERSNOTE"
->3. Note to Upgraders</A
-></H1
+NAME="UPGRADERSNOTE">3. Note to Upgraders</H1
><P
> There are very significant changes from earlier
<SPAN
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="installation.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
VALIGN="top"
><A
HREF="quickstart.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
projects / privoxy.git / commitdiff