From 5e2c53186cd6a537069055bc3edc8e1aa95dfbd0 Mon Sep 17 00:00:00 2001 From: hal9 Date: Wed, 3 Apr 2002 03:53:43 +0000 Subject: [PATCH] A few minor bug fixes, and touch ups. Ready for review. --- doc/source/user-manual.sgml | 238 +++++++++++++++++++----------------- 1 file changed, 129 insertions(+), 109 deletions(-) diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index cc2389b0..25752408 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -2,6 +2,8 @@ + + ]> 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. - + +&p-intro; This documentation is included with the current BETA version of @@ -310,7 +292,7 @@ Thanx David Schmidt! Privoxy is packaged in a WarpIN self- installing archive. The self-installing program will be named depending on the release version, something like: - ijbos2_setup_1.2.3.exe. In order to install it, simply + privoxyos2_setup_1.2.3.exe. In order to install it, simply run this executable or double-click on its icon and follow the WarpIN installation panels. A shadow of the Privoxy executable will be placed in your startup folder so it will start @@ -392,7 +374,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! @@ -401,7 +383,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. @@ -606,7 +588,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. @@ -706,7 +688,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.) @@ -804,9 +786,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. @@ -998,8 +980,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 @@ -1050,7 +1032,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 @@ -2028,19 +2010,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. @@ -2087,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. @@ -2104,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. @@ -2144,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 @@ -2259,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. @@ -2291,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. @@ -2384,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! @@ -2495,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. @@ -2579,7 +2583,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. @@ -2669,7 +2676,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. @@ -2873,9 +2880,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: @@ -2959,7 +2966,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. @@ -3022,6 +3029,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. + + + @@ -3038,12 +3052,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. - @@ -3138,6 +3158,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. @@ -3208,17 +3233,36 @@ For any other issues, feel free to use the + + + + + + GNU's Pet GNU + + + +--> 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. + details, which is available from the Free Software Foundation, + Inc, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + + + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software Foundation, Inc., + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. @@ -3255,47 +3299,12 @@ For any other issues, feel free to use the 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; - @@ -3941,7 +3950,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. + + @@ -4023,6 +4040,9 @@ For any other issues, feel free to use the