By: Privoxy Developers
-$Id: developer-manual.sgml,v 1.18 2002/04/03 03:51:48 hal9 Exp $
+$Id: developer-manual.sgml,v 1.24 2002/04/04 21:33:37 hal9 Exp $
The developer manual gives the users information on how to help the developer
team. It provides guidance on coding, testing, documentation and other issues.
tastes. Privoxy has application for both stand-alone systems and multi-user
networks.
-Privoxy is based on the code of the Internet Junkbuster. Junkbuster was
+Privoxy is based on the code of the Internet Junkbuster (tm). Junkbuster was
originally written by JunkBusters Corporation, and was released as free
open-source software under the GNU GPL. Stefan Waldherr made many improvements,
and started the SourceForge project to continue development.
-Privoxy continues the Junkbuster tradition, but adds many refinements and
-enhancements.
+Privoxy continues the Junkbuster tradition, but adds many refinements,
+enhancements and new features.
You can find the latest version of the this manual at http://www.privoxy.org/
-developer-manual/. Please see the Contact section of the User Manual on how to
-contact the developers.
+developer-manual/. Please see the Contact section on how to contact the
+developers.
-------------------------------------------------------------------------------
Table of Contents
+
1. Introduction
-2. Quickstart to Privoxy Development
-3. Documentation Guidelines
-4. Coding Guidelines
+3. Quickstart to Privoxy Development
+4. Documentation Guidelines
- 4.1. Introduction
- 4.2. Using Comments
+ 4.1. Quickstart to Docbook and SGML
+ 4.2. Privoxy Documentation Style
+ 4.3. Privoxy Custom Entities
+
+5. Coding Guidelines
+
+ 5.1. Introduction
+ 5.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.4. Comment each logical step
- 4.2.5. Comment All Functions Thoroughly
- 4.2.6. Comment at the end of braces if the content is more than one
+ 5.2.1. Comment, Comment, Comment
+ 5.2.2. Use blocks for comments
+ 5.2.3. Keep Comments on their own line
+ 5.2.4. Comment each logical step
+ 5.2.5. Comment All Functions Thoroughly
+ 5.2.6. Comment at the end of braces if the content is more than one
screen length
- 4.3. Naming Conventions
+ 5.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
+ 5.3.1. Variable Names
+ 5.3.2. Function Names
+ 5.3.3. Header file prototypes
+ 5.3.4. Enumerations, and #defines
+ 5.3.5. Constants
- 4.4. Using Space
+ 5.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.4. Use white space freely because it is free
- 4.4.5. Don't use white space around structure operators
- 4.4.6. Make the last brace of a function stand out
- 4.4.7. Use 3 character indentions
+ 5.4.1. Put braces on a line by themselves.
+ 5.4.2. ALL control statements should have a block
+ 5.4.3. Do not belabor/blow-up boolean expressions
+ 5.4.4. Use white space freely because it is free
+ 5.4.5. Don't use white space around structure operators
+ 5.4.6. Make the last brace of a function stand out
+ 5.4.7. Use 3 character indentions
- 4.5. Initializing
+ 5.5. Initializing
- 4.5.1. Initialize all variables
+ 5.5.1. Initialize all variables
- 4.6. Functions
+ 5.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.4. Pass and Return by Const Reference
- 4.6.5. Pass and Return by Value
- 4.6.6. Names of include files
- 4.6.7. Provide multiple inclusion protection
- 4.6.8. Use `extern "C"` when appropriate
- 4.6.9. Where Possible, Use Forward Struct Declaration Instead of
+ 5.6.1. Name functions that return a boolean as a question.
+ 5.6.2. Always specify a return type for a function.
+ 5.6.3. Minimize function calls when iterating by using variables
+ 5.6.4. Pass and Return by Const Reference
+ 5.6.5. Pass and Return by Value
+ 5.6.6. Names of include files
+ 5.6.7. Provide multiple inclusion protection
+ 5.6.8. Use `extern "C"` when appropriate
+ 5.6.9. Where Possible, Use Forward Struct Declaration Instead of
Includes
- 4.7. General Coding Practices
+ 5.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.4. Use 'long' or 'short' Instead of 'int'
- 4.7.5. Don't mix size_t and other types
- 4.7.6. Declare each variable and struct on its own line.
- 4.7.7. Use malloc/zalloc sparingly
- 4.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring
+ 5.7.1. Turn on warnings
+ 5.7.2. Provide a default case for all switch statements
+ 5.7.3. Try to avoid falling through cases in a switch statement.
+ 5.7.4. Use 'long' or 'short' Instead of 'int'
+ 5.7.5. Don't mix size_t and other types
+ 5.7.6. Declare each variable and struct on its own line.
+ 5.7.7. Use malloc/zalloc sparingly
+ 5.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring
'free'
- 4.7.9. Add loaders to the `file_list' structure and in order
- 4.7.10. "Uncertain" new code and/or changes to exitinst code, use FIXME
+ 5.7.9. Add loaders to the `file_list' structure and in order
+ 5.7.10. "Uncertain" new code and/or changes to exitinst code, use FIXME
- 4.8. Addendum: Template for files and function comment blocks:
+ 5.8. Addendum: Template for files and function comment blocks:
+
+6. Version Control Guidelines
+7. Testing Guidelines
+
+ 7.1. Testplan for releases
+ 7.2. Test reports
-5. Version Control Guidelines
-6. Testing Guidelines
+8. Releasing a new version
- 6.1. Testplan for releases
- 6.2. Test reports
+ 8.1. Before the Release
+ 8.2. Update the webserver
+ 8.3. SuSE or Red Hat
+ 8.4. OS/2
+ 8.5. Solaris
+ 8.6. Windows
+ 8.7. Debian
+ 8.8. Mac OSX
+ 8.9. FreeBSD
+ 8.10. Tarball
+ 8.11. HP-UX 11
+ 8.12. Amiga OS
+ 8.13. AIX
-7. Releasing a new version
+9. Contacting the developers, Bug Reporting and Feature Requests
+10. Copyright and History
- 7.1. Before the Release
- 7.2. Update the webserver
- 7.3. SuSE or Red Hat
- 7.4. OS/2
- 7.5. Solaris
- 7.6. Windows
- 7.7. Debian
- 7.8. Mac OSX
- 7.9. FreeBSD
- 7.10. Tarball
- 7.11. HP-UX 11
- 7.12. Amiga OS
- 7.13. AIX
+ 10.1. Copyright
+ 10.2. History
-8. Contact the developers
-9. Copyright and History
-10. See also
+11. See also
+
+-------------------------------------------------------------------------------
1. Introduction
-------------------------------------------------------------------------------
-2. Quickstart to Privoxy Development
+3. Quickstart to Privoxy Development
You'll need an account on Sourceforge to support our development. Mail your ID
to the list and wait until a project manager has added you.
-------------------------------------------------------------------------------
-3. Documentation Guidelines
+4. Documentation Guidelines
All formal documents are maintained in docbook SGML and located in the doc/
source directory. You will need docbook and the docbook stylesheets (or
-comparable alternatives), and either jade or openjade installed in order to
-build docs from source. Currently there is user-manual, FAQ, and, of course
-this, the developer-manual in this format.
+comparable alternatives), and either jade or openjade (recommended) installed
+in order to build docs from source. Currently there is user-manual, FAQ, and,
+of course this, the developer-manual in this format. The README, is also now
+maintained as SGML. The README in the top-level source directory is a generated
+file. DO NOT edit this directly. Edit the SGML source!
-Other, less formal documents (e.g. README, LICENSE) are maintained as plain
-text files in the toplevel source directory.
+Other, less formal documents (e.g. AUTHORS, LICENSE) are maintained as plain
+text files in the toplevel source directory. At least for the time being.
Packagers are encouraged to include this documentation. For those without the
ability to build the docs locally, text versions of each are kept in CVS. Or
HTML versions can be downloaded from the www.privoxy.org website, which should
-be fairly current.
+be fairly current. (This is only a temporary solution.)
Formal documents are built with the Makefile targets of make dok, or
alternately make redhat-dok. If you have problems, try both. The build process
-------------------------------------------------------------------------------
-4. Coding Guidelines
+4.1. Quickstart to Docbook and SGML
+
+If you are not familiar with SGML, it is a markup language similar to HTML. In
+fact, HTML is an SGML application. Both use "tags" to format text and other
+content. SGML tags are much more varied, and flexible, but do much of the same
+kinds of things. The tags, or "elements", are definable in SGML. There is no
+set "standards". Since we are using Docbook, our tags are those that are
+defined by Docbook. Much of how the finish document is rendered is determined
+by the "stylesheets". The stylesheets determine how each tag gets translated to
+HTML, or other formats.
+
+Tags in SGML need to be always "closed". If not, you will likely generate
+errors. Example: <title>My Title</title>. They are also case-insensitive, but
+we strongly suggest using all lower case. This keeps compatibility with
+[Docbook] XML.
+
+Our documents use "sections" for the most part. Sections will be processed into
+HTML headers (e.g. h1 for sect1). The Docbook stylesheets will use these to
+also generate the Table of Contents for each doc. Our TOC's are set to a depth
+of three. Meaning sect1, sect2, and sect3 will have TOC entries, but sect4 will
+not. Each section requires a <title> element, and at least one <para>. There is
+a limit of five section levels in Docbook, but generally three should be
+sufficient for our purposes.
+
+Some common elements that you likely will use:
+
+<para></para>, paragraph delimiter. Most text needs to be within paragraph
+elements.
+<emphasis></emphasis>, stylesheets make this italics.
+<filename></filename>, files and directories.
+<command></command>, command examples.
+<literallayout></literllayout>, like <pre>, more or less.
+<itemizedlist></itemizdelist>, list with bullets.
+<listitem></listitem>, member of the above.
+<screen></screen>, screen output, implies <literallayout>.
+<ulink url="example.com"></ulink>, like HTML <a> tag.
+<quote></quote>, for, doh, quoting text.
+
+Look at any of the existing docs for examples of all these and more.
+
+-------------------------------------------------------------------------------
+
+4.2. Privoxy Documentation Style
+
+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 is all done in a similar
+fashion.
+
+Here it is:
+
+ * All tags should be lower case.
+
+ * Tags delimiting a block of text should be on their own line. Like:
+
+ <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.
+
+
+ * Tags should be nested and step indented like:
+
+ <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
+ 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>
+ element, or the <!-- --> style comment familiar from HTML.
+
+ * We have an international audience. Refrain from slang, or English
+ idiosyncrasies (too many to list :).
+
+ * Try to keep overall line lengths in source files to 80 characters or less
+ for obvious reasons. This is not always possible, with lenghty 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:
+
+ My favorite site is <ulink url="http://example.com">here</ulink>.
+
+ This will render as "My favorite site is here", which is not real helpful
+ in a text doc. Better like this:
+
+ My favorite site is <ulink url="http://example.com">example.com</ulink>.
+
+ * All documents should be spell checked occasionally. aspell can check SGML
+ with the -H option. (ispell I think too.)
+
+-------------------------------------------------------------------------------
+
+4.3. Privoxy Custom Entities
+
+Privoxy documentation is using a number of customized "entities" to facilitate
+documentation maintenance.
+
+We are using a set of "boilerplate" files with generic text, 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 generic. That is the purpose; so it
+can be used in varying contexts without additional modifications.
+
+We are also using what Docbook calls "internal entities". These are like
+variables in programming. Well, sort of. For instance, we have the p-version
+entity that contains the current Privoxy version string. You are strongly
+encouraged to use these where possible. Some of these obviously require
+re-setting with each release. A sampling of custom entities are listed below.
+See any of the main docs for examples.
+
+ * Re-cyclable "boilerplate" text entities are defined like:
+
+ <!entity supported SYSTEM "supported.sgml">
+
+ In this example, the contents of the file, supported.sgml is available for
+ inclusion anywhere in the doc. To make this happen, just reference the now
+ defined entity: &supported; (starts with an ampersand and ends with a
+ semi-colon), and the contents will be dumped into the finished doc at that
+ point.
+
+ * Commonly used "internal entities":
+
+ p-version: the Privoxy version string, e.g. "2.9.13".
+ 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!
+
+-------------------------------------------------------------------------------
+
+5. Coding Guidelines
-4.1. Introduction
+5.1. Introduction
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 Privoxy"
-------------------------------------------------------------------------------
-4.2. Using Comments
+5.2. Using Comments
-4.2.1. Comment, Comment, Comment
+5.2.1. Comment, Comment, Comment
Explanation:
-------------------------------------------------------------------------------
-4.2.2. Use blocks for comments
+5.2.2. Use blocks for comments
Explanation:
-------------------------------------------------------------------------------
-4.2.3. Keep Comments on their own line
+5.2.3. Keep Comments on their own line
Explanation:
-------------------------------------------------------------------------------
-4.2.4. Comment each logical step
+5.2.4. Comment each logical step
Explanation:
-------------------------------------------------------------------------------
-4.2.5. Comment All Functions Thoroughly
+5.2.5. Comment All Functions Thoroughly
Explanation:
-------------------------------------------------------------------------------
-4.2.6. Comment at the end of braces if the content is more than one screen
+5.2.6. Comment at the end of braces if the content is more than one screen
length
Explanation:
-------------------------------------------------------------------------------
-4.3. Naming Conventions
+5.3. Naming Conventions
-4.3.1. Variable Names
+5.3.1. Variable Names
Explanation:
-------------------------------------------------------------------------------
-4.3.2. Function Names
+5.3.2. Function Names
Explanation:
-------------------------------------------------------------------------------
-4.3.3. Header file prototypes
+5.3.3. Header file prototypes
Explanation:
-------------------------------------------------------------------------------
-4.3.4. Enumerations, and #defines
+5.3.4. Enumerations, and #defines
Explanation:
-------------------------------------------------------------------------------
-4.3.5. Constants
+5.3.5. Constants
Explanation:
-------------------------------------------------------------------------------
-4.4. Using Space
+5.4. Using Space
-4.4.1. Put braces on a line by themselves.
+5.4.1. Put braces on a line by themselves.
Explanation:
-------------------------------------------------------------------------------
-4.4.2. ALL control statements should have a block
+5.4.2. ALL control statements should have a block
Explanation:
-------------------------------------------------------------------------------
-4.4.3. Do not belabor/blow-up boolean expressions
+5.4.3. Do not belabor/blow-up boolean expressions
Example:
-------------------------------------------------------------------------------
-4.4.4. Use white space freely because it is free
+5.4.4. Use white space freely because it is free
Explanation:
-------------------------------------------------------------------------------
-4.4.5. Don't use white space around structure operators
+5.4.5. Don't use white space around structure operators
Explanation:
-------------------------------------------------------------------------------
-4.4.6. Make the last brace of a function stand out
+5.4.6. Make the last brace of a function stand out
Example:
-------------------------------------------------------------------------------
-4.4.7. Use 3 character indentions
+5.4.7. Use 3 character indentions
Explanation:
-------------------------------------------------------------------------------
-4.5. Initializing
+5.5. Initializing
-4.5.1. Initialize all variables
+5.5.1. Initialize all variables
Explanation:
-------------------------------------------------------------------------------
-4.6. Functions
+5.6. Functions
-4.6.1. Name functions that return a boolean as a question.
+5.6.1. Name functions that return a boolean as a question.
Explanation:
-------------------------------------------------------------------------------
-4.6.2. Always specify a return type for a function.
+5.6.2. Always specify a return type for a function.
Explanation:
-------------------------------------------------------------------------------
-4.6.3. Minimize function calls when iterating by using variables
+5.6.3. Minimize function calls when iterating by using variables
Explanation:
-------------------------------------------------------------------------------
-4.6.4. Pass and Return by Const Reference
+5.6.4. Pass and Return by Const Reference
Explanation:
-------------------------------------------------------------------------------
-4.6.5. Pass and Return by Value
+5.6.5. Pass and Return by Value
Explanation:
-------------------------------------------------------------------------------
-4.6.6. Names of include files
+5.6.6. Names of include files
Explanation:
-------------------------------------------------------------------------------
-4.6.7. Provide multiple inclusion protection
+5.6.7. Provide multiple inclusion protection
Explanation:
-------------------------------------------------------------------------------
-4.6.8. Use `extern "C"` when appropriate
+5.6.8. Use `extern "C"` when appropriate
Explanation:
-------------------------------------------------------------------------------
-4.6.9. Where Possible, Use Forward Struct Declaration Instead of Includes
+5.6.9. Where Possible, Use Forward Struct Declaration Instead of Includes
Explanation:
-------------------------------------------------------------------------------
-4.7. General Coding Practices
+5.7. General Coding Practices
-4.7.1. Turn on warnings
+5.7.1. Turn on warnings
Explanation
-------------------------------------------------------------------------------
-4.7.2. Provide a default case for all switch statements
+5.7.2. Provide a default case for all switch statements
Explanation:
-------------------------------------------------------------------------------
-4.7.3. Try to avoid falling through cases in a switch statement.
+5.7.3. Try to avoid falling through cases in a switch statement.
Explanation:
-------------------------------------------------------------------------------
-4.7.4. Use 'long' or 'short' Instead of 'int'
+5.7.4. Use 'long' or 'short' Instead of 'int'
Explanation:
-------------------------------------------------------------------------------
-4.7.5. Don't mix size_t and other types
+5.7.5. Don't mix size_t and other types
Explanation:
-------------------------------------------------------------------------------
-4.7.6. Declare each variable and struct on its own line.
+5.7.6. Declare each variable and struct on its own line.
Explanation:
-------------------------------------------------------------------------------
-4.7.7. Use malloc/zalloc sparingly
+5.7.7. Use malloc/zalloc sparingly
Explanation:
-------------------------------------------------------------------------------
-4.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring 'free'
+5.7.8. The Programmer Who Uses 'malloc' is Responsible for Ensuring 'free'
Explanation:
-------------------------------------------------------------------------------
-4.7.9. Add loaders to the `file_list' structure and in order
+5.7.9. Add loaders to the `file_list' structure and in order
Explanation:
-------------------------------------------------------------------------------
-4.7.10. "Uncertain" new code and/or changes to exitinst code, use FIXME
+5.7.10. "Uncertain" new code and/or changes to exitinst code, use FIXME
Explanation:
-------------------------------------------------------------------------------
-4.8. Addendum: Template for files and function comment blocks:
+5.8. Addendum: Template for files and function comment blocks:
Example for file comments:
-const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.18 2002/04/03 03:51:48 hal9 Exp $";
+const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.24 2002/04/04 21:33:37 hal9 Exp $";
/*********************************************************************
*
* File : $Source$
#ifndef _FILENAME_H
#define _FILENAME_H
-#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.18 2002/04/03 03:51:48 hal9 Exp $"
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.24 2002/04/04 21:33:37 hal9 Exp $"
/*********************************************************************
*
* File : $Source$
-------------------------------------------------------------------------------
-5. Version Control Guidelines
+6. Version Control Guidelines
To be filled. note on cvs comments. Don't only comment what you did, but also
why you did it!
-------------------------------------------------------------------------------
-6. Testing Guidelines
+7. Testing Guidelines
To be filled.
-------------------------------------------------------------------------------
-6.1. Testplan for releases
+7.1. Testplan for releases
Explain release numbers. major, minor. developer releases. etc.
-------------------------------------------------------------------------------
-6.2. Test reports
+7.2. Test reports
Please submit test reports only with the test form at sourceforge. Three simple
steps:
-------------------------------------------------------------------------------
-7. Releasing a new version
+8. Releasing a new version
To minimize trouble with distribution contents, webpage errors and the like, we
strongly encourage you to follow this section if you prepare a new release of
-------------------------------------------------------------------------------
-7.1. Before the Release
+8.1. Before the Release
The following must be done by one of the developers prior to each new release:
-------------------------------------------------------------------------------
-7.2. Update the webserver
+8.2. Update the webserver
All files must be group-readable and group-writable (or no one else will be
able to change them). To update the webserver, create any pages locally in the
-------------------------------------------------------------------------------
-7.3. SuSE or Red Hat
+8.3. SuSE or Red Hat
Ensure that you have the latest code version. Hence run:
-------------------------------------------------------------------------------
-7.4. OS/2
+8.4. OS/2
Ensure that you have the latest code version. Hence run:
- cd current
- cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
-
+ cd current
+ cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
+ cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
+ cd ..
+ cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
+
-first.
+You will need a mix of development tools. The main compilation takes place with
+IBM Visual Age C++. Some ancillary work takes place with GNU tools, available
+from various sources like hobbes.nmsu.edu. Specificially, you will need
+autoheader, autoconf and sh tools. The packaging takes place with WarpIN,
+available from various sources, including its home page: xworkplace.
- autoheader && autoconf && ./configure
+Change directory to the os2setup directory. Edit the os2build.cmd file to set
+the final executable filename. For example,
+
+ installExeName='privoxyos2_setup_X.Y.Z.exe'
-Then do FIXME.
+Next, edit the IJB.wis file so the release number matches in the PACKAGEID
+section:
+
+ PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
+
+
+You're now ready to build. Run:
+
+ os2build
+
+
+And in the ./files directory you will have the WarpIN-installable executable.
+Upload this anonymously to uploads.sourceforge.net/incoming, create a release
+for it, and you're done.
-------------------------------------------------------------------------------
-7.5. Solaris
+8.5. Solaris
Login to Sourceforge's compilefarm via ssh
-------------------------------------------------------------------------------
-7.6. Windows
+8.6. Windows
Ensure that you have the latest code version. Hence run
-------------------------------------------------------------------------------
-7.7. Debian
+8.7. Debian
Ensure that you have the latest code version. Hence run:
-------------------------------------------------------------------------------
-7.8. Mac OSX
-
-Login to Sourceforge's compilefarm via ssh
-
- ssh cf.sourceforge.net
-
+8.8. Mac OSX
-Choose the right operating system. If you have downloaded Privoxy before,
+Ensure that you have the latest code version. Hence run:
- cd current
- cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
-
+ cd current
+ cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
+ cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
+ cd ..
+ cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup
+
-If not, please checkout Privoxy via CVS first. Run:
+From the osxsetup directory, run:
- autoheader && autoconf && ./configure
+ build
-Then run:
+This will run autoheader, autoconf and configure as well as make. Finally, it
+will copy over the necessary files to the ./osxsetup/files directory for
+further processing by PackageMaker.
+
+Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the
+package name to match the release, and hit the "Create package" button. If you
+specify ./Privoxy.pkg as the output package name, you can then create the
+distributable zip file with the command:
- make macosx-dist
+zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
-which creates a gzip'ed tar archive. Sadly, you cannot use make macosx-upload
-on the Sourceforge machine (no ncftpput). You now have to manually upload the
-archive to Sourceforge's ftp server and release the file publicly.
+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.
-------------------------------------------------------------------------------
-7.9. FreeBSD
+8.9. FreeBSD
Change the version number of Privoxy in the configure.in file. Run:
-------------------------------------------------------------------------------
-7.10. Tarball
+8.10. Tarball
Ensure that you have the latest code version. Hence run:
-------------------------------------------------------------------------------
-7.11. HP-UX 11
+8.11. HP-UX 11
Ensure that you have the latest code version. Hence run:
-------------------------------------------------------------------------------
-7.12. Amiga OS
+8.12. Amiga OS
Ensure that you have the latest code version. Hence run:
-------------------------------------------------------------------------------
-7.13. AIX
+8.13. AIX
Login to Sourceforge's compilefarm via ssh:
-------------------------------------------------------------------------------
-8. Contact the developers
+9. Contacting the developers, Bug Reporting and Feature Requests
+
+We value your feedback. However, to provide you with the best support, please
+note:
+
+ * Use the Sourceforge Support Forum to get help:
+
+ http://sourceforge.net/tracker/?group_id=11118&atid=211118
+
+
+ * Submit bugs only through our Sourceforge Bug Forum:
+
+ http://sourceforge.net/tracker/?group_id=11118&atid=111118.
+
+
+ Make sure that the bug has not already been submitted. Please try to verify
+ that it is a Privoxy bug, and not a browser or site bug first. If you are
+ using your own custom configuration, please try the stock configs to see if
+ the problem is a configuration related bug. And if not using the latest
+ development snapshot, please try the latest one. Or even better, CVS
+ sources. Please be sure to include the Privoxy/Junkbuster version,
+ platform, browser, any pertinent log data, any other relevant details
+ (please be specific) and, if possible, some way to reproduce the bug.
+
+ * Submit feature requests only through our Sourceforge feature request
+ forum:
+
+ http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.
+
+
+ * For any other issues, feel free to use the mailing lists:
+
+ http://sourceforge.net/mail/?group_id=11118.
+
+
+ Anyone interested in actively participating in development and related
+ discussions can also join the appropriate mailing list. Archives are
+ available too.
+
+-------------------------------------------------------------------------------
+
+10. Copyright and History
+
+10.1. Copyright
+
+Privoxy 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, which
+is available from the Free Software Foundation, Inc, 59 Temple Place - Suite
+330, Boston, MA 02111-1307, USA.
-Please see the contact page in the user-manual for details.
+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.
-------------------------------------------------------------------------------
-9. Copyright and History
+10.2. History
-Please see the user-manual for information on Copyright and History.
+Privoxy is evolved, and derived from, the Internet Junkbuster, with many
+improvments and enhancements over the original.
+
+Junkbuster was originally written by Anonymous Coders and Junkbuster's
+Corporation, and was released as free open-source software under the GNU GPL.
+Stefan Waldherr made many improvements, and started the SourceForge project
+Privoxy to rekindle development. There are now several active developers
+contributing. The last stable release of Junkbuster was v2.0.2, which has now
+grown whiskers ;-).
-------------------------------------------------------------------------------
-10. See also
+11. See also
+
+Other references and sites of interest to Privoxy users:
+
+http://www.privoxy.org/, The Privoxy Home page.
+
+http://sourceforge.net/projects/ijbswa, the Project Page for Privoxy on
+Sourceforge.
+
+http://p.p/, access Privoxy from your browser. Alternately, http://
+config.privoxy.org may work in some situations where the first does not.
+
+http://www.junkbusters.com/ht/en/cookies.html
+
+http://www.waldherr.org/junkbuster/
+
+http://privacy.net/analyze/
+
+http://www.squid-cache.org/
-Please see the user-manual for others references.
+
By: Privoxy Developers
-$Id: user-manual.sgml,v 1.64 2002/04/03 03:53:43 hal9 Exp $
+$Id: user-manual.sgml,v 1.68 2002/04/04 18:46:47 swa Exp $
The user manual gives users information on how to install, configure and use
-Privoxy. Privoxy is a web proxy with advanced filtering capabilities for
-protecting privacy, filtering web page content, managing cookies, controlling
-access, and removing ads, banners, pop-ups and other obnoxious Internet Junk.
-Privoxy has a very flexible configuration and can be customized to suit
-individual needs and tastes. Privoxy has application for both stand-alone
-systems and multi-user networks.
+Privoxy.
+
+Privoxy is a web proxy with advanced filtering capabilities for protecting
+privacy, filtering web page content, managing cookies, controlling access, and
+removing ads, banners, pop-ups and other obnoxious Internet junk. Privoxy has a
+very flexible configuration and can be customized to suit individual needs and
+tastes. Privoxy has application for both stand-alone systems and multi-user
+networks.
+
+Privoxy is based on the code of the Internet Junkbuster (tm). Junkbuster was
+originally written by JunkBusters Corporation, and was released as free
+open-source software under the GNU GPL. Stefan Waldherr made many improvements,
+and started the SourceForge project to continue development.
+
+Privoxy continues the Junkbuster tradition, but adds many refinements,
+enhancements and new features.
You can find the latest version of the user manual at http://www.privoxy.org/
-user-manual/.
+user-manual/. Please see the Contact section on how to contact the developers.
-------------------------------------------------------------------------------
Table of Contents
+
1. Introduction
1.1. New Features
-2. Installation
-
- 2.1. Source
- 2.2. Red Hat
- 2.3. SuSE
- 2.4. OS/2
- 2.5. Windows
- 2.6. Other
+3. Installation
-3. Quickstart to Using Privoxy
+ 3.1. Source
+
+ 3.1.1. Red Hat
+ 3.1.2. SuSE
+ 3.1.3. OS/2
+ 3.1.4. Windows
+ 3.1.5. Other
+
+4. Quickstart to Using Privoxy
- 3.1. Command Line Options
+ 4.1. Command Line Options
-4. Privoxy Configuration
+5. Privoxy Configuration
- 4.1. Controlling Privoxy with Your Web Browser
- 4.2. Configuration Files Overview
- 4.3. The Main Configuration File
+ 5.1. Controlling Privoxy with Your Web Browser
+ 5.2. Configuration Files Overview
+ 5.3. The Main Configuration File
- 4.3.1. Defining Other Configuration Files
- 4.3.2. Other Configuration Options
- 4.3.3. Access Control List (ACL)
- 4.3.4. Forwarding
- 4.3.5. Windows GUI Options
+ 5.3.1. Defining Other Configuration Files
+ 5.3.2. Other Configuration Options
+ 5.3.3. Access Control List (ACL)
+ 5.3.4. Forwarding
+ 5.3.5. Windows GUI Options
- 4.4. The Actions File
+ 5.4. The Actions File
- 4.4.1. URL Domain and Path Syntax
- 4.4.2. Actions
- 4.4.3. Aliases
+ 5.4.1. URL Domain and Path Syntax
+ 5.4.2. Actions
+ 5.4.3. Aliases
- 4.5. The Filter File
- 4.6. Templates
+ 5.5. The Filter File
+ 5.6. Templates
-5. Contacting the Developers, Bug Reporting and Feature Requests
-6. Copyright and History
+6. Contacting the Developers, Bug Reporting and Feature Requests
+7. Copyright and History
- 6.1. License
- 6.2. History
+ 7.1. Copyright
+ 7.2. History
-7. See Also
-8. Appendix
+8. See Also
+9. Appendix
- 8.1. Regular Expressions
- 8.2. Privoxy's Internal Pages
+ 9.1. Regular Expressions
+ 9.2. Privoxy's Internal Pages
- 8.2.1. Bookmarklets
+ 9.2.1. Bookmarklets
- 8.3. Anatomy of an Action
+ 9.3. Anatomy of an Action
-1. Introduction
-
-Privoxy is a web proxy with advanced filtering capabilities for protecting
-privacy, filtering web page content, managing cookies, controlling access, and
-removing ads, banners, pop-ups and other obnoxious Internet junk. Privoxy has a
-very flexible configuration and can be customized to suit individual needs and
-tastes. Privoxy has application for both stand-alone systems and multi-user
-networks.
-
-Privoxy is based on the code of the Internet Junkbuster. Junkbuster was
-originally written by JunkBusters Corporation, and was released as free
-open-source software under the GNU GPL. Stefan Waldherr made many improvements,
-and started the SourceForge project to continue development.
+-------------------------------------------------------------------------------
-Privoxy continues the Junkbuster tradition, but adds many refinements and
-enhancements.
+1. Introduction
-This documentation is included with the current BETA version of Privoxy 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 BETA version of Privoxy,
+v.2.9.13, 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" ;-).
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
-------------------------------------------------------------------------------
-2. Installation
+3. Installation
-Privoxy is available as raw source code, or pre-compiled binaries. See the
-Privoxy Home Page for binaries and current release info. Privoxy is also
-available via CVS. This is the recommended approach at this time. But please be
-aware that CVS is constantly changing, and it may break in mysterious ways.
+Privoxy is available as raw source code (tarball or via CVS), or pre-compiled
+binaries for various platforms. See the Privoxy Project Page for the most up to
+date release information. Privoxy is also available via CVS. This is the
+recommended approach at this time. But please be aware that CVS is constantly
+changing, and it may break in mysterious ways.
+
+At present, Privoxy is known to run on Win32, Mac OSX, OS/2, AmigaOS, Linux
+(RedHat, Suse, Debian), FreeBSD, and many flavors of Unix. There are source and
+binary releases for these available for download at http://sourceforge.net/
+project/showfiles.php?group_id=11118.
-------------------------------------------------------------------------------
-2.1. Source
+3.1. Source
+
+There are several ways to install Privoxy.
-For gzipped tar archives, unpack the source:
+To build Privoxy from source, autoconf and GNU make (gmake) are required.
+Source is available as gzipped tar archives. For this, first unpack the source:
tar xzvf privoxy-2.9.13-beta-src* [.tgz or .tar.gz]
cd privoxy-2.9.13-beta
For retrieving the current CVS sources, you'll need the CVS package installed
-first. To download CVS source:
+first. Note CVS source is development quality, and may not be stable, or well
+tested. To download CVS source:
cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
This will create a directory named current/, which will contain the source
tree.
-Then, in either case, to build from tarball/CVS source:
+Then, in either case, to build from unpacked tarball or CVS source:
+ autoheader
+ autoconf
./configure (--help to see options)
make (the make from gnu, gmake for *BSD)
su
make install (to really install)
+Redhat and SuSE src and binary RPMs can be built with "make redhat-dist" or "
+make suse-dist" from unpacked sources. You will need to run "autoconf;
+autoheader; ./configure" beforehand. *BSD will require gmake (from http://
+www.gnu.org).
+
For Redhat and SuSE Linux RPM packages, see below.
-------------------------------------------------------------------------------
-2.2. Red Hat
+3.1.1. Red Hat
-To build Redhat RPM packages, install source as above. Then:
+To build Redhat RPM packages from source, install source as above. Then:
autoheader
autoconf
This will create both binary and src RPMs in the usual places. Example:
- /usr/src/redhat/RPMS/i686/privoxy-2.9.11-1.i686.rpm
+ /usr/src/redhat/RPMS/i686/privoxy-2.9.13-1.i686.rpm
- /usr/src/redhat/SRPMS/privoxy-2.9.11-1.src.rpm
+ /usr/src/redhat/SRPMS/privoxy-2.9.13-1.src.rpm
To install, of course:
- rpm -Uvv /usr/src/redhat/RPMS/i686/privoxy-2.9.11-1.i686.rpm
+ rpm -Uvv /usr/src/redhat/RPMS/i686/privoxy-2.9.13-1.i686.rpm
This will place the Privoxy configuration files in /etc/privoxy/, and log files
-in /var/log/privoxy/.
+in /var/log/privoxy/. Run ckconfig privoxy on to have Privoxy start
+automatically during init.
-------------------------------------------------------------------------------
-2.3. SuSE
+3.1.2. SuSE
To build SuSE RPM packages, install source as above. Then:
This will create both binary and src RPMs in the usual places. Example:
- /usr/src/packages/RPMS/i686/privoxy-2.9.11-1.i686.rpm
+ /usr/src/packages/RPMS/i686/privoxy-2.9.13-1.i686.rpm
- /usr/src/packages/SRPMS/privoxy-2.9.11-1.src.rpm
+ /usr/src/packages/SRPMS/privoxy-2.9.13-1.src.rpm
To install, of course:
- rpm -Uvv /usr/src/packages/RPMS/i686/privoxy-2.9.11-1.i686.rpm
+ rpm -Uvv /usr/src/packages/RPMS/i686/privoxy-2.9.13-1.i686.rpm
This will place the Privoxy configuration files in /etc/privoxy/, and log files
-------------------------------------------------------------------------------
-2.4. OS/2
+3.1.3. OS/2
Privoxy is packaged in a WarpIN self- installing archive. The self-installing
program will be named depending on the release version, something like:
-privoxyos2_setup_1.2.3.exe. In order to install it, simply run this executable
+privoxyos2_setup_2.9.13.exe. In order to install it, simply run this executable
or double-click on its icon and follow the WarpIN installation panels. A shadow
of the Privoxy executable will be placed in your startup folder so it will
start automatically whenever OS/2 starts.
-------------------------------------------------------------------------------
-2.5. Windows
+3.1.4. Windows
Click-click. (I need help on this. Not a clue here. Also for configuration
section below. HB.)
-------------------------------------------------------------------------------
-2.6. Other
+3.1.5. Other
Some quick notes on other Operating Systems.
-------------------------------------------------------------------------------
-3. Quickstart to Using Privoxy
+4. Quickstart to Using Privoxy
Before launching Privoxy for the first time, you will want to configure your
browser(s) to use Privoxy as a HTTP and HTTPS proxy. The default is localhost
-------------------------------------------------------------------------------
-3.1. Command Line Options
+4.1. Command Line Options
Privoxy may be invoked with the following command-line options:
-------------------------------------------------------------------------------
-4. Privoxy Configuration
+5. 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
-------------------------------------------------------------------------------
-4.1. Controlling Privoxy with Your Web Browser
+5.1. Controlling Privoxy with Your Web Browser
Privoxy can be reached by the special URL http://p.p/ (or alternately http://
config.privoxy.org/), which is an internal page. You will see the following
-------------------------------------------------------------------------------
-4.2. Configuration Files Overview
+5.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
The installed defaults provide a reasonable starting point, though possibly
aggressive by some standards. For the time being, there are only three default
-configuration files (this will change in time):
+configuration files (this may change in time):
* The main configuration file is named config on Linux, Unix, BSD, OS/2, and
AmigaOS and config.txt on Windows.
-------------------------------------------------------------------------------
-4.3. The Main Configuration File
+5.3. The Main Configuration File
Again, the main configuration file is named config on Linux/Unix/BSD and OS/2,
and config.txt on Windows. Configuration lines consist of an initial keyword
-------------------------------------------------------------------------------
-4.3.1. Defining Other Configuration Files
+5.3.1. Defining Other Configuration Files
Privoxy can use a number of other files to tell it what ads to block, what
cookies to accept, and perform other functions. This section of the
-------------------------------------------------------------------------------
-4.3.2. Other Configuration Options
+5.3.2. Other Configuration Options
This part of the configuration file contains options that control how Privoxy
operates.
-------------------------------------------------------------------------------
-4.3.3. Access Control List (ACL)
+5.3.3. Access Control List (ACL)
Access controls are included at the request of some ISPs and systems
administrators, and are not usually needed by individual users. Please note the
-------------------------------------------------------------------------------
-4.3.4. Forwarding
+5.3.4. Forwarding
This feature allows chaining of HTTP requests via multiple proxies. It can be
used to better protect privacy and confidentiality when accessing specific
If you intend to chain Privoxy and squid locally, then chain as browser ->
squid -> privoxy is the recommended way.
-Your squid configuration could then look like this:
+Your squid configuration could then look like this (assuming that the IP
+address of the box is 192.168.0.1 ):
# Define Privoxy as parent cache
- cache_peer 127.0.0.1 parent 8118 0 no-query
+ cache_peer 192.168.0.1 parent 8118 0 no-query
+
+ # don't listen to the whole world
+ http_port 192.168.0.1:3128
+
+ # define the local lan
+ acl mylocallan src 192.168.0.1-192.168.0.5/255.255.255.255
+
+ # grant access for http to local lan
+ http_access allow mylocallan
# Define ACL for protocol FTP
acl FTP proto FTP
-------------------------------------------------------------------------------
-4.3.5. Windows GUI Options
+5.3.5. Windows GUI Options
Privoxy has a number of options specific to the Windows GUI interface:
-------------------------------------------------------------------------------
-4.4. The Actions File
+5.4. The Actions File
The "default.action" file (formerly actionsfile or ijb.action) is used to
define what actions Privoxy takes, and thus determines how ad images, cookies
-------------------------------------------------------------------------------
-4.4.1. URL Domain and Path Syntax
+5.4.1. URL Domain and Path Syntax
Generally, a pattern has the form <domain>/<path>, where both the <domain> and
<path> part are optional. If you only specify a domain part, the "/" can be
-------------------------------------------------------------------------------
-4.4.2. Actions
+5.4.2. Actions
Actions are enabled if preceded with a "+", and disabled if preceded with a
"-". Actions are invoked by enclosing the action name in curly braces (e.g.
want invisible ads, they should be defined as images and blocked. And also,
"image-blocker" should be set to "blank". Note you cannot treat HTML pages
as images in most cases. For instance, frames require an HTML page to
- display. Forcing an "image" in this situation just will not work.
+ display. So a frame that is an ad, cannot be treated as an image. Forcing
+ an "image" in this situation just will not work.
+image
misbehave, possibly even not to display at all. There are many ways a site
designer may choose to design his site, and what HTTP header content 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.
+Appendix for a brief example on troubleshooting actions.
-------------------------------------------------------------------------------
-4.4.3. Aliases
+5.4.3. 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".
Now let's define a few aliases:
- # Useful customer aliases we can use later. These must come first!
+ # Useful custom aliases we can use later. These must come first!
{{alias}}
+no-cookies = +no-cookies-set +no-cookies-read
-no-cookies = -no-cookies-set -no-cookies-read
-------------------------------------------------------------------------------
-4.5. The Filter File
+5.5. The Filter File
Any web page can be dynamically modified with the filter file. This
modification can be removal, or re-writing, of any web page content, including
-------------------------------------------------------------------------------
-4.6. Templates
+5.6. Templates
When Privoxy displays one of its internal pages, such as a 404 Not Found error
page, it uses the appropriate template. On Linux, BSD, and Unix, these are
-------------------------------------------------------------------------------
-5. Contacting the Developers, Bug Reporting and Feature Requests
+6. Contacting the Developers, Bug Reporting and Feature Requests
We value your feedback. However, to provide you with the best support, please
note:
- * Use the Sourceforge support forum to get help.
+ * Use the Sourceforge Support Forum to get help:
+
+ http://sourceforge.net/tracker/?group_id=11118&atid=211118
+
- * Submit bugs only thru our Sourceforge bug forum.
+ * Submit bugs only through our Sourceforge Bug Forum:
+
+ http://sourceforge.net/tracker/?group_id=11118&atid=111118.
+
Make sure that the bug has not already been submitted. Please try to verify
that it is a Privoxy bug, and not a browser or site bug first. If you are
platform, browser, any pertinent log data, any other relevant details
(please be specific) and, if possible, some way to reproduce the bug.
- * Submit feature requests only thru our Sourceforge feature request forum.
+ * Submit feature requests only through our Sourceforge feature request
+ forum:
+
+ http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.
+
+
+ * For any other issues, feel free to use the mailing lists:
+
+ http://sourceforge.net/mail/?group_id=11118.
+
+
+ Anyone interested in actively participating in development and related
+ discussions can also join the appropriate mailing list. Archives are
+ available too.
-
-
-For any other issues, feel free to use the mailing lists.
-
-Anyone interested in actively participating in development and related
-discussions can join the appropriate mailing list here. Archives are available
-here too.
-
-------------------------------------------------------------------------------
-6. Copyright and History
+7. Copyright and History
-6.1. License
+7.1. Copyright
Privoxy 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
-------------------------------------------------------------------------------
-6.2. History
+7.2. History
Privoxy is evolved, and derived from, the Internet Junkbuster, with many
improvments and enhancements over the original.
-------------------------------------------------------------------------------
-7. See Also
+8. See Also
Other references and sites of interest to Privoxy users:
- http://www.privoxy.org/, The Privoxy Home page.
+http://www.privoxy.org/, The Privoxy Home page.
- http://sourceforge.net/projects/ijbswa, the Project Page for Privoxy on
+http://sourceforge.net/projects/ijbswa, the Project Page for Privoxy on
Sourceforge.
- http://p.p/, access Privoxy from your browser. Alternately, http://
+http://p.p/, access Privoxy from your browser. Alternately, http://
config.privoxy.org may work in some situations where the first does not.
- http://www.junkbusters.com/ht/en/cookies.html
+http://www.junkbusters.com/ht/en/cookies.html
- http://www.waldherr.org/junkbuster/
+http://www.waldherr.org/junkbuster/
- http://privacy.net/analyze/
+http://privacy.net/analyze/
- http://www.squid-cache.org/
+http://www.squid-cache.org/
-------------------------------------------------------------------------------
-8. Appendix
+9. Appendix
-8.1. Regular Expressions
+9.1. Regular Expressions
Privoxy can use "regular expressions" in various config files. Assuming support
for "pcre" (Perl Compatible Regular Expressions) is compiled in, which is the
-------------------------------------------------------------------------------
-8.2. Privoxy's Internal Pages
+9.2. Privoxy's Internal Pages
Since Privoxy proxies each requested web page, it is easy for Privoxy to trap
certain special URLs. In this way, we can talk directly to Privoxy, and see how
-------------------------------------------------------------------------------
-8.2.1. Bookmarklets
+9.2.1. Bookmarklets
Here are some bookmarklets to allow you to easily access a "mini" version of
this page. They are designed for MS Internet Explorer, but should work equally
-------------------------------------------------------------------------------
-8.3. Anatomy of an Action
+9.3. Anatomy of an Action
The way Privoxy applies "actions" and "filters" to any given URL can be
complex, and not always so easy to understand what is happening. And sometimes
of HTML pages. So you will only get info for the actual URL that is pasted into
the prompt area -- not any sub-URLs. If you want to know about embedded URLs
like ads, you will have to dig those out of the HTML source. Use your browser's
-"View Page Source" option for this.
+"View Page Source" option for this. Or right click on the ad, and grab the URL.
Let's look at an example, google.com, one section at a time:
Now the page displays ;-) Be sure to flush your browser's caches when making
-such changes. Or, try using Shift+Reload.
+such changes. Or, try using Shift+Reload.
But now what about a situation where we get no explicit matches like we did
-with:
+with:
{ -block }
/adsl
projects / privoxy.git / commitdiff