X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fprivoxy-man-page.sgml;h=dc12a6aec8fd9d5fe59fc004d00e348e0a9aaf56;hp=cdce0ba70698c1255f0ef9f8d2c01dd7f591ae19;hb=7a99a61ab1a3ce0401821aedcd06eba19a698b2a;hpb=f7e9457f167479bd8f8465d7ba7727fb1be2e30d diff --git a/doc/source/privoxy-man-page.sgml b/doc/source/privoxy-man-page.sgml index cdce0ba7..dc12a6ae 100644 --- a/doc/source/privoxy-man-page.sgml +++ b/doc/source/privoxy-man-page.sgml @@ -4,22 +4,22 @@ Purpose : Manual Page This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - - $Id: privoxy-man-page.sgml,v 2.21 2008/08/30 15:37:35 fabiankeil Exp $ - Copyright (C) 2001-2008 Privoxy Developers http://www.privoxy.org/ + $Id: privoxy-man-page.sgml,v 2.51 2016/01/21 15:55:49 fabiankeil Exp $ + + Copyright (C) 2001-2012 Privoxy Developers http://www.privoxy.org/ See LICENSE. ======================================================================== - NOTE: Please read developer-manual/documentation.html before touching - anything in this, or other Privoxy documentation. + NOTE: Please read developer-manual/documentation.html before touching + anything in this, or other Privoxy documentation. ======================================================================== 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 can verify the changes - will improve finished output! - + 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 :). @@ -28,35 +28,36 @@ Requires docbook2man (short perl script), see CVS http://sources.redhat.com/docbook-tools/. Also requires openjade and SGMLSpm - perl module. - + 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 --> + - + + ]> - 2007-04-12 + 2012-11-08 - privoxy + privoxy 1 Privoxy &p-version; @@ -69,16 +70,17 @@ - + privoxy + + - - pidfile - user[.group] - - hostname - configfile + pidfile + hostname + user[.group] + + configfile @@ -91,21 +93,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,6 +162,17 @@ + + --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] @@ -147,36 +188,23 @@ + - --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. - - + --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 . If no - configfile is found, Privoxy will + config in the current directory. If no + configfile is found, Privoxy will fail to start. @@ -200,27 +228,21 @@ 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; + HTTP proxy in Firefox, go through: Tools; Options; General; Connection Settings; - Manual Proxy Configuration. + 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 + HTTPS presents some limitations, and not all features will work with HTTPS connections. @@ -235,26 +257,26 @@ 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, 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. + 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. - - Privoxy uses the concept of actions + + 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 + 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 + 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. @@ -269,124 +291,15 @@ - -Sample Configuration - - A brief example of what a simple default.action - configuration might look like: - - - - # Define a few useful custom aliases for later use - {{alias}} - - # 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 - - ## Turn some actions on ################################ - ## 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 all URLs that match these patterns - { +block } - ad. - ad[sv]. - .*ads. - banner?. - /.*count(er)?\.(pl|cgi|exe|dll|asp|php[34]?) - .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 our +block patterns just above. - { -block } - adsl. - adobe. - advice. - .*downloads. - # uploads or downloads - /.*loads - - - - 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 - .msdn.microsoft.com - - # 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 full 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 @@ -408,13 +321,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. @@ -423,7 +337,7 @@ Notes - This is a &p-status; version of Privoxy. Not + This is a &p-status; version of Privoxy. Not all features are well tested. ]]>