From: hal9 Date: Thu, 5 Sep 2002 23:26:23 +0000 (+0000) Subject: Just regenerating to get fresh version in place of very dated versions. X-Git-Tag: v_3_1_archive_branchpoint~150 X-Git-Url: http://www.privoxy.org/gitweb/%22https:/@default-cgi@toggle?a=commitdiff_plain;h=a5b1999794b4b0faa68812c0b8b2861316ae8341;p=privoxy.git Just regenerating to get fresh version in place of very dated versions. --- diff --git a/doc/pdf/privoxy-developer-manual.pdf b/doc/pdf/privoxy-developer-manual.pdf index 2575a0bd..f1b89617 100644 Binary files a/doc/pdf/privoxy-developer-manual.pdf and b/doc/pdf/privoxy-developer-manual.pdf differ diff --git a/doc/pdf/privoxy-faq.pdf b/doc/pdf/privoxy-faq.pdf index e5a458c3..e7bd2db1 100644 Binary files a/doc/pdf/privoxy-faq.pdf and b/doc/pdf/privoxy-faq.pdf differ diff --git a/doc/pdf/privoxy-user-manual.pdf b/doc/pdf/privoxy-user-manual.pdf index 012e2e43..b0056d18 100644 Binary files a/doc/pdf/privoxy-user-manual.pdf and b/doc/pdf/privoxy-user-manual.pdf differ diff --git a/doc/text/developer-manual.txt b/doc/text/developer-manual.txt index 99df01d2..c65e06f4 100644 --- a/doc/text/developer-manual.txt +++ b/doc/text/developer-manual.txt @@ -2,14 +2,17 @@ Privoxy Developer Manual Copyright © 2001, 2002 by Privoxy Developers -$Id: developer-manual.sgml,v 1.42 2002/05/05 20:26:02 hal9 Exp $ +$Id: developer-manual.sgml,v 2.3 2002/09/05 02:27:59 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. +The developer manual provides guidance on coding, testing, packaging, +documentation and other issues of importance to those involved with Privoxy +development. It is mandatory (and helpful!) reading for anyone who wants to +join the team. -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. +Please note that this document is constantly evolving. This copy represents the +state at the release of version 3.1.1. 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. ------------------------------------------------------------------------------- @@ -21,8 +24,8 @@ Table of Contents 2. The CVS Repository 2.1. Access to CVS - 2.2. CVS Commit Guideline - 2.3. Discussing Changes First + 2.2. Branches + 2.3. CVS Commit Guidelines 3. Documentation Guidelines @@ -105,17 +108,18 @@ Table of Contents 6.2. Before the Release: Freeze 6.3. Building and Releasing the Packages - 6.3.1. Source Tarball - 6.3.2. SuSE or Red Hat RPM - 6.3.3. OS/2 - 6.3.4. Solaris - 6.3.5. Windows - 6.3.6. Debian - 6.3.7. Mac OSX - 6.3.8. FreeBSD - 6.3.9. HP-UX 11 - 6.3.10. Amiga OS - 6.3.11. AIX + 6.3.1. Note on Privoxy Packaging + 6.3.2. Source Tarball + 6.3.3. SuSE, Conectiva or Red Hat RPM + 6.3.4. OS/2 + 6.3.5. Solaris + 6.3.6. Windows + 6.3.7. Debian + 6.3.8. Mac OSX + 6.3.9. FreeBSD + 6.3.10. HP-UX 11 + 6.3.11. Amiga OS + 6.3.12. AIX 6.4. Uploading and Releasing Your Package 6.5. After the Release @@ -124,9 +128,9 @@ Table of Contents 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 filter problems + 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 @@ -154,6 +158,11 @@ porting, are all important jobs as well. 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. +You will also need to have a cvs package installed, which will entail having +ssh installed as well (which seems to be a requirement of SourceForge), in +order to access the cvs repository. Having the GNU build tools is also going to +be important (particularly, autoconf and gmake). + For the time being (read, this section is under construction), please refer to the extensive comments in the source code. @@ -177,13 +186,37 @@ tree module is called current. ------------------------------------------------------------------------------- -2.2. CVS Commit Guideline +2.2. Branches + +Within the CVS repository, there are modules and branches. As mentioned, the +sources are in the current "module". Other modules are present for platform +specific issues. There is a webview of the CVS hierarchy at http:// +cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/, which might help with +visualizing how these pieces fit together. + +Branches are used to fork a sub-development path from the main trunk. Within +the current module where the sources are, there is always at least one "branch" +from the main trunk devoted to a stable release series. The main trunk is where +active development takes place for the next stable series (e.g. 3.2.x). And for +testing bugfixes for the stable series. Just prior to each stable series (e.g. +3.0.x), a branch is created just for stable series releases (e.g. 3.0.0 -> +3.0.1 -> 3.0.2, etc). Once the initial stable release of any stable branch has +taken place, this branch is only used for bugfixes, which have had prior +testing before being committed to CVS. (See Version Numbers below for details +on versioning.) + +------------------------------------------------------------------------------- + +2.3. CVS Commit Guidelines The source tree is the heart of every software project. Every effort must be -made to ensure that it is readable, compilable and consistent at all times. We -therefore ask anyone with CVS access to strictly adhere to the following +made to ensure that it is readable, compilable and consistent at all times. +There are differing guidelines for the stable branch and the main development +trunk, and we ask anyone with CVS access to strictly adhere to the following guidelines: +Basic Guidelines, for all branches: + * 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. @@ -196,34 +229,40 @@ guidelines: all those files. * If your changes span multiple files, and the code won't recompile unless - all changes are commited (e.g. when changing the signature of a function), - then commit all files one after another, without long delays in beween. If + 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 - the team's general consensus on what should be done (see below). + the team's general consensus on what should be done. -------------------------------------------------------------------------------- - -2.3. Discussing Changes First - -We don't have a too formal policy on this, just use common sense. Hints: If it -is.. + * Note that near a major public release, we get more cautious. There is + always the possibility to submit a patch to the patch tracker instead. + +Stable branches are handled with decidedly more care, especially after the +initial *.*.0 release, and we are just in bugfix mode. In addition to the +above, the below applies only to the stable branch (currently the +v_3_0_branchpoint branch): - 1. ..a bugfix / clean-up / cosmetic thing: shoot + * Do not commit anything into the stable branch, unless immediately before a + new release! There needs to be testing done before it hits CVS, and to + ensure that all changes are appropriate just to fix whatever the problem + is. - 2. ..a new feature that can be turned off: shoot + * Where possible, bugfixes and changes should be tested in the main + development trunk first. There may be occasions where this is not feasible, + though. - 3. ..a clear improvement w/o side effects on other parts of the code: shoot + * Alternately, proposed changes can be submitted as patches to the patch + tracker on Sourceforge first: http://sourceforge.net/tracker/?group_id= + 11118&atid=311118. Then ask for peer review. - 4. ..a matter of taste: ask the list + * Do not commit anything unless your proposed changes have been well tested + first, by other members of the project, and have prior approval of the + project leaders or consensus of the devel list. - 5. ..a major redesign of some part of the code: ask the list + * Do not even think about anything except bugfixes. No new features! -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 @@ -233,11 +272,21 @@ source/* directory. You will need Docbook, the Docbook DTD's and the Docbook modular stylesheets (or 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, AUTHORS privoxy.1 (man page) files are also now maintained as Docbook -SGML. The finished files are all in the top-level source directory are -generated files! Also, index.html, the Privoxy home page, is maintained as -SGML. DO NOT edit these directly. Edit the SGML source, or contact someone -involved in the documentation (at present Stefan and Hal). +README, AUTHORS privoxy.1 (man page), and config files are also now maintained +as Docbook SGML. These files, when built, in the top-level source directory are +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 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 +conversion process requires going from SGML to HTML to text to special +formatting required for the embedded comments. Some of this does not survive so +well. Especially some of the examples that are longer than 80 characters. The +build process for this file outputs to config.new, which should be reviewed for +errors and mis-formatting. Once satisfied that it is correct, then it should be +hand copied to config. Other, less formal documents (e.g. LICENSE, INSTALL) are maintained as plain text files in the top-level source directory. At least for the time being. @@ -257,6 +306,7 @@ before committing to CVS, if possible. 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. @@ -371,8 +421,8 @@ Here it is: 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 (), and avoid this mistake: + plain text, TML, and PDF, but others are always a future possibility. Be + careful with URLs (), and avoid this mistake: My favorite site is here. @@ -416,7 +466,7 @@ entities are listed below. See any of the main docs for examples. * Commonly used "internal entities": - p-version: the Privoxy version string, e.g. "2.9.15". + p-version: the Privoxy version string, e.g. "3.1.1". 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"). @@ -1310,7 +1360,7 @@ If you have to "malloc" an instance, you are responsible for insuring that the instance is `free'd, even if the deallocation event falls within some other programmer's code. You are also responsible for ensuring that deletion is timely (i.e. not too soon, not too late). This is known as "low-coupling" and -is a "good thing (tm)". You may need to offer a free/unload/destuctor type +is a "good thing (tm)". You may need to offer a free/unload/destructor type function to accommodate this. Example: @@ -1370,49 +1420,49 @@ from the project). Example for file comments: -const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.42 2002/05/05 20:26:02 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; +const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 2.3 2002/09/05 02:27:59 hal9 Exp $"; +/********************************************************************* + * + * File : $Source$ + * + * Purpose : (Fill me in with a good description!) + * + * Copyright : Written by and Copyright (C) 2001 the SourceForge + * Privoxy team. http://www.privoxy.org/ + * + * Based on the Internet Junkbuster originally written + * by and Copyright (C) 1997 Anonymous Coders and + * Junkbusters Corporation. http://www.junkbusters.com + * + * This program is free software; you can redistribute it + * and/or modify it under the terms of the GNU General + * Public License as published by the Free Software + * Foundation; either version 2 of the License, or (at + * your option) any later version. + * + * This program is distributed in the hope that it will + * be useful, but WITHOUT ANY WARRANTY; without even the + * implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU General Public + * License for more details. + * + * The GNU General Public License should be included with + * this file. If not, you can view it at + * http://www.gnu.org/copyleft/gpl.html + * or write to the Free Software Foundation, Inc., 59 + * Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * Revisions : + * $Log$ + * + *********************************************************************/ + + +#include "config.h" + + ...necessary include files for us to do our work... + +const char FILENAME_h_rcs[] = FILENAME_H_VERSION; Note: This declares the rcs variables that should be added to the "show-proxy-args" page. If this is a brand new creation by you, you are free to @@ -1425,71 +1475,71 @@ can. Example for file header comments: -#ifndef _FILENAME_H -#define _FILENAME_H -#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.42 2002/05/05 20:26:02 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: -*/ +#ifndef _FILENAME_H +#define _FILENAME_H +#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 2.3 2002/09/05 02:27:59 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: @@ -1565,7 +1615,7 @@ steps: * Fill the Summary and Detailed Description with something intelligent (keep it short and precise). -Do not mail to the mailinglist (we cannot keep track on issues there). +Do not mail to the mailing list (we cannot keep track on issues there). ------------------------------------------------------------------------------- @@ -1587,8 +1637,8 @@ scp, ssh (ssh), gmake (GNU's version of make), autoconf, cvs. 6.1. Version numbers First you need to determine which version number the release will have. Privoxy -version numbers consist of three numbers, separated by dots, like in X.Y.Z, -where: +version numbers consist of three numbers, separated by dots, like in X.Y.Z +(e.g. 3.0.0), where: * X, the version major, is rarely ever changed. It is increased by one if turning a development branch into stable substantially changes the @@ -1598,11 +1648,11 @@ where: * 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 bugfixes are made, and 2N+1, the development branch, in + added and only bug-fixes are made, and 2N+1, the development branch, in which the further development of Privoxy takes place. This enables us to turn the code upside down and inside out, while at the same time providing and maintaining a stable version. The minor is reset to zero (and one) when - the major is inrcemented. When a development branch has matured to the + the major is incremented. When a development branch has matured to the point where it can be turned into stable, the old stable branch 2N is given 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. @@ -1618,6 +1668,19 @@ where: distinguished from released versions. The point version is reset to zero when the minor changes. +In summary, the main CVS trunk is the development branch where new features are +being worked on for the next stable series. This should almost always be where +the most activity takes place. There is always at least one stable branch from +the trunk, e.g now it is 3.0, which is only used to release stable versions. +Once the initial .0 release of the stable branch has been done, then as a rule, +only bugfixes that have had prior testing should be committed to the stable +branch. At that point, it is mostly "hands off". Once there are enough bugfixes +to justify a new release, the version of this branch is again incremented +Example: 3.0.0 -> 3.0.1 -> 3.0.2, etc are all stable releases from within the +stable branch. 3.1.x is currently the main trunk, and where work on 3.2.x is +taking place. If any questions, please post to the devel list before committing +to a stable branch! + ------------------------------------------------------------------------------- 6.2. Before the Release: Freeze @@ -1630,7 +1693,8 @@ The following must be done by one of the developers prior to each new release. last minute changes. * Increment the version number (point from odd to even in development - branches!) in configure.in. + 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 standalone actions file release), bump up its version info to A.B in this @@ -1641,9 +1705,26 @@ The following must be done by one of the developers prior to each new release. Then change the version info in doc/webserver/actions/index.php, line: '$required_actions_file_version = "A.B";' - * If the HTML documentation is not in sync with the SGML sources you need to - regenerate and upload it to the webserver. (If in doubt, just do it.) See - the Section "Updating the webserver" in this manual for details. + * 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 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! @@ -1668,7 +1749,7 @@ reasons the first package to be released is always the source tarball. For all types of packages, including the source tarball, you must make sure that you build from clean sources by exporting the right version from CVS into -an empty directory:. +an empty directory (just press return when asked for a password): mkdir dist # delete or choose different name if it already exists cd dist @@ -1680,11 +1761,71 @@ after export from CVS. This is to make sure that all release packages, and with them, all future bug reports, are based on exactly the same code. Please find additional instructions for the source tarball and the individual -platform dependent binary packages below. +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 + 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: + + LICENSE (top-level directory) + + README (top-level directory) + + AUTHORS (top-level directory) + + man page (top-level directory, Unix-like platforms only) + + The User Manual (doc/webserver/user-manual/) + + FAQ (doc/webserver/faq/) + + Also suggested: Developer Manual (doc/webserver/developer-manual) and + ChangeLog (top-level directory). FAQ and the manuals are HTML docs. There + are also text versions in doc/text/ which could conceivably also be + included. + + The documentation has been designed such that the manuals are linked to + each other from parallel directories, and should be packaged that way. + privoxy-index.html can also be included and can serve as a focal point for + docs and other links of interest (and possibly renamed to index.html). This + should be one level up from the manuals. There is a link also on this page + to an HTMLized version of the man page. To avoid 404 for this, it is in CVS + as doc/webserver/man-page/privoxy-man-page.html, and should be included + along with the manuals. There is also a css stylesheets that can be + included for better presentation: p_doc.css. This should be in the same + 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 + overwritten! + + * 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 + "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. + 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.1. Source Tarball +6.3.2. Source Tarball First, make sure that you have freshly exported the right version into an empty directory. (See "Building and releasing packages" above). Then run: @@ -1705,7 +1846,7 @@ change log field, use the relevant section of the ChangeLog file. ------------------------------------------------------------------------------- -6.3.2. SuSE or Red Hat RPM +6.3.3. SuSE, Conectiva or Red Hat RPM In following text, replace dist with either "rh" for Red Hat or "suse" for SuSE. @@ -1740,7 +1881,7 @@ notes and change log from the source tarball package. ------------------------------------------------------------------------------- -6.3.3. OS/2 +6.3.4. OS/2 First, make sure that you have freshly exported the right version into an empty directory. (See "Building and releasing packages" above). Then get the OS/2 @@ -1775,7 +1916,7 @@ tarball package. ------------------------------------------------------------------------------- -6.3.4. Solaris +6.3.5. Solaris Login to Sourceforge's compilefarm via ssh: @@ -1799,7 +1940,7 @@ release notes and Change Log from the source tarball package. ------------------------------------------------------------------------------- -6.3.5. Windows +6.3.6. Windows You should ensure you have the latest version of Cygwin (from http:// www.cygwin.com/). Run the following commands from within a Cygwin bash shell. @@ -1808,13 +1949,13 @@ First, make sure that you have freshly exported the right version into an empty directory. (See "Building and releasing packages" above). Then get the Windows setup module: - cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co winsetup + cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co winsetup Then you can build the package. This is fully automated, and is controlled by winsetup/GNUmakefile. All you need to do is: - cd winsetup - make + cd winsetup + make 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 @@ -1822,19 +1963,26 @@ release notes and Change Log from the source tarball package. ------------------------------------------------------------------------------- -6.3.6. Debian +6.3.7. Debian First, make sure that you have freshly exported the right version into an empty -directory. (See "Building and releasing packages" above). Then, run: +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: - cd current - autoheader && autoconf && ./configure + debchange -v 3.1.1-alpha-1 "New upstream version" -Then do FIXME. +Then, run: + + dpkg-buildpackage -rfakeroot -us -uc -b + +This will create ../privoxy_3.1.1-alpha-1_i386.deb which can be uploaded. To +upload the package to Sourceforge, simply issue + + make debian-upload ------------------------------------------------------------------------------- -6.3.7. Mac OSX +6.3.8. Mac OSX First, make sure that you have freshly exported the right version into an empty directory. (See "Building and releasing packages" above). Then get the Mac OSX @@ -1856,7 +2004,7 @@ package name to match the release, and hit the "Create package" button. If you specify ./Privoxy.pkg as the output package name, you can then create the distributable zip file with the command: -zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg + zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg 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 @@ -1864,9 +2012,9 @@ the release notes and Change Log from the source tarball package. ------------------------------------------------------------------------------- -6.3.8. FreeBSD +6.3.9. FreeBSD -Login to Sourceforge's compilefarm via ssh: +Login to Sourceforge's compile-farm via ssh: ssh cf.sourceforge.net @@ -1888,7 +2036,7 @@ release notes and Change Log from the source tarball package. ------------------------------------------------------------------------------- -6.3.9. HP-UX 11 +6.3.10. HP-UX 11 First, make sure that you have freshly exported the right version into an empty directory. (See "Building and releasing packages" above). Then run: @@ -1900,7 +2048,7 @@ Then do FIXME. ------------------------------------------------------------------------------- -6.3.10. Amiga OS +6.3.11. Amiga OS First, make sure that you have freshly exported the right version into an empty directory. (See "Building and releasing packages" above). Then run: @@ -1912,7 +2060,7 @@ Then do FIXME. ------------------------------------------------------------------------------- -6.3.11. AIX +6.3.12. AIX Login to Sourceforge's compilefarm via ssh: @@ -1947,11 +2095,13 @@ through the release steps. The upload is done via FTP: * 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.15 (beta). +3.1.1 (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 @@ -1972,30 +2122,36 @@ essentially the same steps, but select Edit Release, instead of Add 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, incosistent 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 redkat-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 @@ -2003,71 +2159,80 @@ This will do the upload to the webserver (www.privoxy.org) and ensure all files 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. However, to provide you with the best support, please -note the following sections. +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 -To get support, use the Sourceforge Support Forum: +For casual users, our support forum at SourceForge is probably best suited: +http://sourceforge.net/tracker/?group_id=11118&atid=211118 - http://sourceforge.net/tracker/?group_id=11118&atid=211118 +All users are of course welcome to discuss their issues on the users mailing +list, where the developers also hang around. ------------------------------------------------------------------------------- -8.2. Report bugs +8.2. Report Bugs -To submit bugs, use the Sourceforge Bug Forum: +Please report all bugs only through our bug tracker: http://sourceforge.net/ +tracker/?group_id=11118&atid=111118. - http://sourceforge.net/tracker/?group_id=11118&atid=111118. +Before doing so, please make sure that the bug has not already been submitted +and observe the additional hints at the top of the submit form. -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 version, platform, browser, any pertinent log data, -any other relevant details (please be specific) and, if possible, some way to -reproduce the bug. +Please try to verify that it is a Privoxy bug, and not a browser or site bug +first. If unsure, try toggling off Privoxy, and see if the problem persists. +The appendix of the user manual also has helpful information on action +debugging. If you are using your own custom configuration, please try the stock +configs to see if the problem is configuration related. -------------------------------------------------------------------------------- +If not using the latest version, chances are that the bug has been found and +fixed in the meantime. We would appreciate if you could take the time to +upgrade to the latest version (or even the latest CVS snapshot) and verify your +bug, but this is not required for reporting. -8.3. Request new features +------------------------------------------------------------------------------- -To submit ideas on new features, use the Sourceforge feature request forum: +8.3. Request New Features - http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse. +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 filter problems +8.4. Report Ads or Other Actions-Related Problems -You can also send feedback on websites that Privoxy has problems with. Please -bookmark the following link: "Privoxy - Submit Filter Feedback". Once you surf -to a page with problems, use the bookmark to send us feedback. We will look -into the issue as soon as possible. +Please send feedback on ads that slipped through, innocent images that were +blocked, and any other problems relating to the default.action file through our +actions feedback mechanism located at http://www.privoxy.org/actions/. On this +page, you will also find a bookmark which will take you back there from any +troubled site and even pre-fill the form! New, improved default.action files will occasionally be made available based on -your feedback. These will be announced on the ijbswa-announce list. +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 -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. See the page on Sourceforge. +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! You can find an overview of all Privoxy-related +mailing lists, including list archives, at: http://sourceforge.net/mail/? +group_id=11118. ------------------------------------------------------------------------------- @@ -2104,15 +2269,31 @@ this program; if not, write to the 9.2. History -Privoxy is evolved, and derived from, the Internet Junkbuster, with many -improvments and enhancements over the original. +In the beginning, there was the Internet Junkbuster, by Anonymous Coders and +Junkbusters Corporation. It saved many users a lot of pain in the early days of +web advertising and user tracking. -Junkbuster was originally written by Anonymous Coders and Junkbusters -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 ;-). +But the web, its protocols and standards, and with it, the techniques for +forcing users to consume ads, give up autonomy over their browsing, and for +spying on them, kept evolving. Unfortunately, the Internet Junkbuster did not. +Version 2.0.2, published in 1998, was (and is) the last official release +available from Junkbusters Corporation. Fortunately, it had been released under +the GNU GPL, which allowed further development by others. + +So Stefan Waldherr started maintaining an improved version of the software, to +which eventually a number of people contributed patches. It could already +replace banners with a transparent image, and had a first version of pop-up +killing, but it was still very closely based on the original, with all its +limitations, such as the lack of HTTP/1.1 support, flexible per-site +configuration, or content modification. The last release from this effort was +version 2.0.2-10, published in 2000. + +Then, some developers picked up the thread, and started turning the software +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, was released +August, 2002. ------------------------------------------------------------------------------- @@ -2120,24 +2301,34 @@ grown whiskers ;-). 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://www.privoxy.org/faq/, the Privoxy FAQ. + +http://sourceforge.net/projects/ijbswa/, the Project Page for Privoxy on +SourceForge. + +http://config.privoxy.org/, the web-based user interface. Privoxy must be +running for this to work. Shortcut: http://p.p/ -http://sourceforge.net/projects/ijbswa, the Project Page for Privoxy on -Sourceforge. +http://www.privoxy.org/actions/, to submit "misses" to the developers. -http://p.p/, access Privoxy from your browser. Alternately, http:// -config.privoxy.org may work in some situations where the first does not. +http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/contrib/, cool and fun +ideas from Privoxy users. -http://p.p/, and select "Privoxy - Submit Filter Feedback" to submit "misses" -to the developers. +http://www.junkbusters.com/ht/en/cookies.html, an explanation how cookies are +used to track web users. -http://www.junkbusters.com/ht/en/cookies.html +http://www.junkbusters.com/ijb.html, the original Internet Junkbuster. -http://www.waldherr.org/junkbuster/ +http://www.waldherr.org/junkbuster/, Stefan Waldherr's version of Junkbuster, +from which Privoxy was derived. -http://privacy.net/analyze/ +http://privacy.net/analyze/, a useful site to check what information about you +is leaked while you browse the web. -http://www.squid-cache.org/ +http://www.squid-cache.org/, a very popular caching proxy, which is often used +together with Privoxy. - +http://www.privoxy.org/developer-manual/, the Privoxy developer manual. diff --git a/doc/text/faq.txt b/doc/text/faq.txt index 5c4cbeb8..05ac4b52 100644 --- a/doc/text/faq.txt +++ b/doc/text/faq.txt @@ -2,10 +2,10 @@ Privoxy Frequently Asked Questions Copyright © 2001, 2002 by Privoxy Developers -$Id: faq.sgml,v 1.57 2002/05/05 20:26:02 hal9 Exp $ +$Id: faq.sgml,v 2.2 2002/09/05 04:25:05 hal9 Exp $ -This FAQ gives users and developers alike answers to frequently asked questions -about Privoxy . +This FAQ gives quick answers to frequently asked questions about Privoxy. It +can't and doesn't replace the User Manual. Privoxy is a web proxy with advanced filtering capabilities for protecting privacy, filtering web page content, managing cookies, controlling access, and @@ -16,8 +16,10 @@ networks. Privoxy is based on Internet Junkbuster (tm). -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. +Please note that this document is constantly evolving. This copy represents the +state at the release of version 3.1.1. 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. ------------------------------------------------------------------------------- @@ -27,17 +29,17 @@ Table of Contents 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? - 1.4. What are some of the new features? - 1.5. What is a "proxy"? How does Privoxy work? - 1.6. How does Privoxy know what is an ad, and what is not? - 1.7. Can Privoxy make mistakes? This does not sound very scientific. - 1.8. My browser does the same things as Privoxy. Why should I use Privoxy + 1.4. What is a "proxy"? How does Privoxy work? + 1.5. How does Privoxy know what is an ad, and what is not? + 1.6. Can Privoxy make mistakes? This does not sound very scientific. + 1.7. My browser does the same things as Privoxy. Why should I use Privoxy at all? - 1.9. Is there is a license or fee? What about a warranty? Registration? - 1.10. I would like to help you, what do I do? + 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.10.1. Money Money Money - 1.10.2. You want to work with us? + 1.9.1. Money Money Money + 1.9.2. Software + 1.9.3. You want to work with us? 2. Installation @@ -51,25 +53,30 @@ Table of Contents 3. Configuration - 3.1. Can I use my old config files? - 3.2. What is an "actions" file? - 3.3. The "actions" concept confuses me. Please list some of these + 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. How are actions files configured? What is the easiest way to do this? - 3.5. There are several different "actions" files. What are the differences? - 3.6. Why can I change the configuration with a browser? Does that not raise + 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? + 3.8. What's the difference between the "Cautious", "Medium" and "Advanced" + defaults? + 3.9. Why can I change the configuration with a browser? Does that not raise security issues? - 3.7. What is "default.filter"? - 3.8. How can I set up Privoxy to act as a proxy for my LAN? - 3.9. Instead of ads, now I get a checkerboard pattern. I don't want to see + 3.10. What is the default.filter file? What is a "filter"? + 3.11. How can I set up Privoxy to act as a proxy for my LAN? + 3.12. Instead of ads, now I get a checkerboard pattern. I don't want to see anything. - 3.10. Why would anybody want to see a checkerboard pattern? - 3.11. I see large red banners on some pages that say "Blocked". Why and how - do I get rid of this? - 3.12. I cannot see all of the "Blocked" page banner. Help. - 3.13. Can Privoxy run as a service on Win2K/NT? - 3.14. How can I make Privoxy work with other proxies like Squid? - 3.15. Can Privoxy run as a "transparent" proxy? + 3.13. Why would anybody want to see a checkerboard pattern? + 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? + 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 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 @@ -77,22 +84,27 @@ Table of Contents time to browsing. 4.2. I noticed considerable delays in page requests compared to the old Junkbuster. What's wrong? - 4.3. What is the "http://p.p/"? + 4.3. What are "http://config.privoxy.org/" and "http://p.p/"? 4.4. Do you still maintain the blocklists? 4.5. How can I submit new ads? 4.6. How can I hide my IP address? 4.7. Can Privoxy guarantee I am anonymous? - 4.8. Might some things break because header information is being altered? + 4.8. Might some things break because header information or content is being + altered? 4.9. Can Privoxy act as a "caching" proxy to speed up web browsing? 4.10. What about as a firewall? Can Privoxy protect me? - 4.11. The Privoxy logo that replaces ads is very blocky and ugly looking. - Can't a better font be used? - 4.12. I have large empty spaces now where ads used to be. Why? - 4.13. How can Privoxy filter Secure (HTTPS) URLs? - 4.14. Privoxy runs as a "server". How secure is it? Do I need to take any + 4.11. I have large empty spaces / a checkerboard pattern now where ads used + to be. Why? + 4.12. How can Privoxy filter Secure (HTTPS) URLs? + 4.13. Privoxy runs as a "server". How secure is it? Do I need to take any special precautions? - 4.15. How can I temporarily disable Privoxy? - 4.16. Where can I find more information about Privoxy and related issues? + 4.14. How can I temporarily disable Privoxy? + 4.15. When "disabled" is Privoxy totally out of the picture? + 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 @@ -101,13 +113,23 @@ Table of Contents 5.2. I just added a new rule, but the steenkin ad is still getting through. How? 5.3. One of my favorite sites does not work with Privoxy. What can I do? + 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 + 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: + . 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 filter problems + 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 @@ -119,30 +141,47 @@ Table of Contents 1.1. What is this new version of Privoxy? -The original Internet JunkbusterTM (tm) is a copyrighted product of Junkbusters -Corporation. Development of this effort stopped some time ago as of version -2.0.2. Stefan Waldherr started the ijbswa project on Sourceforge to rekindle -development. Other developers subsequently joined with Stefan, and have since -added many new features, refinements and enhancements. The result of this -effort is Privoxy. +In the beginning, there was the Internet Junkbuster, by Anonymous Coders and +Junkbusters Corporation. It saved many users a lot of pain in the early days of +web advertising and user tracking. -Privoxy has evolved from the Junkbuster 2.0.2 code base, and has advanced -significantly at this point. +But the web, its protocols and standards, and with it, the techniques for +forcing users to consume ads, give up autonomy over their browsing, and for +spying on them, kept evolving. Unfortunately, the Internet Junkbuster did not. +Version 2.0.2, published in 1998, was (and is) the last official release +available from Junkbusters Corporation. Fortunately, it had been released under +the GNU GPL, which allowed further development by others. -Please see the History section for more information on the history of -Junkbuster and Privoxy. +So Stefan Waldherr started maintaining an improved version of the software, to +which eventually a number of people contributed patches. It could already +replace banners with a transparent image, and had a first version of pop-up +killing, but it was still very closely based on the original, with all its +limitations, such as the lack of HTTP/1.1 support, flexible per-site +configuration, or content modification. The last release from this effort was +version 2.0.2-10, published in 2000. + +Then, some developers picked up the thread, and started turning the software +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, was released +August, 2002. ------------------------------------------------------------------------------- 1.2. Why "Privoxy"? Why a name change at all? -Privoxy is the "Privacy Enhancing Proxy". +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 +Internet Junkbuster, so publishing our Junkbuster-derived software under the +same name led to confusion. -There are 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. -And thus they "own" the rights to the name. (There are, however, no objections -from Junkbusters Corporation to the Privoxy project itself, and they, in fact, -still share our ideals and goals.) +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 @@ -158,14 +197,12 @@ helps protect your privacy. But, these are all enhanced, and many new features 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 you are upgrading from Junkbuster 2.0.x. -The "blocklist" file does not exist any more. This is replaced by "actions" -files, such as default.actions. This is where most of the per site -configuration is now. +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. -------------------------------------------------------------------------------- - -1.4. What are some of the new features? +Privoxy's new features include: * Integrated browser based configuration and control utility at http:// config.privoxy.org/ (shortcut: http://p.p/). Browser-based tracing of rule @@ -176,7 +213,7 @@ configuration is now. * Modularized configuration that allows for standard settings and user settings to reside in separate files, so that installing updated actions - files won't overwrite idividual user settings. + files won't overwrite individual user settings. * HTTP/1.1 compliant (but not all optional 1.1 features are supported). @@ -207,51 +244,56 @@ configuration is now. ------------------------------------------------------------------------------- -1.5. What is a "proxy"? How does Privoxy work? +1.4. What is a "proxy"? How does Privoxy work? -When you connect to a web site with Privoxy, you are really connecting to your -locally running version of Privoxy. Privoxy intercepts your requests for the -web page, and relays that to the "real" web site. The web site sends the HTTP -data stream back to Privoxy, where Privoxy can work its magic before it relays -this data back to your web browser. +A web proxy is a service, based on a software such as Privoxy, that clients +(i.e. browsers) can use instead of connecting directly to the web servers on +the Internet. The clients then ask the proxy to fetch the objects they need +(web pages, images, movies etc) on their behalf, and when the proxy has done +so, it hands the results back to the client. -Since Privoxy sits between you and the WWW, it is in a position to intercept -and completely manage all web traffic and HTTP content before it gets to your -browser. Privoxy uses various programming methods to do this, all of which is -under your control via the various configuration files and options. +There are many reasons to use web proxies, such as security (firewalling), +efficiency (caching) and others, and there are just as many different proxies +to accommodate those needs. -There are many kinds of proxies. Privoxy best fits the "filtering proxy" -category. +Privoxy is a proxy that is solely focused on privacy protection and junk +elimination. Sitting between your browser(s) and the Internet, it is in a +perfect position to filter outbound personal information that your browser is +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.6. How does Privoxy know what is an ad, and what is not? +1.5. How does Privoxy know what is an ad, and what is not? + +Privoxy's approach to blocking ads is twofold: -Privoxy processes all the raw content of every web page. So it reads everything -on each page. It then compares this to the rules as set up in the configuration -files, and looks for any matches to these rules. Privoxy makes heavy use of -"regular expressions". (If you are not familiar with regular expressions, it is -explained briefly in the user manual.) Regular expressions facilitate matching -of one text string against another, using wildcards to build complex patterns. -So Privoxy will typically look for URLs and other content that match certain -key words and expressions as defined in the configuration files. For instance a -URL that contains "/banners", has a high probability of containing ad banners, -and thus would be a prime candidate to have a matching rule. +First, there are certain patterns in the locations (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 "banners"!) and the host (blocking the +big banner hosting services like doublecklick.net already helps a lot). Privoxy +takes advantage of this fact by using URL patterns to sort out and block the +requests for banners. -So Privoxy will look for these kinds of obvious looking culprits. And also, -will use lists of known organizations that specialize in ads. Again, using -complex patterns to match as many potential combinations as possible since -there tend to be many, many variations used by advertisers, and new ones are -being introduced all the time. +Second, banners tend to come in certain sizes. 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, Privoxy also inspects the HTML sources of web pages +while they are loaded, and replaces references to images with standard banner +sizes by dummy references, so that your browser doesn't request them anymore in +the first place. + +Both of this involves a certain amount of guesswork and is, of course, freely +configurable. ------------------------------------------------------------------------------- -1.7. Can Privoxy make mistakes? This does not sound very scientific. +1.6. Can Privoxy make mistakes? This does not sound very scientific. Actually, it's a black art ;-) And yes, it is always possible to have a broad -rule accidentally block something by mistake. There is a good chance you may -run into such a situation at some point. It is tricky writing rules to cover -every conceivable possibility, and not occasionally get false positives. +rule accidentally block or change something by mistake. There is a good chance +you may run into such a situation at some point. It is tricky writing rules to +cover every conceivable possibility, and not occasionally get false positives. But this should not be a big concern since the Privoxy configuration is very flexible, and includes tools to help identify these types of situations so they @@ -260,7 +302,7 @@ the Troubleshooting section below.) ------------------------------------------------------------------------------- -1.8. My browser does the same things as Privoxy. Why should I use Privoxy at +1.7. My browser does the same things as Privoxy. Why should I use Privoxy at all? Modern browsers do indeed have some of the same functionality as Privoxy. Maybe @@ -273,7 +315,7 @@ you don't have to maintain a similar configuration for possibly many browsers. ------------------------------------------------------------------------------- -1.9. Is there is a license or fee? What about a warranty? Registration? +1.8. Is there is a license or fee? What about a warranty? Registration? Privoxy is licensed under the GNU General Public License (GPL). It is free to use, copy, modify or distribute as you wish under the terms of this license. @@ -286,22 +328,33 @@ Privoxy really is free in every respect! ------------------------------------------------------------------------------- -1.10. I would like to help you, what do I do? +1.9. I would like to help you, what do I do? + +1.9.1. Money Money Money + +We, of course, welcome donations and could use money for domain registering, +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.10.1. Money Money Money +1.9.2. Software -We, of course, welcome donations and use the money for domain registering, -regular world-wide get-togethers (hahaha). Anyway, we'll soon describe the -process how to donate money to the team. +If you are a vendor of a web-related software like a browser, web server or +proxy, and would like us to ensure that Privoxy runs smoothly with your +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.10.2. You want to work with us? +1.9.3. You want to work with us? -Well, helping the team is always a good idea. We welcome new developers, RPM -gurus or documentation makers. Simply get an account on sourceforge.net and -mail your id to the developer mailing list. Then read the section Quickstart in -the Developer's Manual. +Well, helping the team is always a good idea. We welcome new developers, +packaging gurus or documentation writers. Simply get an account on +SourceForge.net and mail your id to the developers mailing list. Then read the +Developer's Manual. 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. @@ -312,38 +365,38 @@ repository, and together we'll find a suitable task for you. 2.1. Which browsers are supported by Privoxy? -Any browser that can be configured to use a "proxy", which should be virtually +Any browser that can be configured to use a proxy, which should be virtually all browsers. Direct browser support is not necessary since Privoxy runs as a -separate application and just exchanges standard HTML data with your browser, -just like a web server does. +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? At present, Privoxy is known to run on Windows(95, 98, ME, 2000, XP), Linux -(RedHat, Suse, Debian), Mac OSX, OS/2, AmigaOS, FreeBSD, NetBSD, BeOS, and many -more flavors of Unix. +(RedHat, SuSE, Debian, Conectiva, Gentoo, Slackware), Mac OSX, OS/2, AmigaOS, +BeOS, FreeBSD, NetBSD, Solaris, and more flavors of Unix. 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 +Source code is freely available, so porting to other operating systems is always a possibility. ------------------------------------------------------------------------------- 2.3. Can I install Privoxy over Junkbuster? -We recommend you uninstall Junkbuster first to minimize conflicts and +We recommend you un-install Junkbuster first to minimize conflicts and confusion. You may want to save your old configuration files for future -reference. The configuration is substantially changed. +reference. The configuration files and syntax have substantially changed, so +you will need to manually port your old patterns. See the note to upgraders and +installation chapter in the user manual for details. -See the user-manual for platform specific installation instructions. - -Note: Some installers may automatically uninstall Junkbuster, if present! +Note: Some installers may automatically un-install Junkbuster, if present! ------------------------------------------------------------------------------- @@ -351,8 +404,8 @@ Note: Some installers may automatically uninstall Junkbuster, if present! All browsers must be told to use Privoxy as a proxy by specifying the correct proxy address and port number in the appropriate configuration area for the -browser. See below. Also, you should flush your browser's memory and disk cache -to get rid of any cached items. +browser. See below. You should also flush your browser's memory and disk cache +to get rid of any cached junk items. ------------------------------------------------------------------------------- @@ -360,18 +413,20 @@ to get rid of any cached items. If you set up the Privoxy to run on the computer you browse from (rather than your ISP's server or some networked computer on a LAN), the proxy will be on -"localhost" (which is the special name used by every computer on the Internet -to refer to itself) and the port will be 8118 (unless you have Privoxy to run -on a different port with the listen-address config option). +127.0.0.1 (sometimes referred to as "localhost", which is the special name used +by every computer on the Internet to refer to itself) and the port will be 8118 +(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" 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. +"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. +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. @@ -384,229 +439,307 @@ What's wrong? Did you configure your browser to use Privoxy as a proxy? It does not sound like it. See above. You might also try flushing the browser's caches to force a full re-reading of pages. You can verify that Privoxy is running, and your -browser is correctly configured by entering the special URL: http://p.p/. This -should give you a banner that says "This is Privoxy" and access to Privoxy's -internal configuration. If you see this, then you are good to go. If not, the -browser or Privoxy are not set up correctly. +browser is correctly configured by entering the special URL: http:// +config.privoxy.org/. This should take you to a page titled "This is Privoxy.." +with access to Privoxy's internal configuration. If you see this, then you are +good to go. If you receive a page saying "Privoxy is not running", then the +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 -3.1. Can I use my old config files? +3.1. Where can I get updated Actions Files? -There are major changes to Junkbuster/ Privoxy configuration from version 2.0.x -to 2.9.x and later. Most of the older files will not work at all. This is -especially true of blocklist. If this is the case, you will need to re-enter -your old data into the new configuration structure. This is probably also a -good recommendation even if upgrading from 2.9.x to 3.x since there were many -minor changes along the way. +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 +Privoxy or the actions file, subscribe to our announce mailing list, +ijbswa-announce@lists.sourceforge.net. -3.2. What is an "actions" file? +------------------------------------------------------------------------------- -"actions" files are where various actions that Privoxy might take, are -configured. Typically, you would define a set of default actions that apply to -all URLs, then add exceptions to these defaults where needed. +3.2. Can I use my old config files? -Actions can be defined on a per site basis, or for groups of sites. Actions can -also be grouped together and then applied to one or more sites. There are many -possible actions that might apply to any given site. As an example, if we are -blocking cookies as one of our default actions, but need to accept cookies from -a given site, we would define this in our "actions" file. +The syntax, number, and purpose of configuration files has substantially +changed from Junkbuster and earlier versions of Privoxy. The old files, like +blocklist will not work at all. If you are upgrading from a 2.0.x version, you +will need to port your configuration data to the new format. Note that even the +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. The "actions" concept confuses me. Please list some of these "actions". +3.3. What is an "actions" file? -These are all explained in the user-manual. Please refer to that. +Actions files are where various actions that Privoxy might take while +processing a certain request, are configured. Typically, you would define a set +of default actions that apply to all URLs, then add exceptions to these +defaults where needed. + +Actions can be defined on a URL pattern basis, i.e. for single URLs, whole web +sites, groups or parts thereof etc. Actions can also be grouped together and +then applied to requests matching one or more patterns. There are many possible +actions that might apply to any given site. As an example, if you are blocking +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. How are actions files configured? What is the easiest way to do this? +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. -The easiest way to do this, is to access Privoxy with your web browser at http: -//p.p/, and then select "View & change the current configuration" from the -selection list. You can also do this by editing the appropriate file with a -text editor. +------------------------------------------------------------------------------- + +3.5. How are actions files configured? What is the easiest way to do this? -Please see the user-manual for a detailed explanation of these and other -configuration files, and their various options and syntax. +Actions files are just text files in a special syntax and can be edited with a +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.5. There are several different "actions" files. What are the differences? +3.6. There are several different "actions" files. What are the differences? As of Privoxy v2.9.15, three actions files are being included, to be used for -different purposes. These are default.action, standard.action, and user.action. -Please see the User Manual for an explanation of each. +different purposes: These are default.action, the "main" actions file which is +actively maintained by the Privoxy developers, user.action, where users are +encouraged to make their private customizations, and standard.action, which is +for internal Privoxy use only. Please see the actions chapter in the user +manual for a more detailed explanation. + +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. + +------------------------------------------------------------------------------- -Earlier versions included three different versions default.action files. The -new scheme allows for greater flexibility of local configuration, and for -browser based configuration. +3.7. How can I make my Yahoo/Hotmail/GMX account work? + +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 login credentials in between browser sessions. If you would +like not to have to log in manually each time you access those websites, simply +turn off all cookie handling for them in the user.action file. An example for +yahoo might look like: + +# Allow all cookies for Yahoo login: +# +{ -crunch-incoming-cookies -crunch-outgoing-cookies -session-cookies-only } +.login.yahoo.com + +------------------------------------------------------------------------------- + +3.8. What's the difference between the "Cautious", "Medium" and "Advanced" +defaults? + +Configuring Privoxy is not entirely trivial. To help you get started, we +provide you with three different default action "packages" in the web based +actions file editor at http://config.privoxy.org/show-status. The following +table shows you, which of the most important features are enabled in each +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.6. Why can I change the configuration with a browser? Does that not raise +3.9. Why can I change the configuration with a browser? Does that not raise security issues? -What I don't understand, is how I can browser edit the config file as a regular -user, while the whole /etc/privoxy hierarchy belongs to the user "privoxy", -with only 644 permissions. +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 +"privoxy", with only 644 permissions. When you use the browser-based editor, Privoxy itself is writing to the config files. Because Privoxy is running as the user "privoxy", it can update the config files. -If you don't like this, setting "enable-edit-actions 0" in the config file will -disable the browser-based editor. If you're that paranoid, you should also -consider setting "enable-remote-toggle 0" to prevent browser-based enabling/ -disabling of Privoxy. +If you run Privoxy for multiple untrusted users (e.g. in a LAN), you will +probably want to turn the web-based editor and remote toggle features off by +setting "enable-edit-actions 0" and "enable-remote-toggle 0" in the main +configuration file. -Note that normally only local users can connect to Privoxy, so this is not -(normally) a security problem. +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.7. What is "default.filter"? +3.10. What is the default.filter file? What is a "filter"? -The "default.filter" file is where "filters" are defined, which are used to -"filter" any web page content. By "filtering" we mean it can modify, remove, or -change anything on the page, including HTML tags, and JavaScript. Regular -expressions are used to accomplish this, and operate on a line by line basis. -This is potentially a very powerful feature, but requires some expertise. +The default.filter file is where filters are defined, which can be used to +modify or remove, web page content on the fly. Filters apply to anything 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 annoyances. The filters are only defined here, to invoke them, you need +to use the filter action in one of the actions files. Filtering is +automatically disabled for inappropriate MIME types. If you are familiar with regular expressions, and HTML, you can look at the -provided default.filter with a text editor and see some of things it can be -used for. +provided default.filter with a text editor and define your own filters. This is +potentially a very powerful feature, but requires some expertise in both +regular expressions and HTML/HTTP. Presently, there is no GUI editor option for this part of the configuration, -but you can disable/enable various sections of the included default file with -the "View & change the current configuration" from your browser. +but you can disable/enable the various pre-defined filters of the included +default.filter file with the web-based actions file editor. ------------------------------------------------------------------------------- -3.8. How can I set up Privoxy to act as a proxy for my LAN? +3.11. How can I set up Privoxy to act as a proxy for my LAN? -By default, Privoxy only responds to requests from localhost. To have it act as -a server for a network, this needs to be changed in the main config file where -the Privoxy configuration is located. In that file is a "listen-address" -option. It may be commented out with a "#" symbol. Make sure it is uncommented, -and assign it the address of the LAN gateway interface, and port number to use: +By default, Privoxy only responds to requests from 127.0.0.1 (localhost). To +have it act as a server for a network, this needs to be changed in the main +configuration file. Look for the listen-address option, which may be commented +out with a "#" symbol. Make sure it is uncommented, and assign it the address +of the LAN gateway interface, and port number to use. Assuming your LAN address +is 192.168.1.1 and you wish to run Privoxy on port 8118, this line should look +like: listen-address 192.168.1.1:8118 Save the file, and restart Privoxy. Configure all browsers on the network then to use this address and port number. +If you run Privoxy on a LAN with untrusted users, we recommend that you +double-check the access control and security options! + ------------------------------------------------------------------------------- -3.9. Instead of ads, now I get a checkerboard pattern. I don't want to see +3.12. Instead of ads, now I get a checkerboard pattern. I don't want to see anything. -This is a configuration option for images that Privoxy is stopping. You have -the choice of a checkerboard pattern, a transparent 1x1 GIF image (aka -"blank"), or a custom URL of your choice. Note that to fit this category, the -URL must match both the "+handle-as-image" and "+block" actions. +The replacement for blocked images can be controlled with the set-image-blocker +action. You have the choice of a checkerboard pattern, a transparent 1x1 GIF +image (aka "blank"), or a redirect to a custom image of your choice. Note that +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 -"+image-blocker{blank}". This can be done from the "View & change the current -configuration" selection at http://p.p/. Or by hand editing the appropriate -actions file. This will only effect what is defined as "images" though. Also, -some URLs that generate the bright red "Blocked" banner, can be moved to the -"+set-image-blocker" section for the same reason, but there are some limits and -risks to this (see below). +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.10. Why would anybody want to see a checkerboard pattern? +3.13. Why would anybody want to see a checkerboard pattern? -This can be helpful for troubleshooting problems. It might also be good for -anyone new to Privoxy so that they can see if their favorite pages are -displaying correctly, and Privoxy is not inadvertently removing something -important. +Remember that telling which image is an ad and which isn't, is mostly +guesswork. While we hope that the standard configuration is rather smart, it +can and will make errors. The checkerboard image is visually 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 don't have to see.. ------------------------------------------------------------------------------- -3.11. I see large red banners on some pages that say "Blocked". Why and how do -I get rid of this? +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? -These are URLs that match something in one of Privoxy's block actions ("+block" -). It is meant to be a warning so that you know something has been blocked and -an easy way for you to see why. These are handled differently than what has -been defined explicitly as "images" (e.g. ads that are GIF image files). -Depending on the URL itself, it is sometimes hard for Privoxy to really know -whether there is indeed an ad image there or not. And there are limitations as -to what Privoxy can do to "fool" the browser. +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 or +(i)layers, and these external HTML documents are blocked. Being non-images they +get replaced by a substitute HTML page rather than a substitute image, which +wouldn't work out technically, since the browser expects and accepts only HTML +when it has requested an HTML document. -For instance, if the ad is in a frame, then it is embedded in the separate HTML -page used for the frame. In this case, you cannot just substitute an aribitrary -image (like we would for a "blank" image), for an HTML page. The browser is -expecting an HTML page, and that is what it must have for frames. Such -situations can be a little trickier to deal with, and Privoxy may show the -"Blocked" page, despite your best efforts. +The substitute page adapts to the available space and shows itself as a +miniature two-liner if loaded into small frames, or full-blown with a large red +"BLOCKED" banner if space allows. -If you want these to be treated as if they were images, so that they can be -made invisible, you can try moving the offending URL from the "+block" section -to the "+imageblock" section of your actions file. Just be forewarned, if any -URL is made "invisible", you may not have any inkling that something has been -removed from that page, or why. If this approach does not work, then you are -probably dealing with a frame (or "ilayer"), and the only thing that can go -there is an HTML page of some sort. - -To deal with this situation, you could modify the "block" HTML template that is -used by Privoxy to display this, and make it something more to your liking. -Currently, there is no configuration option for this. You will have to modify, -or create your own page, and use this to replace templates/blocked, which is -what Privoxy uses to display the "Blocked" page. - -Another way to deal with this is find why and where Privoxy is blocking the -frame, and diable this. Then let the "+set-image-blocker" action handle the ad -that is embedded in the frame's HTML page. +If you prefer the banners to be blocked by images, you must see to it that the +HTML documents in which they are embedded are not blocked. Clicking the "See +why" link offered in the substitute page will show you which rule blocked the +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.12. I cannot see all of the "Blocked" page banner. Help. +3.15. Can Privoxy run as a service on Win2K/NT? -There is not enough available space to fit the entire Blocked page. Try right -clicking on the visible portion, and select "Show Frame", or equivalent. This -will usually allow you to see the entire Privoxy "Blocked" page, and from there -you can see just what is being blocked, and why. +Yes, it can run as a system service using srvany.exe. The only catch is that +this will effectively disable the Privoxy icon (and its menu!) in the taskbar. +You can have one or the other, but not both at this time :( -As of Privoxy 2.9.14, the Blocked banner page is re-sizeable, and tries to -adjust to the allotted space. There may be occassions where there just isn't -enough room to display much of anything useful though. +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.13. Can Privoxy run as a service on Win2K/NT? - -Yes, it can run as a system service using srvany.exe. The only catch is that -this will effectively disable the Privoxy icon in the taskbar. You can have one -or the other, but not both at this time :( +3.16. How can I make Privoxy work with other proxies like Squid? -There is a pending feature request for this functionality. See thread: http:// -sourceforge.net/tracker/?func=detail&atid=361118&aid=485617&group_id=11118, for -details, and a sample configuration. +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.14. How can I make Privoxy work with other proxies like Squid? +3.17. Can I just set Privoxy to use port 80 and thus avoid individual browser +configuration? -This can be done. See the user manual, which describes how to do this. +No, its more complicated than that. This only works with special kinds of +proxies known as "transparent" proxies (see below). ------------------------------------------------------------------------------- -3.15. Can Privoxy run as a "transparent" proxy? +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 headers beyond what Privoxy is now capable of. -Chaining Privoxy with another proxy that has this ability should work though. -See the user manual, which describes this, and also http:// -www.transproxy.nlc.net.au/. +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/). ------------------------------------------------------------------------------- @@ -621,75 +754,79 @@ processing time required by Privoxy itself for each page, is relatively small in the overall scheme of things, and happens very quickly. This is typically more than offset by time saved not downloading and rendering ad images. -"Filtering" via the filterfile mechanism may cause a perceived slowdown, since -the entire page is buffered before displaying. See below. +"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 Junkbuster. What's wrong? -The entire page content must be loaded into memory in order for the filtering -mechanism to work, and nothing is sent to the browser during this time. The -loading time does not really change in real numbers, but the feeling is +If you use any filter action, such as filtering banners by size, web-bugs etc, +or the deanimate-gifs action, the entire document must be loaded into memory in +order for the filtering mechanism to work, and nothing is sent to the browser +during this time. + +The loading time does not really change in real numbers, but the feeling is different, because most browsers are able to start rendering incomplete -content, giving the user a feeling of "it works". +content, giving the user a feeling of "it works". This effect is especially +noticeable on slow dialup connections. -To modify the content of a page (i.e. make frames resizeable again, etc.) and -not just replace ads, Privoxy needs to download the entire page first, do its -content magic and then send the page to the browser. +Filtering is automatically disabled for inappropriate MIME types. ------------------------------------------------------------------------------- -4.3. What is the "http://p.p/"? +4.3. What are "http://config.privoxy.org/" and "http://p.p/"? -Since Privoxy sits between your web browser and the Internet, it can be -programmed to handle certain pages specially. +http://config.privoxy.org/ is the address of Privoxy's built-in user interface, +and http://p.p/ is a shortcut for it. -With recent versions of Privoxy (version 2.9.x and greater), you can get some -information about Privoxy and change some settings by going to http://p.p/ or, -equivalently, http://config.privoxy.org/ (Note that p.p is far easier to type -but may not work in some configurations. With the name change to Privoxy, this -is changed from the previous http://i.j.b/ and earlier 2.9.x versions). +Since Privoxy sits between your web browser and the Internet, it can simply +intercept requests for these addresses and answer them with its built-in "web +server". -These pages are not forwarded to a server on the Internet - instead they are -handled by a special web server which is built in to Privoxy. +This also makes for a good test for your browser configuration: If entering the +URL http://config.privoxy.org/ takes you to a page saying "This is Privoxy..", +everything is OK. If you get a page saying "Privoxy is not working" instead, +then your browser didn't use Privoxy for the request, hence it could not be +intercepted, and you have accessed the real web site at config.privoxy.org. -If you are not running Privoxy, then http://p.p/ will fail, and http:// -config.privoxy.org/ will return a web page telling you you're not running -Privoxy. +With recent versions of Privoxy (version 2.9.x and later), the user interface +features information on the run time status, the configuration, and even a +built-in editor for the actions files. -If you have version 2.0.2, then the equivalent is http://example.com/ -show-proxy-args (but you get far less information, and you should really -consider upgrading to 2.9.15). +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 +3.1.1. ------------------------------------------------------------------------------- 4.4. Do you still maintain the blocklists? -No, not by this name. The format of the blocklists has changed significantly in -versions 2.9.x and later. This functionality is done by the "actions" file now. -See next question ... +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? -Please see the Contact section. - -This process does not work with earlier versions of Privoxy or Junkbuster. +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? -You cannot hide your IP address with Privoxy or any other software, since the -server needs to know your IP address to send the answers back to you. +If you run both the browser and the proxy locally, you cannot hide your IP +address with Privoxy or any other software. The server needs to know your IP +address to send the answers back to you. Fortunately there are many publicly usable anonymous proxies out there, which solve the problem by providing a further level of indirection between you and -the web server, shared by many people and thus letting your requests "drown" in -white noise of unrelated requests as far as user tracking is concerned. +the web server, shared by many people, and thus letting your requests "drown" +in white noise of unrelated requests as far as user tracking is concerned. Most of them will, however, log your IP address and make it available to the authorities in case you abuse that anonymity for criminal purposes. In fact you @@ -697,7 +834,13 @@ can't even rule out that some of them only exist to *collect* information on (those suspicious) people with a more than average preference for privacy. You can find a list of anonymous public proxies at multiproxy.org and many more -through Google. +through Google. A particularly interesting project is the JAP service offered +by the Technical University of Dresden (http://anon.inf.tu-dresden.de/ +index_en.html. + +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. ------------------------------------------------------------------------------- @@ -726,25 +869,31 @@ Luke! ------------------------------------------------------------------------------- -4.8. Might some things break because header information is being altered? +4.8. Might some things break because header information or content is being +altered? 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, so having hard and fast rules, is tricky. -"USER AGENT" in particular is often used in this way to identify the browser, -and adjust content accordingly. Changing this now is not recommended, since so -many sites do look for this. You may get undesirable results by changing this. +"User-Agent" in particular is often used in this way to identify the browser, +and adjust content accordingly. Changing this now (at least not further than +removing the OS information) is not recommended, since so many sites do look +for it. You may get undesirable results by changing this. For instance, different browsers use different encodings of Russian and Czech characters, certain web servers convert pages on-the-fly according to the User Agent header. Giving a "User Agent" with the wrong operating system or browser manufacturer causes some sites in these languages to be garbled; Surfers to Eastern European sites should change it to something closer. And then some page -access counters work by looking at the "REFERER" header; they may fail or break +access counters work by looking at the "Referer" header; they may fail or break if unavailable. The weather maps of Intellicast have been blocked by their -server when no "REFERER" or cookie is provided, is another example. There are -many, many other ways things can go wrong when trying to fool a web server. +server when no "Referer" or cookie is provided, is another example. (But you +can forge both headers without giving information away). There are many other +ways things can go wrong when trying to fool a web server. + +Similar thoughts apply to modifying JavaScript, and, to a lesser degree, HTML +elements. 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 @@ -756,102 +905,160 @@ required, but by no means the only one. 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. +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, or a proxy that has -this specific capability. Privoxy can help protect your privacy, but not really -protect you from intrusion attempts. +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. The Privoxy logo that replaces ads is very blocky and ugly looking. Can't -a better font be used? +4.11. I have large empty spaces / a checkerboard pattern now where ads used to +be. Why? -This is not a font problem. The logo is an image that is created by Privoxy on -the fly. So as to not waste memory, the image is rather small. The blockiness -comes when the image is scaled to fill a largish area. There is not much to be -done about this, other than to use one of the other "imageblock" directives: -pattern, blank, or a URL of your choosing. +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, +i.e. eliminating the whole image references from the HTML pages instead of +letting them stay in, and blocking the resulting requests for the banners +themselves. -Given the above problem, we have decided to remove the logo option entirely [as -of v2.9.13]. +But this would consume considerable CPU resources, would likely destroy the +layout of many web pages which rely on the banners consuming a certain amount +of screen space, and would fail in other cases, where the screen space is +reserved e.g. by tables anyway. Also, making the banners disappear without a +visual trace complicates troubleshooting. -------------------------------------------------------------------------------- +So we won't support this in the default configuration, but you can of course +define appropriate filters yourself. -4.12. I have large empty spaces now where ads used to be. Why? +------------------------------------------------------------------------------- -It would be easy enough to just eliminate this space altogether, rather than -fill it with blank space. But, this would create problems with many pages that -use the overall size of the ad to help organize the page layout and position -the various components of the page where they were intended to be. It is best -left this way. +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 +Privoxy can do but hand the raw gibberish data though from one end to the other +unprocessed. -4.13. How can Privoxy filter Secure (HTTPS) URLs? +The only exception to this is blocking by host patterns, as the client needs to +tell Privoxy the name of the remote server, so that Privoxy can establish the +connection. If that name matches a host-only pattern, the connection will be +blocked. -This is a limitation since HTTPS transactions are encrypted SSL sessions -between your browser and the secure site, and are meant to be reliably secure -and private. This means that all cookies and HTTP header information are also -encrypted from the time they leave your browser, to the site, and vice versa. -Privoxy does not try to unencrypt this information, so it just passes through -as is. Privoxy can still catch images and ads that are embedded in the SSL -stream though. +As far as ad blocking is concerned, this is less of a restriction than it may +seem, since ad sources are often identifiable by the host name, and often the +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.14. Privoxy runs as a "server". How secure is it? Do I need to take any +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 effect 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". The server -aspect of Privoxy is not itself directly exposed to the Internet in this +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. If you want to have Privoxy serve as a LAN proxy, this will have to be opened up to allow for LAN requests. In this case, we'd recommend you specify only the LAN gateway address, e.g. 192.168.1.1, in the main Privoxy -config file. All LAN hosts can then use this as their proxy address in the -browser proxy configuration. In this way, Privoxy will not listen on any -external ports. Of course, a firewall is always good too. Better safe than -sorry. +configuration file and check all access control and security options. All LAN +hosts can then use this as their proxy address in the browser proxy +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.15. How can I temporarily disable Privoxy? +4.14. How can I temporarily disable Privoxy? -The easiest way is to access Privoxy with your browser by using the special -URL: http://p.p/ and select "Toggle Privoxy on or off" from that page. +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.16. Where can I find more information about Privoxy and related issues? +4.15. When "disabled" is Privoxy totally out of the picture? + +No, this just means all filtering and actions are disabled. Privoxy is still +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.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/, The Privoxy Home page. +http://www.privoxy.org/, the Privoxy Home page. -http://sourceforge.net/projects/ijbswa, the Project Page for Privoxy on -Sourceforge. +http://www.privoxy.org/faq/, the Privoxy FAQ. -http://p.p/, access Privoxy from your browser. Alternately, http:// -config.privoxy.org may work in some situations where the first does not. +http://sourceforge.net/projects/ijbswa/, the Project Page for Privoxy on +SourceForge. -http://p.p/, and select "Privoxy - Submit Filter Feedback" to submit "misses" -to the developers. +http://config.privoxy.org/, the web-based user interface. Privoxy must be +running for this to work. Shortcut: http://p.p/ -http://www.junkbusters.com/ht/en/cookies.html +http://www.privoxy.org/actions/, to submit "misses" to the developers. -http://www.waldherr.org/junkbuster/ +http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/contrib/, cool and fun +ideas from Privoxy users. -http://privacy.net/analyze/ +http://www.junkbusters.com/ht/en/cookies.html, an explanation how cookies are +used to track web users. -http://www.squid-cache.org/ +http://www.junkbusters.com/ijb.html, the original Internet Junkbuster. - +http://www.waldherr.org/junkbuster/, Stefan Waldherr's version of Junkbuster, +from which Privoxy was derived. + +http://privacy.net/analyze/, a useful site to check what information about you +is leaked while you browse the web. + +http://www.squid-cache.org/, a very popular caching proxy, which is often used +together with Privoxy. + +http://www.privoxy.org/developer-manual/, the Privoxy developer manual. ------------------------------------------------------------------------------- @@ -865,8 +1072,8 @@ port than what Privoxy is using. The old Privoxy (and also Junkbuster) used port 8000 by default. This has been changed to port 8118 now, due to a conflict with NAS (Network Audio Service), which uses port 8000. If you haven't, you need to change your browser to the -new port number, or alternately change Privoxy's "listen-address" setting in -the config file used to start Privoxy. +new port number, or alternately change the listen-address option in Privoxy's +main configuration file. ------------------------------------------------------------------------------- @@ -880,97 +1087,201 @@ thing to do is try flushing the browser's caches. And then try again. 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 any actions match your new rule. +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? -First verify that it is indeed a Privoxy problem, by disabling Privoxy -filtering and blocking. Go to http://p.p/ and click on "Toggle Privoxy On or -Off", then disable it. Now try that page again. It's probably a good idea to -flush the browser cache as well with Shift+Reload to flush caches. - -If still a problem, go to "Show which actions apply to a URL and why" from -http://p.p/ and paste the full URL of the page in question into the prompt. See -which actions are being applied to the URL. Now, armed with this information, -go to "View & change the current configuration". Here you should see various -sections that have various Privoxy features disabled for specific sites. Most -disabled "actions" will have a "-" (minus sign) in front of them. Some aliases -are used just to disable other actions, e.g. "shop" and "fragile", and won't -necessarily use a "+" or "-" sign. Add your problem page URL to one of these -sections that looks like it is disabling the feature that is causing the -problem. Rember to flush your browser's caches when making such changes! As a -last resort, try "fragile" which disables most actions. Now re-try the page. -There might be some trial and error involved. This is discussed in more detail -in the user-manual appendix. +First verify that it is indeed a Privoxy problem, by toggling off Privoxy +through http://config.privoxy.org/toggle, and then shift-reloading the problem +page (i.e. holding down the shift key while clicking reload. Alternatively, +flush your browser's disk and memory caches). + +If still a problem, go to http://config.privoxy.org/show-url-info and paste the +full URL of the page in question into the prompt. See which actions are being +applied to the URL, and which matches in which actions files are responsible +for that. Now, armed with this information, go to http://config.privoxy.org/ +show-status and select the appropriate actions files for editing. + +You can now either look for a section which disables the actions that you +suspect to cause the problem and add a pattern for your site there, or make up +a completely new section for your site. In any case, the recommended way is to +disable only the prime suspect, reload the problem page, and only if the +problem persists, disable more and more actions until you have identified the +culprit. You may or may not want to turn the other actions on again. Remember +to flush your browser's caches in between any such changes! Alternately, if you are comfortable with a text editor, you can accomplish the -same thing by editing the appropriate "actions" file. +same thing by editing the appropriate actions file. Probably the easiest way to +deal with such problems when editing by hand is to add your site to a { fragile +} section in user.action, which is an alias that turns off most "dangerous" +actions, but is also likely to turn off more actions then needed, and thus +lower your privacy and protection more than necessary, + +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 +gives? + +This is a quirk that effects the installation of Privoxy, in conjunction with +Internet Explorer and Internet Connection Sharing on Windows 2000 and Windows +XP. The symptoms may appear to be corrupted or invalid DUN settings, or +passwords. + +When setting up an NT based Windows system with Privoxy you may find that +things do not seem to be doing what you expect. When you set your system up you +will probably have set up Internet Connection Sharing (ICS) with Dial up +Networking (DUN) when logged in with administrator privileges. You will +probably have made this DUN connection available to other accounts that you may +have set-up on your system. E.g. Mum or Dad sets up the system and makes +accounts suitably configured for the kids. + +When setting up Privoxy in this environment you will have to alter the proxy +set-up of Internet Explorer (IE) for the specific DUN connection on which you +wish to use Privoxy. When you do this the ICS DUN set-up becomes user specific. +In this instance you will see no difference if you change the DUN connection +under the account used to set-up the connection. However when you do this from +another user you will notice that the DUN connection changes to make available +to "Me only". You will also find that you have to store the password under each +different user! + +The reason for this is that each user's set-up for IE is user specific. Each +set-up DUN connection and each LAN connection in IE store the settings for each +user individually. As such this enforces individual configurations rather than +common ones. Hence the first time you use a DUN connection after re-booting +your system it may not perform as you expect, and prompt you for the password. +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 +as the HTTP proxy. + +Microsoft Internet Explorer (in versions like 5.1) respects system-wide network +settings. In order to change the HTTP proxy, open System Preferences, and click +on the Network icon. In the settings pane that comes up, click on the Proxies +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. +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 +administration password. + +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: +. + +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. However, to provide you with the best support, please -note the following sections. +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 -To get support, use the Sourceforge Support Forum: +For casual users, our support forum at SourceForge is probably best suited: +http://sourceforge.net/tracker/?group_id=11118&atid=211118 - http://sourceforge.net/tracker/?group_id=11118&atid=211118 +All users are of course welcome to discuss their issues on the users mailing +list, where the developers also hang around. ------------------------------------------------------------------------------- -6.2. Report bugs +6.2. Report Bugs -To submit bugs, use the Sourceforge Bug Forum: +Please report all bugs only through our bug tracker: http://sourceforge.net/ +tracker/?group_id=11118&atid=111118. - http://sourceforge.net/tracker/?group_id=11118&atid=111118. +Before doing so, please make sure that the bug has not already been submitted +and observe the additional hints at the top of the submit form. -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 version, platform, browser, any pertinent log data, -any other relevant details (please be specific) and, if possible, some way to -reproduce the bug. +Please try to verify that it is a Privoxy bug, and not a browser or site bug +first. If unsure, try toggling off Privoxy, and see if the problem persists. +The appendix of the user manual also has helpful information on action +debugging. If you are using your own custom configuration, please try the stock +configs to see if the problem is configuration related. -------------------------------------------------------------------------------- +If not using the latest version, chances are that the bug has been found and +fixed in the meantime. We would appreciate if you could take the time to +upgrade to the latest version (or even the latest CVS snapshot) and verify your +bug, but this is not required for reporting. -6.3. Request new features +------------------------------------------------------------------------------- -To submit ideas on new features, use the Sourceforge feature request forum: +6.3. Request New Features - http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse. +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 filter problems +6.4. Report Ads or Other Actions-Related Problems -You can also send feedback on websites that Privoxy has problems with. Please -bookmark the following link: "Privoxy - Submit Filter Feedback". Once you surf -to a page with problems, use the bookmark to send us feedback. We will look -into the issue as soon as possible. +Please send feedback on ads that slipped through, innocent images that were +blocked, and any other problems relating to the default.action file through our +actions feedback mechanism located at http://www.privoxy.org/actions/. On this +page, you will also find a bookmark which will take you back there from any +troubled site and even pre-fill the form! New, improved default.action files will occasionally be made available based on -your feedback. These will be announced on the ijbswa-announce list. +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 -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. See the page on Sourceforge. +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! You can find an overview of all Privoxy-related +mailing lists, including list archives, at: http://sourceforge.net/mail/? +group_id=11118. ------------------------------------------------------------------------------- @@ -1010,13 +1321,29 @@ this program; if not, write to the 7.2. 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 Junkbusters -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 ;-). +In the beginning, there was the Internet Junkbuster, by Anonymous Coders and +Junkbusters Corporation. It saved many users a lot of pain in the early days of +web advertising and user tracking. + +But the web, its protocols and standards, and with it, the techniques for +forcing users to consume ads, give up autonomy over their browsing, and for +spying on them, kept evolving. Unfortunately, the Internet Junkbuster did not. +Version 2.0.2, published in 1998, was (and is) the last official release +available from Junkbusters Corporation. Fortunately, it had been released under +the GNU GPL, which allowed further development by others. + +So Stefan Waldherr started maintaining an improved version of the software, to +which eventually a number of people contributed patches. It could already +replace banners with a transparent image, and had a first version of pop-up +killing, but it was still very closely based on the original, with all its +limitations, such as the lack of HTTP/1.1 support, flexible per-site +configuration, or content modification. The last release from this effort was +version 2.0.2-10, published in 2000. + +Then, some developers picked up the thread, and started turning the software +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, was released +August, 2002. diff --git a/doc/text/user-manual.txt b/doc/text/user-manual.txt index e3566a08..2e5302c9 100644 --- a/doc/text/user-manual.txt +++ b/doc/text/user-manual.txt @@ -1,10 +1,10 @@ -Privoxy User Manual +Privoxy 3.1.1 User Manual Copyright © 2001, 2002 by Privoxy Developers -$Id: user-manual.sgml,v 1.117 2002/05/17 13:56:16 oes Exp $ +$Id: user-manual.sgml,v 2.2 2002/09/05 05:45:30 hal9 Exp $ -The user manual gives users information on how to install, configure and use +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 @@ -16,7 +16,7 @@ networks. Privoxy is based on Internet Junkbuster (tm). -You can find the latest version of the user manual at http://www.privoxy.org/ +You can find the latest version of the User Manual at http://www.privoxy.org/ user-manual/. Please see the Contact section on how to contact the developers. ------------------------------------------------------------------------------- @@ -30,15 +30,17 @@ Table of Contents 2.1. Binary Packages - 2.1.1. Red Hat, SuSE RPMs and Conectiva + 2.1.1. Red Hat, SuSE and Conectiva RPMs 2.1.2. Debian 2.1.3. Windows 2.1.4. Solaris, NetBSD, FreeBSD, HP-UX 2.1.5. OS/2 - 2.1.6. Max OSX + 2.1.6. Mac OSX 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 @@ -47,14 +49,16 @@ Table of Contents 5. Starting Privoxy - 5.1. RedHat, Conectiva and Debian - 5.2. SuSE - 5.3. Windows - 5.4. Solaris, NetBSD, FreeBSD, HP-UX and others - 5.5. OS/2 - 5.6. MAX OSX - 5.7. AmigaOS - 5.8. Command Line Options + 5.1. Red Hat and Conectiva + 5.2. Debian + 5.3. SuSE + 5.4. Windows + 5.5. Solaris, NetBSD, FreeBSD, HP-UX and others + 5.6. OS/2 + 5.7. Mac OSX + 5.8. AmigaOS + 5.9. Gentoo + 5.10. Command Line Options 6. Privoxy Configuration @@ -174,14 +178,14 @@ Table of Contents 1. Introduction -This documentation is included with the current beta version of Privoxy, -v.2.9.15, and is mostly complete at this point. The most up to date reference +This documentation is included with the current alpha version of Privoxy, +v.3.1.1, 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 +Since this is a alpha 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! @@ -253,9 +257,9 @@ How to install the binary packages depends on your operating system: ------------------------------------------------------------------------------- -2.1.1. Red Hat, SuSE RPMs and Conectiva +2.1.1. Red Hat, SuSE and Conectiva RPMs -RPMs can be installed with rpm -Uvh privoxy-2.9.15-1.rpm, and will use /etc/ +RPMs can be installed with rpm -Uvh privoxy-3.1.1-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. @@ -263,7 +267,7 @@ You will need to enable that using chkconfig, ntsysv, or similar methods. Note that SuSE will automatically start Privoxy in the boot process. If you have problems with failed dependencies, try rebuilding the SRC RPM: rpm ---rebuild privoxy-2.9.15-1.src.rpm;. This will use your locally installed +--rebuild privoxy-3.1.1-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 @@ -274,7 +278,8 @@ remove Junkbuster automatically, before installing Privoxy. 2.1.2. Debian -FIXME. +DEBs can be installed with dpkg -i privoxy_3.1.1-1.deb, and will use /etc/ +privoxy for the location of configuration files. ------------------------------------------------------------------------------- @@ -289,14 +294,15 @@ 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. FIXME. +most part, you'll have to figure out where things go. ------------------------------------------------------------------------------- 2.1.5. OS/2 First, make sure that no previous installations of Junkbuster and / or Privoxy -are left on your system. You can do this by +are left on your system. Check that no Junkbuster or Privoxy objects are in +your startup folder. Then, just double-click the WarpIN self-installing archive, which will guide you through the installation process. A shadow of the Privoxy executable will @@ -308,14 +314,22 @@ configuration files. ------------------------------------------------------------------------------- -2.1.6. Max OSX +2.1.6. Mac OSX + +Unzip the downloaded file (you can either double-click on the file from the +finder, or from the desktop if you downloaded it there). Then, double-click on +the package installer icon named Privoxy.pkg and follow the installation +process. Privoxy will be installed in the folder /Library/Privoxy. It will +start automatically whenever you start up. To prevent it from starting +automatically, remove or rename the folder /Library/StartupItems/Privoxy. + +To start Privoxy by hand, double-click on StartPrivoxy.command in the /Library/ +Privoxy folder. Or, type this command in the Terminal: + + /Library/Privoxy/StartPrivoxy.command + -Unzip the downloaded package (you can either double-click on the file in the -finder, or on the desktop if you downloaded it there). Then, double-click on -the package installer icon and follow the installation process. Privoxy will be -installed in the subdirectory /Applications/Privoxy.app. Privoxy will set -itself up to start automatically on system bring-up via /System/Library/ -StartupItems/Privoxy. +You will be prompted for the administrator password. ------------------------------------------------------------------------------- @@ -325,11 +339,20 @@ 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. -Start Privoxy (with RUN <>NIL:) in your startnet script (AmiTCP), in s: -user-startup (RoadShow), as startup program in your startup script (Genesis), -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). +------------------------------------------------------------------------------- + +2.1.8. Gentoo + +Gentoo source packages (Ebuilds) for Privoxy are contained in the Gentoo +Portage Tree (they are not on the download page, but there is a Gentoo section, +where you can see when a new Privoxy Version is added to the Portage Tree). + +Before installing Privoxy under Gentoo just do first emerge rsync to get the +latest changes from the Portage tree. With emerge privoxy you install the +latest version. + +Configuration files are in /etc/privoxy, the documentation is in /usr/share/doc +/privoxy-3.1.1 and the Log directory is in /var/log/privoxy. ------------------------------------------------------------------------------- @@ -348,8 +371,8 @@ compiler like gcc are required. When building from a source tarball (either release version or nightly CVS tarball), first unpack the source: - tar xzvf privoxy-2.9.15-beta-src* [.tgz or .tar.gz] - cd privoxy-2.9.15-beta + tar xzvf privoxy-3.1.1-beta-src* [.tgz or .tar.gz] + cd privoxy-3.1.1-beta For retrieving the current CVS sources, you'll need CVS installed. Note that sources from CVS are development quality, and may not be stable, or well @@ -372,6 +395,14 @@ Then, in either case, to build from unpacked tarball or CVS source: 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: @@ -385,6 +416,23 @@ etc, please consult the developer manual. ------------------------------------------------------------------------------- +2.3. Keeping your Installation Up-to-Date + +As user feedback comes in and development continues, we will make updated +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 +Privoxy or the actions file, subscribe to our announce mailing list, +ijbswa-announce@lists.sourceforge.net. + +In order not to loose your personal changes and adjustments when updating to +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 There are very significant changes from earlier Junkbuster versions to the @@ -481,7 +529,7 @@ surely common ground for everybody. This section will provide a quick summary of ad blocking so you can get up to speed quickly without having to read the more extensive information provided -below, though this is highly recommeneded. +below, though this is highly recommended. First a bit of a warning ... blocking ads is much like blocking SPAM: the more aggressive you are about it, the more likely you are to block things that were @@ -501,16 +549,18 @@ Actions, and action configuration files, are explained in depth below. Actions are specified in Privoxy's configuration, followed by one or more URLs to which the action should apply. URLs can actually be URL type patterns that -use wildcards so they can apply potentially to a range of similar URLs. - -When you connect to a website, the full path of the URL will either match one -of the "actions" as defined in Privoxy's configuration, or not. If so, then -Privoxy will perform the action accordingly. If not, then nothing special -happens. Futhermore, web pages may contain embedded, secondary URLs that your -web browser will display as it parses the original page's HTML content. An ad -image for instance, is just a URL embedded in the page somewhere. The image -itself may be on the same server, or a server somewhere else on the Internet. -Complex web pages will have many such embedded URLs. +use wildcards so they can apply potentially to a range of similar URLs. The +actions, together with the URL patterns are called a section. + +When you connect to a website, the full URL will either match one or more of +the sections as defined in Privoxy's configuration, or not. If so, then Privoxy +will perform the respective actions. If not, then nothing special happens. +Furthermore, web pages may contain embedded, secondary URLs that your web +browser will use to load additional components of the page, as it parses the +original page's HTML content. An ad image for instance, is just an URL embedded +in the page somewhere. The image itself may be on the same server, or a server +somewhere else on the Internet. Complex web pages will have many such embedded +URLs. The actions we need to know about for ad blocking are: block, handle-as-image, and set-image-blocker: @@ -518,33 +568,35 @@ and set-image-blocker: * 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. If this - is the only action that matches for this particular URL, then Privoxy will - display its own BLOCKED page to let you now what has happened. - - * handle-as-image - forces Privoxy to treat this URL as if it were an image. - Privoxy knows about common image types (e.g. GIF), but there are many - situations where this does not apply. So we'll force it. This is - particularly important for ad blocking, since once we can treat it as an - image, we can make more intelligent decisisions on how to handle it. There - are some limitations to this though. For instance, you can't just force an - image substituion for an entire HTML page in most situations. + 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 + 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 + blocking, since only if we know that it's an image of some kind, can we + replace it with an image of our choosing, instead of the Privoxy BLOCKED + page (which would only result in a "broken image" icon). There are some + 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 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 either be of - a known image type, or match an handle-as-image action. + 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 checkboard 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 "invisible" configuration option. - http:// - A redirect to any URL of the user's choosing (advanced - usage). + http:// - 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: @@ -567,16 +619,17 @@ A quick and simple step by step example: Figure 1. Actions Files in Use - Screenshot of Files in Use + [files-in-u] - * You should have an Actions section labeled +block. If not, click the "Edit" - button just under the word "Actions". This will bring up a list of all - actions. Find block near the top, and click in the "Enabled" column, then - "Submit" just below the list. + * 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 + "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". + 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 browser caches). The image should be gone now. @@ -587,7 +640,8 @@ site. For a more extensive explanation of "patterns", and the entire actions concept, see the Actions section. For advanced users who want to hand edit their config files, you might want to -now go to the Actions Files Tutorial. +now go to the Actions Files Tutorial. The ideas explained therein also apply to +the web-based editor. ------------------------------------------------------------------------------- @@ -598,11 +652,37 @@ browser(s) to use Privoxy as a HTTP and HTTPS proxy. The default is 127.0.0.1 (or localhost) for the proxy address, and port 8118 (earlier versions used port 8000). This is the one configuration step that must be done! -With Netscape (and Mozilla), this can be set under Edit -> Preferences -> -Advanced -> Proxies -> HTTP Proxy. For Internet Explorer: Tools -> Internet -Properties -> Connections -> LAN Setting. Then, check "Use Proxy" and fill in -the appropriate info (Address: 127.0.0.1, Port: 8118). Include if HTTPS proxy -support too. +Please note that Privoxy can only proxy HTTP and HTTPS traffic. It will not +work with FTP or other protocols. + +Figure 2. Proxy Configuration (Mozilla) + +[proxy_setu] + +With Netscape (and Mozilla), this can be set under: + + Edit + |_ + Preferences + |_ + Advanced + |_ + Proxies + |_ + HTTP Proxy + +For Internet Explorer: + + 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. After doing this, flush your browser's disk and memory caches to force a re-reading of all pages and to get rid of any ads that may be cached. You are @@ -615,17 +695,26 @@ Except on Win32 where it will try config.txt. ------------------------------------------------------------------------------- -5.1. RedHat, Conectiva and Debian +5.1. Red Hat and Conectiva -We use a script. Note that RedHat does not start Privoxy upon booting per +We use a script. Note that Red Hat does not start Privoxy upon booting per default. It will use the file /etc/privoxy/config as its main configuration -file. FIXME: Debian?? +file. # /etc/rc.d/init.d/privoxy start ------------------------------------------------------------------------------- -5.2. SuSE +5.2. Debian + +We use a script. Note that Debian starts Privoxy upon booting per default. It +will use the file /etc/privoxy/config as its main configuration file. + + # /etc/init.d/privoxy start + +------------------------------------------------------------------------------- + +5.3. SuSE We use a script. It will use the file /etc/privoxy/config as its main configuration file. Note that SuSE starts Privoxy upon booting your PC. @@ -634,7 +723,7 @@ configuration file. Note that SuSE starts Privoxy upon booting your PC. ------------------------------------------------------------------------------- -5.3. Windows +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. @@ -642,7 +731,7 @@ Note that Windows will automatically start Privoxy upon booting you PC. ------------------------------------------------------------------------------- -5.4. Solaris, NetBSD, FreeBSD, HP-UX and others +5.5. Solaris, NetBSD, FreeBSD, HP-UX and others Example Unix startup command: @@ -650,25 +739,55 @@ Example Unix startup command: ------------------------------------------------------------------------------- -5.5. OS/2 +5.6. OS/2 -FIXME. +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.6. MAX OSX +5.7. Mac OSX + +During installation, Privoxy is configured to start automatically when the +system restarts. To start Privoxy by hand, double-click on the +StartPrivoxy.command icon in the /Library/Privoxy folder. Or, type this command +in the Terminal: -FIXME. + /Library/Privoxy/StartPrivoxy.command + + +You will be prompted for the administrator password. ------------------------------------------------------------------------------- -5.7. AmigaOS +5.8. AmigaOS -FIXME. +Start Privoxy (with RUN <>NIL:) in your startnet script (AmiTCP), in s: +user-startup (RoadShow), as startup program in your startup script (Genesis), +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.8. Command Line Options +5.9. Gentoo + +A script is again used. It will use the file /etc/privoxy/config as its main +configuration file. + + /etc/init.d/privoxy start + + +Note that Privoxy is not automatically started at boot time by default. You can +change this with the rc-update command. + + rc-update add privoxy default + + +------------------------------------------------------------------------------- + +5.10. Command Line Options Privoxy may be invoked with the following command-line options: @@ -720,12 +839,13 @@ 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 + 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 @@ -833,7 +953,7 @@ 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. +files and actions files. ------------------------------------------------------------------------------- @@ -981,7 +1101,7 @@ Default value: Effect if unset: - No log file is used, all log messages go to the console (stderr). + No log file is used, all log messages go to the console (STDERR). Notes: @@ -1104,7 +1224,7 @@ Notes: Unix, in local filesystem: - user-manual file:///usr/share/doc/privoxy-2.9.15/user-manual/ + user-manual file:///usr/share/doc/privoxy-3.1.1/user-manual/ Any platform, on local webserver (called "local-webserver"): @@ -1248,6 +1368,7 @@ Notes: debug 256 # debug GIF de-animation debug 512 # Common Log Format debug 1024 # debug kill pop-ups + debug 2048 # CGI user interface debug 4096 # Startup banner and warnings. debug 8192 # Non-fatal errors @@ -1331,8 +1452,11 @@ Notes: If you leave out the IP address, Privoxy will bind to all interfaces (addresses) on your machine and may become reachable from the Internet. In - that case, consider using access control lists (ACL's) (see "ACLs" below), - or a firewall. + that case, consider using access control lists (ACL's, see below), and/or a + firewall. + + If you open Privoxy to untrusted users, you will also want to turn off the + enable-edit-actions and enable-remote-toggle options! Example: @@ -1576,13 +1700,14 @@ Specifies: Type of value: - target_domain[:port] http_parent[/port] + target_pattern http_parent[:port] - Where target_domain is a domain name pattern (see the chapter on domain - matching in the default.action file), http_parent is the address of the - parent HTTP proxy as an IP addresses in dotted decimal notation or as a - valid DNS name (or "." to denote "no forwarding", and the optional port - parameters are TCP ports, i.e. integer values from 1 to 64535 + where target_pattern is a URL pattern that specifies to which requests + (i.e. URLs) this forward rule shall apply. Use / to denote "all URLs". + http_parent[:port] is the DNS name or IP address of the parent HTTP proxy + through which the requests should be forwarded, optionally followed by its + listening port (default: 8080). Use a single dot (.) to denote "no + forwarding". Default value: @@ -1605,13 +1730,13 @@ Examples: Everything goes to an example anonymizing proxy, except SSL on port 443 (which it doesn't handle): - forward .* anon-proxy.example.org:8080 + forward / anon-proxy.example.org:8080 forward :443 . Everything goes to our example ISP's caching proxy, except for requests to that ISP's sites: - forward .*. caching-proxy.example-isp.net:8000 + forward / caching-proxy.example-isp.net:8000 forward .example-isp.net . ------------------------------------------------------------------------------- @@ -1625,13 +1750,14 @@ Specifies: Type of value: - target_domain[:port] socks_proxy[/port] http_parent[/port] + target_pattern socks_proxy[:port] http_parent[:port] - Where target_domain is a domain name pattern (see the chapter on domain - matching in the default.action file), http_parent and socks_proxy are IP - addresses in dotted decimal notation or valid DNS names (http_parent may be - "." to denote "no HTTP forwarding"), and the optional port parameters are - TCP ports, i.e. integer values from 1 to 64535 + where target_pattern is a URL pattern that specifies to which requests + (i.e. URLs) this forward rule shall apply. Use / to denote "all URLs". + http_parent and socks_proxy are IP addresses in dotted decimal notation or + valid DNS names (http_parent may be "." to denote "no HTTP forwarding"), + and the optional port parameters are TCP ports, i.e. integer values from 1 + to 64535 Default value: @@ -1660,13 +1786,13 @@ Examples: domains, but everything outbound goes through their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to the Internet. - forward-socks4a .*. socks-gw.example.com:1080 www-cache.example-isp.net:8080 + forward-socks4a / socks-gw.example.com:1080 www-cache.example-isp.net:8080 forward .example.com . A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this: - forward-socks4 .*. socks-gw.example.com:1080 . + forward-socks4 / socks-gw.example.com:1080 . ------------------------------------------------------------------------------- @@ -1683,12 +1809,12 @@ look like this: host-a: - forward .*. . + forward / . forward .isp-b.net host-b:8118 host-b: - forward .*. . + forward / . forward .isp-a.net host-a:8118 Now, your users can set their browser's proxy to use either host-a or host-b @@ -1716,6 +1842,12 @@ You would then need to change your browser's proxy settings to squid's address and port. Squid normally uses port 3128. If unsure consult http_port in squid.conf. +You could just as well decide to only forward requests for Windows executables +through a virus-scanning parent proxy, say, on antivir.example.com, port 8010: + + forward / . + forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010 + ------------------------------------------------------------------------------- 7.6. Windows GUI Options @@ -1880,8 +2012,9 @@ compared to all patterns in each action file file. Every time it matches, the list of applicable actions for the URL is incrementally updated, using the heading of the section in which the pattern is located. If multiple matches for the same URL set the same action differently, the last match wins. If not, the -effects are aggregated (e.g. a URL might match both the "+handle-as-image" and -"+block" actions). +effects are aggregated. E.g. a URL might match a regular section with a heading +line of { +handle-as-image }, then later another one with just { +block }, +resulting in both actions to apply. You can trace this process for any given URL by visiting http:// config.privoxy.org/show-url-info. @@ -1980,7 +2113,7 @@ Note that the path pattern is automatically left-anchored at the "/", i.e. it matches as if it would start with a "^" (regular expression speak for the beginning of a line). -Please also note that matching in the path is case INSENSITIVE by default, but +Please also note that matching in the path is CASE INSENSITIVE by default, but 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. @@ -2343,13 +2476,14 @@ Type: Parameter: The name of a filter, as defined in the filter file (typically - default.filter, set by the filterfile option in the config file) + 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 bunch of pre-defined filters available in - the distribution filter file that you can use. See the example below for a - list. + 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. This is potentially a very powerful feature! But "rolling your own" filters requires a knowledge of regular expressions and HTML. @@ -2360,13 +2494,20 @@ Notes: page is not incrementally displayed.) This effect will be more noticeable on slower connections. + The amount of data that can be filtered is limited to the buffer-limit + option in the main config file. The default is 4096 KB (4 Megs). Once this + limit is exceeded, the buffered data, and all pending data, is passed + through unfiltered. Inappropriate MIME types are not filtered. + At this time, Privoxy cannot (yet!) uncompress compressed documents. If you want filtering to work on all documents, even those that would normally be sent compressed, use the prevent-compression action in conjunction with filter. - Filtering can achieve some of the effects as the block action, i.e. it can - be used to block ads and banners. + Filtering can achieve some of the same effects as the block action, i.e. it + can be used to block ads and banners. But the mechanism works quite + differently. One effective use, is to block ad banners based on their size + (see below), since many of these seem to be somewhat standardized. Feedback with suggestions for new or improved filters is particularly welcome! @@ -2377,7 +2518,11 @@ Example usage (with filters from the distribution default.filter file): +filter{js-annoyances} # Get rid of particularly annoying JavaScript abuse - +filter{banners-by-size} # Kill banners by size (very efficient!) + +filter{banners-by-size} # Kill banners based on their size for this page (very efficient!) + + +filter{banners-by-link} # Kill banners based on the link they are contained in (experimental) + + +filter{img-reorder} # Reorder attributes in tags to make the banners-by-* filters more effective +filter{content-cookies} # Kill cookies that come sneaking in the HTML or JS content @@ -2397,6 +2542,8 @@ Example usage (with filters from the distribution default.filter file): +filter{crude-parental} # Kill all web pages that contain the words "sex" or "warez" + +filter{js-events} # Kill all JS event bindings (Radically destructive! Only for extra nasty sites) + ------------------------------------------------------------------------------- 8.5.9. handle-as-image @@ -2433,8 +2580,8 @@ Notes: reflect the file type, like in the second example section. Note that you cannot treat HTML pages as images in most cases. For - instance, (inline) ad frames require an HTML page to be sent, or they won't - display properly. Forcing handle-as-image in this situation will not + instance, (in-line) ad frames require an HTML page to be sent, or they + won't display properly. Forcing handle-as-image in this situation will not replace the ad frame with an image, but lead to error messages. Example usage (sections): @@ -3092,7 +3239,7 @@ patterns to which they apply. Remember all actions are disabled when matching starts, so we have to explicitly enable the ones we want. The first regular section is probably the most important. It has only one -pattern, "/", but this pattern matches all URLs.. Therefore, the set of actions +pattern, "/", but this pattern matches all URLs. Therefore, the set of actions used in this "default" section will be applied to all requests as a start. 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 @@ -3100,7 +3247,7 @@ browsing experience. Again, at the start of matching, all actions are disabled, so there is no real need to disable any actions here, but we will do that nonetheless, to have a -complete listing for your reference. (Remember: A "+" preceding the action name +complete listing for your reference. (Remember: a "+" preceding the action name enables the action, a "-" disables!). Also note how this long line has been made more readable by splitting it into multiple lines with line continuation. @@ -3124,8 +3271,11 @@ made more readable by splitting it into multiple lines with line continuation. -filter{fun} \ +filter{nimda} \ +filter{banners-by-size} \ + -filter{banners-by-link} \ + -filter{img-reorder} \ -filter{shockwave-flash} \ -filter{crude-parental} \ + -filter{js-events} \ -handle-as-image \ +hide-forwarded-for-headers \ +hide-from-header{block} \ @@ -3330,15 +3480,14 @@ example made clear how it works. 8.7.2. user.action So far we are painting with a broad brush by setting general policies, which -would be a reasonable starting point for many people. Now, you'd maybe want to -be more specific and have customized rules that are more suitable to your -personal habits and preferences. These would be for narrowly defined situations -like your ISP or your bank, and should be placed in user.action, which is -parsed after all other actions files and hence has the last word, over-riding -any previously defined actions. user.action is also a safe place for your -personal settings, since default.action is actively maintained by the Privoxy -developers and you'll probably want to install updated versions from time to -time. +would be a reasonable starting point for many people. Now, you might want to be +more specific and have customized rules that are more suitable to your personal +habits and preferences. These would be for narrowly defined situations like +your ISP or your bank, and should be placed in user.action, which is parsed +after all other actions files and hence has the last word, over-riding any +previously defined actions. user.action is also a safe place for your personal +settings, since default.action is actively maintained by the Privoxy developers +and you'll probably want to install updated versions from time to time. So let's look at a few examples of things that one might typically do in user.action: @@ -3556,12 +3705,15 @@ time only point out the constructs of special interest: # The status bar is for displaying link targets, not pointless blahblah # -s/window\.status\s*=\s*['"].*?['"]/dUmMy=1/ig +s/window\.status\s*=\s*(['"]).*?\1/dUmMy=1/ig \s stands for whitespace characters (space, tab, newline, carriage return, form feed), so that \s* means: "zero or more whitespace". The ? in .*? makes this matching of arbitrary text ungreedy. (Note that the U option is not set). The -['"] construct means: "a single or a double quote". +['"] construct means: "a single or a double quote". Finally, \1 is a +backreference to the first parenthesis just like $1 above, with the difference +that in the pattern, a backslash indicates a backreference, whereas in the +substitute, it's the dollar. So what does this job do? It replaces assignments of single- or double-quoted strings to the "window.status" object with a dummy assignment (using a variable @@ -3572,12 +3724,16 @@ over links. # Kill OnUnload popups. Yummy. Test: http://www.zdnet.com/zdsubs/yahoo/tree/yfs.html # -s/()/$1never$2/iU +s/(]*)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 "onunload" attribute in "" tags with the dummy word never. Note that the -i option makes the pattern matching case-insensitive. +i option makes the pattern matching case-insensitive. Also note that ungreedy +matching alone doesn't always guarantee a minimal match: In the first +parenthesis, we had to use [^>]* instead of .* to prevent the match from +exceeding the tag if it doesn't contain "OnUnload", but the page's +content does. The last example is from the fun department: @@ -3590,12 +3746,14 @@ 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 "microsoft" in the page. This prevents links to microsoft.com from being -messed, while still replacing the word everywhere else. +trashed, while still replacing the word everywhere else. # Buzzword Bingo (example for extended regex syntax) # s* industry[ -]leading \ | cutting[ -]edge \ +| customer[ -]focused \ +| market[ -]driven \ | award[ -]winning # Comments are OK, too! \ | high[ -]performance \ | solutions[ -]based \ @@ -3617,10 +3775,10 @@ You get the idea? All Privoxy built-in pages, i.e. error pages such as the "404 - No Such Domain" error page, the "BLOCKED" page and all pages of its web-based user interface, are generated from templates. (Privoxy must be running for the above links to -work as intended) +work as intended.) These templates are stored in a subdirectory of the configuration directory -called templates. On unixish platforms, this is typically /etc/privoxy/ +called templates. On Unixish platforms, this is typically /etc/privoxy/ templates/. The templates are basically normal HTML files, but with place-holders (called @@ -3685,7 +3843,7 @@ Please report all bugs only through our bug tracker: http://sourceforge.net/ tracker/?group_id=11118&atid=111118. Before doing so, please make sure that the bug has not already been submitted -and observe the aditional hints at the top of the submit form. +and observe the additional hints at the top of the submit form. Please try to verify that it is a Privoxy bug, and not a browser or site bug first. If unsure, try toggling off Privoxy, and see if the problem persists. @@ -3718,7 +3876,7 @@ troubled site and even pre-fill the form! 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 project page. +available from our the files section of our project page. ------------------------------------------------------------------------------- @@ -3726,7 +3884,7 @@ available from our project page. 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! You can find an overview of all Prixoxy-related +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. @@ -3788,8 +3946,8 @@ Then, some developers picked up the thread, and started turning the software 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 in May -2002. +The result of this is Privoxy, whose first stable release, 3.0, was released +August, 2002. ------------------------------------------------------------------------------- @@ -3807,16 +3965,20 @@ Current Project Developers: Current Project Contributors: 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 + Joerg Strohmayer (Amiga) Sarantis Paskalis -Originally developed by: +Based in part on code originally developed by: Junkbusters Corp. Anonymous Coders @@ -3825,16 +3987,22 @@ 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 + Daniel Leite Paul Lieverse + David Mediavilla Roberto Ragusa + Maynard Riley Bart Schelstraete Darren Wiebe + Jamie Zawinski ------------------------------------------------------------------------------- @@ -3854,6 +4022,9 @@ running for this to work. Shortcut: http://p.p/ 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. @@ -3998,7 +4169,7 @@ can learn more on your own :/ More reading on Perl Compatible Regular expressions: http://www.perldoc.com/ perl5.6/pod/perlre.html -For information on regular expression based substititions and their +For information on regular expression based substitutions and their applications in filters, please see the filter file tutorial in this manual. ------------------------------------------------------------------------------- @@ -4019,7 +4190,7 @@ friendly error message. Internet access is not necessary either. http://config.privoxy.org/ - There is a shortcut: http://p.p/ (But it doesn't provide a fallback to a + 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 @@ -4079,6 +4250,8 @@ click. * Privoxy - Submit Actions File Feedback + * Privoxy - Why? + Credit: The site which gave us the general idea for these bookmarklets is www.bookmarklets.com. They have more information about bookmarklets. @@ -4119,7 +4292,7 @@ requested by your browser and Privoxy is on duty: * 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 deterimed 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 @@ -4159,7 +4332,7 @@ with regular expressions whose consequences are not always so obvious. One quick test to see if Privoxy is causing a problem or not, is to disable it temporarily. This should be the first troubleshooting step. See the Bookmarklets section on a quick and easy way to do this (be sure to flush -caches afterward!). +caches afterward!). Looking at the logs is a good idea too. Privoxy also provides the http://config.privoxy.org/show-url-info page that can show us very specifically how actions are being applied to any given URL. This @@ -4312,7 +4485,7 @@ defined as "ad.doubleclick.net" is done here -- as both a "+block" and an and make it more readable. One last example. Let's try "http://www.rhapsodyk.net/adsl/HOWTO/". This one is -giving us problems. We are getting a blank page. Hmmm... +giving us problems. We are getting a blank page. Hmmm ... Matches for http://www.rhapsodyk.net/adsl/HOWTO/: @@ -4370,8 +4543,9 @@ That actually was very telling and pointed us quickly to where the problem was. If you don't get this kind of match, then it means one of the default rules in 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. Try adding the URL for the site -to one of aliases that turn off "+filter": +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 +"+filter": {shop} .quietpc.com @@ -4386,8 +4560,12 @@ you could do your own exception to negate filtering: {-filter} .forbes.com -This would probably be most appropriately put in user.action, for local site -exceptions. +This would turn off all filtering for that site. This would probably be most +appropriately put in user.action, for local site exceptions. + +Images that are inexplicably being blocked, may well be hitting the "+filter +{banners-by-size}" rule, which assumes that images of certain sizes are ad +banners (works well most of the time since these tend to be standardized). "{fragile}" is an alias that disables most actions. This can be used as a last resort for problem sites. Remember to flush caches! If this still does not diff --git a/doc/webserver/developer-manual/coding.html b/doc/webserver/developer-manual/coding.html index 364af8e1..ca973e34 100644 --- a/doc/webserver/developer-manual/coding.html +++ b/doc/webserver/developer-manual/coding.html @@ -4,7 +4,7 @@ >Coding Guidelines
Prev

