.\" Hal Burgiss <hal@foobox.net> \r
.\" for Junkbuster developers: ijbswa-developers@lists.sourceforge.net\r
.\"\r
-.TH JUNKBUSTER 1 "v2.9.10 (alpha) Date: 2001/12/01"\r
+.TH JUNKBUSTER 1 "v2.9.11 (beta) Date: 2002/03/06"\r
\r
.SH NAME\r
\fBjunkbuster\fP\r
\s-2(TM)\s+2\r
.SH SYNOPSIS\r
\fBjunkbuster\fP\r
-\fI\&[config_file]\fP\r
-.br\r
+[--help] [--version] [--no-daemon] [--pidfile \fIPID_FILE\fP] [--user USER] \r
+\fI\&[config_file]\fP (Unix)\r
+.TP\r
\fBjunkbstr.exe\fP\r
\fI\&[config_file]\fP\r
(Windows)\r
.br\r
-.P\r
-If the configuration file is not specified on the command line,\r
-\fBJunkbuster\fP will look for a file named \fIconfig\fP in the \r
-current directory (except on Amiga where it will look for \r
-\fIAmiTCP:db/junkbuster/config\fP and Win32 where it will try \r
-\fIconfig.txt\fP).\r
+\r
+.SH OPTIONS\r
+\fBJunkbuster\fP may be invoked with the following command-line options:\r
+.TP\r
+.BR --version " (unix only)"\r
+Print version info and exit.\r
+.TP\r
+.BR --help " (unix only)"\r
+Print a short usage info and exit.\r
+.TP\r
+.BR --no-daemon " (unix only)"\r
+Don't become a daemon, i.e. don't fork and become process group\r
+leader, don't detach from controlling tty.\r
+.TP\r
+\fB --pidfile\fP \fIPID_FILE\fP (unix only)\r
+On startup, write the process ID to \fIpidfile\fP. Delete the\r
+\fIpidfile\fP on exit. Failiure to create or delete the\r
+\fIpidfile\fP is non-fatal. If no \fB--pidfile\fP option\r
+is given, no PID file will be used.\r
+.TP\r
+\fB --user\fP \fIUSER\fP (unix only)\r
+After (optionally) writing the PID file, assume the user ID\r
+of \fIuser\fP. Exit if the privileges are not sufficient to\r
+do so.\r
+\r
+.PP\r
+If the \fIconfig file\fP is not specified on the command line,\r
+\fBJunkbuster\fP will look for a file named \fBconfig\fP in the \r
+current directory (except on Win32 where it will try \fBconfig.txt\fP).\r
\r
\r
.SH DESCRIPTION\r
Browsers must be configured to use \r
\fBJunkbuster\fP\r
(the default is localhost, \r
-port 8000).\r
+port 8118).\r
To set the \r
\s-2HTTP\s0\r
proxy in Netscape and Mozilla,\r
\fB\&Connections\fP;\r
\fB\&LAN Settings\fP.\r
.P\r
-Set the HTTP proxy location for localhost, port 8000.\r
+Set the HTTP proxy location for localhost, port 8118.\r
The\r
Secure (SSL) Proxy\" ijbfaq.html#security\r
should also be set to the same values,\r
\fB\&https:\fP\r
\s-2URL\s0s\r
won't be proxied.\r
+.P\r
+For other browsers, check the documentation.\r
\r
.SH CONFIGURATION\r
-All \fBJunkbuster\fP configuration is done via the various configuarion \r
+\fBJunkbuster\fP can be configured with the various configuration \r
files. The default configuration files are: \fIconfig\fP, \r
\fIijb.action\fP, and \fIre_filterfile\fP. These are well commented. \r
On Unix and Unix-like systems, these are located in \fI/etc/junkbuster/\fP \r
-by default. On Windows and OS/2, these files are in the same directory \r
+by default. On Windows, OS/2 and AmigaOS, these files are in the same directory \r
as the \fBJunkbuster\fP executable. \r
.P\r
The name and number of configuration files has changed from previous versions,\r
itself is changed and much more sophisticated. See the user-manual for a brief\r
explanation of all configuration options.\r
.P\r
-\fBJunkbuster's\fP configuration parameters can be viewed at\r
-\fIhttp://i.j.b./\fP. This is an internal page. In\r
-addition, the \fIijb.action\fP file can be edited here, and \fBJunkbuster\fP can\r
-be toggled on/off.\r
+The actions list (ad blocks, etc) can also be configured with your \r
+web browser at \fIhttp://ijbswa.sourceforge.net/config\fP.\r
+\fBJunkbuster's\fP configuration parameters can also be viewed at\r
+at the same page. In addition, \fBJunkbuster\fP can be toggled on/off.\r
+This is an internal page. \r
\r
.SH "SAMPLE CONFIGURATION"\r
.PP\r
\r
# Now set exceptions to the above defined policies #######\r
\r
-# Sites that DO need persistant cookies\r
+# Sites where we want persistant cookies\r
{-no-cookies -no-cookies-keep}\r
.redhat.com\r
.sun.com\r
+add-header{X-User-Tracking: No thanks!} -filter}\r
privacy.net\r
\r
+# Block, and treat these URLs as 'images'.\r
{+imageblock}\r
.adforce.imgis.com\r
.ad.preferences.com/image.*\r
.br\r
\fI/etc/junkbuster/ijb.action\fP\r
.br\r
+\fI/etc/junkbuster/ijb-advanced.action\fP\r
+.br\r
+\fI/etc/junkbuster/ijb-basic.action\fP\r
+.br\r
+\fI/etc/junkbuster/ijb-intermediate.action\fP\r
+.br\r
\fI/etc/junkbuster/re_filterfile\fP\r
.br\r
+\fI/etc/junkbuster/trust\fP\r
+.br\r
+\fI/etc/junkbuster/templates/*\fP\r
+.br\r
\fI/var/log/junkbuster/logfile\fP\r
\r
.P\r
and build configuration. More documentation should be included in the local\r
documentation directory, though is not complete at this time.\r
\r
+.SH SIGNALS\r
+\fBJunkbuster\fP teriminates on the \fBSIGINT\fP, \fBSIGTERM\fP and \fBSIGABRT\fP\r
+signals. Log rotation scripts may cause a re-opening of the logfile by sending\r
+a \fBSIGHUP\fP to \fBJunkbuster\fP. Note that unlike other daemons, \fBJunkbuster\fP\r
+does not need to be made aware of config file changes by \fBSIGHUP\fP -- it will\r
+detect them automatically.\r
+ \r
.SH NOTES\r
-This is a development version of \fBJunkbuster\fP. Not all features are \r
+This is a \fBBETA\fP version of \fBJunkbuster\fP. Not all features are \r
complete.\r
+.br\r
+Please see the user-maual on how to contact the developers for \r
+feature requests, reporting problems, and other questions.\r
\r
.SH BUGS\r
-Yes. HTTP/1.1 support is only partially implemented. See the user-manual for \r
-how and where to report bugs.\r
+Probably. Please see the user-manual for how and where to report bugs.\r
\r
.SH SEE ALSO\r
.br\r
-http://i.j.b./\r
+http://ijbswa.sourceforge.net/config\r
.br\r
http://ijbswa.sourceforge.net/\r
.br\r
http://privacy.net/analyze/\r
.br\r
http://www.squid-cache.org/\r
+.br\r
+http://linuxalpha.ch/packages/\r
\r
.SH DEVELOPMENT TEAM\r
.br\r
.br\r
Haroon Rafique\r
.br\r
- Jorg Strohmayer\r
+ Joerg Strohmayer\r
.br\r
Shamim Mohamed\r
.br\r
projects / privoxy.git / blobdiff