point users to the right feedback forms,
[privoxy.git] / junkbuster.1
index ce17bf2..e2f7bc6 100644 (file)
@@ -1,6 +1,8 @@
-.\" Revised man page 10/13/01\r
-.\" Hal Burgiss <hal@foobox.net for Junkbuster developers\r
-.TH JUNKBUSTER 1 "v2.9.9 (alpha) Date: 2001/10/14"\r
+.\" Revised man page 10/13/01, for development version.\r
+.\" Hal Burgiss <hal@foobox.net> \r
+.\" for Junkbuster developers: ijbswa-developers@lists.sourceforge.net\r
+.\"\r
+.TH JUNKBUSTER 1 "v2.9.11 (beta) Date: 2002/02/24"\r
 \r
 .SH NAME\r
 \fBjunkbuster\fP\r
@@ -10,7 +12,7 @@ Proxy
 \s-2(TM)\s+2\r
 .SH SYNOPSIS\r
 \fBjunkbuster\fP\r
-\fI\&[config_file] &\fP\r
+\fI\&[config_file]\fP\r
 .br\r
 \fBjunkbstr.exe\fP\r
 \fI\&[config_file]\fP\r
@@ -19,9 +21,7 @@ Proxy
 .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
-\fIjunkbstr.txt\fP).\r
+current directory (except on Win32 where it will try \fIconfig.txt\fP).\r
 \r
 \r
 .SH DESCRIPTION\r
@@ -31,7 +31,7 @@ is an instrumentable HTTP proxy that filters the
 data stream between\r
 web servers and browsers.\r
 \fBJunkbuster\fP can be used to protect privacy, manage cookies, filter web\r
-page content, manage access restrictions, and to remove such annoying Internet\r
+page content, manage access restrictions, and to discard such annoying Internet\r
 junk as ads, banners, and pop-ups. Or whatever other annoyances strike your\r
 fancy.\r
 \r
@@ -66,29 +66,38 @@ otherwise
 \fB\&https:\fP\r
 \s-2URL\s0s\r
 won't be proxied.\r
+.P\r
+For other browser, check the documentation.\r
 \r
 .SH CONFIGURATION\r
-All \fBJunkbuster\fP configuration is done via the various configuarion \r
+All \fBJunkbuster\fP configuration is done via the various configuration \r
 files. The default configuration files are: \fIconfig\fP, \r
-\fIactionsfile\fP, and \fIre_filterfile\fP. These are well commented. \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
 and is subject to change as development progresses. In fact, the configuration\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
 \r
 .SH "SAMPLE CONFIGURATION"\r
 .PP\r
-A brief example of what an \fIactionsfile\fP configuration might look like:\r
+A brief example of what an \fIijb.action\fP configuration might look like:\r
 .PP\r
 .nf\r
 \r
 # Define a few useful custom aliases for later use\r
 {{alias}}\r
+# Don't accept cookies\r
 +no-cookies = +no-cookies-set +no-cookies-read\r
+# Do accept cookies\r
 -no-cookies = -no-cookies-set -no-cookies-read\r
 +imageblock = +block +image\r
 \r
@@ -105,24 +114,26 @@ A brief example of what an \fIactionsfile\fP configuration might look like:
  -hide-user-agent \\\r
  -image \\\r
  +image-blocker{blank} \\\r
- +no-cookies-read \\\r
- +no-cookies-set \\\r
+ +no-cookies-keep \\\r
+ -no-cookies-read \\\r
+ -no-cookies-set \\\r
  +no-popups \\\r
- +vanilla-wafer \\\r
+ -vanilla-wafer \\\r
+ -wafer \\\r
 }\r
 /\r
 \r
 # Now set exceptions to the above defined policies #######\r
 \r
-# Sites that DO need cookies\r
-{-no-cookies}\r
+# Sites where we want persistant cookies\r
+{-no-cookies -no-cookies-keep}\r
  .redhat.com\r
  .sun.com\r
  .yahoo.com\r
  .msdn.microsoft.com\r
 \r
 # This site requires cookies AND 'fast-redirects' on\r
