From: oes Date: Fri, 3 May 2002 17:46:00 +0000 (+0000) Subject: Further proofread & reactivated short build instructions X-Git-Tag: v_3_0_branchpoint~129 X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=commitdiff_plain;h=0b81a3fd2183af3cdd55171675475fafaa4de8af Further proofread & reactivated short build instructions --- diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index 06daeb7a..b081757a 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -25,7 +25,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: user-manual.sgml,v 1.100 2002/04/29 03:05:55 hal9 Exp $ + $Id: user-manual.sgml,v 1.101 2002/05/03 03:58:30 hal9 Exp $ Written by and Copyright (C) 2001 the SourceForge Privoxy team. http://www.privoxy.org/ @@ -46,7 +46,7 @@ Privoxy User Manual -$Id: user-manual.sgml,v 1.100 2002/04/29 03:05:55 hal9 Exp $ +$Id: user-manual.sgml,v 1.101 2002/05/03 03:58:30 hal9 Exp $ @@ -147,39 +147,28 @@ packages for a wide range of operating systems, and as raw source code. For most users, we recommend using the packages, which can be downloaded from our Privoxy Project - Page. For installing and compiling the source code, please look - into our Developer Manual. + Page. - - If you like to live on the bleeding edge and are not afraid of using - possibly unstable development versions, you can check out the up-to-the-minute - version directly from the - CVS repository or simply download the nightly CVS - tarball. Again, we refer you to the Developer Manual. - - - - &supported; - - Note: If you have a previous Junkbuster or Privoxy installation on your system, you will need to remove it. Some platforms do this for you as part of their installation procedure. (See below for your platform). - - - In any case be sure to backup your old configuration if it is valuable to you. See the note to upgraders section below. + +Binary Packages + +How to install the binary packages depends on your operating system: + + -Red Hat and SuSE RPMs +Red Hat and SuSE RPMs RPMs can be installed with rpm -Uvh privoxy-&p-version;-1.rpm, @@ -207,17 +196,17 @@ automatically start Privoxy in the boot process. Otherwise, RPM will try to remove Junkbuster automatically, before installing Privoxy. - + -Debian +Debian FIXME. - + -Windows +Windows Just double-click the installer, which will guide you through @@ -225,20 +214,20 @@ automatically start Privoxy in the boot process. in the same directory as you installed Privoxy in. We do not use the registry of Windows. - + -Solaris, NetBSD, FreeBSD, HP-UX +Solaris, NetBSD, FreeBSD, HP-UX Create a new directory, cd to it, then unzip and untar the archive. For the most part, you'll have to figure out where things go. FIXME. - + -OS/2 +OS/2 First, make sure that no previous installations of @@ -258,10 +247,10 @@ automatically start Privoxy in the boot process. The directory you choose to install Privoxy into will contain all of the configuration files. - + -Max OSX +Max OSX Unzip the downloaded package (you can either double-click on the file in the finder, or on the desktop if you downloaded it there). Then, @@ -273,10 +262,10 @@ automatically start Privoxy in the boot process. automatically on system bring-up via /System/Library/StartupItems/Privoxy. - + -AmigaOS +AmigaOS Copy and then unpack the lha archive to a suitable location. All necessary files will be installed into Privoxy @@ -292,7 +281,35 @@ automatically start Privoxy in the boot process. TCP/IP stack (just ignore the harmless warning your TCP/IP stack may display that Privoxy is still running). + + + +Building from Source + + + The most convenient way to obtain the Privoxy sources + is to download the source tarball from our project + page. + + + + If you like to live on the bleeding edge and are not afraid of using + possibly unstable development versions, you can check out the up-to-the-minute + version directly from the + CVS repository or simply download the nightly CVS + tarball. + + + +&buildsource; + + + + + + @@ -301,14 +318,17 @@ automatically start Privoxy in the boot process. Note to Upgraders - There are very significant changes from older versions of - Junkbuster to the current - Privoxy. Configuration is substantially - changed. Junkbuster 2.0.x and earlier - configuration files will not migrate. The functionality of the old - blockfile, cookiefile and - imagelist, are now combined into the - actions files. + There are very significant changes from earlier + Junkbuster versions to the current + Privoxy. The number, names, syntax, and + purposes of configuration files have substantially changed. + Junkbuster 2.0.x configuration + files will not migrate, Junkbuster 2.9.x + and Privoxy configurations will need to be + ported. The functionalities of the old blockfile, + cookiefile and imagelist + are now combined into the actions + files. default.action, is the main actions file. Local exceptions should best be put into user.action. @@ -759,8 +779,8 @@ must find a better place for this paragraph This should be self-explanatory. Note the first item leads to an editor for the - actions list, which is where the ad, banner, cookie, - and URL blocking magic is configured as well as other advanced features of + actions files, which is where the ad, banner, + cookie, and URL blocking magic is configured as well as other advanced features of Privoxy. This is an easy way to adjust various aspects of Privoxy configuration. The actions file, and other configuration files, are explained in detail below. @@ -771,7 +791,8 @@ must find a better place for this paragraph have problems with your current actions and filters. You can in fact use it as a test to see whether it is Privoxy causing the problem or not. Privoxy continues - to run as a proxy in this case, but all filtering is disabled. There + to run as a proxy in this case, but all manipulation is disabled, i.e. + Privoxy acts like a normal forwarding proxy. There is even a toggle Bookmarklet offered, so that you can toggle Privoxy with one click from your browser. @@ -808,7 +829,7 @@ must find a better place for this paragraph - The main configuration file is named config + The main configuration file is named config on Linux, Unix, BSD, OS/2, and AmigaOS and config.txt on Windows. This is a required file. @@ -816,25 +837,29 @@ must find a better place for this paragraph - default.action (the main actions file) is used to define - the default settings for various actions relating to images, banners, - pop-ups, access restrictions, banners and cookies. + default.action (the main actions file) + is used to define which actions relating to banner-blocking, images, pop-ups, + content modification, cookie handling etc should be applied by default. It also defines many + exceptions (both positive and negative) from this default set of actions that enable + Privoxy to selectively eliminate the junk, and only the junk, on + as many websites as possible. Multiple actions files may be defined in config. These are processed in the order they are defined. Local customizations and locally - preferred exceptions to the default policies as defined in - default.action are probably best applied in - user.action, which should be preserved across - upgrades. standard.action is also included. This is mostly - for Privoxy's internal use. + preferred exceptions to the default policies as defined in + default.action (which you will most propably want + to define sooner or later) are probably best applied in + user.action, where you can preserve them across + upgrades. standard.action is for + Privoxy's internal use. There is also a web based editor that can be accessed from http://config.privoxy.org/show-status/ + url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status (Shortcut: http://p.p/show-status/) for the + url="http://p.p/show-status">http://p.p/show-status) for the various actions files. @@ -854,7 +879,7 @@ must find a better place for this paragraph All files use the # character to denote a - comment (the rest of the line will be ignored) angd understand line continuation + comment (the rest of the line will be ignored) and understand line continuation through placing a backslash ("\") as the very last character in a line. If the # is preceded by a backslash, it looses its special function. Placing a # in front of an otherwise @@ -909,8 +934,7 @@ must find a better place for this paragraph - confdir /etc/privoxy - + confdir /etc/privoxy @@ -952,61 +976,6 @@ must find a better place for this paragraph be modified, such as log files. -user-manual - - - Specifies: - - - Location of the Privoxy User Manual. - - - - - Type of value: - - A fully qualified URI - - - - Default value: - - http://www.privoxy.org/user-manual/ - - - - Effect if unset: - - - The default will be used. - - - - - Notes: - - - The User Manual is used for help hints from some of the internal CGI pages. - It is normally packaged with the binary distributions, and would make more - sense to have this pointed at a locally installed copy. - - - A more useful example (Unix): - - -   user-manual  file:///usr/share/doc/privoxy-&p-version;/user-manual/ - - - - If this option is defined, it must come first! It is needed before the rest of - config is read. - - - - - - - confdir @@ -1106,14 +1075,14 @@ actionsfile Specifies: - The actions file(s) to use + The actions file(s) to use Type of value: - File name, relative to confdir + File name, relative to confdir, without the .action suffix @@ -1121,7 +1090,7 @@ actionsfile - standard # Internal purposes, recommended not editing + standard # Internal purposes, no editing recommended default # Main actions file @@ -1192,7 +1161,7 @@ actionsfile No textual content filtering takes place, i.e. all +filter{name} - actions in the actions files are turned off + actions in the actions files are turned neutral. @@ -1372,7 +1341,6 @@ actionsfile - @@ -1390,6 +1358,72 @@ actionsfile you, what you block and why you do that, your policies etc. +user-manual + + + Specifies: + + + Location of the Privoxy User Manual. + + + + + Type of value: + + A fully qualified URI + + + + Default value: + + Unset + + + + Effect if unset: + + + http://www.privoxy.org/version/user-manual/ + will be used, where version is the Privoxy version. + + + + + Notes: + + + The User Manual URI is used for help links from some of the internal CGI pages. + The manual itself is normally packaged with the binary distributions, so you propably want + to set this to a locally installed copy. For multi-user setups, you could provide a copy on + a local webserver for all your users and use the corresponding URL here. + + + Examples: + + + Unix, in local filesystem: + + + user-manual  file:///usr/share/doc/privoxy-&p-version;/user-manual/ + + + Any platform, on local webserver (called local-webserver): + + + user-manual  http://local-webserver/privoxy-user-manual/ + + + + If set, this option should be the first option in the config file, because + it is used while the config file is being read. + + + + + + + trust-info-url @@ -2571,7 +2605,7 @@ forward-socks4 and forward-socks4a The actions files are used to define what actions - Privoxy takes for which URLs, and thus determines + Privoxy takes for which URLs, and thus determine how ad images, cookies and various other aspects of HTTP content and transactions are handled, and on which sites (or even parts thereof). There are three such files included with Privoxy (as of @@ -2585,7 +2619,9 @@ forward-socks4 and forward-socks4a standard.action - is used by the web based editor, to set various pre-defined sets of rules for the default actions section in default.action. These have increasing levels of - aggressiveness. It is not recommend to edit this file. + aggressiveness and have no influence on your browsing unless + you select them explicitly in the editor. It is not recommend + to edit this file. @@ -2618,11 +2654,18 @@ forward-socks4 and forward-socks4a - An actions file typically has sections. Near the top, aliases are - optionally defined (discussed below), then the default set of rules - which will apply universally to all sites and pages. And then below that, - exceptions to the defined universal policies. + An actions file typically has multiple sections. If you want to use + aliases in an actions file, you have to place the (optional) + alias section at the top of that file. + Then comes the default set of rules which will apply universally to all + sites and pages (be very careful with using such a + universal set in user.action or any other actions file after + default.action, because it will override the result + from consulting any previous file). And then below that, + exceptions to the defined universal policies. You can regard + user.action as an appendix to default.action, + with the advantage that is a separate file, which makes preserving your + personal settings across Privoxy upgrades easier. @@ -2630,7 +2673,8 @@ forward-socks4 and forward-socks4a 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), content can be modified, JavaScripts tamed, user-tracking - fooled, and much more. See below for a complete list of actions. + fooled, and much more. See below for a complete list + of actions. @@ -2661,14 +2705,18 @@ forward-socks4 and forward-socks4a How to Edit - The easiest way to edit the actions files is with a browser by + The easiest way to edit the actions files is with a browser by using our browser-based editor, which can be reached from http://config.privoxy.org/show-status. + The editor allows both fine-grained control over every single feature on a + per-URL basis, and easy choosing from wholesale sets of defaults like + Cautious, Medium or Advanced. If you prefer plain text editing to GUIs, you can of course also directly edit the - the actions files. + the actions files. Look at default.action which is richly + commented. @@ -2686,7 +2734,7 @@ forward-socks4 and forward-socks4a To determine which actions apply to a request, the URL of the request is - compared to all patterns in this file. Every time it matches, the list of + compared to all patterns in each action file file. Every time it matches, the list of applicable actions for the URL is incrementally updated, using the heading of the section in which the pattern is located. If multiple matches for the same URL set the same action differently, the last match wins. If not, @@ -2697,7 +2745,7 @@ forward-socks4 and forward-socks4a - You can trace this process by visiting http://config.privoxy.org/show-url-info. @@ -2905,73 +2953,84 @@ forward-socks4 and forward-socks4a All actions are disabled by default, until they are explicitly enabled somewhere in an actions file. Actions are turned on if preceded with a +, and turned off if preceded with a -. So a - +action means do that action, e.g. - +block means please block the following URL - patterns. + +action means do that action, e.g. + +block means please block URLs that match the + following patterns, and -block means don't + block URLs that match the following patterns, even if +block + previously applied. + + + + + Again, actions are invoked by placing them on a line, enclosed in curly braces and + separated by whitespace, like in + {+some-action -some-other-action{some-parameter}}, + followed by a list of URL patterns, one per line, to which they apply. + Together, the actions line and the following pattern lines make up a section + of the actions file. - Actions are invoked by enclosing the action name in curly braces (e.g. - {+some_action}), followed by a list of URLs (or patterns that match URLs) to - which the action applies. There are three classes of actions: + There are three classes of actions: - - Boolean, i.e the action can only be on or - off. Examples: - + Boolean, i.e the action can only be enabled or + disabled. Syntax: + - - - - {+name} # enable this action - {-name} # disable this action - - - + + +name # enable action name + -name # disable action name + + + Example: +block - Parameterized, e.g. +/-hide-user-agent{ Mozilla 1.0 }, - where some value is required in order to enable this type of action. - Examples: + Parameterized, where some value is required in order to enable this type of action. + Syntax: - - - - {+name{param}} # enable action and set parameter to param - {-name} # disable action (parameter) can be omitted - - - + + +name{param} # enable action and set parameter to param, + # overwriting parameter from previous match if necessary + -name # disable action. The parameter can be omitted + + + Note that if the URL matches multiple positive forms of a parameterized action, + the last match wins, i.e. the params from earlier matches are simply ignored. + + + Example: +hide-user-agent{ Mozilla 1.0 } - - Multi-value, e.g. {+/-add-header{Name: value}} or - {+/-send-wafer{name=value}}), where some value needs to be defined - in addition to simply enabling the action. Examples: + Multi-value. These look exactly like parameterized actions, + but they behave differently: If the action applies multiple times to the + same URL, but with different parameters, all the parameters + from all matches are remembered. This is used for actions + that can be executed for the same request repeatedly, like adding multiple + headers, or filtering through multiple filters. Syntax: - - - - {+name{param=value}} # enable action and set param to value - {-name{param=value}} # remove the parameter param completely - {-name} # disable this action totally and remove param too - - - + + +name{param} # enable action and add param to the list of parameters + -name{param} # remove the parameter param from the list of parameters + # If it was the last one left, disable the action. + -name # disable this action completely and remove all parameters from the list + + + Examples: +add-header{X-Fun-Header: Some text} and + +filter{html-annoyances} @@ -2994,12 +3053,12 @@ forward-socks4 and forward-socks4a Actions files are processed in the order they are defined in config (the default installation has three actions files). It also quite possible for any given URL pattern to match more than - one action! + one pattern and thus more than one set of actions! - The list of valid Privoxy actions are: + The list of valid Privoxy actions are: @@ -3025,10 +3084,10 @@ forward-socks4 and forward-socks4a - Typical uses: + Purpose and typical uses: - Send a user defined HTTP header to the web server. + Send a user defined HTTP header to the web server. Can be used to confuse log analysis. @@ -3038,6 +3097,8 @@ forward-socks4 and forward-socks4a Any value is possible. Validity of the defined HTTP headers is not checked. + It is recommended that you use the X- prefix + for custom headers. @@ -3047,8 +3108,7 @@ forward-socks4 and forward-socks4a {+add-header{X-User-Tracking: sucks}} - .example.com - + .example.com @@ -3081,12 +3141,14 @@ forward-socks4 and forward-socks4a - Typical uses: + Purpose and typical uses: - Used to block a URL from reaching your browser. The URL may be - anything, but is typically used to block ads or other obnoxious - content. + Requests for URLs to which this action applies are blocked, i.e. the requests are not + forwarded to the remote server, but answered locally with a substitute page or image, + as determined by the handle-as-image and + set-image-blocker actions. + It is typically used to block ads or other obnoxious content. @@ -5831,6 +5893,10 @@ Requests Temple Place - Suite 330, Boston, MA 02111-1307, USA. $Log: user-manual.sgml,v $ + Revision 1.101 2002/05/03 03:58:30 hal9 + Move the user-manual config directive to top of section. Add note about + Privoxy needing read permissions for configs, and write for logs. + Revision 1.100 2002/04/29 03:05:55 hal9 Add clarification on differences of new actions files.