This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: user-manual.sgml,v 1.34 2002/03/04 19:32:07 oes Exp $
+ $Id: user-manual.sgml,v 1.42 2002/03/07 18:16:55 swa 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.34 2002/03/04 19:32:07 oes Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.42 2002/03/07 18:16:55 swa Exp $</pubdate>
<authorgroup>
<author>
<abstract>
<para>
- The user manual gives the users information on how to install and configure
- <application>Internet Junkbuster</application>. <application>Internet
- Junkbuster</application> is an application that provides privacy and
- security to users of the World Wide Web.
+ The user manual gives users information on how to install, configure
+ and use <application>Internet Junkbuster</application>.
+ <application>Internet Junkbuster</application> is an application that
+ provides privacy and security to users of the World Wide Web.
</para>
<para>
You can find the latest version of the user manual at <ulink url="http://ijbswa.sourceforge.net/user-manual/">http://ijbswa.sourceforge.net/user-manual/</ulink>.
<para>
This documentation is included with the current BETA version of
- <application>Internet Junkbuster</application> and mostly complete at this
+ <application>Internet Junkbuster</application> and is 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
<para>
Since this is a BETA version, not all new features are well tested. This
- documentation may be slightly out of sync as a result. And there
- <emphasis>may be</emphasis> bugs, though hopefully not many!
+ documentation may be slightly out of sync as a result (especially with
+ CVS sources). And there <emphasis>may be</emphasis> bugs, though hopefully
+ not many!
</para>
<application>Junkbuster</application> is available as raw source code, or
pre-compiled binaries. See the <ulink
url="http://sourceforge.net/projects/ijbswa/">Junkbuster Home Page</ulink>
- for current release info. <application>Junkbuster</application> is also available
- via <ulink
+ for binaries and current release info. <application>Junkbuster</application>
+
is also available via <ulink
url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/">CVS</ulink>.
This is the recommended approach at this time. But please be aware that CVS
is constantly changing, and it may break in mysterious ways.
<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>
<!-- ~~~~~ New section ~~~~~ -->
-<sect1 id="configuration"><title>Invoking and Configuring Junkbuster</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, OS/2, and
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>
</listitem>
-
</itemizedlist>
</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>
<listitem>
<para>
Decides what to do with URLs that end up tagged with <quote>{+block
- +image}</quote>. There are 4 options. <quote>-image-blocker</quote> will
- send a HTML <quote>blocked</quote> page, usually resulting in a
- <quote>broken image</quote> icon. <quote>+image-blocker{logo}</quote> will
- send a <quote>JunkBuster</quote> image.
- <quote>+image-blocker{blank}</quote> will send a 1x1 transparent GIF image.
- And finally, <quote>+image-blocker{http://xyz.com}</quote> will send a HTTP
- temporary redirect to the specified image. This has the advantage of the
- icon being being cached by the browser, which will speed up the display.
+ +image}</quote>, e.g an advertizement. There are five options.
+ <quote>-image-blocker</quote> will send a HTML <quote>blocked</quote> page,
+ usually resulting in a <quote>broken image</quote> icon.
+ <quote>+image-blocker{logo}</quote> will send a <quote>JunkBuster</quote>
+ logo image. <quote>+image-blocker{blank}</quote> will send a 1x1
+ transparent GIF image. And finally,
+ <quote>+image-blocker{http://xyz.com}</quote> will send a HTTP temporary
+ redirect to the specified image. This has the advantage of the icon being
+ being cached by the browser, which will speed up the display.
+ <quote>+image-blocker{pattern}</quote> will send a checkboard type pattern,
+ which scales better than the logo (which can get blocky if the browser
+ enlarges it too much).
</para>
<para>
<literal>
<sect1 id="contact"><title>Contacting the Developers, Bug Reporting and Feature
Requests</title>
<para>
- Please do not use the mailing lists for feature requests or
- bug reports. They are not as easily tracked this way!
+We value your feedback. However, to provide you with the best support,
+please note:
+
+ <itemizedlist>
+
+ <listitem><para>Use the <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=211118">Sourceforge support forum</ulink> to get
+ help.</para></listitem>
+
+ <listitem><para>Submit bugs only thru our <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=111118">Sourceforge bug
+ forum</ulink>.
+Make sure that the bug has not already been submitted. Please try to
+verify that it is a <application>Junkbuster</application> bug, and not
+a browser or site bug first. 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.</para>
+</listitem>
+
+
+ <listitem><para>Submit feature requests only thru our <ulink
+ url="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse">Sourceforge feature request forum</ulink>.</para></listitem>
+
+
+ </itemizedlist>
</para>
<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.
+For any other issues, feel free to use the <ulink url="http://sourceforge.net/mail/?group_id=11118">mailing lists</ulink>.
</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. If you are using your own custom configuration, please
- try the stock configs to see if the problem is a configuration related bug.
-</para>
-
</sect1>
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: user-manual.sgml,v $
+ Revision 1.42 2002/03/07 18:16:55 swa
+ looks better
+
+ Revision 1.41 2002/03/07 16:46:43 hal9
+ Fix a few markup problems for jade.
+
+ Revision 1.40 2002/03/07 16:28:39 swa
+ provide correct feedback channels
+
+ 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
projects / privoxy.git / blobdiff