X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fprivoxy-man-page.sgml;h=556225faf26f80386bf3e4e5de9d3e85e631037a;hp=dc21a872ba5b07fb8c516ecdae1223b093e318c2;hb=979620bb4c7aaaeb96f07b73b823c686d83cf14c;hpb=e70110618027c7cb90164df41ae9b5fefb6ef5ac diff --git a/doc/source/privoxy-man-page.sgml b/doc/source/privoxy-man-page.sgml index dc21a872..556225fa 100644 --- a/doc/source/privoxy-man-page.sgml +++ b/doc/source/privoxy-man-page.sgml @@ -1,25 +1,21 @@ + - - + + - - - + - + + ]> - 2002-05-14 + 2012-11-08 - privoxy + privoxy 1 Privoxy &p-version; @@ -71,22 +66,19 @@ - + privoxy + + - - pidfile - user[.group] - configfile - (UNIX) + pidfile + hostname + user[.group] + + configfile - - privoxy.exe - configfile - (Windows) - @@ -97,21 +89,49 @@ options: - + + - --help + --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. + + + + + + --config-test - Print brief usage info and exit. + Exit after loading the configuration files before binding to + the listen address. The exit code signals whether or not the + configuration files have been successfully loaded. + + + If the exit code is 1, at least one of the configuration files + is invalid, if it is 0, all the configuration files have been + successfully loaded (but may still contain errors that can + currently only be detected at run time). + + This option doesn't affect the log setting, combination with + "--no-daemon" is recommended if a configured log file shouldn't + be used. + - --version + --help - Print version info and exit. + Print brief usage info and exit. @@ -132,12 +152,23 @@ 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. + + --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. + + + + --user user[.group] @@ -153,14 +184,23 @@ + + + --version + + + Print version info and exit. + + + + - + 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 - configfile is found, Privoxy will + config in the current directory. If no + configfile is found, Privoxy will fail to start. @@ -178,24 +218,30 @@ 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; - Preferences; Advanced; - Proxies; Manual Proxy Configuration; - View. + 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 Firefox, go through: Tools; + Options; General; + Connection Settings; + Manual Proxy Configuration. - For Internet Explorer, go through: Tools; + For Internet Explorer, go through: Tools; Internet Properties; Connections; - LAN Settings. + LAN Settings. The Secure (SSL) Proxy should also be set to the same values, otherwise 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,151 +253,52 @@ Privoxy can be configured with the various configuration files. The default configuration files are: config, - 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. + default.filter, default.action and + default.action. user.action should + be used for locally defined exceptions to the default rules in + match-all.action and 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. 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. + 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://config.privoxy.org/. + 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, and does not require Internet access. - - - - -Sample Configuration - A brief example of what a simple default.action - configuration might look like: + See the User Manual for a detailed + explanation of installation, general usage, all configuration options, new + features and notes on upgrading. - - - # Define a few useful custom aliases for later use - {{alias}} - - # Useful aliases - +crunch-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies - -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies - +imageblock = +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 ################################ - { \ - -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 - - # 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. - - - - - 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 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 - - - - - See the comments in the configuration files themselves, or the - user-manual - for explanations of the above syntax, and other Privoxy - configuration options. - - + Files - + /usr/sbin/privoxy /etc/privoxy/config + /etc/privoxy/match-all.action /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 @@ -359,7 +306,7 @@ Various other files should be included, but may vary depending on platform - and build configuration. More documentation should be included in the local + and build configuration. Additional documentation should be included in the local documentation directory. @@ -370,13 +317,14 @@ Signals - Privoxy terminates on the SIGINT, - SIGTERM and SIGABRT signals. Log - rotation scripts may cause a re-opening of the logfile by sending a + Privoxy terminates on the SIGINT + and SIGTERM signals. Log + rotation scripts may cause a re-opening of the logfile by sending a SIGHUP to Privoxy. Note that unlike other daemons, Privoxy does not need to be made aware of config file changes by SIGHUP -- it will detect them - automatically. + automatically. Signals other than the ones listed above aren't explicitly + handled and result in the default action defined by the operating system. @@ -385,15 +333,12 @@ Notes - This is a &p-status; version of Privoxy. Buyer beware! Do - not use in production situations.]]> -]]> -]]> + This is a &p-status; version of Privoxy. Not + all features are well tested. +]]> Please see the User Manual on how to contact the - developers for feature requests, reporting problems, and other questions. + developers, for feature requests, reporting problems, and other questions.