From: hal9 Date: Thu, 18 Apr 2002 03:18:06 +0000 (+0000) Subject: Spellcheck, and minor touchups. X-Git-Tag: v_3_0_branchpoint~294 X-Git-Url: http://www.privoxy.org/gitweb/%22https:/@default-cgi@toggle?a=commitdiff_plain;h=764090bd9b33279e6ffb040521b67620cdc33a70;p=privoxy.git Spellcheck, and minor touchups. --- diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index 02f985dd..d599631e 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -24,7 +24,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: user-manual.sgml,v 1.77 2002/04/17 13:51:23 oes Exp $ + $Id: user-manual.sgml,v 1.78 2002/04/17 18:04:16 oes Exp $ Written by and Copyright (C) 2001 the SourceForge Privoxy team. http://www.privoxy.org/ @@ -45,7 +45,7 @@ Privoxy User Manual -$Id: user-manual.sgml,v 1.77 2002/04/17 13:51:23 oes Exp $ +$Id: user-manual.sgml,v 1.78 2002/04/17 18:04:16 oes Exp $ @@ -127,7 +127,7 @@ New Features In addition to Internet Junkbuster's traditional - feature of ad and banner blocking and cookie management, + features of ad and banner blocking and cookie management, Privoxy provides new features: @@ -161,13 +161,13 @@ -&supported; + &supported; Binary Packages - The packages can be downloaded from our Privoxy Project Page. @@ -179,13 +179,13 @@ Redhat and SuSE RPMs - RPMs can be installed with rpm -i <name-of-rpm.rpm>, + RPMs can be installed with rpm -Uvh <name-of-rpm.rpm>, and will use /etc/privoxy for configuration files. - Note that if you have a Junkbuster RPM installed on your system, you - need to remove it first, because the packages conflict. + Note that if you have a Junkbuster RPM installed + on your system, you need to remove it first, because the packages conflict. @@ -248,8 +248,9 @@ For more detailed instructions, on how to build Redhat and SuSE RPMs, - Windows self-extracting installers etc, please consult the developer manual. + Windows self-extracting installers etc, and for building from CVS sources, + please consult the developer + manual. @@ -280,7 +281,7 @@ A filter file (typically default.filter) is new with Privoxy 2.9.x, and provides some - of the new sophisticaton (explained below). config is + of the new sophistication (explained below). config is much the same as before. @@ -326,8 +327,8 @@ The primary configuration file for cookie management, ad and banner blocking, and many other aspects of Privoxy configuration is default.action. It is strongly - recommended to make oneself familiar with the new actions concept below - before modifying that file. + recommended to become familiar with the new actions concept below, + before modifying this file. @@ -367,7 +368,7 @@ 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 + re-reading of all pages and to get rid of any ads that may be cached. You are now ready to start enjoying the benefits of using Privoxy. @@ -432,9 +433,9 @@ - Another feature where you will propably want to define exceptions for trusted + Another feature where you will probably want to define exceptions for trusted sites is the popup-killing (through the +popup and - +filter{popups} actions), because your favourite shopping, + +filter{popups} actions), because your favorite shopping, banking, or leisure site may need popups. @@ -446,7 +447,7 @@ try to force HTTP/1.0 compatibility. For Mozilla, look under Edit -> Preferences -> Debug -> Networking. Alternatively, set the +downgrade config option in - default.action which will downgrade you brower's HTTP + default.action which will downgrade your browser's HTTP requests from HTTP/1.1 to HTTP/1.0 before processing them. @@ -476,7 +477,7 @@ If you encounter problems, try loading the page without Privoxy. If that helps, enter the URL where you have the problems into the browser - based rule tracing utility. Watch out which rules apply and why, and + based rule tracing utility. See which rules apply and why, and then try turning them off for that site one after the other, until the problem is gone. When you have found the culprit, you might want to turn the rest on again. @@ -541,7 +542,7 @@ On startup, write the process ID to FILE. Delete the - FILE on exit. Failiure to create or delete the + FILE on exit. Failure to create or delete the FILE is non-fatal. If no FILE option is given, no PID file will be used. Unix only. @@ -599,7 +600,7 @@ 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. + which is a built-in page and works without Internet access. You will see the following section: @@ -774,8 +775,8 @@ Please choose from the following options: The main config file controls all aspects of Privoxy's - operation that are not location dependent (i.e. that apply invariantly no matter - where in the web you are surfing). + operation that are not location dependent (i.e. they apply to all URLs, no matter + where you may be surfing). @@ -786,7 +787,7 @@ Please choose from the following options: Privoxy can (and normally does) use a number of - other files for addidtional configuration and logging. + other files for additional configuration and logging. This section of the configuration file tells Privoxy where to find those other files. @@ -828,9 +829,9 @@ Please choose from the following options: When development goes modular and multi-user, the blocker, filter, and per-user config will be stored in subdirectories of confdir. - For now, the configuration dir structure is flat, except for + For now, the configuration directory structure is flat, except for confdir/templates, where the HTML templates for CGI - output reside. + output reside (e.g. Privoxy's 404 error page). @@ -881,49 +882,6 @@ Please choose from the following options: actionsfile - - - Specifies: - - - The actions file to use - - - - - Type of value: - - File name, relative to confdir - - - - Default value: - - default.action (Unix) or default.action.txt (Windows) - - - - Effect if unset: - - - No action is taken at all. Simple neutral proxying. - - - - - Notes: - - - There is no point in using Privoxy without - an actions file. - - - - - - -actionsfile - Specifies: @@ -958,7 +916,7 @@ Please choose from the following options: There is no point in using Privoxy without - an actions file. There are three diffrent actions files included in the + an actions file. There are three different actions files included in the distribution, with varying degrees of aggressiveness: default.action, intermediate.action and advanced.action. @@ -1052,7 +1010,7 @@ Please choose from the following options: Notes: - The windows version will additionally log to the console + The windows version will additionally log to the console. The logfile is where all logging and error messages are written. The level @@ -1147,7 +1105,7 @@ Please choose from the following options: Effect if unset: - The whole trust mechansim is turned off. + The whole trust mechanism is turned off. @@ -1155,7 +1113,7 @@ Please choose from the following options: Notes: - The trust mechansim is an experimental feature for building whitelists and should + The trust mechanism is an experimental feature for building white-lists and should be used with care. It is NOT recommended for the casual user. @@ -1165,7 +1123,7 @@ Please choose from the following options: the effect that access to untrusted sites will be granted, if a link from a trusted referrer was used. The link target will then be added to the trustfile. - Possible applications include limiting internet access for children. + Possible applications include limiting Internet access for children. If you use + operator in the trust file, it may grow considerably over time. @@ -1184,7 +1142,7 @@ Please choose from the following options: -Local Setup Documentation +Local Set-up Documentation If you intend to operate Privoxy for more users @@ -1231,7 +1189,7 @@ Please choose from the following options: activated. (See trustfile above.) - If you use the trust mechanism, it is a good idea to write up some online + If you use the trust mechanism, it is a good idea to write up some on-line documentation about your trust policy and to specify the URL(s) here. Use multiple times for multiple URLs. @@ -1358,7 +1316,7 @@ Please choose from the following options: Specifies: - Keys that determine what information gets logged. + Key values that determine what information gets logged. @@ -1414,7 +1372,8 @@ Please choose from the following options: as it happens. 1, 4096 and 8192 are highly recommended so that you will notice when things go wrong. The other levels are probably only of interest if you are hunting down a specific problem. They can produce - a hell of output (especially 16). + a hell of an output (especially 16). + The reporting of fatal errors (i.e. ones which crash @@ -1500,7 +1459,7 @@ Please choose from the following options: Type of value: - [IP-Adddress]:Port + [IP-Address]:Port @@ -1534,7 +1493,7 @@ Please choose from the following options: 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. + (see ACLs below), or a firewall. @@ -1650,9 +1609,9 @@ Please choose from the following options: For the time being, access to the toggle feature can not be - controlled separately by Acls or HTTP authentication, + controlled separately by ACLs or HTTP authentication, so that everybody who can access Privoxy (see - Acls and listen-address above) can + ACLs and listen-address above) can toggle it for all users. So this option is not recommended for multi-user environments with untrusted users. @@ -1702,9 +1661,9 @@ Please choose from the following options: For the time being, access to the editor can not be - controlled separately by Acls or HTTP authentication, + controlled separately by ACLs or HTTP authentication, so that everybody who can access Privoxy (see - Acls and listen-address above) can + ACLs and listen-address above) can modify its configuration for all users. So this option is not recommended for multi-user environments with untrusted users. @@ -1717,7 +1676,7 @@ Please choose from the following options: -Acls: permit-access and deny-access +ACLs: permit-access and deny-access Specifies: @@ -1774,8 +1733,8 @@ Please choose from the following options: weaknesses. - Multiple acl lines are OK. - If any acls are specified, then the Privoxy + Multiple ACL lines are OK. + If any ACLs are specified, then the Privoxy talks only to IP addresses that match at least one permit-access line and don't match any subsequent deny-access line. In other words, the last match wins, with the default being deny-access. @@ -1795,7 +1754,7 @@ Please choose from the following options: IP addresses, only the first one is used. - Denying access to particular sites by acl may have undesired side effects + Denying access to particular sites by ACL may have undesired side effects if the site in question is hosted on a machine which also hosts other sites. @@ -1804,7 +1763,7 @@ Please choose from the following options: Examples: - Explicitly define the defauklt behaviour if no acl and + Explicitly define the default behavior if no ACL and listen-address are set: localhost is OK. The absence of a dst_addr implies that all destination addresses are OK: @@ -1911,8 +1870,8 @@ Please choose from the following options: through an anonymous public proxy (see e.g. http://www.multiproxy.org/anon_list.htm) Or to use a caching proxy to speed up browsing. Or chaining to a parent - proxy may be necessary because the mackine that Privoxy - runs on has no direct internet access. + proxy may be necessary because the machine that Privoxy + runs on has no direct Internet access. @@ -2065,9 +2024,10 @@ Please choose from the following options: Examples: - From the company example.com, direct connections are made to all internal - domains, but everything outbound goes through their ISP's proxy by way example.com's - corporate SOCKS 4A gateway to the Internet. + From the company example.com, direct connections are made to all + internal domains, but everything outbound goes through + their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to + the Internet. @@ -2126,7 +2086,7 @@ Please choose from the following options: - Now, you users can set their browser's proxy to use either + Now, your users can set their browser's proxy to use either host-a or host-b and be able to browse the internal content on both isp-a or isp-b. @@ -2376,14 +2336,14 @@ Removed references to Win32. HB 09/23/01 Note that some actions like cookie suppression or script disabling may render some sites unusable, which rely on these techniques to work properly. - Finding the right mix of actions is not easy and sure a matter of personal + Finding the right mix of actions is not easy and a matter of personal taste. In general, it can be said that the more aggressive your default settings (in the top section of the actions file) are, - the more exceptions for trustes sites you will have to + the more exceptions for trusted sites you will have to make later. If, for example, you want to kill popup windows per default, you'll have to make exceptions from that rule for sites that you regularly use and that require popups for actually useful content, like maybe your bank, - favourite shop, or newspaper. + favorite shop, or newspaper. @@ -2413,9 +2373,9 @@ Removed references to Win32. HB 09/23/01 How Actions are Applied to URLs - The actions file is separated into sections. There are special sections, + The actions file is divided into sections. There are special sections, like the alias sections which will be discussed later. For now let's - concentrate on regular sectiions: They have a heading line (often split + concentrate on regular sections: They have a heading line (often split up to multiple lines for readability) which consist of a list of actions, separated by whitespace and enclosed in curly braces. Below that, there is a list of URL patterns, each on a separate line. @@ -2435,7 +2395,8 @@ Removed references to Win32. HB 09/23/01 - More detail on this is provided in the Appendix Anatomy of an Action. + More detail on this is provided in the Appendix, + Anatomy of an Action. @@ -2592,11 +2553,11 @@ Removed references to Win32. HB 09/23/01 - There is an Appendix with a brief quickstart into regular - expressions, and full (very technical) documentation on PCRE regex syntax is available online + There is an Appendix with a brief quick-start into regular + expressions, and full (very technical) documentation on PCRE regex syntax is available on-line at http://www.pcre.org/man.txt. You might also find the Perl man page on regular expressions (man perlre) - useful, which is available online at http://www.perldoc.com/perl5.6/pod/perlre.html. @@ -2861,7 +2822,7 @@ Removed references to Win32. HB 09/23/01 - no-poups: Kill all popups in JS and HTML + no-popups: Kill all popups in JS and HTML @@ -3052,7 +3013,7 @@ Removed references to Win32. HB 09/23/01 Decides what to do with URLs that end up tagged with {+block - +image}, e.g an advertizement. There are five options. + +image}, e.g an advertisement. There are four options. -image-blocker will send a HTML blocked page, usually resulting in a broken image icon. @@ -3062,7 +3023,7 @@ Removed references to Win32. HB 09/23/01 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{pattern} will send a checkerboard type pattern: @@ -3309,8 +3270,8 @@ icon being being cached by the browser, which will speed up the display. Turn on page filtering according to rules in the defined sections - of refilterfile, and make one exception for - sourceforge: + of default.filter, and make one exception for + Sourceforge: @@ -4079,7 +4040,7 @@ Requests 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, + Bookmarklet directly from your favorites/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. @@ -4144,7 +4105,7 @@ Requests easy to understand what is happening. And sometimes we need to be able to see just what Privoxy is doing. Especially, if something Privoxy is doing - is causing us a problem inadvertantly. It can be a little daunting to look at + is causing us a problem inadvertently. It can be a little daunting to look at the actions and filters files themselves, since they tend to be filled with regular expressions whose consequences are not always so obvious. Privoxy provides the @@ -4159,7 +4120,7 @@ Requests how the current configuration will handle it. This will not help with filtering effects from the default.filter file! It also will not tell you about any other URLs that may be embedded within the - URL you are testing. For instance, images such as ads are expressed as URLs + URL you are testing (i.e. a web page). For instance, images such as ads are expressed as URLs within the raw page source of HTML pages. So you will only get info for the actual URL that is pasted into the prompt area -- not any sub-URLs. If you want to know about embedded URLs like ads, you will have to dig those out of @@ -4230,7 +4191,7 @@ Requests These are the default actions we have enabled. But we can define additional actions that would be exceptions to these general rules, and then list specific URLs that these exceptions would apply to. Last match wins. - Just below this then are two explict matches for .google.com. + Just below this then are two explicit matches for .google.com. The first is negating our various cookie blocking actions (i.e. we will allow cookies here). The second is allowing fast-redirects. Note that there is a leading dot here -- .google.com. This will @@ -4243,7 +4204,7 @@ Requests And now we pull it altogether in the bottom section and summarize how - Privoxy is appying all its actions + Privoxy is applying all its actions to google.com: @@ -4331,7 +4292,7 @@ Requests Ooops, the /adsl/ is matching /ads! But we did not want this at all! Now we see why we get the blank page. We could - now add a new action below this that explictly does not + now add a new action below this that explicitly does not block (-block) pages with adsl. There are various ways to handle such exceptions. Example: @@ -4434,6 +4395,9 @@ Requests Temple Place - Suite 330, Boston, MA 02111-1307, USA. $Log: user-manual.sgml,v $ + Revision 1.78 2002/04/17 18:04:16 oes + Proofreading part 2 + Revision 1.77 2002/04/17 13:51:23 oes Proofreading, part one