From 68ef9079fc9fa317581069233c979d242ed6f365 Mon Sep 17 00:00:00 2001 From: hal9 Date: Sat, 2 Mar 2002 22:00:14 +0000 Subject: [PATCH] Updated 'New Features' list. Ran through spell-checker. --- doc/source/user-manual.sgml | 155 ++++++++++++++++++++++-------------- 1 file changed, 97 insertions(+), 58 deletions(-) diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index 2ed25df6..d719d956 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -6,7 +6,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: user-manual.sgml,v 1.28 2002/02/24 14:34:24 jongfoster Exp $ + $Id: user-manual.sgml,v 1.29 2002/03/02 20:34:07 david__schmidt Exp $ Written by and Copyright (C) 2001 the SourceForge IJBSWA team. http://ijbswa.sourceforge.net @@ -17,10 +17,9 @@ --> @@ -29,7 +28,7 @@ Hal Burgiss Junkbuster User Manual -$Id: user-manual.sgml,v 1.28 2002/02/24 14:34:24 jongfoster Exp $ +$Id: user-manual.sgml,v 1.29 2002/03/02 20:34:07 david__schmidt Exp $ @@ -72,19 +71,19 @@ You can find the latest version of the user manual at - A browser based configuration utility (WIP at - http://i.j.b). + Integrated browser based configuration and control utility (http://i.j.b). Browser-based tracing of rule + and filter effects. @@ -116,48 +116,84 @@ You can find the latest version of the user manual at Junkbuster Configuration - For Unix, *BSD and Linux, all configuraton files are located in + For Unix, *BSD and Linux, all configuration files are located in /etc/junkbuster/ by default. For MS Windows and OS/2, these are all in the same directory as the Junkbuster executable. The name and number of @@ -445,7 +481,7 @@ configuration section below. HB.) 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. Other actions + configuring actions. (Other actions files are included as well with differing levels of filtering and blocking, e.g. ijb-basic.action.) @@ -550,12 +586,12 @@ configuration section below. HB.) On Windows, Junkbuster looks for these files in the same directory as the executable. On Unix and OS/2, Junkbuster looks for these files in the current - working directory. In either case, an absolute path name can be used to + working directory. In either case, an absolute path name can be used to avoid problems. - When development goes modular and multiuser, the blocker, filter, and + When development goes modular and multi-user, the blocker, filter, and per-user config will be stored in subdirectories of confdir. For now, only confdir/templates is used for storing HTML templates for CGI results. @@ -600,7 +636,7 @@ configuration section below. HB.) 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 kept only during the current browser session (i.e. they - are not saved to disk). Popups are disabled for all sites. All sites are + are not saved to disk). Pop-ups 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 The re_filterfile file contains content modification rules. These rules permit powerful changes on the content of Web pages, e.g., you - could disable your favourite JavaScript annoyances, rewrite the actual + could disable your favorite JavaScript annoyances, rewrite the actual content, or just have some fun replacing Microsoft with MicroSuck wherever it appears on a Web page. Default: No content modification, or whatever the developers are playing with :-/ @@ -696,7 +732,7 @@ configuration section below. HB.) with the effect that access to untrusted sites will be granted, if a link from a trusted referrer was used. The link target will then be added to the trustfile. This is a very restrictive feature that typical - users most propably want to leave disabled. Default: Disabled, don't use the + users most probably want to leave disabled. Default: Disabled, don't use the trust mechanism. @@ -711,7 +747,7 @@ configuration section below. HB.) - If you use the trust mechanism, it is a good idea to write up some online + If you use the trust mechanism, it is a good idea to write up some on-line documentation about your blocking policy and to specify the URL(s) here. They will appear on the page that your users receive when they try to access untrusted content. Use multiple times for multiple URLs. Default: Don't @@ -767,7 +803,7 @@ configuration section below. HB.) configuration and policies. It is used in many of the proxy-generated pages and its use is highly recommended in multi-user installations, since your users will want to know why certain content is blocked or modified. Default: - Don't show a link to online documentation. + Don't show a link to on-line documentation. @@ -857,9 +893,9 @@ configuration section below. HB.) debug 32 # FRC = debug force feature debug 64 # REF = debug regular expression filter debug 128 # = debug fast redirects - debug 256 # = debug GIF deanimation + debug 256 # = debug GIF de-animation debug 512 # CLF = Common Log Format - debug 1024 # = debug kill popups + debug 1024 # = debug kill pop-ups debug 4096 # INFO = Startup banner and warnings. debug 8192 # ERROR = Non-fatal errors @@ -971,7 +1007,7 @@ configuration section below. HB.) For content filtering, i.e. the +filter and - +deanimate-gif actions, it is neccessary that + +deanimate-gif actions, it is necessary that Junkbuster buffers the entire document body. This can be potentially dangerous, since a server could just keep sending data indefinitely and wait for your RAM to exhaust. With nasty consequences. @@ -1374,7 +1410,7 @@ configuration section below. HB.) - (NOTE: the syntax for specifiying target_domain has changed since the + (NOTE: the syntax for specifying target_domain has changed since the previous paragraph was written -- it will not work now. More information is welcome.) @@ -1835,10 +1871,10 @@ Removed references to Win32. HB 09/23/01 - Additionally, there are wildcards that you can use in the domain names - themselves. They work pretty similar to shell wildcards: * + Additionally, there are wild-cards that you can use in the domain names + themselves. They work pretty similar to shell wild-cards: * stands for zero or more arbitrary characters, ? stands for - any single character. And you can define charachter classes in square + any single character. And you can define character classes in square brackets and they can be freely mixed: @@ -1866,7 +1902,7 @@ Removed references to Win32. HB 09/23/01 If Junkbuster was compiled with pcre support (default), Perl compatible regular expressions - can be used. See the pcre/docs/ direcory or man + can be used. See the pcre/docs/ directory or man perlre (also available on http://www.perldoc.com/perl5.6/pod/perlre.html) for details. A brief discussion of regular expressions is in the @@ -2030,7 +2066,7 @@ Removed references to Win32. HB 09/23/01 This will also shrink the images considerably (in bytes, not pixels!). If the option first is given, the first frame of the animation is used as the replacement. If last is given, the last frame - of the animation is used instead, which propably makes more sense for most + of the animation is used instead, which probably makes more sense for most banner animations, but also has the risk of not showing the entire last frame (if it is only a delta to an earlier frame). @@ -2075,7 +2111,7 @@ Removed references to Win32. HB 09/23/01 Sometimes, there are even multiple consecutive redirects encoded in the - URL. These redirections via scripts make your web browing more traceable, + URL. These redirections via scripts make your web browsing more traceable, since the server from which you follow such a link can see where you go to. Apart from that, valuable bandwidth and time is wasted, while your browser ask the server for one redirect after the other. Plus, it feeds the @@ -2451,13 +2487,13 @@ Removed references to Win32. HB 09/23/01 - # Turn off all persistant cookies + # Turn off all persistent cookies { +no-cookies-read } { +no-cookies-set } # Allow cookies for this browser session ONLY { +no-cookies-keep } - # Execeptions to the above, sites that benefit from persistant cookies + # Exceptions to the above, sites that benefit from persistent cookies { -no-cookies-read } { -no-cookies-set } { -no-cookies-keep } @@ -2756,7 +2792,7 @@ Removed references to Win32. HB 09/23/01 Quickstart to Using Junkbuster - Install package, then run and enjoy! Junbuster + Install package, then run and enjoy! JunkBuster accepts only one command line option -- the configuration file to be used. Example Unix startup command: @@ -2806,7 +2842,7 @@ For RedHat: /etc/rc.d/init.d/junkbuster start 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 persistant cookies, and add these to + want to keep an eye out for sites that require persistent 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 @@ -2826,7 +2862,7 @@ For RedHat: /etc/rc.d/init.d/junkbuster start HTTP/1.1 support is not fully implemented. If browsers that support HTTP/1.1 (like Mozilla or recent versions - of I.E.) experience problems, you might try to force HTTP/1.0 compatiblity. + of I.E.) experience problems, you might try to force HTTP/1.0 compatibility. For Mozilla, look under Edit -> Preferences -> Debug -> Networking. Or set the +downgrade config option in ijb.action. @@ -2930,7 +2966,7 @@ communication (bugs, feature requests, etc.) Junkbuster was originally written by Anonymous Coders and JunkBusters + url="http://www.junkbusters.com/ht/en/ijbfaq.html">Junkbuster's Corporation, and was released as free open-source software under the GNU GPL. Stefan Waldherr made many improvements, and started the pcre (Perl Compatible Regular Expressions) is compiled in, which is the default. Such configuration directives do not require regular expressions, but they can be - used to increase flexibility by matching a pattern with wildcards against + used to increase flexibility by matching a pattern with wild-cards against URLs. @@ -3015,18 +3051,18 @@ communication (bugs, feature requests, etc.) expression against another to see if it matches or not. One of the expressions is a literal string of readable characters (letter, numbers, etc), and the other is a complex string of literal - characters combined with wildcards, and other special characters, called - metacharacters. The metacharacters have special meanings and + characters combined with wild-cards, and other special characters, called + meta-characters. The meta-characters have special meanings and are used to build the complex pattern to be matched against. Perl Compatible Regular Expressions is an enhanced form of the regular expression language with backward compatibility. - To make a simple analogy, we do something similar when we use wildcard + To make a simple analogy, we do something similar when we use wild-card characters when listing files with the dir command in DOS. *.* matches all filenames. The special - character here is the asterik which matches any and all characters. We can be + character here is the asterisk which matches any and all characters. We can be more specific and use ? to match just individual characters. So dir file?.text would match file1.txt, file2.txt, etc. We are pattern @@ -3073,7 +3109,7 @@ communication (bugs, feature requests, etc.) \ - The escape character denotes that the following character should be taken literally. This is used where one of the special characters (e.g. .) needs to be taken literally and - not as a special metacharacter. + not as a special meta-character. @@ -3086,7 +3122,7 @@ communication (bugs, feature requests, etc.) - () - pararentheses are used to group a sub-expression, + () - parentheses are used to group a sub-expression, or multiple sub-expressions. @@ -3198,7 +3234,7 @@ communication (bugs, feature requests, etc.) s/microsoft(?!.com)/MicroSuck/i - This is - a substitution. MicroSuck will replace any occurence of + a substitution. MicroSuck will replace any occurrence of microsoft. The i at the end of the expression means ignore case. The (?!.com) means the match should fail if microsoft is followed by @@ -3245,6 +3281,9 @@ communication (bugs, feature requests, etc.) Temple Place - Suite 330, Boston, MA 02111-1307, USA. $Log: user-manual.sgml,v $ + Revision 1.29 2002/03/02 20:34:07 david__schmidt + Update OS/2 build section + Revision 1.28 2002/02/24 14:34:24 jongfoster Formatting changes. Now changing the doctype to DocBook XML 4.1 will work - no other changes are needed. -- 2.39.2