X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=88adb4fa5a969a63752ba8772818983cefdcf656;hb=ccedf2853b21370ecb456bda0551e7dbfa76aee9;hp=0879dab00ff437a765f5057f27071d41a614331b;hpb=fe047abc4a402ca510c7d15b9fd782baa2946fb6;p=privoxy.git diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index 0879dab0..88adb4fa 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -7,7 +7,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: user-manual.sgml,v 1.18 2001/10/24 18:45:26 hal9 Exp $ + $Id: user-manual.sgml,v 1.26 2002/01/09 20:02:50 hal9 Exp $ Written by and Copyright (C) 2001 the SourceForge IJBSWA team. http://ijbswa.sourceforge.net @@ -30,7 +30,7 @@ Hal Burgiss Junkbuster User Manual -$Id: user-manual.sgml,v 1.18 2001/10/24 18:45:26 hal9 Exp $ +$Id: user-manual.sgml,v 1.26 2002/01/09 20:02:50 hal9 Exp $ @@ -111,7 +111,7 @@ You can find the latest version of the user manual at + + + Auto-detection of config file changes. + + + + - In addition, the configuration is more versatile overall. + In addition, the configuration is much more versatile overall. @@ -182,8 +189,8 @@ You can find the latest version of the user manual at - Then, in either case, to build from source: + Then, in either case, to build from tarball/CVS source: - autoconf #recommended for CVS source - ./configure - make - su - make install + ./configure (--help to see options) + make (the make from gnu, gmake for *BSD) + su + make -n install (to see where all the files will go) + make install (to really install) @@ -234,7 +241,8 @@ You can find the latest version of the user manual at -    /usr/src/redhat/RPMS/i686/junkbuster-2.9.8-1.i686.rpm +    /usr/src/redhat/RPMS/i686/junkbuster-2.9.10-1.i686.rpm -    /usr/src/redhat/SRPMS/junkbuster-2.9.9-1.src.rpm +    /usr/src/redhat/SRPMS/junkbuster-2.9.10-1.src.rpm @@ -257,7 +265,7 @@ You can find the latest version of the user manual at - autoconf #recommended for CVS source + autoheader [suggested for CVS source] + autoconf [suggested for CVS source] ./configure make suse-dist @@ -288,10 +297,10 @@ You can find the latest version of the user manual at - rpm -Uvv /usr/src/packages/RPMS/i686/junkbuster-2.9.9-1.i686.rpm + rpm -Uvv /usr/src/packages/RPMS/i686/junkbuster-2.9.10-1.i686.rpm @@ -380,7 +389,7 @@ configuration section below. HB.) - For FreeBSD (and other *BSDs?), the build will need gmake + For FreeBSD (and other *BSDs?), the build will require gmake instead of the included make. gmake is available from http://www.gnu.org. The rest should be the same as above for Linux/Unix. @@ -405,9 +414,9 @@ configuration section below. HB.) - The installed defaults provide a reasonable starting point. For the - time being, there are only three default configuration files (this will - change in time): + The installed defaults provide a reasonable starting point, though possibly + aggressive by some standards. For the time being, there are only three + default configuration files (this will change in time): @@ -416,7 +425,7 @@ configuration section below. HB.) The main configuration file is named config - on Linux, Unix, BSD, and OS/2, and junkbustr.txt on + on Linux, Unix, BSD, and OS/2, and config.txt on Windows. On Amiga, it is AmiTCP:db/junkbuster/config. @@ -424,12 +433,14 @@ configuration section below. HB.) - The actionsfile file is used to define various + The ijb.action file is used to define various actions relating to images, banners, pop-ups, access restrictions, banners and cookies. There is a CGI based editor for this file that can be accessed via http://i.j.b./. This is the easiest method of - configuring actions. (Still under active development.) + url="http://i.j.b">http://i.j.b. This is the easiest method of + configuring actions. (Still under active development. Other actions + files are included as well with differing levels of filtering + and blocking, e.g. ijb-basic.action.) @@ -444,12 +455,14 @@ configuration section below. HB.) - actionsfile and re_filterfile + ijb.action and re_filterfile can use Perl style regular expressions for maximum flexibility. All files use the # character to denote a comment. Such lines are not processed by Junkbuster. After - making any changes, restart Junkbuster in order - for the changes to take effect. + making any changes, there is no need to restart + Junkbuster in order for the changes to take + effect. Junkbuster should detect such changes + automatically. @@ -465,7 +478,7 @@ configuration section below. HB.) The Main Configuration File Again, the main configuration file is named config on - Linux/Unix/BSD and OS/2, and junkbustr.txt on Windows. + Linux/Unix/BSD and OS/2, and config.txt on Windows. Configuration lines consist of an initial keyword followed by a list of values, all separated by whitespace (any number of spaces or tabs). For example: @@ -577,20 +590,21 @@ configuration section below. HB.) - The actionsfile contains patterns to specify the actions to + The ijb.action file contains patterns to specify the actions to apply to requests for each site. Default: Cookies to and from all - destinations are filtered. Popups are disabled for all sites. All sites are - filtered if re_filterfile specified. No sites are blocked. An empty image is - displayed for filtered ads and other images (formerly - tinygif). The syntax of this file is explained in detail - below. + destinations are kept only during the current browser session (i.e. they + are not saved to disk). Popups are disabled for all sites. All sites are + filtered if re_filterfile specified. No sites are blocked. An + empty image is displayed for filtered ads and other images (formerly + tinygif). The syntax of this file is explained in detail below. - actionsfile actionsfile + actionsfile ijb.action @@ -925,9 +939,9 @@ configuration section below. HB.) choice is Enable. Clicking on enable toggles Junkbuster on and off. This is useful if you want to temporarily disable Junkbuster, e.g., to access - a site that requires cookies which you normally have blocked. This can also + a site that requires cookies which you would otherwise have blocked. This can also be toggled via a web browser at the Junkbuster - internal address of http://i.j.b./ on + internal address of http://i.j.b on any platform. @@ -977,12 +991,12 @@ configuration section below. HB.) - To enable the web-based actionsfile editor set + To enable the web-based ijb.action file editor set enable-edit-actions to 1, or 0 to disable. Note that you must have compiled JunkBuster with support for this feature, otherwise this option has no effect. This internal page can be reached at http://i.j.b./. + url="http://i.j.b">http://i.j.b. @@ -1011,7 +1025,7 @@ configuration section below. HB.) Security note: If this is enabled, anyone who can use the proxy can toggle - it on or off (see http://i.j.b./), and + it on or off (see http://i.j.b), and their changes will affect all users. For shared proxies, you probably want to disable this. Default: enabled. @@ -1390,8 +1404,8 @@ configuration section below. HB.) - Also, we're told they insist on getting cookies and JavaScript, so you need - to add home.com to the cookie file. We consider JavaScript a security risk. + Also, we're told they insist on getting cookies and JavaScript, so you should + add home.com to the cookie file. We consider JavaScript a security risk. Java need not be enabled. @@ -1728,12 +1742,16 @@ Removed references to Win32. HB 09/23/01 The Actions File - The actionsfile is used to define what actions + The ijb.action file (formerly + actionsfile) is used to define what actions Junkbuster takes, and thus determines how images, cookies and various other aspects of HTTP content and transactions are handled. Images can be anything you want, including ads, banners, or just some obnoxious image that you would rather not see. Cookies can be accepted - or rejected. The default file is in fact named actionsfile. + or rejected, or accepted only during the current browser session (i.e. + not written to disk). Changes to ijb.action should + be immediately visible to Junkbuster without + the need to restart. @@ -1746,7 +1764,7 @@ Removed references to Win32. HB 09/23/01 The actions file can be edited with a browser by loading - http://i.j.b, and then select + http://i.j.b/, and then select Edit Actions. @@ -1950,7 +1968,7 @@ Removed references to Win32. HB 09/23/01 So in this case JunkBuster would just be a normal, non-blocking, non-anonymizing proxy. You must specifically enable the privacy and blocking features you need (although the - provided default actionsfile file will + provided default ijb.action file will give a good starting point). @@ -2305,6 +2323,24 @@ Removed references to Win32. HB 09/23/01 + + + If the website sets cookies, no-cookies-keep will make sure + they are erased when you exit and restart your web browser. This makes + profiling cookies useless, but won't break sites which require cookies so + that you can log in for transactions. Default: on. + + + + + + +no-cookies-keep + + + + + + Prevent the website from reading cookies: @@ -2408,13 +2444,16 @@ Removed references to Win32. HB 09/23/01 - # Turn off all cookies + # Turn off all persistant cookies { +no-cookies-read } { +no-cookies-set } + # Allow cookies for this browser session ONLY + { +no-cookies-keep } - # Execeptions to the above, sites that need cookies + # Execeptions to the above, sites that benefit from persistant cookies { -no-cookies-read } { -no-cookies-set } + { -no-cookies-keep } .javasoft.com .sun.com .yahoo.com @@ -2422,7 +2461,7 @@ Removed references to Win32. HB 09/23/01 .redhat.com # Alternative way of saying the same thing - {-no-cookies-set -no-cookies-read} + {-no-cookies-set -no-cookies-read -no-cookies-keep} .sourceforge.net .sf.net @@ -2545,8 +2584,8 @@ Removed references to Win32. HB 09/23/01 { or }. But please use only a- z, 0-9, +, and -. Alias names are not case sensitive, and - must be defined before anything else in - actionsfile! And there can only be one set of + must be defined before anything else in the + ijb.actionfile ! And there can only be one set of aliases defined. @@ -2683,8 +2722,30 @@ Removed references to Win32. HB 09/23/01 + + + + + + + +Templates + + When Junkbuster displays one of its internal + pages, such as a 404 Not Found error page, it uses the appropriate template. + On Linux, BSD, and Unix, these are locate in + /etc/junkbuster/templates by default. These may be + customized, if desired. + + + + + + + + Quickstart to Using Junkbuster @@ -2696,17 +2757,30 @@ Removed references to Win32. HB 09/23/01 - # /usr/sbin/junkbuster /etc/junkbuster/config & + # /usr/sbin/junkbuster /etc/junkbuster/config + + An init script is provided for SuSE and Redhat. + + + +For for SuSE: /etc/rc.d/junkbuster start + + + +For RedHat: /etc/rc.d/init.d/junkbuster start + + + If no configuration file is specified on the command line, Junkbuster will look for a file named config in the current directory. Except on Amiga where it will look for AmiTCP:db/junkbuster/config and Win32 - where it will try junkbstr.txt. If no file is specified + where it will try config.txt. If no file is specified on the command line and no default configuration file can be found, Junkbuster will fail to start. @@ -2725,12 +2799,12 @@ Removed references to Win32. HB 09/23/01 The included default configuration files should give a reasonable starting point, though may be somewhat aggressive in blocking junk. You will probably - want to keep an eye out for sites that require cookies, and add these to - actionsfile as needed. By default, most of these will - be blocked until you add them to the configuration. If you want the browser - to handle this instead, you will need to edit - actionsfile and disable this feature. If you use more - than one browser, it would make more sense to let + want to keep an eye out for sites that require persistant cookies, and add these to + ijb.action as needed. By default, most of these will + be accepted only during the current browser session, until you add them to + the configuration. If you want the browser to handle this instead, you will + need to edit ijb.action and disable this feature. If you + use more than one browser, it would make more sense to let Junkbuster handle this. In which case, the browser(s) should be set to accept all cookies. @@ -2738,7 +2812,7 @@ Removed references to Win32. HB 09/23/01 If a particular site shows problems loading properly, try adding it to the {fragile} section of - actionsfile. This will turn off most actions for + ijb.action. This will turn off most actions for this site. @@ -2748,16 +2822,16 @@ Removed references to Win32. HB 09/23/01 of I.E.) experience problems, you might try to force HTTP/1.0 compatiblity. For Mozilla, look under Edit -> Preferences -> Debug -> Networking. Or set the +downgrade config option in - actionsfile. + ijb.action. After running Junkbuster for a while, you can start to fine tune the configuration to suit your personal, or site, preferences and requirements. There are many, many aspects that can - be customized. Actions (from actionsfile) + be customized. Actions (as specified in ijb.action) can be adjusted by pointing your browser to - http://i.j.b./, + http://i.j.b/, and then follow the link to edit the actions list. (This is an internal page and does not require Internet access.) @@ -2767,7 +2841,7 @@ Removed references to Win32. HB 09/23/01 configuration can be viewed from this page, including current configuration parameters, source code version numbers, the browser's request headers, and actions that apply - to a given URL. In addition to the actionsfile + to a given URL. In addition to the ijb.action file editor mentioned above, Junkbuster can also be turned on and off from this page. @@ -2878,7 +2952,7 @@ communication (bugs, feature requests, etc.) -   http://i.j.b./ +   http://i.j.b/ @@ -3164,6 +3238,24 @@ communication (bugs, feature requests, etc.) Temple Place - Suite 330, Boston, MA 02111-1307, USA. $Log: user-manual.sgml,v $ + Revision 1.26 2002/01/09 20:02:50 hal9 + Fix bug re: auto-detect config file changes. + + Revision 1.25 2002/01/09 18:20:30 hal9 + Touch ups for *.action files. + + Revision 1.24 2001/12/02 01:13:42 hal9 + Fix typo. + + Revision 1.23 2001/12/02 00:20:41 hal9 + Updates for recent changes. + + Revision 1.22 2001/11/05 23:57:51 hal9 + Minor update for startup now daemon mode. + + Revision 1.21 2001/10/31 21:11:03 hal9 + Correct 2 minor errors + Revision 1.18 2001/10/24 18:45:26 hal9 *** empty log message ***