1 .\" Revised man page 10/13/01, for development version.
2 .\" Hal Burgiss <hal@foobox.net>
3 .\" for Junkbuster developers: ijbswa-developers@lists.sourceforge.net
5 .TH JUNKBUSTER 1 "v2.9.11 (beta) Date: 2002/03/06"
15 [--help] [--version] [--no-daemon] [--pidfile \fIpidfile\fP] [--user \fIuser\fP[.\fIgroup\fP]]
16 \fI\&[configfile]\fP (Unix)
18 \fBjunkbstr.exe\fP \fI[configfile]\fP (Windows)
22 \fBJunkbuster\fP may be invoked with the following command-line options:
24 .BR --version " (unix only)"
25 Print version info and exit.
27 .BR --help " (unix only)"
28 Print a short usage info and exit.
30 .BR --no-daemon " (unix only)"
31 Don't become a daemon, i.e. don't fork and become process group
32 leader, don't detach from controlling tty, and do all logging
35 \fB --pidfile\fP \fIpidfile\fP (unix only)
36 On startup, write the process ID to \fIpidfile\fP. Delete the
37 \fIpidfile\fP on exit. Failiure to create or delete the
38 \fIpidfile\fP is non-fatal. If no \fB--pidfile\fP option
39 is given, no PID file will be used.
41 \fB --user\fP \fIuser\fP[.\fIgroup\fP] (unix only)
42 After (optionally) writing the PID file, assume the user ID
43 of \fIuser\fP and the GID of \fIgroup\fP, or, if the optional
44 \fIgroup\fP was not given, the default group of \fIuser\fP.
45 Exit if the privileges are not sufficient to do so.
48 If the \fIconfigfile\fP is not specified on the command line,
49 \fBJunkbuster\fP will look for a file named \fBconfig\fP in the
50 current directory (except on Win32 where it will try \fBconfig.txt\fP).
55 is an instrumentable HTTP proxy that filters the
58 web servers and browsers.
59 \fBJunkbuster\fP can be used to protect privacy, manage cookies, filter web
60 page content, manage access restrictions, and to discard such annoying Internet
61 junk as ads, banners, and pop-ups. Or whatever other annoyances strike your
64 .SH INSTALLATION AND USE
65 Browsers must be configured to use
67 (the default is localhost,
71 proxy in Netscape and Mozilla,
77 \fB\&Manual Proxy Configuration\fP;
80 For Internet Explorer,
83 \fB\&Internet Properties\fP;
87 Set the HTTP proxy location for localhost, port 8118.
89 Secure (SSL) Proxy\" ijbfaq.html#security
90 should also be set to the same values,
96 For other browsers, check the documentation.
99 \fBJunkbuster\fP can be configured with the various configuration
100 files. The default configuration files are: \fIconfig\fP,
101 \fIijb.action\fP, and \fIre_filterfile\fP. These are well commented.
102 On Unix and Unix-like systems, these are located in \fI/etc/junkbuster/\fP
103 by default. On Windows, OS/2 and AmigaOS, these files are in the same directory
104 as the \fBJunkbuster\fP executable.
106 The name and number of configuration files has changed from previous versions,
107 and is subject to change as development progresses. In fact, the configuration
108 itself is changed and much more sophisticated. See the user-manual for a brief
109 explanation of all configuration options.
111 The actions list (ad blocks, etc) can also be configured with your
112 web browser at \fIhttp://ijbswa.sourceforge.net/config\fP.
113 \fBJunkbuster's\fP configuration parameters can also be viewed
114 at the same page. In addition, \fBJunkbuster\fP can be toggled on/off.
115 This is an internal page.
117 .SH "SAMPLE CONFIGURATION"
119 A brief example of what an \fIijb.action\fP configuration might look like:
123 # Define a few useful custom aliases for later use
125 # Don't accept cookies
126 +no-cookies = +no-cookies-set +no-cookies-read
128 -no-cookies = -no-cookies-set -no-cookies-read
129 +imageblock = +block +image
131 ## Default Policies (actions) ############################
140 +hide-referer{forge} \\
143 +image-blocker{blank} \\
153 # Now set exceptions to the above defined policies #######
155 # Sites where we want persistant cookies
156 {-no-cookies -no-cookies-keep}
162 # This site requires cookies AND 'fast-redirects' on
163 {-no-cookies -no-cookies-keep -fast-redirects}
166 # Add custom headers, and turn off filtering of page source
167 {+add-header{X-Privacy: Yes please} #-add-header{*} \\
168 +add-header{X-User-Tracking: No thanks!} -filter}
171 # Block, and treat these URLs as 'images'.
174 .ad.preferences.com/image.*
176 .ad-adex3.flycast.com
179 .ad.de.doubleclick.net
180 /.*/count\\.cgi\\?.*df=
182 a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/
184 # Block any URLs that match these patterns
186 /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\\.(gif|jpe?g))
187 /.*/(plain|live|rotate)[-_.]?ads?/
188 /.*/(sponsor)s?[0-9]?/
189 /.*/ad(server|stream|juggler)\\.(cgi|pl|dll|exe)
191 /.*/adv((er)?ts?|ertis(ing|ements?))?/
194 /.*/advert[0-9]+\\.jpg
197 /images/.*/.*_anim\\.gif
199 /.*(ms)?backoff(ice)?.*\\.(gif|jpe?g)
200 195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|)
202 .images.yahoo.com/adv/
208 See the comments in the configuration files themselves, or the user-manual
209 for explanations of the above syntax, and other \fBJunkbuster\fP configuration
213 \fI/usr/sbin/junkbuster\fP
215 \fI/etc/junkbuster/config\fP
217 \fI/etc/junkbuster/ijb.action\fP
219 \fI/etc/junkbuster/ijb-advanced.action\fP
221 \fI/etc/junkbuster/ijb-basic.action\fP
223 \fI/etc/junkbuster/ijb-intermediate.action\fP
225 \fI/etc/junkbuster/re_filterfile\fP
227 \fI/etc/junkbuster/trust\fP
229 \fI/etc/junkbuster/templates/*\fP
231 \fI/var/log/junkbuster/logfile\fP
234 Various other files should be included, but may vary depending on platform
235 and build configuration. More documentation should be included in the local
236 documentation directory, though is not complete at this time.
239 \fBJunkbuster\fP teriminates on the \fBSIGINT\fP, \fBSIGTERM\fP and \fBSIGABRT\fP
240 signals. Log rotation scripts may cause a re-opening of the logfile by sending
241 a \fBSIGHUP\fP to \fBJunkbuster\fP. Note that unlike other daemons, \fBJunkbuster\fP
242 does not need to be made aware of config file changes by \fBSIGHUP\fP -- it will
243 detect them automatically.
246 This is a \fBBETA\fP version of \fBJunkbuster\fP. Not all features are
249 Please see the user-maual on how to contact the developers for
250 feature requests, reporting problems, and other questions.
253 Probably. Please see the user-manual for how and where to report bugs.
257 http://ijbswa.sourceforge.net/config
259 http://ijbswa.sourceforge.net/
261 http://sourceforge.net/projects/ijbswa
263 http://www.waldherr.org/junkbuster/\" waldherr.org#
265 http://www.junkbusters.com/ht/en/cookies.html\" cookies.html#
267 http://privacy.net/analyze/
269 http://www.squid-cache.org/
271 http://linuxalpha.ch/packages/
303 .SH COPYRIGHT AND LICENSE
304 Orginally written by, and copyrighted by, the Anonymous Coders and Junkbusters
307 This program is free software; you can redistribute it and/or modify
308 it under the terms of the GNU General Public License as published by
309 the Free Software Foundation; either version 2 of the License, or
310 (at your option) any later version.
312 This program is distributed in the hope that it will be useful,
313 but WITHOUT ANY WARRANTY; without even the implied warranty of
314 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
315 GNU General Public License for more details.
317 You should have received a copy of the GNU General Public License
318 along with this program; if not, write to the Free Software
319 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
324 trademark\" legal.html#marks
325 of Junkbusters Corporation.