X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=42f0b4e559e5be39ca21928c7dafc4744c7743f6;hb=8fde31719c9ebdcddd3e786501dc7d65309de687;hp=aa5b7d97b2ba1614db3341d919a5f6a56be4d615;hpb=4aa8fafb44ae7cb6c38cd8fb9a08e5a2c3c8ba49;p=privoxy.git diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index aa5b7d97..42f0b4e5 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.2 2001/09/13 15:27:40 swa Exp $ + $Id: user-manual.sgml,v 1.21 2001/10/31 21:11:03 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.2 2001/09/13 15:27:40 swa Exp $ +$Id: user-manual.sgml,v 1.21 2001/10/31 21:11:03 hal9 Exp $ @@ -48,7 +48,7 @@ Hal Burgiss security to users of the World Wide Web. -You can find the latest version of the user manual at http://ijbswa.sourceforge.net/doc/user-manual/. +You can find the latest version of the user manual at http://ijbswa.sourceforge.net/user-manual/. @@ -65,11 +65,11 @@ You can find the latest version of the user manual at Internet Junkbuster and is incomplete at this point. The most up to date reference for the time being is still the comments in the source files and in the individual configuration files. Development - of version 3.0 is currently underway, and includes significant changes and - enhancements over earlier verions. + of version 3.0 is currently underway, and includes many significant changes and + enhancements over earlier verions. The target release date for stable v3.0 is + December 2001. - Since this is a development version, there are bugs! + Since this is a development version, some features are in the process of + being implemented. This documentation may be slightly out of sync as a + result. And there are bugs, though hopefully not many! - + -License +New Features - Internet Junkbuster is free software; you can - redistribute it and/or modify it under the terms of the GNU General Public - License as published by the Free Software Foundation; either version 2 of the - License, or (at your option) any later version. + In addition to Junkbuster's traditional features + of ad and banner blocking and cookie management, this is a list of new + features currently under development: - This program is distributed in the hope that it will be useful, but WITHOUT - ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS - FOR A PARTICULAR PURPOSE. See the GNU General Public License for more - details, which is available from the Free Software Foundation, - Inc, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - + - + + + A browser based configuration utility (WIP at + http://i.j.b). + + - + + + Modularized configuration that will allow for system wide settings, and + individual user settings. (not implemented yet) + + + + + Blocking of annoying pop-up browser windows (previously available as a + patch). + + - + + + Support for HTTP/1.1 (partially implemented at this point). + + + + + + Support for Perl Compatible Regular Expressions in the configuration files, and + generally a more sophisticated configuration syntax over previous versions. + + + + + + Web page content filtering. + + + + + + Multi-threaded. + + + + + - -History - Junkbuster was originally written by Anonymouse - Coders and JunkBusters - Corporation, and was released as free open-source software under the - GNU GPL. Stefan - Waldherr made many improvements, and started the SourceForge project to - rekindle development. The last stable release was v2.0.2. + In addition, the configuration is more versatile overall. @@ -138,10 +167,11 @@ You can find the latest version of the user manual at Junkbuster Home Page - for current releases. Junkbuster is also available + for current release info. Junkbuster is also available via CVS. - This is the recommended approach at this time. + This is the recommended approach at this time. But please be aware that CVS + is constantly changing, and it may break in mysterious ways. @@ -152,8 +182,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: - ./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) @@ -203,6 +234,8 @@ You can find the latest version of the user manual at -    /usr/src/redhat/SRPMS/junkbuster-2.9.8-1.src.rpm +    /usr/src/redhat/SRPMS/junkbuster-2.9.9-1.src.rpm @@ -225,7 +258,7 @@ You can find the latest version of the user manual at + autoheader [suggested for CVS source] + autoconf [suggested for CVS source] ./configure make suse-dist @@ -255,10 +290,10 @@ You can find the latest version of the user manual at - rpm -Uvv /usr/src/suse/RPMS/i686/junkbuster-2.9.8-1.i686.rpm + rpm -Uvv /usr/src/packages/RPMS/i686/junkbuster-2.9.9-1.i686.rpm @@ -335,15 +370,24 @@ Thanx David Schmidt! Windows -I need help on this. Not a clue here. Also for -configuration section below. +Click-click. (I need help on this. Not a clue here. Also for +configuration section below. HB.) Other -I need help on this too. What others? + + Some quick notes on other Operating Systems. + + + For FreeBSD (and other *BSDs?), the build will need 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. + + @@ -354,11 +398,12 @@ configuration section below. Junkbuster Configuration - For Unix and Linux, all configuraton files are located in - /etc/junkbuster/ by default. For MS Windows, these - are all in the same directory as the Junkbuster - executable. The name and number of configuration files has changed from - previous versions, and is subject to change as development progresses. + For Unix, *BSD and Linux, all configuraton 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 + configuration files has changed from previous versions, and is subject to + change as development progresses. @@ -373,14 +418,20 @@ configuration section below. The main configuration file is named config - on Linux and Unix, and junkbustr.txt on Windows. + on Linux, Unix, BSD, and OS/2, and junkbustr.txt on + Windows. On Amiga, it is + AmiTCP:db/junkbuster/config. The actionsfile file is used to define various - actions relating to images, banners, pop-ups, banners and cookies. + 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.) @@ -403,6 +454,12 @@ configuration section below. for the changes to take effect. + + While under development, the configuration content is subject to change. + The below documentation may not be accurate by the time you read this. + Also, what constitutes a default setting, may change, so + please check all your configuration files on important issues. + @@ -410,7 +467,7 @@ configuration section below. The Main Configuration File Again, the main configuration file is named config on - Linux and Unix, and junkbustr.txt on Windows. + Linux/Unix/BSD and OS/2, and junkbustr.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: @@ -431,7 +488,7 @@ configuration section below. - The # indicates a comment. Any part of a + A # indicates a comment. Any part of a line following a # is ignored, except if the # is preceded by a \. @@ -455,7 +512,7 @@ configuration section below. There are various aspects of Junkbuster behavior - that can be adjusted. + that can be tuned. @@ -473,8 +530,8 @@ configuration section below. On Windows, Junkbuster - looks for these files in the same directory as the executable. On Unix, - Junkbuster looks for these files in the current + 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 avoid problems. @@ -718,10 +775,10 @@ configuration section below. serve requests from other machines (e.g. on your local network) as well, you will need to override the default. The syntax is listen-address [<ip-address>]:<port>. If you leave - out the IP adress, junkbuster will bind to all + out the IP address, junkbuster will bind to all interfaces (addresses) on your machine and may become reachable from the - internet. In that case, consider using access control lists (acl's) (see - aclfile above). + Internet. In that case, consider using access control lists (acl's) (see + aclfile above), or a firewall. @@ -865,20 +922,22 @@ configuration section below. The Windows version of Junkbuster puts an icon in - the system tray, which allows you to change this option without having to - edit this file. If you right-click on that icon (or select the - Options menu), one 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. + the system tray, which also allows you to change this option. If you + right-click on that icon (or select the Options menu), one + 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 + be toggled via a web browser at the Junkbuster + internal address of http://i.j.b./ on + any platform. toggle 1 means Junkbuster runs normally, toggle 0 means that Junkbuster becomes a non-anonymizing non-blocking - proxy. Default: 1. + proxy. Default: 1 (on). @@ -891,6 +950,84 @@ configuration section below. + + For content filtering, i.e. the +filter and + +deanimate-gif actions, it is neccessary 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. + + + + The buffer-limit option lets you set the maximum + size in Kbytes that each buffer may use. When the documents buffer exceeds + this size, it is flushed to the client unfiltered and no further attempt to + filter the rest of it is made. Remember that there may multiple threads + running, which might require increasing the buffer-limit + Kbytes each, unless you have enabled + single-threaded above. + + + + + + + buffer-limit 4069 + + + + + + + To enable the web-based actionsfile 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./. + + + + Security note: If this is enabled, anyone who can use the proxy + can edit the actions file, and their changes will affect all users. + For shared proxies, you probably want to disable this. Default: enabled. + + + + + + + enable-edit-actions 1 + + + + + + + Allow JunkBuster to be toggled on and off + remotely, using your web browser. Set enable-remote-toggleto + 1 to enable, and 0 to disable. Note that you must have compiled + JunkBuster with support for this feature, + otherwise this option has no effect. + + + + Security note: If this is enabled, anyone who can use the proxy can toggle + 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. + + + + + + + enable-remote-toggle 1 + + + + + @@ -1124,10 +1261,11 @@ configuration section below. Forwarding - This feature allows routing of HTTP requests via multiple proxies. + This feature allows chaining of HTTP requests via multiple proxies. It can be used to better protect privacy and confidentiality when accessing specific domains by routing requests to those domains - to a special purpose filtering proxy such as lpwa.com. + to a special purpose filtering proxy such as lpwa.com. Or to use + a caching proxy to speed up browsing. @@ -1269,7 +1407,7 @@ configuration section below. - forward_socks4 .* lpwa.com:8000 firewall.my_company.com:1080 + forward-socks4 .* lpwa.com:8000 firewall.my_company.com:1080 forward my_company.com . @@ -1284,7 +1422,7 @@ configuration section below. - forward_socks4a .* . firewall.my_company.com:1080 + forward-socks4a .* . firewall.my_company.com:1080 @@ -1382,8 +1520,11 @@ configuration section below. # Define junkbuster as parent cache + + cache_peer 127.0.0.1 parent 8000 0 no-query + # Define ACL for protocol FTP acl FTP proto FTP @@ -1605,10 +1746,18 @@ Removed references to Win32. HB 09/23/01 url="http://i.j.b/show-url-info">http://i.j.b/show-url-info. + + The actions file can be edited with a browser by loading + http://i.j.b, and then select + Edit Actions. + + There are four types of lines in this file: comments (begin with a # character), actions, aliases and patterns, all of which are - explained below. + explained below, as well as the configuration file syntax that + Junkbuster understands. + @@ -1873,7 +2022,26 @@ Removed references to Win32. HB 09/23/01 - + + + + +downgrade will downgrade HTTP/1.1 client requests to + HTTP/1.0 and downgrade the responses as well. Use this action for servers + that use HTTP/1.1 protocol features that + Junkbuster doesn't handle well yet. HTTP/1.1 + is only partially implemented. Default is not to downgrade requests. + + + + + + +downgrade + + + + + + Many sites, like yahoo.com, don't just link to other sites. Instead, they @@ -2079,6 +2247,66 @@ Removed references to Win32. HB 09/23/01 + + + By default (i.e. in the absence of a +limit-connect + action), Junkbuster will only allow CONNECT + requests to port 443, which is the standard port for https as a + precaution. + + + + The CONNECT methods exists in HTTP to allow access to secure websites + (https:// URLs) through proxies. It works very simply: the proxy + connects to the server on the specified port, and then short-circuits + its connections to the client and to the remote proxy. + This can be a big security hole, since CONNECT-enabled proxies can + be abused as TCP relays very easily. + + + + If you want to allow CONNECT for more ports than this, or want to forbid + CONNECT altogether, you can specify a comma separated list of ports and + port ranges (the latter using dashes, with the minimum defaulting to 0 and + max to 65K): + + + + + + + +limit-connect{443} # This is the default and need no be specified. + +limit-connect{80,443} # Ports 80 and 443 are OK. + +limit-connect{-3, 7, 20-100, 500-} # Port less than 3, 7, 20 to 100 + #and above 500 are OK. + + + + + + + + + + +no-compression prevents the website from compressing the + data. Some websites do this, which can be a problem for + Junkbuster, since +filter, + +no-popup and +gif-deanimate will not work on + compressed data. This will slow down connections to those websites, + though. Default is nocompression is turned on. + + + + + + + +nocompression + + + + + + Prevent the website from reading cookies: @@ -2313,13 +2541,15 @@ Removed references to Win32. HB 09/23/01 Aliases Custom actions, known to Junkbuster - as aliases, can be defined by combing other actions. + as aliases, can be defined by combining other actions. These can in turn be invoked just like the built-in actions. Currently, an alias can contain any character except space, tab, =, { or }. But please use only a- z, 0-9, +, and - -. Alias names are not case sensitive, and must be defined - before they are used. + -. Alias names are not case sensitive, and + must be defined before anything else in + actionsfile! And there can only be one set of + aliases defined. @@ -2330,10 +2560,8 @@ Removed references to Win32. HB 09/23/01 - # Aliases + # Useful customer aliases we can use later. These must come first! {{alias}} - - # Useful aliases +no-cookies = +no-cookies-set +no-cookies-read -no-cookies = -no-cookies-set -no-cookies-read fragile = -block -no-cookies -filter -fast-redirects -hide-referer -no-popups @@ -2365,6 +2593,7 @@ Removed references to Win32. HB 09/23/01 {fragile} .office.microsoft.com .windowsupdate.microsoft.com + .nytimes.com # Shopping sites - still want to block ads. {shop} @@ -2460,27 +2689,234 @@ Removed references to Win32. HB 09/23/01 Quickstart to Using Junkbuster -To be filled. + + Install package, then run and enjoy! Junbuster + accepts only one command line option -- the configuration file to be + used. Example Unix startup command: + + + + + + # /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 + on the command line and no default configuration file can be found, + Junkbuster will fail to start. + + + + Be sure your browser is set to use the proxy which is by default at + localhost, port 8000. With Netscape (and + Mozilla), this can be set under Edit + -> Preferences -> Advanced -> Proxies -> HTTP Proxy. + For Internet Explorer: Tools > + Internet Properties -> Connections -> LAN Setting. Then, + check Use Proxy and fill in the appropriate info (Address: + localhost, Port: 8000). Include if HTTPS proxy support too. + + + + 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 + Junkbuster handle this. In which case, the + browser(s) should be set to accept all cookies. + + + + If a particular site shows problems loading properly, try adding it + to the {fragile} section of + actionsfile. This will turn off most actions for + this site. + + + + 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. + For Mozilla, look under Edit -> Preferences -> Debug -> + Networking. Or set the +downgrade config option in + actionsfile. + + + + 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) + can be adjusted by pointing your browser to + 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.) + + + In fact, various aspects of Junkbuster + 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 + editor mentioned above, Junkbuster can also + be turned on and off from this page. + + + + If you encounter problems, please verify it is a + Junkbuster bug, by disabling + Junkbuster, and then trying the same page. + Also, try another browser if possible to eliminate browser or site + problems. Before reporting it as a bug, see if there is not a configuration + option that is enabled that is causing the page not to load. You can + then add an exception for that page or site. If a bug, please report it to + the developers (see below). + + -Contact the developers -To be filled. mention the support forums as the primary channel of +Contact the Developers + + + Feature requests and other questions should be posted to the Feature + request page at SourceForge. There is also an archive there. + + + Anyone interested in actively participating in development and related + discussions can join the appropriate mailing list + here. + Archives are available here too. + + + + Please report bugs, using the form at + Sourceforge. + Please try to verify that it is a Junkbuster bug, + and not a browser or site bug first. Also, check to make sure this is not + already a known bug. + + + Copyright and History -To be filled. + + +License + + Internet Junkbuster is free software; you can + redistribute it and/or modify it under the terms of the GNU General Public + License as published by the Free Software Foundation; either version 2 of the + License, or (at your option) any later version. + + + + This program is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + details, which is available from the Free Software Foundation, + Inc, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + + + + + + + + + +History + + Junkbuster was originally written by Anonymous + Coders and JunkBusters + Corporation, and was released as free open-source software under the + GNU GPL. Stefan + Waldherr made many improvements, and started the SourceForge project to + rekindle development. The last stable release was v2.0.2, which has now + grown whiskers ;-). + + + + See also -To be filled. + + + + +   http://sourceforge.net/projects/ijbswa + + + + +   http://ijbswa.sourceforge.net/ + + + + +   http://i.j.b./ + + + + +   http://www.junkbusters.com/ht/en/cookies.html + + + + +   http://www.waldherr.org/junkbuster/ + + + + +   http://privacy.net/analyze/ + + + + +  http://www.squid-cache.org/ + + + @@ -2494,7 +2930,228 @@ communication (bugs, feature requests, etc.) Regular Expressions - WIP + Junkbuster can use regular expressions + in various config files. Assuming support for 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 + URLs. + + + + If you are reading this, you probably don't understand what regular + expressions are, or what they can do. So this will be a very brief + introduction only. A full explanation would require a book ;-) + + + + Regular expressions is a way of matching one character + 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 + 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 + 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 + more specific and use ? to match just individual + characters. So dir file?.text would match + file1.txt, file2.txt, etc. We are pattern + matching, using a similar technique to regular expressions! + + + + Regular expressions do essentially the same thing, but are much, much more + powerful. There are many more special characters and ways of + building complex patterns however. Let's look at a few of the common ones, + and then some examples: + + + + + . - Matches any single character, e.g. a, + A, 4, :, or @. + + + + + + ? - The preceding character or expression is matched ZERO or ONE + times. Either/or. + + + + + + + - The preceding character or expression is matched ONE or MORE + times. + + + + + + * - The preceding character or expression is matched ZERO or MORE + times. + + + + + + \ - 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. + + + + + + [] - Characters enclosed in brackets will be matched if + any of the enclosed characters are encountered. + + + + + + () - Pararentheses are used to group a sub-expression, + or multiple sub-expressions. + + + + + + | - The bar character works like an + or conditional statement. A match is successful if the + sub-expression on either side of | matches. + + + + + + s/string1/string2/g - This is used to rewrite strings of text. + string1 is replaced by string2 in this + example. + + + + + These are just some of the ones you are likely to use when matching URLs with + Junkbuster, and is a long way from a definitive + list. This is enough to get us started with a few simple examples which may + be more illuminating: + + + + /.*/banners/.* - A simple example + that uses the common combination of . and * to + denote any character, zero or more times. In other words, any string at all. + So we start with a literal forward slash, then our regular expression pattern + (.*) another literal forward slash, the string + banners, another forward slash, and lastly another + .*. We are building + a directory path here. This will match any file with the path that has a + directory named banners in it. The .* matches + any characters, and this could conceivably be more forward slashes, so it + might expand into a much longer looking path. For example, this could match: + /eye/hate/spammers/banners/annoy_me_please.gif, or just + /banners/annoying.html, or almost an infinite number of other + possible combinations, just so it has banners in the path + somewhere. + + + + A now something a little more complex: + + + + /.*/adv((er)?ts?|ertis(ing|ements?))?/ - + We have several literal forward slashes again (/), so we are + building another expression that is a file path statement. We have another + .*, so we are matching against any conceivable sub-path, just so + it matches our expression. The only true literal that must + match our pattern is adv, together with + the forward slashes. What comes after the adv string is the + interesting part. + + + + Remember the ? means the preceding expression (either a + literal character or anything grouped with (...) in this case) + can exist or not, since this means either zero or one match. So + ((er)?ts?|ertis(ing|ements?)) is optional, as are the + individual sub-expressions: (er), + (ing|ements?), and the s. The | + means or. We have two of those. For instance, + (ing|ements?), can expand to match either ing + OR ements?. What is being done here, is an + attempt at matching as many variations of advertisement, and + similar, as possible. So this would expand to match just adv, + or advert, or adverts, or + advertising, or advertisement, or + advertisements. You get the idea. But it would not match + advertizements (with a z). We could fix that by + changing our regular expression to: + /.*/adv((er)?ts?|erti(s|z)(ing|ements?))?/, which would then match + either spelling. + + + + /.*/advert[0-9]+\.(gif|jpe?g) - Again + another path statement with forward slashes. Anything in the square brackets + [] can be matched. This is using 0-9 as a + shorthand expression to mean any digit one through nine. It is the same as + saying 0123456789. So any digit matches. The + + means one or more of the preceding expression must be included. The preceding + expression here is what is in the square brackets -- in this case, any digit + one through nine. Then, at the end, we have a grouping: (gif|jpe?g). + This includes a |, so this needs to match the expression on + either side of that bar character also. A simple gif on one side, and the other + side will in turn match either jpeg or jpg, + since the ? means the letter e is optional and + can be matched once or not at all. So we are building an expression here to + match image GIF or JPEG type image file. It must include the literal + string advert, then one or more digits, and a . + (which is now a literal, and not a special character, since it is escaped + with \), and lastly either gif, or + jpeg, or jpg. Some possible matches would + include: //advert1.jpg, + /nasty/ads/advert1234.gif, + /banners/from/hell/advert99.jpg. It would not match + advert1.gif (no leading slash), or + /adverts232.jpg (the expression does not include an + s), or /advert1.jsp (jsp is not + in the expression anywhere). + + + + s/microsoft(?!.com)/MicroSuck/i - This is + a substitution. MicroSuck will replace any occurence 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 + .com. In other words, this acts like a NOT + modifier. In case this is a hyperlink, we don't want to break it ;-). + + + + We are barely scratching the surface of regular expressions here so that you + can understand the default Junkbuster + configuration files, and maybe use this knowledge to customize your own + installation. There is much, much more that can be done with regular + expressions. Now that you know enough to get started, you can learn more on + your own :/ + + + + More reading on Perl Compatible Regular expressions: + http://www.perldoc.com/perl5.6/pod/perlre.html @@ -2522,6 +3179,42 @@ communication (bugs, feature requests, etc.) Temple Place - Suite 330, Boston, MA 02111-1307, USA. $Log: user-manual.sgml,v $ + 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 *** + + Revision 1.17 2001/10/24 17:10:55 hal9 + Catching up with Jon's recent work, and a few other things. + + Revision 1.16 2001/10/21 17:19:21 swa + wrong url in documentation + + Revision 1.15 2001/10/14 23:46:24 hal9 + Various minor changes. Fleshed out SEE ALSO section. + + Revision 1.13 2001/10/10 17:28:33 hal9 + Very minor changes. + + Revision 1.12 2001/09/28 02:57:04 hal9 + Ditto :/ + + Revision 1.11 2001/09/28 02:25:20 hal9 + Ditto. + + Revision 1.9 2001/09/27 23:50:29 hal9 + A few changes. A short section on regular expression in appendix. + + Revision 1.8 2001/09/25 00:34:59 hal9 + Some additions, and re-arranging. + + Revision 1.7 2001/09/24 14:31:36 hal9 + Diddling. + + Revision 1.6 2001/09/24 14:10:32 hal9 + Including David's OS/2 installation instructions. + Revision 1.2 2001/09/13 15:27:40 swa cosmetics