4. Coding Guidelines

4. Coding Guidelines

4.1. Introduction

4.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 @@ -101,21 +100,20 @@ CLASS="SECT2" >

4.2. Using Comments

4.2. Using Comments

4.2.1. Comment, Comment, Comment

4.2.1. Comment, Comment, Comment

Explanation:

Comment as much as possible without commenting the obvious. @@ -131,9 +129,12 @@ CLASS="EMPHASIS" If the comment describes something different than what the code is doing then maybe a programming error is occurring.

Example:

Next

4.2.2. Use blocks for comments

4.2.2. Use blocks for comments

Explanation:

Comments can help or they can clutter. They help when they @@ -182,9 +184,12 @@ CLASS="EMPHASIS" and the code. Block identifiers do, by surrounding the code with a clear, definable pattern.

Example:

Exception:

If you are trying to add a small logic comment and do not @@ -232,13 +240,14 @@ CLASS="SECT3" >

4.2.3. Keep Comments on their own line

4.2.3. Keep Comments on their own line

Explanation:

It goes back to the question of readability. If the comment @@ -250,9 +259,12 @@ CLASS="EMPHASIS" at the end of closing braces, when used to comment parameters.

Example:

4.2.4. Comment each logical step

4.2.4. Comment each logical step

Explanation:

