X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=3c2b827684be5da02744ef96e96962ed9f9e8e9b;hp=8f6ab5fbca0bc1b9a276b1b80423cda1aff96f0b;hb=74b1753765138b23b31d088ce95c9817901a0761;hpb=dcb6d2261f6cc345036a0054be5904667754a2ab diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index 8f6ab5fb..3c2b8276 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.61 2002/03/29 01:31:08 hal9 Exp $ +$Id: user-manual.sgml,v 1.66 2002/04/04 06:48:37 hal9 Exp $ @@ -39,20 +50,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://www.privoxy.org/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/. + @@ -65,33 +86,9 @@ 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 web page content, managing - cookies, controlling access, and removing ads, banners, pop-ups and other - obnoxious Internet junk. Privoxy has a very - flexible configuration and can be customized to suit individual needs and - tastes. Privoxy has application for both - stand-alone systems and multi-user networks. - - - - Privoxy is based on the code of the - Internet Junkbuster. - Junkbuster was originally written by JunkBusters - Corporation, and was released as free open-source software under the GNU GPL. - Stefan Waldherr made many improvements, and started the SourceForge project - to continue development. - - - - Privoxy continues the - Junkbuster tradition, but adds many - refinements and enhancements. - - This documentation is included with the current BETA version of + This documentation is included with the current &p-status; 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 @@ -100,13 +97,15 @@ You can find the latest version of the user manual at In addition to Internet Junkbuster's traditional feature of ad and banner blocking and cookie management, - Privoxy provides new features, some of them - currently under development: + Privoxy provides new features: - - - - - - - Integrated browser based configuration and control utility (http://p.p). 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). - - - - - - Improved signal handling, and a true daemon mode (Unix). - - - - - - 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; + @@ -237,72 +131,38 @@ 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 privoxy-2.9.13-beta-src* [.tgz or .tar.gz] - cd privoxy-2.9.13-beta - - - - - For retrieving the current CVS sources, you'll need the CVS - package installed first. To download CVS source: - - - - - 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: @@ -319,10 +179,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: @@ -363,10 +226,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. @@ -468,6 +331,7 @@ configuration section below. HB.) The rest should be the same as above for Linux/Unix. + @@ -481,7 +345,7 @@ configuration section below. HB.) Before launching Privoxy for the first time, you will want to configure your browser(s) to use Privoxy - and the HTTP and HTTPS proxy. The default is localhost for the proxy address, + 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! @@ -490,7 +354,7 @@ configuration section below. HB.) With Netscape (and Mozilla), this can be set under Edit -> Preferences -> Advanced -> Proxies -> HTTP Proxy. - For Internet Explorer: Tools > + 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. @@ -695,7 +559,7 @@ For RedHat: /etc/rc.d/init.d/privoxy start <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. @@ -795,7 +659,7 @@ Please choose from the following options: file that can be accessed via 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.) @@ -893,9 +757,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. @@ -1087,8 +951,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 @@ -1139,7 +1003,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 @@ -1898,7 +1762,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 ): @@ -1909,7 +1774,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 @@ -2117,19 +1991,33 @@ Removed references to Win32. HB 09/23/01 The default.action file (formerly - actionsfile or ijb.action) 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 + 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. @@ -2176,8 +2064,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. @@ -2193,8 +2082,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. @@ -2233,8 +2122,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 @@ -2348,8 +2238,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. @@ -2380,7 +2272,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. @@ -2473,7 +2367,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! @@ -2584,7 +2480,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. @@ -2668,7 +2564,10 @@ 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. Forcing an image in this + situation just will not work. @@ -2758,7 +2657,7 @@ icon being being cached by the browser, which will speed up the display. 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. @@ -2962,9 +2861,9 @@ icon being being cached by the browser, which will speed up the display. - 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: @@ -3048,7 +2947,7 @@ icon being being cached by the browser, which will speed up the display. 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. @@ -3111,6 +3010,13 @@ icon being being cached by the browser, which will speed up the display. + + The shop and fragile aliases are often used for + problem sites that require most actions to be disabled + in order to function properly. + + + @@ -3127,12 +3033,18 @@ icon being being cached by the browser, which will speed up the display. 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. - @@ -3227,6 +3139,11 @@ icon being being cached by the browser, which will speed up the display. On Linux, BSD, and Unix, these are located in /etc/privoxy/templates by default. These may be customized, if desired. + + + 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. @@ -3241,44 +3158,12 @@ icon being being cached by the browser, which will speed up the display. 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. + - + &contacting; - - - -For any other issues, feel free to use the mailing lists. - - - - Anyone interested in actively participating in development and related - discussions can join the appropriate mailing list - here. - Archives are available here too. - + @@ -3286,24 +3171,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; + @@ -3311,74 +3182,18 @@ For any other issues, feel free to use the -History - - Privoxy is evolved, and derived from, - the Internet Junkbuster, with many - improvments and enhancements over the original. - - - - Junkbuster was originally written by Anonymous - Coders and Junkbuster's - Corporation, and was released as free open-source software under the - GNU GPL. Stefan - Waldherr made many improvements, and started the SourceForge project - Privoxy to rekindle development. There are now several active - developers contributing. The last stable release of - Junkbuster was v2.0.2, which has now - grown whiskers ;-). - - +History + + &history; + - -See also - - - - -   http://sourceforge.net/projects/ijbswa, - the Project Page for Privoxy. - - - - -   http://www.privoxy.org/ - - - - -   http://p.p/ - - - - -   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; + @@ -3818,12 +3633,12 @@ For any other issues, feel free to use the http://config.privoxy.org/show-url-info @@ -4024,7 +3839,8 @@ For any other issues, feel free to use the + + {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. + + @@ -4106,6 +3929,27 @@ For any other issues, feel free to use the