X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fprivoxy-man-page.sgml;h=dc12a6aec8fd9d5fe59fc004d00e348e0a9aaf56;hp=a7c1f902e42b165f3d820cd6a6941499e5027c15;hb=7a99a61ab1a3ce0401821aedcd06eba19a698b2a;hpb=c02c71352a3edd36f392d90a054be965657f056c diff --git a/doc/source/privoxy-man-page.sgml b/doc/source/privoxy-man-page.sgml index a7c1f902..dc12a6ae 100644 --- a/doc/source/privoxy-man-page.sgml +++ b/doc/source/privoxy-man-page.sgml @@ -4,33 +4,31 @@ Purpose : Manual Page This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - - $Id: privoxy-man-page.sgml,v 1.4 2002/04/10 18:45:15 swa Exp $ - Written by and Copyright (C) 2001 the SourceForge - Privoxy team. http://www.privoxy.org/ + $Id: privoxy-man-page.sgml,v 2.51 2016/01/21 15:55:49 fabiankeil Exp $ - Based on the Internet Junkbuster originally written - by and Copyright (C) 1997 Anonymous Coders and - Junkbusters Corporation. http://www.junkbusters.com + 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. You have been warned! - Failure to abide by this rule will result in the revocation of your license - to live a peaceful existence! + NOTE: Please read developer-manual/documentation.html before touching + 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 @@ -38,28 +36,32 @@ --> + + - - + + + + ]> - 2002-04-11 + 2012-11-08 - - privoxy + privoxy 1 - Privoxy &p-version; + + Privoxy &p-version; + @@ -68,22 +70,19 @@ - + privoxy + + - - pidfile - user[.group] - configfile - (UNIX) + pidfile + hostname + user[.group] + + configfile - - privoxy.exe - configfile - (Windows) - @@ -94,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. @@ -129,12 +156,23 @@ On startup, write the process ID to pidfile. Delete the pidfile on exit. - Failiure to create or delete the pidfile - is non-fatal. If no --pidfile option is given, no PID file will be used. + 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] @@ -150,14 +188,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. @@ -175,23 +222,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. + 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. @@ -203,151 +257,52 @@ 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, 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, 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. - - - - - -Sample Configuration - - A brief example of what a default.action configuration - might look like: + This is an internal page, and does not require Internet access. - - - - # 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} - .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 - - # 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 - - - - See the comments in the configuration files themselves, or the - user-manual - for explanations of the above syntax, and other Privoxy - configuration options. + See the User Manual for a detailed + explanation of installation, general usage, all configuration options, new + features and notes on upgrading. - + Files - + /usr/sbin/privoxy /etc/privoxy/config + /etc/privoxy/match-all.action /etc/privoxy/default.action - /etc/privoxy/advanced.action - /etc/privoxy/basic.action - /etc/privoxy/intermediate.action + /etc/privoxy/user.action /etc/privoxy/default.filter + /etc/privoxy/user.filter /etc/privoxy/trust /etc/privoxy/templates/* /var/log/privoxy/logfile @@ -355,8 +310,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. @@ -366,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. @@ -381,12 +337,12 @@ Notes - This is a &p-status; version of Privoxy. Not + 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. + Please see the User Manual on how to contact the + developers, for feature requests, reporting problems, and other questions. @@ -407,9 +363,18 @@ Copyright and License - + +Copyright + ©right; + + +License + + &license; + +