Logical steps should be commented to help others follow the @@ -331,13 +344,14 @@ CLASS="SECT3" >

4.2.5. Comment All Functions Thoroughly

4.2.5. Comment All Functions Thoroughly

Explanation:

A reader of the code should be able to look at the comments @@ -358,14 +372,15 @@ CLASS="SECT3" >

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

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

Explanation:

Each closing brace should be followed on the same line by a @@ -380,9 +395,12 @@ CLASS="EMPHASIS" >use following a closing brace: } /* -END- if() or while () or etc... */

Example:

4.3. Naming Conventions

4.3. Naming Conventions

4.3.1. Variable Names

4.3.1. Variable Names

Explanation:

Use all lowercase, and separate words via an underscore @@ -439,9 +456,12 @@ CLASS="EMPHASIS" template, class, true, false, ...). This is in case we ever decide to port Privoxy to C++.

Example:

Instead of:

4.3.2. Function Names

4.3.2. Function Names

Explanation:

Use all lowercase, and separate words via an underscore @@ -496,9 +520,12 @@ CLASS="EMPHASIS" template, class, true, false, ...). This is in case we ever decide to port Privoxy to C++.

Example:

Instead of:

4.3.3. Header file prototypes

4.3.3. Header file prototypes

Explanation:

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.

