X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=5510575cef4b3256bad5c46864ca86046666155c;hp=faac158fa990170f6e21a51679fde759b785e343;hb=8023259b48217910c1dd8038ffc16a57f9a10f37;hpb=4a5121c3b907c377584ac09d4e5401c4107eaf5a diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index faac158f..5510575c 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -1,4 +1,22 @@ - + + + + + + + + + + + + + + + + + +]> -
Privoxy User Manual -$Id: user-manual.sgml,v 1.52 2002/03/24 11:01:06 swa Exp $ +$Id: user-manual.sgml,v 1.68 2002/04/04 18:46:47 swa Exp $ @@ -39,20 +58,30 @@ Hal Burgiss + - The user manual gives users information on how to install, configure and use - Privoxy. Privoxy is a - web proxy with advanced filtering capabilities for protecting privacy, - filtering web page content, managing cookies, controlling access, and - removing ads, banners, pop-ups and other obnoxious Internet - Junk. Privoxy has a very flexible configuration - and can be customized to suit individual needs and - tastes. Privoxy has application for both - stand-alone systems and multi-user networks. + + This is here to keep vim syntax file from breaking :/ + If I knew enough to fix it, I would. + PLEASE DO NOT REMOVE! HB: hal@foobox.net + +]]> + -You can find the latest version of the user manual at http://ijbswa.sourceforge.net/user-manual/. - + The user manual gives users information on how to install, configure and use + Privoxy. + + + + &p-intro; + + + 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. + @@ -61,37 +90,37 @@ You can find the latest version of the user manual at + + + + -Introduction - - Privoxy is a web proxy with advanced - filtering capabilities for protecting privacy, filtering and modifying web - page content, managing cookies, controlling access, and removing ads, - banners, pop-ups and other obnoxious Internet Junk. - Privoxy has a very flexible configuration and - can be customized to suit individual needs and tastes. Privoxy has application for both stand-alone systems and - multi-user networks. - +Introduction - This documentation is included with the current BETA version of - Privoxy and is mostly complete at this - point. The most up to date reference for the time being is still the comments - in the source files and in the individual configuration files. Development - of version 3.0 is currently nearing completion, and includes many significant - changes and enhancements over earlier versions. The target release date for - stable v3.0 is soon ;-) + This documentation is included with the current &p-status; version of + Privoxy, v.&p-version;soon ;-)]]>. + - Since this is a BETA version, not all new features are well tested. This + Since this is a &p-status; 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! - +]]> @@ -99,112 +128,13 @@ You can find the latest version of the user manual at http://i.j.b). Browser-based tracing of rule - and filter effects. - - - - - - Blocking of annoying pop-up browser windows. - - - - - - HTTP/1.1 compliant (most, but not all 1.1 features are supported). - - - - - - Support for Perl Compatible Regular Expressions in the configuration files, and - generally a more sophisticated and flexible configuration syntax over - previous versions. - - - - - - GIF de-animation. - - - - - - Web page content filtering (removes banners based on size, - invisible web-bugs, JavaScript, pop-ups, status bar abuse, - etc.) - - - - - - Bypass many click-tracking scripts (avoids script redirection). - - - - - - - Multi-threaded (POSIX and native threads). - - - - - - Auto-detection and re-reading of config file changes. - - - - - - User-customizable HTML templates (e.g. 404 error page). - - - - - - Improved cookie management features (e.g. session based cookies). - - - - - - Builds from source on most UNIX-like systems. Packages available for: Linux - (RedHat, SuSE, or Debian), Windows, Sun Solaris, Mac OSX, OS/2, HP-UX 11 and AmigaOS. - - - - - - - In addition, the configuration is much more powerful and versatile over-all. - - - - - + + &newfeatures; + @@ -216,78 +146,44 @@ You can find the latest version of the user manual at Installation - Privoxy is available as raw source code, or - pre-compiled binaries. See the Privoxy Home Page - for binaries and current release info. Privoxy - is also available via Privoxy is available as raw source code (tarball + or via CVS), or pre-compiled binaries for various platforms. See the Privoxy Project Page for + the most up to date release information. + Privoxy is also available via CVS. - This is the recommended approach at this time. But please be aware that CVS - is constantly changing, and it may break in mysterious ways. + But + please be aware that CVS is constantly changing, and it may break in + mysterious ways. + + &supported; + + Source - - For gzipped tar archives, unpack the source: - - - - - tar xzvf ijb_source_* [.tgz or .tar.gz] - cd ijb_source_2.9.11_beta - - - - - For retrieving the current CVS sources, you'll need the CVS - package installed first. To download CVS source: - - - - - cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login - cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current - cd current - - - - - This will create a directory named current/, which will - contain the source tree. - - - Then, in either case, to build from tarball/CVS source: - - - - ./configure (--help to see options) - make (the make from gnu, gmake for *BSD) - su - make -n install (to see where all the files will go) - make install (to really install) - - + + &buildsource; + For Redhat and SuSE Linux RPM packages, see below. - - -Red Hat +Red Hat - To build Redhat RPM packages, install source as above. Then: + To build Redhat RPM packages from source, install source as above. Then: - autoheader [suggested for CVS source] - autoconf [suggested for CVS source] + autoheader + autoconf ./configure make redhat-dist @@ -298,10 +194,10 @@ You can find the latest version of the user manual at - rpm -Uvv /usr/src/redhat/RPMS/i686/privoxy-2.9.11-1.i686.rpm + rpm -Uvv /usr/src/redhat/RPMS/i686/privoxy-&p-version;-1.i686.rpm This will place the Privoxy configuration files in /etc/privoxy/, and log files in - /var/log/privoxy/. + /var/log/privoxy/. Run + ckconfig privoxy on to have + Privoxy start automatically during init. + - + -SuSE +SuSE To build SuSE RPM packages, install source as above. Then: - autoheader [suggested for CVS source] - autoconf [suggested for CVS source] + autoheader + autoconf ./configure make suse-dist @@ -342,10 +241,10 @@ You can find the latest version of the user manual at - rpm -Uvv /usr/src/packages/RPMS/i686/privoxy-2.9.11-1.i686.rpm + rpm -Uvv /usr/src/packages/RPMS/i686/privoxy-&p-version;-1.i686.rpm This will place the Privoxy configuration files in /etc/privoxy/, and log files in - /var/log/privoxy/. + /var/log/privoxy/. - + -OS/2 +OS/2 -Windows +Windows Click-click. (I need help on this. Not a clue here. Also for configuration section below. HB.) - + -Other +Other Some quick notes on other Operating Systems. @@ -447,6 +346,224 @@ configuration section below. HB.) The rest should be the same as above for Linux/Unix. + + + + + + + + + + +Quickstart to Using <application>Privoxy</application> + + Before launching Privoxy for the first time, you + will want to configure your browser(s) to use Privoxy + as a HTTP and HTTPS proxy. The default is localhost for the proxy address, + and port 8118 (earlier versions used port 800). This is the one required + configuration 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: + localhost, Port: 8118). Include if HTTPS proxy support too. + + + + After doing this, flush your browser's disk and memory caches to force a + re-reading of all pages and get rid of any ads that may be cached. You + are now ready to start enjoying the benefits of using + Privoxy. + + + + + Privoxy is typically started by specifying the + main configuration file to be used on the command line. Example Unix startup + command: + + + + + + # /usr/sbin/privoxy /etc/privoxy/config + + + + + + An init script is provided for SuSE and Redhat. + + + + For for SuSE: /etc/rc.d/privoxy start + + + + For RedHat: /etc/rc.d/init.d/privoxy start + + + + + If no configuration file is specified on the command line, + Privoxy will look for a file named + config in the current directory. Except on Win32 where + it will try config.txt. If no file is specified on the + command line and no default configuration file can be found, + Privoxy will fail to start. + + + + + The included default configuration files should give a reasonable starting + point, though may be somewhat aggressive in blocking junk. Most of the + per site configuration is done in the actions files. These + are where various cookie actions are defined, ad and banner blocking, + and other aspects of Privoxy configuration. There + are several such files included, with varying levels of aggressiveness. + + + + You will probably want to keep an eye out for sites that require persistent + cookies, and add these to default.action as needed. By + default, most of these will be accepted only during the current browser + session, until you add them to the configuration. If you want the browser to + handle this instead, you will need to edit + default.action and disable this feature. If you use more + than one browser, it would make more sense to let + Privoxy handle this. In which case, the browser(s) + should be set to accept all cookies. + + + + Privoxy is HTTP/1.1 compliant, but not all 1.1 + features are as yet implemented. If browsers that support HTTP/1.1 (like + Mozilla or recent versions of I.E.) experience + problems, you might try to force HTTP/1.0 compatibility. For Mozilla, look + under Edit -> Preferences -> Debug -> Networking. + Or set the +downgrade config option in + default.action. + + + + After running Privoxy for a while, you can + start to fine tune the configuration to suit your personal, or site, + preferences and requirements. There are many, many aspects that can + be customized. Actions (as specified in default.action) + can be adjusted by pointing your browser to + http://p.p/, + and then follow the link to edit the actions list. + (This is an internal page and does not require Internet access.) + + + + In fact, various aspects of Privoxy + configuration can be viewed from this page, including + current configuration parameters, source code version numbers, + the browser's request headers, and actions that apply + to a given URL. In addition to the default.action file + editor mentioned above, Privoxy can also + be turned on and off from this page. + + + + If you encounter problems, please verify it is a + Privoxy bug, by disabling + Privoxy, and then trying the same page. + Also, try another browser if possible to eliminate browser or site + problems. Before reporting it as a bug, see if there is not a configuration + option that is enabled that is causing the page not to load. You can then add + an exception for that page or site. For instance, try adding it to the + {fragile} section of default.action. + This will turn off most actions for this site. For more on troubleshooting + problem sites, see the Appendix. If a bug, please report it + to the developers (see below). + + + + + + +Command Line Options + + Privoxy may be invoked with the following + command-line options: + + + + + + + + --version + + + Print version info and exit, Unix only. + + + + + --help + + + Print a short usage info and exit, Unix only. + + + + + --no-daemon + + + Don't become a daemon, i.e. don't fork and become process group + leader, don't detach from controlling tty. Unix only. + + + + + --pidfile FILE + + + + On startup, write the process ID to FILE. Delete the + FILE on exit. Failiure to create or delete the + FILE is non-fatal. If no FILE + option is given, no PID file will be used. Unix only. + + + + + --user USER[.GROUP] + + + + After (optionally) writing the PID file, assume the user ID of + USER, and if included the GID of GROUP. Exit if the + privileges are not sufficient to do so. Unix only. + + + + + configfile + + + If no configfile is included on the command line, + Privoxy will look for a file named + config in the current directory (except on Win32 + where it will look for config.txt instead). Specify + full path to avoid confusion. + + + + + + @@ -457,7 +574,7 @@ configuration section below. HB.) <application>Privoxy</application> Configuration - All Privoxy configuration is kept + All Privoxy configuration is stored in text files. These files can be edited with a text editor. Many important aspects of Privoxy can also be controlled easily with a web browser. @@ -471,8 +588,8 @@ configuration section below. HB.) Controlling <application>Privoxy</application> with Your Web Browser Privoxy can be reached by the special - URL http://i.j.b/ (or alternately - http://ijbswa.sourceforge.net/config/), + URL http://p.p/ (or alternately + http://config.privoxy.org/), which is an internal page. You will see the following section: @@ -527,15 +644,15 @@ Please choose from the following options: For Unix, *BSD and Linux, all configuration files are located in /etc/privoxy/ by default. For MS Windows, OS/2, and AmigaOS these are all in the same directory as the - Privoxy executable. The name and number of - configuration files has changed from previous versions, and is subject to - change as development progresses. + Privoxy executable. The installed defaults provide a reasonable starting point, though possibly aggressive by some standards. For the time being, there are only three - default configuration files (this will change in time): + default configuration files (this may change in time): @@ -555,9 +672,9 @@ Please choose from the following options: actions relating to images, banners, pop-ups, access restrictions, banners and cookies. There is a CGI based editor for this file that can be accessed via http://i.j.b. (Other actions + url="http://p.p">http://p.p. (Other actions files are included as well with differing levels of filtering - and blocking, e.g. ijb-basic.action.) + and blocking, e.g. basic.action.) @@ -583,12 +700,14 @@ Please choose from the following options: automatically. + While under development, the configuration content is subject to change. The below documentation may not be accurate by the time you read this. Also, what constitutes a default setting, may change, so please check all your configuration files on important issues. +]]> @@ -655,9 +774,9 @@ Please choose from the following options: Privoxy can use a number of other files to tell it - what ads to block, what cookies to accept, etc. This section of the - configuration file tells Privoxy where to find - all those other files. + what ads to block, what cookies to accept, and perform other functions. This + section of the configuration file tells Privoxy + where to find all those other files. @@ -712,16 +831,16 @@ Please choose from the following options: - The default.action file contains patterns to specify the actions - to apply to requests for each site. Default: Cookies to and from all + The default.action file contains patterns to specify the + actions to apply to requests for each site. Default: Cookies to and from all destinations are kept only during the current browser session (i.e. they are not saved to disk). Pop-ups are disabled for all sites. All sites are filtered through selected sections of default.filter. No sites - are blocked. The Privoxy logo is displayed for - filtered ads and other images. The syntax of this file is explained in detail - below. Other actions files - are included, and you are free to use any of them. They have varying degrees - of aggressiveness. + are blocked. Privoxy displays a checkboard type + pattern for filtered ads and other images. The syntax of this file is + explained in detail below. Other + actions files are included, and you are free to use any of + them. They have varying degrees of aggressiveness. @@ -849,8 +968,8 @@ Please choose from the following options: - trust-info-url http://www.your-site.com/why_we_block.html - trust-info-url http://www.your-site.com/what_we_allow.html + trust-info-url http://www.example.com/why_we_block.html + trust-info-url http://www.example.com/what_we_allow.html @@ -901,7 +1020,7 @@ Please choose from the following options: - proxy-info-url http://www.your-site.com/proxy.html + proxy-info-url http://www.example.com/proxy.html @@ -994,10 +1113,12 @@ Please choose from the following options: + It is highly recommended that you enable ERROR reporting (debug 8192), at least until v3.0 is released. +]]> The reporting of FATAL errors (i.e. ones which crash @@ -1075,7 +1196,7 @@ Please choose from the following options: to temporarily disable Privoxy, e.g., to access a site that requires cookies which you would otherwise have blocked. This can also be toggled via a web browser at the Privoxy - internal address of http://i.j.b on + internal address of http://p.p on any platform. @@ -1130,7 +1251,7 @@ Please choose from the following options: that you must have compiled Privoxy with support for this feature, otherwise this option has no effect. This internal page can be reached at http://i.j.b. + url="http://p.p">http://p.p. @@ -1159,7 +1280,7 @@ Please choose from the following options: Security note: If this is enabled, anyone who can use the proxy can toggle - it on or off (see http://i.j.b), and + it on or off (see http://p.p), and their changes will affect all users. For shared proxies, you probably want to disable this. Default: enabled. @@ -1403,7 +1524,7 @@ Please choose from the following options: - + Forwarding @@ -1660,7 +1781,8 @@ Please choose from the following options: - Your squid configuration could then look like this: +Your squid configuration could then look like this (assuming that the IP +address of the box is 192.168.0.1 ): @@ -1671,7 +1793,16 @@ Please choose from the following options: - cache_peer 127.0.0.1 parent 8118 0 no-query + cache_peer 192.168.0.1 parent 8118 0 no-query + + # don't listen to the whole world + http_port 192.168.0.1:3128 + + # define the local lan + acl mylocallan src 192.168.0.1-192.168.0.5/255.255.255.255 + + # grant access for http to local lan + http_access allow mylocallan # Define ACL for protocol FTP acl FTP proto FTP @@ -1879,20 +2010,34 @@ Removed references to Win32. HB 09/23/01 The default.action file (formerly - actionsfile) is used to define what actions - Privoxy takes, and thus determines how images, - cookies and various other aspects of HTTP content and transactions are - handled. Images can be anything you want, including ads, banners, or just - some obnoxious URL that you would rather not see. Cookies can be accepted - or rejected, or accepted only during the current browser session (i.e. - not written to disk). Changes to default.action should - be immediately visible to Privoxy without - the need to restart. + actionsfile or ijb.action) is used + to define what actions Privoxy takes, and thus + determines how ad images, cookies and various other aspects of HTTP content + and transactions are handled. These can be accepted or rejected for all + sites, or just those sites you choose. See below for a complete list of + actions. + + + Anything you want can blocked, including ads, banners, or just some obnoxious + URL that you would rather not see. Cookies can be accepted or rejected, or + accepted only during the current browser session (i.e. not written to disk). + Changes to default.action should be immediately visible + to Privoxy without the need to restart. + + + + Note that some sites may misbehave, or possibly not work at all with some + actions. This may require some tinkering with the rules to get the most + mileage of Privoxy's features, and still be + able to see and enjoy just what you want to. There is no general rule of + thumb on these things. There just are too many variables, and sites are + always changing. + - The easiest way to edit actions file is with a browser by - loading http://i.j.b/, and then select + The easiest way to edit the actions file is with a browser by + loading http://p.p/, and then select Edit Actions List. A text editor can also be used. @@ -1901,7 +2046,7 @@ Removed references to Win32. HB 09/23/01 compared to all patterns in this file. Every time it matches, the list of applicable actions for the URL is incrementally updated. You can trace this process by visiting http://i.j.b/show-url-info. + url="http://p.p/show-url-info">http://p.p/show-url-info. @@ -1938,8 +2083,9 @@ Removed references to Win32. HB 09/23/01 - /index.html - matches the document /index.html, regardless of - the domain. + /index.html - matches the document /index.html, + regardless of the domain. So would match any page named index.html + on any site. @@ -1955,8 +2101,8 @@ Removed references to Win32. HB 09/23/01 - .example.com - matches any domain that ENDS in - .example.com. + .example.com - matches any domain or sub-domain that + ENDS in .example.com. @@ -1995,8 +2141,9 @@ Removed references to Win32. HB 09/23/01 If Privoxy was compiled with - pcre support (default), Perl compatible regular expressions - can be used. See the pcre/docs/ directory or man + pcre support (the default), Perl compatible regular expressions + can be used. These are more flexible and powerful than other types + of regular expressions. See the pcre/docs/ directory or man perlre (also available on http://www.perldoc.com/perl5.6/pod/perlre.html) for details. A brief discussion of regular expressions is in the @@ -2110,8 +2257,10 @@ Removed references to Win32. HB 09/23/01 - Later defined actions always over-ride earlier ones. For multi-valued - actions, the actions are applied in the order they are specified. + Later defined actions always over-ride earlier ones. So exceptions + to any rules you make, should come in the latter part of the file. For + multi-valued actions, the actions are applied in the order they are + specified. @@ -2142,7 +2291,9 @@ Removed references to Win32. HB 09/23/01 Block this URL totally. In a default installation, a blocked URL will result in bright red banner that says BLOCKED, - with a reason why it is being blocked. + with a reason why it is being blocked, and an option to see it anyway. + The page displayed for this is the blocked template + file. @@ -2203,7 +2354,7 @@ Removed references to Win32. HB 09/23/01 will link to some script on their own server, giving the destination as a parameter, which will then redirect you to the final target. URLs resulting from this scheme typically look like: - http://some.place/some_script?http://some.where-else. + http://some.place/some_script?http://some.where-else. Sometimes, there are even multiple consecutive redirects encoded in the @@ -2215,9 +2366,9 @@ Removed references to Win32. HB 09/23/01 The +fast-redirects option enables interception of these - requests by Privoxy, who will cut off all but - the last valid URL in the request and send a local redirect back to your - browser without contacting the remote site. + types of requests by Privoxy, who will cut off + all but the last valid URL in the request and send a local redirect back to + your browser without contacting the intermediate site(s). @@ -2235,7 +2386,9 @@ Removed references to Win32. HB 09/23/01 Apply the filters in the section_header section of the default.filter file to the site(s). default.filter sections are grouped according to like - functionality. + functionality. Filters can be used to + re-write any of the raw page content. This is a potentially a + very powerful feature! @@ -2346,7 +2499,7 @@ Removed references to Win32. HB 09/23/01 Don't send the Referer: (sic) header to the web site. You can block it, forge a URL to the same server as the request (which is preferred because some sites will not send images otherwise) or set it to a - constant string of your choice. + constant, user defined string of your choice. @@ -2430,7 +2583,11 @@ Removed references to Win32. HB 09/23/01 See +image-blocker{} below for the control over what is actually sent. If you want invisible ads, they should be defined as images and blocked. And also, - image-blocker should be set to blank. + image-blocker should be set to blank. Note you + cannot treat HTML pages as images in most cases. For instance, frames + require an HTML page to display. So a frame that is an ad, cannot be + treated as an image. Forcing an image in this + situation just will not work. @@ -2448,24 +2605,26 @@ Removed references to Win32. HB 09/23/01 +image}, e.g an advertizement. There are five options. -image-blocker will send a HTML blocked page, usually resulting in a broken image icon. - +image-blocker{logo} will send a - Privoxy logo - image. +image-blocker{blank} will send a 1x1 transparent GIF - image. And finally, +image-blocker{http://xyz.com} will send - a HTTP temporary redirect to the specified image. This has the advantage of - the icon being being cached by the browser, which will speed up the display. - +image-blocker{pattern} will send a checkboard type pattern, - which scales better than the logo (which can get blocky if the browser - enlarges it too much). + + + ++image-blocker{blank} will send a 1x1 transparent GIF +image. And finally, +image-blocker{http://xyz.com} will send a +HTTP temporary redirect to the specified image. This has the advantage of the +icon being being cached by the browser, which will speed up the display. ++image-blocker{pattern} will send a checkboard type pattern + + + - +image-blocker{logo} + +image-blocker{blank} +image-blocker{pattern} - +image-blocker{http://i.j.b/send-banner} + +image-blocker{http://p.p/send-banner} @@ -2518,7 +2677,7 @@ Removed references to Win32. HB 09/23/01 Privoxy, since +filter, +no-popup and +gif-deanimate will not work on compressed data. This will slow down connections to those websites, - though. Default is nocompression is turned on. + though. Default is no-compression is turned on. @@ -2722,9 +2881,9 @@ Removed references to Win32. HB 09/23/01 - Now some URLs that we want blocked, ie we won't see them. - Many of these use regular expressions that will expand to match multiple - URLs: + Now some URLs that we want blocked (normally generates + the blocked banner). Many of these use regular expressions + that will expand to match multiple URLs: @@ -2788,7 +2947,6 @@ Removed references to Win32. HB 09/23/01 content he may depend on. There is no way to have hard and fast rules for all sites. See the Appendix for a brief example on troubleshooting actions. - @@ -2808,7 +2966,7 @@ Removed references to Win32. HB 09/23/01 z, 0-9, +, and -. Alias names are not case sensitive, and must be defined before anything else in the - default.actionfile ! And there can only be one set of + default.actionfile! And there can only be one set of aliases defined. @@ -2820,7 +2978,7 @@ Removed references to Win32. HB 09/23/01 - # Useful customer aliases we can use later. These must come first! + # Useful custom aliases we can use later. These must come first! {{alias}} +no-cookies = +no-cookies-set +no-cookies-read -no-cookies = -no-cookies-set -no-cookies-read @@ -2871,6 +3029,13 @@ Removed references to Win32. HB 09/23/01 + + The shop and fragile aliases are often used for + problem sites that require most actions to be disabled + in order to function properly. + + + @@ -2887,12 +3052,18 @@ Removed references to Win32. HB 09/23/01 default.filter, located in the config directory. + + This is potentially a very powerful feature, and requires knowledge of both + regular expression and HTML in order create custom + filters. But, there are a number of useful filters included with + Privoxy for many common situations. + + The included example file is divided into sections. Each section begins with the FILTER keyword, followed by the identifier for that section, e.g. FILTER: webbugs. Each section performs a similar type of filtering, such as html-annoyances. - @@ -2949,243 +3120,51 @@ Removed references to Win32. HB 09/23/01 # Buzzword Bingo: # s/industry-leading|cutting-edge|award-winning/<font color=red><b>BINGO!</b></font>/ig - - - - - - - Kill those pesky little web-bugs: - - - - - - - # webbugs: Squish WebBugs (1x1 invisible GIFs used for user tracking) - FILTER: webbugs - - s/<img\s+[^>]*?(width|height)\s*=\s*['"]?1\D[^>]*?(width|height)\s*=\s*['"]?1(\D[^>]*?)?>/<!-- Squished WebBug -->/sig - - - - - - - - - - - - - - -Templates - - When Privoxy displays one of its internal - pages, such as a 404 Not Found error page, it uses the appropriate template. - On Linux, BSD, and Unix, these are located in - /etc/privoxy/templates by default. These may be - customized, if desired. - - - - - - - - - - - -Quickstart to Using <application>Privoxy</application> - - Install package, then run and enjoy! Privoxy - is typically started by specifying the main configuration file to be - used on the command line. Example Unix startup command: - - - - - - # /usr/sbin/privoxy /etc/privoxy/config - - - - - - An init script is provided for SuSE and Redhat. - - - -For for SuSE: /etc/rc.d/privoxy start - - - -For RedHat: /etc/rc.d/init.d/privoxy start - - - - - If no configuration file is specified on the command line, - Privoxy will look for a file named - config in the current directory. Except on Win32 where - it will try config.txt. If no file is specified on the - command line and no default configuration file can be found, - Privoxy will fail to start. - - - - Be sure your browser is set to use the proxy which is by default at - localhost, port 8118. 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: - localhost, Port: 8118). Include if HTTPS proxy support too. - - - - The included default configuration files should give a reasonable starting - point, though may be somewhat aggressive in blocking junk. You will probably - want to keep an eye out for sites that require persistent cookies, and add these to - default.action as needed. By default, most of these will - be accepted only during the current browser session, until you add them to - the configuration. If you want the browser to handle this instead, you will - need to edit default.action and disable this feature. If you - use more than one browser, it would make more sense to let - Privoxy handle this. In which case, the - browser(s) should be set to accept all cookies. - - - - If a particular site shows problems loading properly, try adding it - to the {fragile} section of - default.action. This will turn off most actions for - this site. - - - - Privoxy is HTTP/1.1 compliant, but not all 1.1 - features are as yet implemented. If browsers that support HTTP/1.1 (like - Mozilla or recent versions of I.E.) experience - problems, you might try to force HTTP/1.0 compatibility. For Mozilla, look - under Edit -> Preferences -> Debug -> Networking. - Or set the +downgrade config option in - default.action. - - - - After running Privoxy for a while, you can - start to fine tune the configuration to suit your personal, or site, - preferences and requirements. There are many, many aspects that can - be customized. Actions (as specified in default.action) - can be adjusted by pointing your browser to - http://i.j.b/, - and then follow the link to edit the actions list. - (This is an internal page and does not require Internet access.) + + + - In fact, various aspects of Privoxy - configuration can be viewed from this page, including - current configuration parameters, source code version numbers, - the browser's request headers, and actions that apply - to a given URL. In addition to the default.action file - editor mentioned above, Privoxy can also - be turned on and off from this page. + Kill those pesky little web-bugs: - If you encounter problems, please verify it is a - Privoxy bug, by disabling - Privoxy, and then trying the same page. - Also, try another browser if possible to eliminate browser or site - problems. Before reporting it as a bug, see if there is not a configuration - option that is enabled that is causing the page not to load. You can - then add an exception for that page or site. If a bug, please report it to - the developers (see below). + + + + # webbugs: Squish WebBugs (1x1 invisible GIFs used for user tracking) + FILTER: webbugs + + s/<img\s+[^>]*?(width|height)\s*=\s*['"]?1\D[^>]*?(width|height)\s*=\s*['"]?1(\D[^>]*?)?>/<!-- Squished WebBug -->/sig + + + + + + + -Command Line Options +Templates - Privoxy may be invoked with the following - command-line options: + When Privoxy displays one of its internal + pages, such as a 404 Not Found error page, it uses the appropriate template. + On Linux, BSD, and Unix, these are located in + /etc/privoxy/templates by default. These may be + customized, if desired. - - - - - - --version - - - Print version info and exit, Unix only. - - - - - --help - - - Print a short usage info and exit, Unix only. - - - - - --no-daemon - - - Don't become a daemon, i.e. don't fork and become process group - leader, don't detach from controlling tty. Unix only. - - - - - --pidfile FILE - - - - On startup, write the process ID to FILE. Delete the - FILE on exit. Failiure to create or delete the - FILE is non-fatal. If no FILE - option is given, no PID file will be used. Unix only. - - - - - --user USER[.GROUP] - - - - After (optionally) writing the PID file, assume the user ID of - USER, and if included the GID of GROUP. Exit if the - privileges are not sufficient to do so. Unix only. - - - - - configfile - - - If no configfile is included on the command line, - Privoxy will look for a file named - config in the current directory (except on Win32 - where it will look for config.txt instead). Specify - full path to avoid confusion. - - + The default Blocked banner page with the bright red top + banner, is called just blocked. This + may be customized or replaced with something else if desired. - - @@ -3198,44 +3177,12 @@ For RedHat: /etc/rc.d/init.d/privoxy start Contacting the Developers, Bug Reporting and Feature Requests - -We value your feedback. However, to provide you with the best support, -please note: - - - - Use the Sourceforge support forum to get - help. - - Submit bugs only thru our Sourceforge bug - forum. -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. - - - - Submit feature requests only thru our Sourceforge feature request forum. - - - - + - -For any other issues, feel free to use the mailing lists. - + &contacting; - - Anyone interested in actively participating in development and related - discussions can join the appropriate mailing list - here. - Archives are available here too. - + @@ -3243,24 +3190,10 @@ For any other issues, feel free to use the Copyright and History - -License - - Privoxy is free software; you can - redistribute it and/or modify it under the terms of the GNU General Public - License as published by the Free Software Foundation; either version 2 of the - License, or (at your option) any later version. - - - - This program is distributed in the hope that it will be useful, but WITHOUT - ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS - FOR A PARTICULAR PURPOSE. See the GNU General Public License for more - details, which is available from the Free Software Foundation, - Inc, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - - +Copyright + + ©right; + @@ -3268,66 +3201,18 @@ For any other issues, feel free to use the Junkbuster's - Corporation, and was released as free open-source software under the - GNU GPL. Stefan - Waldherr made many improvements, and started the SourceForge project - Privoxy to rekindle development. There are now several active - developers contributing. The last stable release was v2.0.2, which has now - grown whiskers ;-). - - +History + + &history; + - -See also - - - - -   http://sourceforge.net/projects/ijbswa - - - - -   http://ijbswa.sourceforge.net/ - - - - -   http://i.j.b/ - - - - -   http://www.junkbusters.com/ht/en/cookies.html - - - - -   http://www.waldherr.org/junkbuster/ - - - - -   http://privacy.net/analyze/ - - - - -  http://www.squid-cache.org/ - - - - +See Also + + &seealso; + @@ -3576,7 +3461,7 @@ For any other issues, feel free to use the
- http://ijbswa.sourceforge.net/config/ + http://config.privoxy.org/
- Alternately, this may be reached at http://i.j.b/, - but this variation may not work as reliably as the above in some - configurations. + Alternately, this may be reached at http://p.p/, but this + variation may not work as reliably as the above in some configurations. @@ -3618,7 +3503,7 @@ For any other issues, feel free to use the http://ijbswa.sourceforge.net/config/show-status + http://config.privoxy.org/show-status @@ -3629,7 +3514,7 @@ For any other issues, feel free to use the http://ijbswa.sourceforge.net/config/show-version + http://config.privoxy.org/show-version @@ -3640,7 +3525,7 @@ For any other issues, feel free to use the http://ijbswa.sourceforge.net/config/show-request + http://config.privoxy.org/show-request @@ -3651,18 +3536,19 @@ For any other issues, feel free to use the http://ijbswa.sourceforge.net/config/show-url-info + http://config.privoxy.org/show-url-info - Toggle Privoxy on or off: + Toggle Privoxy on or off. In this case, Privoxy continues + to run, but only as a pass-through proxy, with no actions taking place:
- http://ijbswa.sourceforge.net/config/toggle + http://config.privoxy.org/toggle
@@ -3670,12 +3556,12 @@ For any other issues, feel free to use the http://ijbswa.sourceforge.net/config/toggle?set=disable + http://config.privoxy.org/toggle?set=disable
- http://ijbswa.sourceforge.net/config/toggle?set=enable + http://config.privoxy.org/toggle?set=enable
@@ -3686,7 +3572,7 @@ For any other issues, feel free to use the http://ijbswa.sourceforge.net/config/edit-actions + http://config.privoxy.org/edit-actions @@ -3699,6 +3585,64 @@ For any other issues, feel free to use the +Bookmarklets + + Here are some bookmarklets to allow you to easily access a + mini version of this page. They are designed for MS Internet + Explorer, but should work equally well in Netscape, Mozilla, and other + browsers which support JavaScript. They are designed to run directly from + your bookmarks - not by clicking the links below (although that will work for + testing). + + + To save them, right-click the link and choose Add to Favorites + (IE) or Add Bookmark (Netscape). You will get a warning that + the bookmark may not be safe - just click OK. Then you can run the + Bookmarklet directly from your favourites/bookmarks. For even faster access, + you can put them on the Links bar (IE) or the Personal + Toolbar (Netscape), and run them with a single click. + + + + + + + + Enable Privoxy + + + + + + Disable Privoxy + + + + + + Toggle Privoxy (Toggles between enabled and disabled) + + + + + + View Privoxy Status + + + + + + + + Credit: The site which gave me the general idea for these bookmarklets is + www.bookmarklets.com. They + have more information about bookmarklets. + + + + + @@ -3708,15 +3652,15 @@ For any other issues, feel free to use the http://ijbswa.sourceforge.net/config/show-url-info + http://config.privoxy.org/show-url-info page that can show us very specifically how actions are being applied to any given URL. This is a big help for troubleshooting. @@ -3724,15 +3668,15 @@ For any other issues, feel free to use the - Now the page displays ;-) + Now the page displays ;-) Be sure to flush your browser's caches when + making such changes. Or, try using Shift+Reload. + + + + But now what about a situation where we get no explicit matches like + we did with: + + + + + + { -block } + /adsl + + + + + + 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: + + + + + + {shop} + .quietpc.com + .worldpay.com # for quietpc.com + .jungle.com + .scan.co.uk + .forbes.com + + + + + + {shop} is an alias that expands to + { -filter -no-cookies -no-cookies-keep }. Or you could do + your own exception to negate filtering: + + + + + + + {-filter} + .forbes.com + + + + + {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 work, you will have to go through the remaining actions one by + one to find which one(s) is causing the problem. @@ -3943,6 +3946,61 @@ For any other issues, feel free to use the