X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fprivoxy-man-page.sgml;h=ed4e05afa295185adc59df52e2da9b5180b9ffc3;hp=dabab051eb61442884d828af1182f81dbf2fa3e4;hb=cc72a4f383da48600c4dccacb879266638833ecf;hpb=47ebc96cd29a0e2de4c752e7b42006c27d365064 diff --git a/doc/source/privoxy-man-page.sgml b/doc/source/privoxy-man-page.sgml index dabab051..ed4e05af 100644 --- a/doc/source/privoxy-man-page.sgml +++ b/doc/source/privoxy-man-page.sgml @@ -5,9 +5,9 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: privoxy-man-page.sgml,v 1.11 2002/05/05 20:26:02 hal9 Exp $ + $Id: privoxy-man-page.sgml,v 2.23 2009/01/13 16:50:35 fabiankeil Exp $ - Copyright (C) 2001, 2002 Privoxy Developers + Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/ See LICENSE. ======================================================================== @@ -42,10 +42,10 @@ - - - - + + + + @@ -53,7 +53,7 @@ - 2002-04-11 + 2009-01-12 privoxy @@ -76,15 +76,11 @@ pidfile user[.group] + + hostname configfile - (UNIX) - - privoxy.exe - configfile - (Windows) - @@ -130,7 +126,7 @@ On startup, write the process ID to pidfile. Delete the pidfile on exit. - Failiure to create or delete the pidfile + Failure to create or delete the pidfile is non-fatal. If no --pidfile option is given, no PID file will be used. @@ -151,13 +147,35 @@ + + --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. + + + + + --pre-chroot-nslookup hostname + + + Initialize the resolver library using hostname + before chroot'ing. On some systems this reduces the number of files + that must be copied into the chroot tree. + + + - + 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. @@ -176,14 +194,23 @@ Installation and Usage - Browsers must be individually configured to use Privoxy as - a HTTP proxy. The default setting is for localhost, on port 8118 - (configurable in the main config file). To set the HTTP proxy in Netscape - and Mozilla, go through: Edit; + Browsers can either be individually configured to use + Privoxy as a HTTP proxy (recommended), + or Privoxy can be combined with a packet + filter to build an intercepting proxy + (see config). The default setting is for + localhost, on port 8118 (configurable in the main config file). To set the + HTTP proxy in Netscape and Mozilla, go through: Edit; Preferences; Advanced; 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; @@ -191,8 +218,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. @@ -207,25 +238,33 @@ 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 + 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. On Windows, OS/2 and AmigaOS, - these files are in the same directory as the Privoxy - executable. + /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/ + (assuming the configuration allows it). 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. @@ -241,64 +280,62 @@ # Define a few useful custom aliases for later use {{alias}} - # Useful aliases - +prevent-cookies = +prevent-setting-cookies +prevent-reading-cookies - -prevent-cookies = -prevent-setting-cookies -prevent-reading-cookies - +imageblock = +block +handle-as-image + # 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 + -hide-referer -prevent-cookies ## Turn some actions on ################################ - { \ - -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 \ - +prevent-reading-cookies \ - +prevent-setting-cookies \ - -kill-popups \ - } - / # Match all URLs - - # Block, and treat these URL patterns as if they were 'images'. - {+imageblock} - .ad.doubleclick.net - .a[0-9].yimg.com/(?:(?!/i/).)*$ - ad.*.doubleclick.net + ## NOTE: Actions are off by default, unless explictily turned on + ## otherwise with the '+' operator. + +{ \ ++change-x-forwarded-for{block} \ ++deanimate-gifs{last} \ ++filter{refresh-tags} \ ++filter{img-reorder} \ ++filter{banners-by-size} \ ++filter{webbugs} \ ++filter{jumping-windows} \ ++filter{ie-exploits} \ ++hide-from-header{block} \ ++hide-referrer{conditional-block} \ ++session-cookies-only \ ++set-image-blocker{pattern} \ +} +/ # '/' Match *all* URL patterns - # Block any URLs that match these patterns - {+block} - ad*. + + # Block all URLs that match these patterns + { +block } + ad. + ad[sv]. .*ads. banner?. /.*count(er)?\.(pl|cgi|exe|dll|asp|php[34]?) - /(?:.*/)?(publicite|werbung|rekla(ma|me|am)|maino(kset|nta|s)?)/ .hitbox.com + media./.*(ads|banner) + + # 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 # Make exceptions for these harmless ones that would be - # caught by +block above. - {-block} + # caught by our +block patterns just above. + { -block } adsl. + adobe. advice. .*downloads. - + # uploads or downloads + /.*loads @@ -307,23 +344,35 @@ + # 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 persistant cookies - {-prevent-reading-cookies -prevent-setting-cookies -session-cookies-only} + # Sites where we want persistent cookies, so allow *all* cookies + { -crunch-cookies -session-cookies-only } .redhat.com .sun.com .msdn.microsoft.com - {-block -fast-redirects} + # These sites break easily. Use our "fragile" alias here. + { fragile } .forbes.com + mybank.example.com + + # 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. @@ -337,9 +386,9 @@ /usr/sbin/privoxy /etc/privoxy/config /etc/privoxy/default.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 @@ -347,8 +396,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. @@ -377,8 +426,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.