Example:

Instead of:

4.3.4. Enumerations, and #defines

4.3.4. Enumerations, and #defines

Explanation:

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.)

Example:

Note: 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.

Example:

4.3.5. Constants

4.3.5. Constants

Explanation:

Spell common words out entirely (do not remove vowels).

Use underscore (_) to separate adjacent acronyms and abbreviations. Never terminate a name with an underscore.

Example:

Instead of:

4.4. Using Space

4.4. Using Space

4.4.1. Put braces on a line by themselves.

4.4.1. Put braces on a line by themselves.

Explanation:

The brace needs to be on a line all by itself, not at the @@ -744,9 +797,12 @@ CLASS="EMPHASIS" easier to identify the opening and closing braces for a block.

Example:

Instead of:

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

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

Note: 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.

Status: developer-discretion.

Example exception:

4.4.2. ALL control statements should have a - block

4.4.2. ALL control statements should have a + block

Explanation:

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.

Example:

Instead of:

if ( this == that ) DoSomething(); DoSomethingElse();

if ( this == that ) DoSomething();

Note: 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 @@ -877,14 +955,15 @@ CLASS="SECT3" >

4.4.3. Do not belabor/blow-up boolean - expressions

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

Example:

Instead of:

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

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 @@ -920,22 +1005,26 @@ CLASS="SECT3" >

