This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: user-manual.sgml,v 1.29 2002/03/02 20:34:07 david__schmidt 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
<artheader>
<title>Junkbuster User Manual</title>
-<pubdate>$Id: user-manual.sgml,v 1.29 2002/03/02 20:34:07 david__schmidt Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.39 2002/03/06 16:19:28 hal9 Exp $</pubdate>
<authorgroup>
<author>
<sect1 id="introduction"><title>Introduction</title>
<para>
<application>Internet Junkbuster</application> 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. <application>Junkbuster</application> has a
- very flexible configuration and can be customized to suit individual needs
- and tastes. <application>Internet Junkbuster</application> 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.
+ <application>Junkbuster</application> has a very flexible configuration and
+ can be customized to suit individual needs and tastes. <application>Internet
+ Junkbuster</application> has application for both stand-alone systems and
+ multi-user networks.
</para>
<para>
This documentation is included with the current BETA version of
- <application>Internet Junkbuster</application> and is incomplete at this
+ <application>Internet Junkbuster</application> 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 <quote>soon</quote> ;-)
</para>
<para>
<para>
<screen>
tar xzvf ijb_source_* [.tgz or .tar.gz]
- cd ijb_source_2.9.10_beta
+ cd ijb_source_2.9.11_beta
</screen>
</para>
</para>
<para>
- /usr/src/redhat/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
+ /usr/src/redhat/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
</para>
<para>
- /usr/src/redhat/SRPMS/junkbuster-2.9.10-1.src.rpm
+ /usr/src/redhat/SRPMS/junkbuster-2.9.11-1.src.rpm
</para>
<para>
<para>
<screen>
- rpm -Uvv /usr/src/redhat/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
+ rpm -Uvv /usr/src/redhat/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
</screen>
</para>
</para>
<para>
- /usr/src/packages/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
+ /usr/src/packages/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
</para>
<para>
- /usr/src/packages/SRPMS/junkbuster-2.9.10-1.src.rpm
+ /usr/src/packages/SRPMS/junkbuster-2.9.11-1.src.rpm
</para>
<para>
<para>
<screen>
- rpm -Uvv /usr/src/packages/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
+ rpm -Uvv /usr/src/packages/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
</screen>
</para>
<screen>
cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
- cd current
</screen>
This will create a directory named os2setup/, which will contain the
<filename>Makefile.vac</filename> makefile and <filename>os2build.cmd</filename>
<!-- ~~~~~ New section ~~~~~ -->
-<sect1 id="configuration"><title>Junkbuster Configuration</title>
+<sect1 id="configuration"><title>Invoking and Configuring JunkBuster</title>
<para>
For Unix, *BSD and Linux, all configuration files are located in
- <filename>/etc/junkbuster/</filename> by default. For MS Windows and OS/2,
- these are all in the same directory as the
+ <filename>/etc/junkbuster/</filename> by default. For MS Windows, OS/2, and
+ AmigaOS these are all in the same directory as the
<application>Junkbuster</application> executable. The name and number of
configuration files has changed from previous versions, and is subject to
change as development progresses.
<listitem>
<para>
The main configuration file is named <filename>config</filename>
- on Linux, Unix, BSD, and OS/2, and <filename>config.txt</filename> on
- Windows. On Amiga, it is
- <filename>AmiTCP:db/junkbuster/config</filename>.
+ on Linux, Unix, BSD, OS/2, and AmigaOS and <filename>config.txt</filename>
+ on Windows.
</para>
</listitem>
please check all your configuration files on important issues.
</para>
+
+
+<!-- ~~~~~ New section ~~~~~ -->
+
+<sect2>
+<title>Command Line Options</title>
+<para>
+ <application>JunkBuster</application> may be invoked with the following
+ command-line options:
+</para>
+
+<para>
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <emphasis>--version</emphasis>
+ </para>
+ <para>
+ Print version info and exit, Unix only.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>--help</emphasis>
+ </para>
+ <para>
+ Print a short usage info and exit, Unix only.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>--no-daemon</emphasis>
+ </para>
+ <para>
+ Don't become a daemon, i.e. don't fork and become process group
+ leader, don't detach from controlling tty. Unix only.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>--pidfile FILE</emphasis>
+
+ </para>
+ <para>
+ On startup, write the process ID to <emphasis>FILE</emphasis>. Delete the
+ <emphasis>FILE</emphasis> on exit. Failiure to create or delete the
+ <emphasis>FILE</emphasis> is non-fatal. If no <emphasis>FILE</emphasis>
+ option is given, no PID file will be used. Unix only.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>--user USER</emphasis>
+
+ </para>
+ <para>
+ After (optionally) writing the PID file, assume the user ID of
+ <emphasis>USER</emphasis>. Exit if the privileges are not sufficient to do
+ so. Unix only.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>configfile</emphasis>
+ </para>
+ <para>
+ If no <emphasis>configfile</emphasis> is included on the command line,
+ <application>JunkBuster</application> will look for a file named
+ <quote>config</quote> in the current directory (except on Win32
+ where it will look for <quote>config.txt</quote> instead). Specify
+ full path to avoid confusion.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+</para>
+
+</sect2>
+
+<!-- ~ End section ~ -->
+
+
<!-- ~~~~~ New section ~~~~~ -->
<sect2>
</para>
<para>
- On <application>Windows</application>, <application>Junkbuster</application>
- looks for these files in the same directory as the executable. On Unix and
- OS/2, <application>Junkbuster</application> looks for these files in the current
+ On <application>Windows</application> and <application>AmigaOS</application>,
+ <application>Junkbuster</application> looks for these files in the same
+ directory as the executable. On Unix and OS/2,
+ <application>Junkbuster</application> looks for these files in the current
working directory. In either case, an absolute path name can be used to
avoid problems.
</para>
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 <quote>re_filterfile</quote> specified. No sites are blocked. An
- empty image is displayed for filtered ads and other images (formerly
- <quote>tinygif</quote>). The syntax of this file is explained in detail <link
- linkend="actionsfile">below</link>.
+ filtered if <quote>re_filterfile</quote> specified according to the
+ contents of <quote>re_filterfile</quote>. No sites are blocked. The
+ JunkBuster logo is displayed for filtered ads and other images . The syntax
+ of this file is explained in detail <link
+ linkend="actionsfile">below</link>.
</para>
<para>
content modification, or whatever the developers are playing with :-/
</para>
+<para>
+ 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.
+
+</para>
+
<para>
<literal>
<msgtext>
<para>
<quote>Listen-address</quote> specifies the address and port where
<application>Junkbuster</application> 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 <quote>localhost</quote> and the
- port as <quote>8000</quote>).
+ port as <quote>8118</quote>).
</para>
<para>
- 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
<quote>listen-address [<ip-address>]:<port></quote>. If you leave
<literal>
<msgtext>
<literallayout>
- <emphasis>listen-address 192.168.0.1:8000</emphasis>
+ <emphasis>listen-address 192.168.0.1:8118</emphasis>
</literallayout>
</msgtext>
</literal>
<literal>
<msgtext>
<literallayout>
- <emphasis>listen-address :8000</emphasis>
+ <emphasis>listen-address :8118</emphasis>
</literallayout>
</msgtext>
</literal>
<para>
If you do this, consider using ACLs (see <quote>aclfile</quote> 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).
</para>
<para>
<msgtext>
<literallayout>
<emphasis>forward .* .</emphasis>
- <emphasis>forward isp-b.com host-b:8000</emphasis>
+ <emphasis>forward isp-b.com host-b:8118</emphasis>
</literallayout>
</msgtext>
</literal>
<msgtext>
<literallayout>
<emphasis>forward .* .</emphasis>
- <emphasis>forward isp-a.com host-a:8000</emphasis>
+ <emphasis>forward isp-a.com host-a:8118</emphasis>
</literallayout>
</msgtext>
</literal>
<literallayout>
# Define junkbuster as parent cache
<!-- per feedback from user...
- cache_peer 127.0.0.1 8000 parent 0 no-query
+ cache_peer 127.0.0.1 8118 parent 0 no-query
-->
- 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
<para>
If no configuration file is specified on the command line,
<application>Junkbuster</application> will look for a file named
- <filename>config</filename> in the current directory. Except on Amiga where
- it will look for <filename>AmiTCP:db/junkbuster/config</filename> and Win32
- where it will try <filename>config.txt</filename>. If no file is specified
- on the command line and no default configuration file can be found,
+ <filename>config</filename> in the current directory. Except on Win32 where
+ it will try <filename>config.txt</filename>. If no file is specified on the
+ command line and no default configuration file can be found,
<application>Junkbuster</application> will fail to start.
</para>
<para>
Be sure your browser is set to use the proxy which is by default at
- localhost, port 8
000. With <application>Netscape</application> (and
+ localhost, port 8
118. With <application>Netscape</application> (and
<application>Mozilla</application>), this can be set under <literal>Edit
-> Preferences -> Advanced -> Proxies -> HTTP Proxy</literal>.
For <application>Internet Explorer</application>: <literal>Tools >
Internet Properties -> Connections -> LAN Setting</literal>. Then,
check <quote>Use Proxy</quote> 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.
</para>
<para>
</para>
<para>
- HTTP/1.1 support is not fully implemented. If browsers that
- support HTTP/1.1 (like <application>Mozilla</application> or recent versions
- of I.E.) experience problems, you might try to force HTTP/1.0 compatibility.
- For Mozilla, look under <literal>Edit -> Preferences -> Debug ->
- Networking</literal>. Or set the <quote>+downgrade</quote> config option in
+ <application>Junkbuster</application> is HTTP/1.1 compliant, but not all 1.1
+ features are as yet implemented. If browsers that support HTTP/1.1 (like
+ <application>Mozilla</application> or recent versions of I.E.) experience
+ problems, you might try to force HTTP/1.0 compatibility. For Mozilla, look
+ under <literal>Edit -> Preferences -> Debug -> Networking</literal>.
+ Or set the <quote>+downgrade</quote> config option in
<filename>ijb.action</filename>.
</para>
<!-- ~~~~~ New section ~~~~~ -->
-<sect1 id="contact"><title>Contact the Developers</title>
+<sect1 id="contact"><title>Contacting the Developers, Bug Reporting and Feature
+Requests</title>
<para>
-<!--
-To be filled. mention the support forums as the primary channel of
-communication (bugs, feature requests, etc.)
--->
- Feature requests and other questions should be posted to the <ulink
- url="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse">Feature
- request page</ulink> at SourceForge. There is also an archive there.
+We value your feedback. However, to provide you with the best support,
+please note:
+ <simplelist>
+ <member>Use the <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=211118">support forum</ulink> to get
+ help.</member>
+ <member>Submit bugs only thru our <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=111118">bug
+ forum</ulink>.
+Make sure that the bug has not yet been submitted. Please try to
+verify that it is a <application>Junkbuster</application> 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.
+</member>
+ <member>Submit feature requests only thru our <ulink
+ url="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse">feature request forum</ulink>.</member>
+ </simplelist>
+</para>
+
+<para>
+For any other issues, feel free to use the <a
+href="http://sourceforge.net/mail/?group_id=11118">mailing lists</a>.
</para>
<para>
Archives are available here too.
</para>
-<para>
- Please report bugs, using the form at
- <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=111118">Sourceforge</ulink>.
- Please try to verify that it is a <application>Junkbuster</application> bug,
- and not a browser or site bug first. Also, check to make sure this is not
- already a known bug.
-</para>
-
</sect1>
GNU GPL. <ulink url="http://www.waldherr.org/junkbuster/">Stefan
Waldherr</ulink> made many improvements, and started the <ulink
url="http://sourceforge.net/projects/ijbswa/">SourceForge project</ulink> 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 ;-).
</para>
</sect2>
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.
+
Revision 1.29 2002/03/02 20:34:07 david__schmidt
Update OS/2 build section
projects / privoxy.git / blobdiff