-{-no-cookies -fast-redirects}\r
+{-no-cookies -no-cookies-keep -fast-redirects}\r
  .nytimes.com\r
 \r
 # Add custom headers, and turn off filtering of page source\r
@@ -130,6 +141,7 @@ A brief example of what an \fIactionsfile\fP configuration might look like:
  +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
@@ -145,7 +157,6 @@ A brief example of what an \fIactionsfile\fP configuration might look like:
 # Block any URLs that match these patterns\r
 {+block}\r
  /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\\.(gif|jpe?g))\r
- /.*/(.*[-_.])?count(er)?(\\.cgi|\\.dll|\\.exe|[?/])\r
  /.*/(plain|live|rotate)[-_.]?ads?/\r
  /.*/(sponsor)s?[0-9]?/\r
  /.*/ad(server|stream|juggler)\\.(cgi|pl|dll|exe)\r
@@ -153,7 +164,6 @@ A brief example of what an \fIactionsfile\fP configuration might look like:
  /.*/adv((er)?ts?|ertis(ing|ements?))?/\r
  /.*/banners?/\r
  /.*/popupads/\r
- /.*/sponsor.*\\.gif\r
  /.*/advert[0-9]+\\.jpg\r
  /ad_images/\r
  /.*/ads/\r
@@ -169,26 +179,48 @@ A brief example of what an \fIactionsfile\fP configuration might look like:
 .sp\r
 .PP\r
 See the comments in the configuration files themselves, or the user-manual \r
-for explanations of the above syntax.\r
+for explanations of the above syntax, and other \fBJunkbuster\fP configuration \r
+options.\r
 \r
 .SH "FILES"\r
 \fI/usr/sbin/junkbuster\fP\r
 .br\r
 \fI/etc/junkbuster/config\fP\r
 .br\r
-\fI/etc/junkbuster/actionsfile\fP\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
-Various other files should be included, but may vary depending on platform.\r
-More documentation should be included in the local documentation directory,\r
-though is not complete at this time.\r
+Various other files should be included, but may vary depending on platform \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 use the signal \fISIGHUP\fP (see kill -l) to reload all configuration\r
+files (see CONFIGURATION). This includes the re-open of the logfiles\r
+(logfile and jarfile) eg. used\r
+after rotation of the logfiles by logrotate.\r
+The \fISIGHUP\fP behavior is only for UNIX like OS'.\r
+.br\r
+However the configfile will be re-read if \fBJunkbuster\fP detects a changed\r
+modification time and then behaves like a re-start of \fBJunkbuster\fP \r
+in context of all the pertinent files.\r
\r
 .SH NOTES\r
-This is a development version of \fBJunkbuster\fP. All features are not \r
+This is a development version of \fBJunkbuster\fP. Not all features are  \r
 complete.\r
 \r
 .SH BUGS\r
@@ -196,6 +228,9 @@ Yes. HTTP/1.1 support is only partially implemented. See the user-manual for
 how and where to report bugs.\r
 \r
 .SH SEE ALSO\r
+.br\r
+http://i.j.b/\r
+.br\r
 http://ijbswa.sourceforge.net/\r
 .br\r
 http://sourceforge.net/projects/ijbswa\r
@@ -204,11 +239,11 @@ http://www.waldherr.org/junkbuster/\" waldherr.org#
 .br\r
 http://www.junkbusters.com/ht/en/cookies.html\" cookies.html#\r
 .br\r
-http://ijbswa.sourceforge.net/config/\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
@@ -226,7 +261,7 @@ http://www.squid-cache.org/
 .br\r
  Haroon Rafique\r
 .br\r
- Jorg Strohmayer\r
+ Joerg Strohmayer\r
 .br\r
  Shamim Mohamed\r
 .br\r
@@ -238,8 +273,7 @@ http://www.squid-cache.org/
 .br\r
  Hal Burgiss\r
 \r
-\r
-.SH COPYRIGHT AND GPL\r
+.SH COPYRIGHT AND LICENSE\r
 Orginally written by, and copyrighted by, the Anonymous Coders and Junkbusters\r
 Corporation. \r
 .P\r