4.4.4. Use white space freely because it is - free

4.4.4. Use white space freely because it is + free

Explanation:

Make it readable. The notable exception to using white space freely is listed in the next guideline.

Example:

4.4.5. Don't use white space around structure - operators

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

Explanation:

- structure pointer operator ( "->" ) - member operator ( @@ -980,9 +1070,12 @@ CLASS="EMPHASIS" connection between the object and variable/function name is not as clear.

Example:

Instead of: aStruct -> aMember; aStruct . aMember; FunctionName ();

4.4.6. Make the last brace of a function stand - out

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

Example:

Instead of:

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

Note: 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 @@ -1061,9 +1164,12 @@ CLASS="EMPHASIS" "do" loops, and long if {} statements too. After all whitespace is free!

Status: developer-discretion on the number of blank lines. Enforced is the end of function comments.

4.4.7. Use 3 character indentions

4.4.7. Use 3 character indentions

Explanation:

If some use 8 character TABs and some use 3 character TABs, @@ -1086,9 +1193,12 @@ CLASS="EMPHASIS" only. If you like to use TABs, pass your code through a filter such as "expand -t3" before checking in your code.

Example:

4.5. Initializing

4.5. Initializing

4.5.1. Initialize all variables

4.5.1. Initialize all variables

Explanation:

Do not assume that the variables declared will not be used @@ -1150,9 +1259,12 @@ CLASS="EMPHASIS" the code. Remove the chance of accidentally using an unassigned variable.

Example:

Note: 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].

