X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=29ce5b1d5f821811c8f1c286a4b6fbb998d8f02d;hb=8459f40f646d1503eac7600aa352c42227903655;hp=9f8e3245043f17f8f4cab70e08782b430864fcb1;hpb=38cc6e90b4e805ca1b4e7e0f5bdd23a73e5162a4;p=privoxy.git diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index 9f8e3245..29ce5b1d 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -27,7 +27,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: user-manual.sgml,v 1.108 2002/05/14 15:29:12 oes Exp $ + $Id: user-manual.sgml,v 1.110 2002/05/14 19:10:45 oes Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -53,7 +53,7 @@ -$Id: user-manual.sgml,v 1.108 2002/05/14 15:29:12 oes Exp $ +$Id: user-manual.sgml,v 1.110 2002/05/14 19:10:45 oes Exp $ - + Patterns Generally, a pattern has the form <domain>/<path>, @@ -3280,6 +3280,144 @@ forward-socks4 and forward-socks4a + + +<emphasis>crunch-incoming-cookies</emphasis> + + + + Typical use: + + + Prevent the web server from setting any cookies on your system + + + + + + Effect: + + + Deletes any Set-Cookie: HTTP headers from server replies. + + + + + + Type: + + + Boolean. + + + + + Parameter: + + + N/A + + + + + + Notes: + + + This action is only concerned with incoming cookies. For + outgoing cookies, use + crunch-outgoing-cookies. + Use both to disable cookies completely. + + + It makes no sense at all to use this action in conjunction + with the session-cookies-only action, + since it would prevent the session cookies from being set. + + + + + + Example usage: + + + +crunch-incoming-cookies + + + + + + + + + +<emphasis>crunch-outgoing-cookies</emphasis> + + + + Typical use: + + + Prevent the web server from reading any cookies from your system + + + + + + Effect: + + + Deletes any Cookie: HTTP headers from client requests. + + + + + + Type: + + + Boolean. + + + + + Parameter: + + + N/A + + + + + + Notes: + + + This action is only concerned with outgoing cookies. For + incoming cookies, use + crunch-incoming-cookies. + Use both to disable cookies completely. + + + It makes no sense at all to use this action in conjunction + with the session-cookies-only action, + since it would prevent the session cookies from being read. + + + + + + Example usage: + + + +crunch-outgoing-cookies + + + + + + + @@ -3977,10 +4115,11 @@ ad.doubleclick.net Notes: - Warning! This breaks many web sites that depend on this in order - to customize their content for the different browser types by looking - at this header (which, btw, is NOT a smart way to - do that!). + Warning! This breaks many web sites that in order to customize their + content for the different browser types depend on looking + at this header (which, btw, is NOT a smart way to + do that!). Using this action in multi-user setups or wherever diffrerent types of @@ -4265,15 +4404,15 @@ www.pclinuxonline.com - -<emphasis>crunch-outgoing-cookies</emphasis> + +<emphasis>send-vanilla-wafer</emphasis> Typical use: - Prevent the web server from reading any cookies from your system + Feed log analysis scripts with useless data. @@ -4282,7 +4421,8 @@ www.pclinuxonline.com Effect: - Deletes any Cookie: HTTP headers from client requests. + Sends a cookie with each request stating that you do not accept any copyright + on cookies sent to you, and asking the site operator not to track you. @@ -4308,15 +4448,10 @@ www.pclinuxonline.com Notes: - This action is only concerned with outgoing cookies. For - incoming cookies, use - crunch-incoming-cookies. - Use both to disable cookies completely. + The vanilla wafer is a (relatively) unique header and could conceivably be used to track you. - It makes no sense at all to use this action in conjunction - with the session-cookies-only action, - since it would prevent the session cookies from being read. + This action is rarely used and not enabled in the default configuration. @@ -4325,7 +4460,7 @@ www.pclinuxonline.com Example usage: - +crunch-outgoing-cookies + +send-vanilla-wafer @@ -4335,15 +4470,15 @@ www.pclinuxonline.com - -<emphasis>crunch-incoming-cookies</emphasis> + +<emphasis>send-wafer</emphasis> Typical use: - Prevent the web server from setting any cookies on your system + Send custom cookies or feed log analysis scripts with even more useless data. @@ -4352,7 +4487,7 @@ www.pclinuxonline.com Effect: - Deletes any Set-Cookie: HTTP headers from server replies. + Sends a custom, user-defined cookie with each request. @@ -4361,7 +4496,7 @@ www.pclinuxonline.com Type: - Boolean. + Multi-value. @@ -4369,7 +4504,8 @@ www.pclinuxonline.com Parameter: - N/A + A string of the form name=value. @@ -4378,24 +4514,20 @@ www.pclinuxonline.com Notes: - This action is only concerned with incoming cookies. For - outgoing cookies, use - crunch-outgoing-cookies. - Use both to disable cookies completely. + Being multi-valued, multiple instances of this action can apply to the same request, + resulting in multiple cookies being sent. - It makes no sense at all to use this action in conjunction - with the session-cookies-only action, - since it would prevent the session cookies from being set. + This action is rarely used and not enabled in the default configuration. - - Example usage: + Example usage (section): - +crunch-incoming-cookies + {+send-wafer{UsingPrivoxy=true}} +my-internal-testing-server.void @@ -4484,138 +4616,6 @@ www.pclinuxonline.com - - -<emphasis>send-vanilla-wafer</emphasis> - - - - Typical use: - - - Feed log analysis scripts with useless data. - - - - - - Effect: - - - Sends a cookie with each request stating that you do not accept any copyright - on cookies sent to you, and asking the site operator not to track you. - - - - - - Type: - - - Boolean. - - - - - Parameter: - - - N/A - - - - - - Notes: - - - The vanilla wafer is a (relatively) unique header and could conceivably be used to track you. - - - This action is rarely used and not enabled in the default configuration. - - - - - - Example usage: - - - +send-vanilla-wafer - - - - - - - - - - -<emphasis>send-wafer</emphasis> - - - - Typical use: - - - Send custom cookies or feed log analysis scripts with even more useless data. - - - - - - Effect: - - - Sends a custom, user-defined cookie with each request. - - - - - - Type: - - - Multi-value. - - - - - Parameter: - - - A string of the form name=value. - - - - - - Notes: - - - Being multi-valued, multiple instances of this action can apply to the same request, - resulting in multiple cookies being sent. - - - This action is rarely used and not enabled in the default configuration. - - - - - Example usage (section): - - - {+send-wafer{UsingPrivoxy=true}} -my-internal-testing-server.void - - - - - - - <emphasis>set-image-blocker</emphasis> @@ -4771,7 +4771,7 @@ my-internal-testing-server.void There are two main reasons to use aliases: One is to save typing for frequently used combinations of actions, the other one is a gain in flexibility: If you decide once how you want to handle shops by defining an alias called - shop, you can later chenge your policy on shops in + shop, you can later change your policy on shops in one place, and your changes will take effect everywhere in the actions file where the shop alias is used. Calling aliases by their purpose also makes your actions files more readable. @@ -4781,7 +4781,8 @@ my-internal-testing-server.void Privoxy's built-in web-based action file editor honors aliases when reading the actions files, but it expands them before writing. So the effects of your aliases are of course preserved, - but the aliases themselves are lost when you edit the files this way. + but the aliases themselves are lost when you edit sections that use aliases + with it. This is likely to change in future versions of Privoxy. @@ -4858,7 +4859,7 @@ my-internal-testing-server.void Sample Actions Files - Remember that the meaning of any of the above references is reversed by preceding + Remember that the meaning of each action is reversed by preceding the action with a -, in place of the +. Also, that some actions are turned on in the default section of the actions file, and require little to no additional configuration. These are just on. @@ -4899,29 +4900,39 @@ for-privoxy-version=3.0 # defined they can be used just like any built-in action -- but within # this file only! Aliases do not require a + or - sign. ########################################################################## +{{alias}} # Some useful aliases. # Alias to turn off cookie handling, ie allow all cookies unmolested. - -crunch-all-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies \ +# +mercy-for-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies \ -session-cookies-only # Alias to both block and treat as if an image for ad blocking # purposes. - +imageblock = +block +handle-as-image - -# Fragile sites should have the minimum changes: - fragile = -block -deanimate-gifs -fast-redirects -filter -hide-referer \ - -crunch-all-cookies -kill-popups +# ++block-as-image = +block +handle-as-image # Shops should be allowed to set persistent cookies - shop = -filter -crunch-all-cookies -session-cookies-only +# +shop = -filter mercy-for-cookies +# Fragile sites should receive minimum interference: +# +fragile = -block -deanimate-gifs -fast-redirects -filter -hide-referer \ + mercy-for-cookies -kill-popups ########################################################################## -# Begin default action settings. Anything in this section will match -# all URLs -- UNLESS we have exceptions that also match, defined below this -# section. We will show all potential actions here whether they are on -# or off. We could omit any disabled action if we wanted, since all +# Matching starts here. Remember that at this time, all actions are +# disabled, so we need to explicitly enable the ones we want. +# +# We begin with "default" action settings, i.e. we define a set of actions +# for a pattern ("/") that matches all URLs. This default set will be +# applied to all requests as a start, and can be partly or wholly overridden +# by later matches further down this file, or in user.action. +# +# We will show all potential actions here whether they are enabled +# or not. We could omit any disabled action if we wanted, since all # actions are 'off' by default anyway. Shown for completeness only. # Actions are enabled if preceded by a '+', otherwise they are disabled # (unless an alias has been defined without this). @@ -5101,7 +5112,7 @@ for-privoxy-version=3.0 # Allow persistent cookies for a few regular sites that we # trust via our above alias. These will be saved from one browser session # to the next. We are explicity turning off any and all cookie handling, -# even though the cunch-*-cookies settings were disabled in our above +# even though the crunch-*-cookies settings were disabled in our above # default.action anyway. So cookies from these domains will come through # unmolested. { -crunch-all-cookies } @@ -6242,6 +6253,12 @@ Requests Temple Place - Suite 330, Boston, MA 02111-1307, USA. $Log: user-manual.sgml,v $ + Revision 1.110 2002/05/14 19:10:45 oes + Restored alphabetical order of actions + + Revision 1.109 2002/05/14 17:23:11 oes + Renamed the prevent-*-cookies actions, extended aliases section and moved it before the example AFs + Revision 1.108 2002/05/14 15:29:12 oes Completed proofreading the actions chapter