X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fprivoxy-man-page.sgml;h=faabc56dadbbf03c70fad9dd452876d50a91e3c2;hp=10c3307b9258bbb1014b3decf4bf47c46d0e0bd9;hb=4f6763ba9c8e92e60879832d264b81f10095117b;hpb=9f15e28f62a164eb51740d57bd2f117a90c4e6d7 diff --git a/doc/source/privoxy-man-page.sgml b/doc/source/privoxy-man-page.sgml index 10c3307b..faabc56d 100644 --- a/doc/source/privoxy-man-page.sgml +++ b/doc/source/privoxy-man-page.sgml @@ -5,61 +5,58 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: privoxy-man-page.sgml,v 1.1 2002/04/06 05:07:29 hal9 Exp $ + $Id: privoxy-man-page.sgml,v 2.3 2002/09/05 05:45:30 hal9 Exp $ - Written by and Copyright (C) 2001 the SourceForge - Privoxy team. http://www.privoxy.org/ - - Based on the Internet Junkbuster originally written - by and Copyright (C) 1997 Anonymous Coders and - Junkbusters Corporation. http://www.junkbusters.com + Copyright (C) 2001, 2002 Privoxy Developers + See LICENSE. ======================================================================== NOTE: Please read developer-manual/documentation.html before touching - anything in this, or other Privoxy documentation. You have been warned! - Failure to abide by this rule will result in the revocation of your license - to live a peaceful existence! + anything in this, or other Privoxy documentation. ======================================================================== - Doc NOTES: This is some tricky stuff! There are some quirks + Doc NOTES: This is some tricky markup! There are some quirks to how this markup is handled. It is not always so co-operative. - Please don't change the markup, unless you are willing to - un-do your changes! + Please don't change the markup unless you can verify the changes + will improve finished output! literallayout tags are particularly sensitive to where they are placed. The 'replaceable' and 'command' tags are used here somewhat unconventionally, since it seems to generate the proper formatting (at least for me :). - Create man page: 'docbook2man privoxy-man-page.sgml' - For man page references, see: http://www.linuxdoc.org/HOWTO/mini/DocBook-Install/using.html http://docbook.org/tdg/en/html/ch02.html#making-refentry --> + + - - - + + + + + + ]> - 2002-04-04 + 2002-05-14 - privoxy 1 - Privoxy &p-version; + + Privoxy &p-version; + @@ -76,13 +73,13 @@ pidfile user[.group] configfile - (UNIX) +  (UNIX) privoxy.exe configfile - (Windows) +  (Windows) @@ -127,13 +124,14 @@ --pidfile pidfile - After (optionally) writing the PID file, assume the user ID of user - and the GID of group, or, if the optional group was not given, the - default group of user. Exit if the privileges are not sufficient to - do so. + On startup, write the process ID to pidfile. + Delete the pidfile on exit. + Failure to create or delete the pidfile + is non-fatal. If no --pidfile option is given, no PID file will be used. + --user user[.group] @@ -141,10 +139,10 @@ After (optionally) writing the PID file, assume the user ID of - user and the GID of - group, or, if the optional - group was not given, the default group of - user. Exit if the privileges are not + user and the GID of + group, or, if the optional + group was not given, the default group of + user. Exit if the privileges are not sufficient to do so. @@ -189,8 +187,10 @@ The Secure (SSL) Proxy should also be set to the same values, otherwise - https: URLs will not be proxied. + https: URLs will not be proxied. Note: Privoxy can only + proxy HTTP and HTTPS traffic. Do not try it with FTP or other protocols. + For other browsers, check the documentation. @@ -202,25 +202,31 @@ Privoxy can be configured with the various configuration files. The default configuration files are: config, - default.action, and - default.filter. These are well commented. On Unix and - Unix-like systems, these are located in /etc/privoxy/ by - default. On Windows, OS/2 and AmigaOS, these files are in the same directory - as the Privoxy executable. + default.filter, and + default.action. user.action should + be used for locally defined exceptions to the default rules of + default.action These are all well commented. On Unix + and Unix-like systems, these are located in + /etc/privoxy/ by default. On Windows, OS/2 and AmigaOS, + these files are in the same directory as the Privoxy + executable. The name and number of configuration files has changed from previous - versions, and is subject to change as development progresses. In fact, the - configuration itself is changed and much more sophisticated. See the - user-manual for a - brief explanation of all configuration options. + versions. In fact, the configuration itself is changed and much more + sophisticated. See the user-manual for a complete + explanation of all configuration options and general usage, and notes for + upgrading from Junkbuster and earlier Privoxy + versions. The actions list (ad blocks, etc) can also be configured with your - web browser at http://ijbswa.sourceforge.net/config. + web browser at http://config.privoxy.org/. Privoxy's configuration parameters can also be viewed at the same page. In addition, Privoxy can be toggled on/off. - This is an internal page. + This is an internal page, and does not require Internet access. @@ -228,101 +234,96 @@ Sample Configuration - A brief example of what a default.action configuration - might look like: + A brief example of what a simple default.action + configuration might look like: - # Define a few useful custom aliases for later use {{alias}} - # Don't accept cookies - +no-cookies = +no-cookies-set +no-cookies-read - - # Do accept cookies - -no-cookies = -no-cookies-set -no-cookies-read + # Useful aliases + +crunch-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies + -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies + +imageblock = +block +handle-as-image - # Treat these blocked URLs as images. - +imageblock = +block +image + # Fragile sites should have the minimum changes + fragile = -block -deanimate-gifs -fast-redirects -filter \ + -hide-referer -prevent-cookies -kill-popups - # Define page filters we want to use. - myfilters = +filter{html-annoyances} +filter{js-annoyances}\ - +filter{no-popups} +filter{webbugs} - - ## Default Policies (actions) ############################ + ## Turn some actions on ################################ { \ - -block \ - -downgrade \ - +fast-redirects \ - myfilters \ - +no-compression \ - +hide-forwarded \ - +hide-from{block} \ - +hide-referer{forge} \ - -hide-user-agent \ - -image \ - +image-blocker{blank} \ - +no-cookies-keep \ - -no-cookies-read \ - -no-cookies-set \ - +no-popups \ - -vanilla-wafer \ - -wafer \ + -add-header \ + -block \ + +deanimate-gifs{last} \ + -downgrade-http-version \ + -fast-redirects \ + +filter{html-annoyances} \ + +filter{js-annoyances} \ + +filter{content-cookies} \ + +filter{webbugs} \ + +filter{banners-by-size} \ + +hide-forwarded-for-headers \ + +hide-from-header{block} \ + +hide-referrer{forge} \ + -hide-user-agent \ + -handle-as-image \ + +set-image-blocker{pattern} \ + -limit-connect \ + +prevent-compression \ + +session-cookies-only \ + -crunch-cookies \ + -kill-popups \ } - / + / # '/' Matches *all* URL patterns + + # Block, and treat these URL patterns as if they were 'images'. + # We would expect these to be ads. + {+imageblock} + .ad.doubleclick.net + .a[0-9].yimg.com/(?:(?!/i/).)*$ + ad.*.doubleclick.net - # Now set exceptions to the above defined policies ####### + # Block any URLs that match these patterns + {+block} + ad*. + .*ads. + banner?. + /.*count(er)?\.(pl|cgi|exe|dll|asp|php[34]?) + .hitbox.com + + # Make exceptions for these harmless ones that would be + # caught by our +block patterns just above. + {-block} + adsl. + advice. + .*downloads. - # Sites where we want persistant cookies - {-no-cookies -no-cookies-keep} - .redhat.com - .sun.com - .yahoo.com - .msdn.microsoft.com + - # This site requires cookies AND 'fast-redirects' on - {-no-cookies -no-cookies-keep -fast-redirects} - .nytimes.com + + Then for a user.action, we would put local, + narrowly defined exceptions: + - # Add custom headers, and turn off filtering of page source - {+add-header{X-Privacy: Yes please} #-add-header{*} \ - +add-header{X-User-Tracking: No thanks!} -filter} - privacy.net + + # Re-define aliases as needed here + {{alias}} - # Block, and treat these URLs as 'images'. - {+imageblock} - .adforce.imgis.com - .ad.preferences.com/image.* - .ads.web.aol.com - .ad-adex3.flycast.com - .ad.doubleclick.net - .ln.doubleclick.net - .ad.de.doubleclick.net - /.*/count\.cgi\?.*df= - 194.221.183.22[1-7] - a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/ + # Useful aliases + -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies + + # Set personal exceptions to the policies in default.action ####### - # Block any URLs that match these patterns - {+block} - /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\.(gif|jpe?g)) - /.*/(plain|live|rotate)[-_.]?ads?/ - /.*/(sponsor)s?[0-9]?/ - /.*/ad(server|stream|juggler)\.(cgi|pl|dll|exe) - /.*/adbanners/ - /.*/adv((er)?ts?|ertis(ing|ements?))?/ - /.*/banners?/ - /.*/popupads/ - /.*/advert[0-9]+\.jpg - /ad_images/ - /.*/ads/ - /images/.*/.*_anim\.gif - /rotations/ - /.*(ms)?backoff(ice)?.*\.(gif|jpe?g) - 195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|) - .images.nytimes.com - .images.yahoo.com/adv/ - /.*cnnstore\.gif + # Sites where we want persistant cookies, so allow *all* cookies + {-crunch-cookies -session-cookies-only} + .redhat.com + .sun.com + .msdn.microsoft.com + + # This site breaks easily. + {-block -fast-redirects} + .forbes.com @@ -343,9 +344,8 @@ /usr/sbin/privoxy /etc/privoxy/config /etc/privoxy/default.action - /etc/privoxy/advanced.action - /etc/privoxy/basic.action - /etc/privoxy/intermediate.action + /etc/privoxy/standard.action + /etc/privoxy/user.action /etc/privoxy/default.filter /etc/privoxy/trust /etc/privoxy/templates/* @@ -355,7 +355,7 @@ Various other files should be included, but may vary depending on platform and build configuration. More documentation should be included in the local - documentation directory, though is not complete at this time. + documentation directory. @@ -384,7 +384,7 @@ all features are well tested. ]]> - Please see the user-manual on how to contact the + Please see the User Manual on how to contact the developers for feature requests, reporting problems, and other questions. @@ -406,9 +406,18 @@ Copyright and License - + +Copyright + ©right; + + +License + + &license; + +