X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=doc%2Fsource%2Fprivoxy-man-page.sgml;h=b77e956552478e8996554926604cc7bdd53db000;hb=ae6beecce49ef10b169c4b843580985430bc698b;hp=de360e5684e993448799cc111a14d169cf179f0e;hpb=5ff5afa53bc3b5860b40ce780223b59acfa01205;p=privoxy.git diff --git a/doc/source/privoxy-man-page.sgml b/doc/source/privoxy-man-page.sgml index de360e56..b77e9565 100644 --- a/doc/source/privoxy-man-page.sgml +++ b/doc/source/privoxy-man-page.sgml @@ -5,61 +5,62 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: privoxy-man-page.sgml,v 1.2 2002/04/08 20:49:10 swa Exp $ + $Id: privoxy-man-page.sgml,v 2.8 2006/09/06 03:04:46 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-2006 Privoxy Developers http://privoxy.org + 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' + Create man page: 'make man' + Requires docbook2man (short perl script), see CVS + http://sources.redhat.com/docbook-tools/. Also requires openjade and SGMLSpm + perl module. + 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 + 2006-08-24 - privoxy 1 - Privoxy &p-version; + + Privoxy &p-version; + @@ -75,15 +76,10 @@ pidfile user[.group] + configfile - (UNIX) - - privoxy.exe - configfile - (Windows) - @@ -127,13 +123,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,21 +138,33 @@ 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. + + --chroot + + + Before changing to the user ID given in the --user option, chroot to + that user's home directory, i.e. make the kernel pretend to the + Privoxy process that the directory tree starts + there. If set up carefully, this can limit the impact of possible + vulnerabilities in Privoxy to the files contained in + that hierarchy. + + + - + If the configfile is not specified on the command line, Privoxy will look for a file named - config in the current directory (except on Win32 where - it will try config.txt). If no + config in the current directory . If no configfile is found, Privoxy will fail to start. @@ -182,6 +191,12 @@ Proxies; Manual Proxy Configuration; View. + + For Firefox, go through: Tools; + Options; General; + Connection Settings; + Manual Proxy Configuration. + For Internet Explorer, go through: Tools; Internet Properties; Connections; @@ -189,8 +204,12 @@ 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. + HTTPS presents some limitations, and not all features will work with HTTPS + connections. + For other browsers, check the documentation. @@ -202,25 +221,35 @@ 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, and user.filter for + locally defined filters. These are well commented. On Unix + and Unix-like systems, these are located in + /etc/privoxy/ by default. - - 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. + + Privoxy uses the concept of actions + in order to manipulate the data stream between the browser and remote sites. + There are various actions available with specific functions for such things + as blocking web sites, managing cookies, etc. These actions can be invoked + individually or combined, and used against individual URLs, or groups of URLs + that can be defined using wildcards and regular expressions. The result is + that the user has greatly enhanced control and freedom. 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. + + + See the User Manual for a detailed + explanation of installation, general usage, all configuration options, new + features and notes on upgrading. @@ -228,108 +257,147 @@ 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 - - # Treat these blocked URLs as images. - +imageblock = +block +image - - # Define page filters we want to use. - myfilters = +filter{html-annoyances} +filter{js-annoyances}\ - +filter{no-popups} +filter{webbugs} - - ## Default Policies (actions) ############################ - { \ - -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 \ - } - / - - # Now set exceptions to the above defined policies ####### - - # Sites where we want persistant cookies - {-no-cookies -no-cookies-keep} + # Useful aliases that combine more than one action + +crunch-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies + -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies + +block-as-image = +block +handle-as-image + + # Fragile sites should have the minimum changes + fragile = -block -deanimate-gifs -fast-redirects -filter \ + -hide-referer -prevent-cookies -kill-popups + + ## Turn some actions on ################################ + ## NOTE: Actions are off by default, unless explictily turned on + ## otherwise with the '+' operator. + +{ \ +-add-header \ +-block \ +-content-type-overwrite \ +-crunch-client-header \ +-crunch-if-none-match \ +-crunch-outgoing-cookies \ +-crunch-incoming-cookies \ +-crunch-server-header \ ++deanimate-gifs{last} \ +-downgrade-http-version \ +-fast-redirects \ +-filter{js-annoyances} \ +-filter{js-events} \ +-filter{html-annoyances} \ +-filter{content-cookies} \ ++filter{refresh-tags} \ +-filter{unsolicited-popups} \ +-filter{all-popups} \ ++filter{img-reorder} \ ++filter{banners-by-size} \ +-filter{banners-by-link} \ ++filter{webbugs} \ +-filter{tiny-textforms} \ ++filter{jumping-windows} \ +-filter{frameset-borders} \ +-filter{demoronizer} \ +-filter{shockwave-flash} \ +-filter{quicktime-kioskmode} \ +-filter{fun} \ +-filter{crude-parental} \ ++filter{ie-exploits} \ +-filter{site-specifics} \ +-filter-client-headers \ +-filter-server-headers \ +-force-text-mode \ +-handle-as-empty-document +-handle-as-image \ +-hide-accept-language \ +-hide-content-disposition \ +-hide-if-modified-since \ ++hide-forwarded-for-headers \ ++hide-from-header{block} \ ++hide-referrer{forge} \ +-hide-user-agent \ +-inspect-jpegs \ +-kill-popups \ +-limit-connect \ +-overwrite-last-modified \ +-redirect \ ++prevent-compression \ +-send-vanilla-wafer \ +-send-wafer \ ++session-cookies-only \ ++set-image-blocker{pattern} \ +-treat-forbidden-connects-like-blocks \ +} +/ # '/' Match *all* URL patterns + + + # Block, and treat these URL patterns as if they were 'images'. + # We would expect these to be ads. + { +block-as-image } + .ad.doubleclick.net + .a[0-9].yimg.com/(?:(?!/i/).)*$ + ad.*.doubleclick.net + + # Block all URLs that match these patterns + { +block } + ad*. + .*ads. + banner?. + /.*count(er)?\.(pl|cgi|exe|dll|asp|php[34]?) + .hitbox.com + media./.*(ads|banner) + + # Make exceptions for these harmless ones that would be + # caught by our +block patterns just above. + { -block } + adsl. + advice. + .*downloads. + + + + + Then for a user.action, we would put local, + narrowly defined exceptions: + + + + # Re-define aliases as needed here + {{alias}} + + # Useful aliases + -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies + + # Set personal exceptions to the policies in default.action ####### + + # Sites where we want persistent cookies, so allow *all* cookies + { -crunch-cookies -session-cookies-only } .redhat.com .sun.com - .yahoo.com .msdn.microsoft.com + + # These sites breaks easily. Use our "fragile" alias here. + { fragile } + .forbes.com + mybank.example.com - # This site requires cookies AND 'fast-redirects' on - {-no-cookies -no-cookies-keep -fast-redirects} - .nytimes.com - - # 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 - - # 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/.*/ - - # 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 + # Replace example.com's style sheet with one of my choosing + { +redirect{http://localhost/css-replacements/example.com.css} } + example.com/stylesheet.css See the comments in the configuration files themselves, or the - user-manual - for explanations of the above syntax, and other Privoxy + User Manual + for full explanations of the above syntax, and other Privoxy configuration options. @@ -343,10 +411,10 @@ /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/user.filter /etc/privoxy/trust /etc/privoxy/templates/* /var/log/privoxy/logfile @@ -354,8 +422,8 @@ 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. + and build configuration. Additional documentation should be included in the local + documentation directory. @@ -384,8 +452,8 @@ all features are well tested. ]]> - Please see the user-manual on how to contact the - developers for feature requests, reporting problems, and other questions. + Please see the User Manual on how to contact the + developers, for feature requests, reporting problems, and other questions. @@ -406,9 +474,18 @@ Copyright and License - + +Copyright + ©right; + + +License + + &license; + +