Debian directory added.
[privoxy.git] / privoxy.1
index bc6b2e0..32e707c 100644 (file)
--- a/privoxy.1
+++ b/privoxy.1
@@ -1,25 +1,24 @@
 .\" Revised man page 10/13/01, for development version.
 .\" Hal Burgiss <hal@foobox.net> 
-.\" for Junkbuster developers: ijbswa-developers@lists.sourceforge.net
+.\" for Privoxy developers: ijbswa-developers@lists.sourceforge.net
 .\"
-.TH JUNKBUSTER 1 "v2.9.11 (beta) Date: 2002/03/12"
+.TH PRIVOXY 1 "v2.9.13 (beta) Date: 2002/03/24"
 
 .SH NAME
-\fBjunkbuster\fP
-- The
-Internet Junkbuster
+\fBprivoxy\fP
+- Privacy enhancing
 Proxy
-\s-2(TM)\s+2
+.\"\s-2(TM)\s+2
 .SH SYNOPSIS
-\fBjunkbuster\fP
+\fBprivoxy\fP
 [--help] [--version] [--no-daemon] [--pidfile \fIpidfile\fP] [--user \fIuser\fP[.\fIgroup\fP]] 
 \fI\&[configfile]\fP (Unix)
 .TP
-\fBjunkbstr.exe\fP \fI[configfile]\fP (Windows)
+\fBprivoxy.exe\fP \fI[configfile]\fP (Windows)
 .br
 
 .SH OPTIONS
-\fBJunkbuster\fP may be invoked with the following command-line options:
+\fBPrivoxy\fP may be invoked with the following command-line options:
 .TP
 .BR --version " (unix only)"
 Print version info and exit.
@@ -46,26 +45,29 @@ Exit if the privileges are not sufficient to do so.
 
 .PP
 If the \fIconfigfile\fP is not specified on the command line,
-\fBJunkbuster\fP will look for a file named \fBconfig\fP in the 
+\fBPrivoxy\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
-\fBJunkbuster\fP
-is an instrumentable HTTP proxy that filters the 
-\s-2HTTP\s0
-data stream between
-web servers and browsers.
-\fBJunkbuster\fP can be used to protect privacy, manage cookies, filter web
-page content, manage access restrictions, and to discard such annoying Internet
-junk as ads, banners, and pop-ups. Or whatever other annoyances strike your
-fancy.
+\fBPrivoxy\fP is a web proxy with advanced filtering capabilities for
+protecting privacy, filtering web page content, managing cookies,
+controlling access, and removing ads, banners, pop-ups and other
+obnoxious Internet junk. \fBPrivoxy\fP has a very flexible configuration and
+can be customized to suit individual needs and tastes. \fBPrivoxy\fP has
+application for both stand-alone systems and multi-user networks.
+.PP
+\fBPrivoxy\fP is based on code of the \fBInternet Junkbuster (tm)\fP. 
+\fBJunkbuster\fP was originally written by JunkBusters Corporation, and was
+released as free open-source software under the GNU GPL. Stefan Waldherr made
+many improvements, and started the SourceForge project to continue
+development.
 
 .SH INSTALLATION AND USE
-Browsers must be configured to use 
-\fBJunkbuster\fP
-(the default is localhost, 
-port 8118).
+Browsers must be individually configured to use 
+\fBPrivoxy\fP as a \s-2HTTP\s0 proxy.
+The default setting is for localhost, 
+on port 8118 (configurable in the main config file).
 To set the 
 \s-2HTTP\s0
 proxy in Netscape and Mozilla,
@@ -76,47 +78,46 @@ go through:
 \fB\&Proxies\fP;
 \fB\&Manual Proxy Configuration\fP;
 \fB\&View\fP.
-.P
+.PP
 For Internet Explorer,
 go through:
 \fB\&Tools\fP;
 \fB\&Internet Properties\fP;
 \fB\&Connections\fP;
 \fB\&LAN Settings\fP.
-.P
-Set the HTTP proxy location for localhost, port 8118.
+.PP
 The
-Secure (SSL) Proxy\" ijbfaq.html#security
+Secure (SSL) Proxy \" ijbfaq.html#security
 should also be set to the same values,
 otherwise
 \fB\&https:\fP
 \s-2URL\s0s
-won't be proxied.
-.P
+will not be proxied.
+.PP
 For other browsers, check the documentation.
 
 .SH CONFIGURATION
-\fBJunkbuster\fP can be configured with the various configuration 
+\fBPrivoxy\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 
+\fIdefault.action\fP, and \fIdefault.filter\fP. These are well commented. 
+On Unix and Unix-like systems, these are located in \fI/etc/privoxy/\fP 
 by default. On Windows, OS/2 and AmigaOS, these files are in the same directory 