Status: developer-discretion if and only if the variable is assigned a value "shortly after" declaration.

4.6. Functions

4.6. Functions

4.6.1. Name functions that return a boolean as a - question.

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

Explanation:

Value should be phrased as a question that would logically be answered as a true or false statement

Example:

4.6.2. Always specify a return type for a - function.

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

Explanation:

The default return for a function is an int. To avoid @@ -1254,22 +1375,26 @@ CLASS="SECT3" >

4.6.3. Minimize function calls when iterating by - using variables

4.6.3. Minimize function calls when iterating by + using variables

Explanation:

It is easy to write the following code, and a clear argument can be made that the code is easy to understand:

Example:

Note: 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 @@ -1304,9 +1432,12 @@ CLASS="EMPHASIS" assign the value to a variable, and evaluate using the variable.

Example:

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

4.6.4. Pass and Return by Const Reference

Explanation:

This allows a developer to define a const pointer and call @@ -1365,13 +1500,14 @@ CLASS="SECT3" >

4.6.5. Pass and Return by Value

4.6.5. Pass and Return by Value

Explanation:

Most structures cannot fit onto a normal stack entry (i.e. @@ -1387,13 +1523,14 @@ CLASS="SECT3" >

4.6.6. Names of include files

4.6.6. Names of include files

Explanation:

Your include statements should contain the file name without @@ -1403,9 +1540,12 @@ CLASS="EMPHASIS" partial path to distinguish their header files from system or other header files.

Example:

Exception:

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

4.6.7. Provide multiple inclusion + protection

Explanation:

Prevents compiler and linker errors resulting from @@ -1471,9 +1618,12 @@ CLASS="EMPHASIS" with your file name, with "." Changed to "_", and make it uppercase.

Example:

4.6.8. Use `extern "C"` when appropriate

4.6.8. Use `extern "C"` when appropriate

Explanation:

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.

Example:

4.6.9. Where Possible, Use Forward Struct - Declaration Instead of Includes

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

Explanation:

Useful in headers that include pointers to other struct's. Modifications to excess header files may cause needless compiles.

Example:

Note: 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.

Status: Use with discretion.

4.7. General Coding Practices

4.7. General Coding Practices

4.7.1. Turn on warnings

4.7.1. Turn on warnings

Explanation

Compiler warnings are meant to help you find bugs. You @@ -1620,14 +1783,15 @@ CLASS="SECT3" >

4.7.2. Provide a default case for all switch - statements

4.7.2. Provide a default case for all switch + statements

Explanation:

What you think is guaranteed is never really guaranteed. The @@ -1635,9 +1799,12 @@ CLASS="EMPHASIS" someday will be passed. So, to protect yourself from the unknown, always have a default step in a switch statement.

Example:

Note: 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.

Another Note: 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.

Status: Programmer discretion is advised.

4.7.3. Try to avoid falling through cases in a - switch statement.

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

Explanation:

In general, you will want to have a 'break' statement within @@ -1724,22 +1901,26 @@ CLASS="SECT3" >

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

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

Explanation:

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

Status: open-to-debate. In the case of most FSF projects (including X/GNU-Emacs), there are typedefs to int4, int8, int16, (or equivalence ... I forget the exact typedefs @@ -1751,13 +1932,14 @@ CLASS="SECT3" >

4.7.5. Don't mix size_t and other types

4.7.5. Don't mix size_t and other types

Explanation:

The type of size_t varies across platforms. Do not make @@ -1772,22 +1954,26 @@ CLASS="SECT3" >

4.7.6. Declare each variable and struct on its - own line.

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

Explanation:

It can be tempting to declare a series of variables all on one line. Don't.

Example:

Instead of:

long a, b, c;

Explanation: - 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

Exceptions: 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.

Status: developer-discretion.

4.7.7. Use malloc/zalloc sparingly

4.7.7. Use malloc/zalloc sparingly

Explanation:

Create a local struct (on the stack) if the variable will @@ -1853,9 +2052,12 @@ CLASS="EMPHASIS" >Only "malloc" a struct (on the heap) if the variable's life will extend beyond the context of one function call.

Example:

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

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

Explanation:

If you have to "malloc" an instance, you are responsible for @@ -1892,11 +2095,14 @@ CLASS="EMPHASIS" responsible for ensuring that deletion is timely (i.e. not too soon, not too late). This is known as "low-coupling" and is a "good thing (tm)". You may need to offer a - free/unload/destuctor type function to accommodate this.

Example:

Exceptions:

The developer cannot be expected to provide `free'ing functions for C run-time library functions ... such as `strdup'.

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

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

Explanation:

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.

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 @@ -1960,14 +2176,15 @@ CLASS="SECT3" >

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

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

Explanation:

If you have enough confidence in new code or confidence in @@ -1988,9 +2205,12 @@ CLASS="EMPHASIS" >/* FIXME: new code that *may* break something else... */ ...new code here...

Note: If you make it clear that this may or may not be a "good thing (tm)", it will be easier to identify and include in the project (or conversely exclude from the @@ -2002,14 +2222,15 @@ CLASS="SECT2" >

4.8. Addendum: Template for files and function - comment blocks:

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

Example for file comments:

const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.45 2002/05/19 23:01:54 hal9 Exp $";
+>const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 2.3 2002/09/05 02:27:59 hal9 Exp $";
 /*********************************************************************
  *
  * File        :  $Source$
@@ -2066,26 +2287,35 @@ 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 change the "Copyright" section to represent the rights you wish to maintain.

Note: 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.

Example for file header comments:

#ifndef _FILENAME_H #define _FILENAME_H -#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.45 2002/05/19 23:01:54 hal9 Exp $" +#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 2.3 2002/09/05 02:27:59 hal9 Exp $" /********************************************************************* * * File : $Source$ @@ -2164,9 +2394,12 @@ extern const char FILENAME_h_rcs[]; >

Example for function comments:

Note: If we all follow this practice, we should be able to parse our code to create a "self-documenting" web page.

PrevContacting the developers, Bug Reporting and Feature Requests
HomeNext
Prev

8. Contacting the developers, Bug Reporting and Feature Requests

8. Contacting the developers, Bug Reporting and Feature Requests

We value your feedback. In fact, we rely on it to improve

8.1. Get Support

8.1. Get Support

For casual users, our support forum at

8.2. Report Bugs

8.2. Report Bugs

Please report all bugs Please report all bugs only through our bug tracker: .

Before doing so, please make sure that the bug has not already been submitted - and observe the aditional hints at the top of the submit @@ -177,9 +177,7 @@ CLASS="SECT2" >

8.3. Request New Features

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 @@ -194,9 +192,7 @@ CLASS="SECT2" >

8.4. Report Ads or Other Actions-Related Problems

8.4. Report Ads or Other Actions-Related Problems

Please send feedback on ads that slipped through, innocent images that were blocked, and any other problems relating to the ijbswa-announce - list and available from our files section of + our project page

8.5. Other

8.5. Other

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! You can find an overview of all PrixoxyPrivoxy-related mailing lists, including list archives, at:

Next
PrevPrivoxy Copyright, License and History
HomeNext
Prev

9. Privoxy Copyright, License and History

9. Privoxy Copyright, License and History

Copyright © 2001, 2002 by Privoxy Developers

Next
HomeNext

Next
HomeNext

Next
<para></para>, paragraph delimiter. Most text needs to be within paragraph elements (there are some exceptions).
<emphasis></emphasis>, the stylesheets make this italics.
<filename></filename>, files and directories.
<command></command>, command examples.
<literallayout></literallayout>, like
<itemizedlist></itemizedlist>, list with bullets.
<listitem></listitem>, member of the above.
<screen></screen>, screen output, implies
<ulink url="example.com"></ulink>, like HTML
<quote></quote>, for, doh, quoting text.
p-version: the Privoxy version string, e.g. "2.9.15""3.1.1".
p-status: the project status, either
p-not-stable: use to conditionally include text in
p-stable: just the opposite.
p-text: this doc is only generated as text.
HomeNext

Next
HomeNext

Next

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