X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=junkbuster.1;h=01cbe9308cb125cf046b5720c480022955a12079;hb=2412eca92924e30e11ef37668bbaa22a23eb2b53;hp=18f11b7df0ec256108826e539cd2dc1e7a69eb2c;hpb=e7f33c16b512f119f65800e85ba0beecfd3a1545;p=privoxy.git diff --git a/junkbuster.1 b/junkbuster.1 index 18f11b7d..01cbe930 100644 --- a/junkbuster.1 +++ b/junkbuster.1 @@ -2,7 +2,7 @@ .\" Hal Burgiss .\" for Junkbuster developers: ijbswa-developers@lists.sourceforge.net .\" -.TH JUNKBUSTER 1 "v2.9.10 (beta) Date: 2001/12/30" +.TH JUNKBUSTER 1 "v2.9.11 (beta) Date: 2002/03/06" .SH NAME \fBjunkbuster\fP @@ -12,18 +12,43 @@ Proxy \s-2(TM)\s+2 .SH SYNOPSIS \fBjunkbuster\fP -\fI\&[config_file]\fP -.br +[--help] [--version] [--no-daemon] [--pidfile \fIPID_FILE\fP] [--user USER] +\fI\&[config_file]\fP (Unix) +.TP \fBjunkbstr.exe\fP \fI\&[config_file]\fP (Windows) .br -.P -If the configuration file is not specified on the command line, -\fBJunkbuster\fP will look for a file named \fIconfig\fP in the -current directory (except on Amiga where it will look for -\fIAmiTCP:db/junkbuster/config\fP and Win32 where it will try -\fIconfig.txt\fP). + +.SH OPTIONS +\fBJunkbuster\fP may be invoked with the following command-line options: +.TP +.BR --version " (unix only)" +Print version info and exit. +.TP +.BR --help " (unix only)" +Print a short usage info and exit. +.TP +.BR --no-daemon " (unix only)" +Don't become a daemon, i.e. don't fork and become process group +leader, don't detach from controlling tty, and do all logging +there. +.TP +\fB --pidfile\fP \fIPID_FILE\fP (unix only) +On startup, write the process ID to \fIpidfile\fP. Delete the +\fIpidfile\fP on exit. Failiure to create or delete the +\fIpidfile\fP is non-fatal. If no \fB--pidfile\fP option +is given, no PID file will be used. +.TP +\fB --user\fP \fIUSER\fP (unix only) +After (optionally) writing the PID file, assume the user ID +of \fIuser\fP. Exit if the privileges are not sufficient to +do so. + +.PP +If the \fIconfig file\fP is not specified on the command line, +\fBJunkbuster\fP will look for a file named \fBconfig\fP in the +current directory (except on Win32 where it will try \fBconfig.txt\fP). .SH DESCRIPTION @@ -41,7 +66,7 @@ fancy. Browsers must be configured to use \fBJunkbuster\fP (the default is localhost, -port 8000). +port 8118). To set the \s-2HTTP\s0 proxy in Netscape and Mozilla, @@ -60,7 +85,7 @@ go through: \fB\&Connections\fP; \fB\&LAN Settings\fP. .P -Set the HTTP proxy location for localhost, port 8000. +Set the HTTP proxy location for localhost, port 8118. The Secure (SSL) Proxy\" ijbfaq.html#security should also be set to the same values, @@ -68,13 +93,15 @@ otherwise \fB\&https:\fP \s-2URL\s0s won't be proxied. +.P +For other browsers, check the documentation. .SH CONFIGURATION -All \fBJunkbuster\fP configuration is done via the various configuration +\fBJunkbuster\fP can be configured with the various configuration files. The default configuration files are: \fIconfig\fP, \fIijb.action\fP, and \fIre_filterfile\fP. These are well commented. On Unix and Unix-like systems, these are located in \fI/etc/junkbuster/\fP -by default. On Windows and OS/2, these files are in the same directory +by default. On Windows, OS/2 and AmigaOS, these files are in the same directory as the \fBJunkbuster\fP executable. .P The name and number of configuration files has changed from previous versions, @@ -82,10 +109,11 @@ and is subject to change as development progresses. In fact, the configuration itself is changed and much more sophisticated. See the user-manual for a brief explanation of all configuration options. .P -\fBJunkbuster's\fP configuration parameters can be viewed at -\fIhttp://i.j.b/\fP. This is an internal page. In -addition, the \fIijb.action\fP file can be edited here, and \fBJunkbuster\fP can -be toggled on/off. +The actions list (ad blocks, etc) can also be configured with your +web browser at \fIhttp://ijbswa.sourceforge.net/config\fP. +\fBJunkbuster's\fP configuration parameters can also be viewed +at the same page. In addition, \fBJunkbuster\fP can be toggled on/off. +This is an internal page. .SH "SAMPLE CONFIGURATION" .PP @@ -199,6 +227,8 @@ options. .br \fI/etc/junkbuster/trust\fP .br +\fI/etc/junkbuster/templates/*\fP +.br \fI/var/log/junkbuster/logfile\fP .P @@ -207,27 +237,25 @@ and build configuration. More documentation should be included in the local documentation directory, though is not complete at this time. .SH SIGNALS -\fBJunkbuster\fP use the signal \fISIGHUP\fP (see kill -l) to reload all configuration -files (see CONFIGURATION). This includes the re-open of the logfiles -(logfile and jarfile) eg. used -after rotation of the logfiles by logrotate. -The \fISIGHUP\fP behavior is only for UNIX like OS'. -.br -However the configfile will be read if \fBJunkbuster\fP notice a different -modification time of this file and behaves so like start of \fBJunkbuster\fP -in context of all the files. +\fBJunkbuster\fP teriminates on the \fBSIGINT\fP, \fBSIGTERM\fP and \fBSIGABRT\fP +signals. Log rotation scripts may cause a re-opening of the logfile by sending +a \fBSIGHUP\fP to \fBJunkbuster\fP. Note that unlike other daemons, \fBJunkbuster\fP +does not need to be made aware of config file changes by \fBSIGHUP\fP -- it will +detect them automatically. .SH NOTES -This is a development version of \fBJunkbuster\fP. Not all features are +This is a \fBBETA\fP version of \fBJunkbuster\fP. Not all features are complete. +.br +Please see the user-maual on how to contact the developers for +feature requests, reporting problems, and other questions. .SH BUGS -Yes. HTTP/1.1 support is only partially implemented. See the user-manual for -how and where to report bugs. +Probably. Please see the user-manual for how and where to report bugs. .SH SEE ALSO .br -http://i.j.b/ +http://ijbswa.sourceforge.net/config .br http://ijbswa.sourceforge.net/ .br @@ -259,7 +287,7 @@ http://linuxalpha.ch/packages/ .br Haroon Rafique .br - Jorg Strohmayer + Joerg Strohmayer .br Shamim Mohamed .br @@ -270,6 +298,8 @@ http://linuxalpha.ch/packages/ John Venvertloh .br Hal Burgiss +.br + Rodrigo Barbosa .SH COPYRIGHT AND LICENSE Orginally written by, and copyrighted by, the Anonymous Coders and Junkbusters