X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=06daeb7a8a0e6de951b064327297394c177986c1;hb=b713238ef11e017be4b4489789dfc8d491698ec5;hp=e92a15f43496b490f74657b919bab153957f6105;hpb=be4b22d1ab5a793668d34f583f52cc867632ccc4;p=privoxy.git diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index e92a15f4..06daeb7a 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -25,7 +25,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: user-manual.sgml,v 1.97 2002/04/27 21:04:42 hal9 Exp $ + $Id: user-manual.sgml,v 1.100 2002/04/29 03:05:55 hal9 Exp $ Written by and Copyright (C) 2001 the SourceForge Privoxy team. http://www.privoxy.org/ @@ -46,7 +46,7 @@ Privoxy User Manual -$Id: user-manual.sgml,v 1.97 2002/04/27 21:04:42 hal9 Exp $ +$Id: user-manual.sgml,v 1.100 2002/04/29 03:05:55 hal9 Exp $ @@ -421,11 +421,11 @@ automatically start Privoxy in the boot process. Starting <application>Privoxy</application> - Before launching Privoxy for the first time, you - will want to configure your browser(s) to use Privoxy - as a HTTP and HTTPS proxy. The default is localhost for the proxy address, - and port 8118 (earlier versions used port 8000). This is the one - configuration step that must be done! + Before launching Privoxy for the first time, you + will want to configure your browser(s) to use + Privoxy as a HTTP and HTTPS proxy. The default is + localhost for the proxy address, and port 8118 (earlier versions used port + 8000). This is the one configuration step that must be done! @@ -445,45 +445,94 @@ automatically start Privoxy in the boot process. Privoxy! - Privoxy is typically started by specifying the - main configuration file to be used on the command line. Example Unix startup - command: + main configuration file to be used on the command line. If no configuration + file is 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. + +RedHat and Debian + +We use a script. Note that RedHat does not start Privoxy upon booting per +default. It will use the file /etc/privoxy/config as its +main configuration file. FIXME: Debian?? + - # /usr/sbin/privoxy /etc/privoxy/config + # /etc/rc.d/init.d/privoxy start + + + + + +SuSE + +We use a script. It will use the file /etc/privoxy/config +as its main configuration file. Note that SuSE starts Privoxy upon booting +your PC. + + + + # rcprivoxy start + + + +Windows + +Click on the Privoxy Icon to start Privoxy. If no configuration file is + specified on the command line, Privoxy will look + for a file named config.txt. Note that Windows will + automatically start Privoxy upon booting you PC. + + + +Solaris, NetBSD, FreeBSD, HP-UX and others - See below for other command line options. +Example Unix startup command: + + + + # /usr/sbin/privoxy /etc/privoxy/config + + + +OS/2 - An init script is provided for SuSE and Red Hat. +FIXME. + + +MAX OSX - For for SuSE: rcprivoxy start +FIXME. + + + +AmigaOS - For Red Hat and Debian: /etc/rc.d/init.d/privoxy start +FIXME. + + + Command Line Options @@ -895,6 +946,66 @@ automatically start Privoxy in the boot process. where to find those other files. + + The user running Privoxy, must have read permission for all + configuration files, and write permission to any files that would + be modified, such as log files. + + +user-manual + + + Specifies: + + + Location of the Privoxy User Manual. + + + + + Type of value: + + A fully qualified URI + + + + Default value: + + http://www.privoxy.org/user-manual/ + + + + Effect if unset: + + + The default will be used. + + + + + Notes: + + + The User Manual is used for help hints from some of the internal CGI pages. + It is normally packaged with the binary distributions, and would make more + sense to have this pointed at a locally installed copy. + + + A more useful example (Unix): + + +   user-manual  file:///usr/share/doc/privoxy-&p-version;/user-manual/ + + + + If this option is defined, it must come first! It is needed before the rest of + config is read. + + + + + + confdir @@ -1157,6 +1268,10 @@ actionsfile the effect that cron.daily will automatically archive, gzip, and empty the log, when it exceeds 1M size. + + Any log files must be writable by whatever user Privoxy + is being run as (default on UNIX, user id is privoxy). + @@ -1258,55 +1373,6 @@ actionsfile -user-manual - - - Specifies: - - - Location of the Privoxy User Manual. - - - - - Type of value: - - A fully qualified URI - - - - Default value: - - http://www.privoxy.org/user-manual/ - - - - Effect if unset: - - - The default will be used. - - - - - Notes: - - - The User Manual is used for help hints from some of the internal CGI pages. - It is normally packaged with the binary distributions, and would make more - sense to have this pointed at a locally installed copy. - - - A more useful example (Unix): - - -   user-manual  file:///usr/share/doc/privoxy-&p-version;/user-manual/ - - - - - - @@ -2508,22 +2574,47 @@ forward-socks4 and forward-socks4a Privoxy takes for which URLs, and thus determines how ad images, cookies and various other aspects of HTTP content and transactions are handled, and on which sites (or even parts thereof). There - are three such files included with Privoxy, - with slightly different purposes. default.action sets - the default policies. standard.action is used by - Privoxy and the web based editor to set - pre-defined values (and normally should not be edited). Local exceptions - are best done in user.action. The content of these - can all be viewed and edited from http://config.privoxy.org/show-status. + are three such files included with Privoxy (as of + version 2.9.15), with differing purposes: + + + + + + standard.action - is used by the web based editor, + to set various pre-defined sets of rules for the default actions section + in default.action. These have increasing levels of + aggressiveness. It is not recommend to edit this file. + + + + + default.action - is the primary action file + that sets the initial values for all actions. It is intended to + provide a base level of functionality for + Privoxy's array of features. So it is + a set of broad rules that should work reasonably well for users everywhere. + This is the file that the developers are keeping updated, and making + available to users. + + + + + user.action - is intended to be for local site + preferences and exceptions. As an example, if your ISP or your bank + has specific requirements, and need special handling, this kind of + thing should go here. This file will not be upgraded. + + + + - - Anything you want can be blocked, including ads, banners, or just some obnoxious - URL that you would rather not see is done here. Cookies can be accepted or rejected, or - accepted only during the current browser session (i.e. not written to disk), - content can be modified, JavaScripts tamed, user-tracking fooled, and much more. - See below for a complete list of available actions. + + The list of actions files to be used are defined in the main configuration + file, and are processed in the order they are defined. The content of these + can all be viewed and edited from http://config.privoxy.org/show-status. @@ -2534,6 +2625,14 @@ forward-socks4 and forward-socks4a exceptions to the defined universal policies. + + Actions can be used to block anything you want, including ads, banners, or + just some obnoxious URL that you would rather not see. Cookies can be accepted + or rejected, or accepted only during the current browser session (i.e. not + written to disk), content can be modified, JavaScripts tamed, user-tracking + fooled, and much more. See below for a complete list of actions. + + Finding the Right Mix @@ -4531,6 +4630,7 @@ for-privoxy-version=3.0 { +block } www.my-isp-example.com/logo[0-9].gif + # Say the site where you do your homebanking needs to open # popup windows, but you have chosen to kill popups by # default. This will allow it for your-example-bank.com: @@ -4538,6 +4638,7 @@ for-privoxy-version=3.0 { -filter{popups} -kill-popups } .my-example-bank.com + # This site is delicate, and requires kid-glove # treatment. { fragile } @@ -5730,6 +5831,16 @@ Requests Temple Place - Suite 330, Boston, MA 02111-1307, USA. $Log: user-manual.sgml,v $ + Revision 1.100 2002/04/29 03:05:55 hal9 + Add clarification on differences of new actions files. + + Revision 1.99 2002/04/28 16:59:05 swa + more structure in starting section + + Revision 1.98 2002/04/28 05:43:59 hal9 + This is the break up of configuration.html into multiple files. This + will probably break links elsewhere :( + Revision 1.97 2002/04/27 21:04:42 hal9 -Rewrite of Actions File example. -Add section for user-manual directive in config.