X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=716d685622b628fd93a8362b0cde33fbeb8e9e87;hp=4217aae3aa5a10e99460f2b1acb12554c37bd063;hb=87d302855827404e449b725962accd92f5e720b2;hpb=fd82f567bc116ca4ce222fd9c82e257bf488a3ba;ds=sidebyside diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index 4217aae3..716d6856 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.30 2002/03/02 22:00:14 hal9 Exp $ + $Id: user-manual.sgml,v 1.39 2002/03/06 16:19:28 hal9 Exp $ Written by and Copyright (C) 2001 the SourceForge IJBSWA team. http://ijbswa.sourceforge.net @@ -28,7 +28,7 @@ Hal Burgiss Junkbuster User Manual -$Id: user-manual.sgml,v 1.30 2002/03/02 22:00:14 hal9 Exp $ +$Id: user-manual.sgml,v 1.39 2002/03/06 16:19:28 hal9 Exp $ @@ -62,22 +62,23 @@ You can find the latest version of the user manual at Introduction Internet Junkbuster is a web proxy with advanced - filtering capabilities for protecting privacy, filtering web page content, - managing cookies, controlling access, and removing ads, banners, pop-ups and - other obnoxious Internet Junk. Junkbuster has a - very flexible configuration and can be customized to suit individual needs - and tastes. Internet Junkbuster has application - for both stand-alone systems and multi-user networks. + filtering capabilities for protecting privacy, filtering and modifying web + page content, managing cookies, controlling access, and removing ads, + banners, pop-ups and other obnoxious Internet Junk. + Junkbuster has a very flexible configuration and + can be customized to suit individual needs and tastes. Internet + Junkbuster has application for both stand-alone systems and + multi-user networks. This documentation is included with the current BETA version of - Internet Junkbuster and is incomplete at this + Internet Junkbuster and mostly complete 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 nearing completion, and includes many significant changes and enhancements over earlier versions. The target release date for - stable v3.0 RSN. + stable v3.0 is soon ;-) @@ -225,7 +226,7 @@ You can find the latest version of the user manual at -    /usr/src/redhat/RPMS/i686/junkbuster-2.9.10-1.i686.rpm +    /usr/src/redhat/RPMS/i686/junkbuster-2.9.11-1.i686.rpm -    /usr/src/redhat/SRPMS/junkbuster-2.9.10-1.src.rpm +    /usr/src/redhat/SRPMS/junkbuster-2.9.11-1.src.rpm @@ -300,7 +301,7 @@ You can find the latest version of the user manual at -    /usr/src/packages/RPMS/i686/junkbuster-2.9.10-1.i686.rpm +    /usr/src/packages/RPMS/i686/junkbuster-2.9.11-1.i686.rpm -    /usr/src/packages/SRPMS/junkbuster-2.9.10-1.src.rpm +    /usr/src/packages/SRPMS/junkbuster-2.9.11-1.src.rpm @@ -344,7 +345,7 @@ You can find the latest version of the user manual at Junkbuster Configuration +Invoking and Configuring JunkBuster 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 + /etc/junkbuster/ by default. For MS Windows, OS/2, and + AmigaOS 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. @@ -467,9 +468,8 @@ configuration section below. HB.) The main configuration file is named config - on Linux, Unix, BSD, and OS/2, and config.txt on - Windows. On Amiga, it is - AmiTCP:db/junkbuster/config. + on Linux, Unix, BSD, OS/2, and AmigaOS and config.txt + on Windows. @@ -514,6 +514,89 @@ configuration section below. HB.) please check all your configuration files on important issues. + + + + + +Command Line Options + + JunkBuster may be invoked with the following + command-line options: + + + + + + + + --version + + + Print version info and exit, Unix only. + + + + + --help + + + Print a short usage info and exit, Unix only. + + + + + --no-daemon + + + Don't become a daemon, i.e. don't fork and become process group + leader, don't detach from controlling tty. Unix only. + + + + + --pidfile FILE + + + + On startup, write the process ID to FILE. Delete the + FILE on exit. Failiure to create or delete the + FILE is non-fatal. If no FILE + option is given, no PID file will be used. Unix only. + + + + + --user USER + + + + After (optionally) writing the PID file, assume the user ID of + USER. Exit if the privileges are not sufficient to do + so. Unix only. + + + + + configfile + + + If no configfile is included on the command line, + JunkBuster will look for a file named + config in the current directory (except on Win32 + where it will look for config.txt instead). Specify + full path to avoid confusion. + + + + + + + + + + + @@ -582,9 +665,10 @@ 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 + On Windows and AmigaOS, + 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 avoid problems. @@ -636,10 +720,11 @@ configuration section below. HB.) 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). 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 below. + filtered if re_filterfile specified according to the + contents of re_filterfile. No sites are blocked. The + JunkBuster logo is displayed for filtered ads and other images . The syntax + of this file is explained in detail below. @@ -661,6 +746,15 @@ configuration section below. HB.) content modification, or whatever the developers are playing with :-/ + + Filtering requires buffering the page content, which may appear to slow down + page rendering since nothing is displayed until all content has passed + the filters. (It does not really take longer, but seems that way since + the page is not incrementally displayed.) This effect will be more noticeable + on slower connections. + + + @@ -818,14 +912,14 @@ configuration section below. HB.) Listen-address specifies the address and port where Junkbuster will listen for connections from your - Web browser. The default is to listen on the localhost port 8000, and + Web browser. The default is to listen on the localhost port 8118, and this is suitable for most users. (In your web browser, under proxy configuration, list the proxy server as localhost and the - port as 8000). + port as 8118). - If you already have another service running on port 8000, or if you want to + If you already have another service running on port 8118, or if you want to 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 @@ -846,7 +940,7 @@ configuration section below. HB.) - listen-address 192.168.0.1:8000 + listen-address 192.168.0.1:8118 @@ -861,7 +955,7 @@ configuration section below. HB.) - listen-address :8000 + listen-address :8118 @@ -870,7 +964,7 @@ configuration section below. HB.) If you do this, consider using ACLs (see aclfile above). Note: you will need to point your browser(s) to the address and port that you have - configured here. Default: localhost:8000 (127.0.0.1:8000). + configured here. Default: localhost:8118 (127.0.0.1:8118). @@ -1509,7 +1603,7 @@ configuration section below. HB.) forward .* . - forward isp-b.com host-b:8000 + forward isp-b.com host-b:8118 @@ -1525,7 +1619,7 @@ configuration section below. HB.) forward .* . - forward isp-a.com host-a:8000 + forward isp-a.com host-a:8118 @@ -1575,9 +1669,9 @@ configuration section below. HB.) # Define junkbuster as parent cache - cache_peer 127.0.0.1 parent 8000 0 no-query + cache_peer 127.0.0.1 parent 8118 0 no-query # Define ACL for protocol FTP acl FTP proto FTP @@ -2820,22 +2914,21 @@ 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 config.txt. If no file is specified - on the command line and no default configuration file can be found, + config in the current directory. Except on Win32 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. Be sure your browser is set to use the proxy which is by default at - localhost, port 8000. With Netscape (and + localhost, port 8118. 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. + localhost, Port: 8118). Include if HTTPS proxy support too. @@ -2859,11 +2952,12 @@ 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 compatibility. - For Mozilla, look under Edit -> Preferences -> Debug -> - Networking. Or set the +downgrade config option in + Junkbuster is HTTP/1.1 compliant, but not all 1.1 + features are as yet 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 compatibility. For Mozilla, look + under Edit -> Preferences -> Debug -> Networking. + Or set the +downgrade config option in ijb.action. @@ -2903,15 +2997,32 @@ For RedHat: /etc/rc.d/init.d/junkbuster start -Contact the Developers +Contacting the Developers, Bug Reporting and Feature +Requests - - Feature requests and other questions should be posted to the Feature - request page at SourceForge. There is also an archive there. +We value your feedback. However, to provide you with the best support, +please note: + + Use the support forum to get + help. + Submit bugs only thru our bug + forum. +Make sure that the bug has not yet been submitted. 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. If you are using your own custom configuration, +please try the stock configs to see if the problem is a configuration +related bug. And if not using the latest development snapshot, please +try the latest one. Or even better, CVS sources. + + Submit feature requests only thru our feature request forum. + + + + +For any other issues, feel free to use the mailing lists. @@ -2921,14 +3032,6 @@ communication (bugs, feature requests, etc.) 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. - - @@ -2970,8 +3073,8 @@ communication (bugs, feature requests, etc.) 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 ;-). + rekindle development. There are now several active developers contributing. + The last stable release was v2.0.2, which has now grown whiskers ;-). @@ -3280,6 +3383,35 @@ communication (bugs, feature requests, etc.) Temple Place - Suite 330, Boston, MA 02111-1307, USA. $Log: user-manual.sgml,v $ + Revision 1.39 2002/03/06 16:19:28 hal9 + Note on perceived filtering slowdown per FR. + + Revision 1.38 2002/03/05 23:55:14 hal9 + Stupid I did it again. Double hyphen in comment breaks jade. + + Revision 1.37 2002/03/05 23:53:49 hal9 + jade barfs on '- -' embedded in comments. - -user option broke it. + + Revision 1.36 2002/03/05 22:53:28 hal9 + Add new - - user option. + + Revision 1.35 2002/03/05 00:17:27 hal9 + Added section on command line options. + + Revision 1.34 2002/03/04 19:32:07 oes + Changed default port to 8118 + + Revision 1.33 2002/03/03 19:46:13 hal9 + Emphasis on where/how to report bugs, etc + + Revision 1.32 2002/03/03 09:26:06 joergs + AmigaOS changes, config is now loaded from PROGDIR: instead of + AmiTCP:db/junkbuster/ if no configuration file is specified on the + command line. + + Revision 1.31 2002/03/02 22:45:52 david__schmidt + Just tweaking + Revision 1.30 2002/03/02 22:00:14 hal9 Updated 'New Features' list. Ran through spell-checker.