-as the \fBJunkbuster\fP executable. 
-.P
+as the \fBPrivoxy\fP executable. 
+.PP
 The name and number of configuration files has changed from previous versions,
 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
+.PP
 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.
+web browser at \fIhttp://www.privoxy.org/config\fP.
+\fBPrivoxy's\fP configuration parameters can also be viewed 
+at the same page. In addition, \fBPrivoxy\fP can be toggled on/off.
 This is an internal page. 
 
 .SH "SAMPLE CONFIGURATION"
 .PP
-A brief example of what an \fIijb.action\fP configuration might look like:
+A brief example of what a \fIdefault.action\fP configuration might look like:
 .PP
 .nf
 
@@ -214,46 +215,46 @@ myfilters = +filter{html-annoyances} +filter{js-annoyances}\\
 .sp
 .PP
 See the comments in the configuration files themselves, or the user-manual 
-for explanations of the above syntax, and other \fBJunkbuster\fP configuration 
+for explanations of the above syntax, and other \fBPrivoxy\fP configuration 
 options.
 
 .SH "FILES"
-\fI/usr/sbin/junkbuster\fP
+\fI/usr/sbin/privoxy\fP
 .br
-\fI/etc/junkbuster/config\fP
+\fI/etc/privoxy/config\fP
 .br
-\fI/etc/junkbuster/ijb.action\fP
+\fI/etc/privoxy/default.action\fP
 .br
-\fI/etc/junkbuster/ijb-advanced.action\fP
+\fI/etc/privoxy/advanced.action\fP
 .br
-\fI/etc/junkbuster/ijb-basic.action\fP
+\fI/etc/privoxy/basic.action\fP
 .br
-\fI/etc/junkbuster/ijb-intermediate.action\fP
+\fI/etc/privoxy/intermediate.action\fP
 .br
-\fI/etc/junkbuster/re_filterfile\fP
+\fI/etc/privoxy/default.filter\fP
 .br
-\fI/etc/junkbuster/trust\fP
+\fI/etc/privoxy/trust\fP
 .br
-\fI/etc/junkbuster/templates/*\fP
+\fI/etc/privoxy/templates/*\fP
 .br
-\fI/var/log/junkbuster/logfile\fP
+\fI/var/log/privoxy/logfile\fP
 
-.P
+.PP
 Various other files should be included, but may vary depending on platform 
 and build configuration. More documentation should be included in the local
 documentation directory, though is not complete at this time.
 
 .SH SIGNALS
-\fBJunkbuster\fP teriminates on the \fBSIGINT\fP, \fBSIGTERM\fP and \fBSIGABRT\fP
+\fBPrivoxy\fP terminates 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
+a \fBSIGHUP\fP to \fBPrivoxy\fP. Note that unlike other daemons, \fBPrivoxy\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 \fBBETA\fP version of \fBJunkbuster\fP. Not all features are  
-complete.
-.br
+This is a \fBBETA\fP version of \fBPrivoxy\fP. Not all features are  
+well tested.
+.PP
 Please see the user-maual on how to contact the developers for 
 feature requests, reporting problems, and other questions.
 
@@ -262,11 +263,17 @@ Probably. Please see the user-manual for how and where to report bugs.
 
 .SH SEE ALSO
 .br
-http://ijbswa.sourceforge.net/config
+http://www.privoxy.org/faq/
+.br
+http://www.privoxy.org/user-manual/
+.br
+http://www.privoxy.org/developer-manual/
 .br
-http://ijbswa.sourceforge.net/
+http://www.privoxy.org/config
 .br
-http://sourceforge.net/projects/ijbswa
+http://www.privoxy.org/
+.br
+http://sourceforge.net/projects/ijbswa (Privoxy Project Page)
 .br
 http://www.waldherr.org/junkbuster/\" waldherr.org#
 .br
@@ -276,7 +283,7 @@ http://privacy.net/analyze/
 .br
 http://www.squid-cache.org/
 .br
-http://linuxalpha.ch/packages/
+http://linuxalpha.ch/steudten/software/
 
 .SH DEVELOPMENT TEAM
 .br
@@ -309,25 +316,25 @@ http://linuxalpha.ch/packages/
  Rodrigo Barbosa
 
 .SH COPYRIGHT AND LICENSE
-Orginally written by, and copyrighted by, the Anonymous Coders and Junkbusters
-Corporation. 
-.P
+\"Orginally written by, and copyrighted by, the Anonymous Coders and Junkbusters
+\"Corporation. 
+\".PP
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 2 of the License, or
 (at your option) any later version.
-.P
+.PP
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
-.P
+.PP
 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-.P
+.PP
 Internet Junkbuster
 Proxy
 is a
-trademark\" legal.html#marks
+trademark \" legal.html#marks
 of Junkbusters Corporation.