.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "PRIVOXY" "1" "05 September 2002" "Privoxy 3.1.1 alpha" ""
.SH NAME
privoxy \- Privacy Enhancing Proxy
.SH SYNOPSIS

\fBprivoxy\fR [\fB--help\fR ] [\fB--version\fR ] [\fB--no-daemon\fR ] [\fB--pidfile \fIpidfile\fB\fR ] [\fB--user \fIuser[.group]\fB\fR ] [\fB\fIconfigfile\fB\fR ]\fB (UNIX)\fR


\fBprivoxy.exe\fR [\fB\fIconfigfile\fB\fR ]\fB (Windows)\fR

.SH "OPTIONS"
.PP
\fBPrivoxy\fR may be invoked with the following command line
options:
.TP
\fB--help\fR
Print brief usage info and exit.
.TP
\fB--version\fR
Print version info and exit.
.TP
\fB--no-daemon\fR
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 \fIpidfile\fB\fR
On startup, write the process ID to \fIpidfile\fR.
Delete the \fIpidfile\fR on exit.
Failure to create or delete the \fIpidfile\fR
is non-fatal. If no \fB--pidfile\fR option is given, no PID file will be used.
.TP
\fB--user \fIuser[.group]\fB\fR
After (optionally) writing the PID file, assume the user ID of
\fIuser\fR and the GID of
\fIgroup\fR, or, if the optional
\fIgroup\fR was not given, the default group of
\fIuser\fR. Exit if the privileges are not
sufficient to do so.
.PP
If the \fIconfigfile\fR is not specified on  the  command  line,
\fBPrivoxy\fR  will  look for a file named
\fIconfig\fR in the current directory (except on Win32 where
it will try \fIconfig.txt\fR). If no
\fIconfigfile\fR is found, \fBPrivoxy\fR will 
fail to start.
.SH "DESCRIPTION"
.PP
\fBPrivoxy\fR 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\fR has a very
flexible configuration and can be customized to suit individual needs and
tastes. \fBPrivoxy\fR has application for both
stand-alone systems and multi-user networks.
.PP
\fBPrivoxy\fR is based on \fBInternet
Junkbuster\fR (tm).
.SH "INSTALLATION AND USAGE"
.PP
Browsers must be individually configured to use \fBPrivoxy\fR as
a HTTP proxy.  The default setting is  for  localhost,  on port  8118
(configurable in the main config file).  To set the HTTP proxy in Netscape
and Mozilla, go through:  \fBEdit\fR;
\fBPreferences\fR;  \fBAdvanced\fR;
\fBProxies\fR;  \fBManual Proxy Configuration\fR;
\fBView\fR. 
.PP
For Internet Explorer, go through: \fBTools\fR; 
\fBInternet Properties\fR; \fBConnections\fR;
\fBLAN Settings\fR. 
.PP
The Secure (SSL) Proxy should also be set to the same values, otherwise
https: URLs will not be proxied. Note: \fBPrivoxy\fR can only
proxy HTTP and HTTPS traffic. Do not try it with FTP or other protocols.
.PP
For other browsers, check the documentation.
.SH "CONFIGURATION"
.PP
\fBPrivoxy\fR can be configured with the various configuration
files. The default configuration files are: \fIconfig\fR,
\fIdefault.filter\fR, and
\fIdefault.action\fR. \fIuser.action\fR should 
be used for locally defined exceptions to the default rules of
\fIdefault.action\fR These are all well commented.  On Unix
and Unix-like systems, these are located in
\fI/etc/privoxy/\fR by default. On Windows, OS/2 and AmigaOS,
these files are in the same directory as the \fBPrivoxy\fR
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 complete
explanation of all configuration options and general usage, and notes for 
upgrading from \fBJunkbuster\fR and earlier \fBPrivoxy\fR
versions.
.PP
The actions list (ad blocks, etc) can also be configured with your
web browser at http://config.privoxy.org/.
\fBPrivoxy's\fR configuration parameters  can also  be viewed at
the same page. In addition, \fBPrivoxy\fR can be toggled on/off.
This is an internal page, and does not require Internet access.
.SH "SAMPLE CONFIGURATION"
.PP
A brief example of what a simple \fIdefault.action\fR
configuration might look like:

.nf
 # Define a few useful custom aliases for later use
 {{alias}}

 # Useful aliases
 +crunch-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
 -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
 +imageblock      = +block +handle-as-image

 # Fragile sites should have the minimum changes
 fragile     = -block -deanimate-gifs -fast-redirects -filter \\
               -hide-referer -prevent-cookies -kill-popups

 ## Turn some actions on ################################
 { \\
 -add-header \\
 -block \\
 +deanimate-gifs{last} \\
 -downgrade-http-version \\
 -fast-redirects \\
 +filter{html-annoyances} \\
 +filter{js-annoyances} \\
 +filter{content-cookies} \\
 +filter{webbugs} \\
 +filter{banners-by-size} \\
 +hide-forwarded-for-headers \\
 +hide-from-header{block} \\
 +hide-referrer{forge} \\
 -hide-user-agent \\
 -handle-as-image \\
 +set-image-blocker{pattern} \\
 -limit-connect \\
 +prevent-compression \\
 +session-cookies-only \\
 -crunch-cookies \\
 -kill-popups \\
 }
 /   # '/' Matches *all* URL patterns
 
 # Block, and treat these URL patterns as if they were 'images'.
 # We would expect these to be ads.
 {+imageblock}
  .ad.doubleclick.net
  .a[0-9].yimg.com/(?:(?!/i/).)*$
  ad.*.doubleclick.net

 # Block any URLs that match these patterns
 {+block}
  ad*.
  .*ads.
  banner?.
  /.*count(er)?\\.(pl|cgi|exe|dll|asp|php[34]?)
  .hitbox.com 

 # Make exceptions for these harmless ones that would be 
 # caught by our +block patterns just above.
 {-block}
  adsl.
  advice.
  .*downloads.
.fi
.PP
Then for a \fIuser.action\fR, we would put local,
narrowly defined exceptions:

.nf
 # Re-define aliases as needed here
 {{alias}}

 # Useful aliases
 -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
 
 # Set personal exceptions to the policies in default.action #######

 # Sites where we want persistant cookies, so allow *all* cookies
 {-crunch-cookies -session-cookies-only}
  .redhat.com
  .sun.com
  .msdn.microsoft.com
 
 # This site breaks easily.
 {-block -fast-redirects}
  .forbes.com
.fi
.PP
See the comments in the configuration files themselves, or the 
\fIuser-manual\fR
for explanations of the above syntax, and other \fBPrivoxy\fR
configuration options.
.SH "FILES"

.nf
 
 \fI/usr/sbin/privoxy\fR
 \fI/etc/privoxy/config\fR
 \fI/etc/privoxy/default.action\fR
 \fI/etc/privoxy/standard.action\fR
 \fI/etc/privoxy/user.action\fR
 \fI/etc/privoxy/default.filter\fR
 \fI/etc/privoxy/trust\fR
 \fI/etc/privoxy/templates/*\fR
 \fI/var/log/privoxy/logfile\fR
.fi
.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.
.SH "SIGNALS"
.PP
\fBPrivoxy\fR terminates on the \fBSIGINT\fR,
\fBSIGTERM\fR and \fBSIGABRT\fR signals. Log
rotation scripts may cause a re-opening of the logfile by sending a 
\fBSIGHUP\fR to \fBPrivoxy\fR. Note that unlike
other daemons,  \fBPrivoxy\fR does not need to be made aware of
config file changes by \fBSIGHUP\fR -- it will detect them
automatically. 
.SH "NOTES"
.PP
This is a alpha version of \fBPrivoxy\fR. Not 
all features are well tested.
.PP
Please see the \fIUser Manual\fR on how to contact the
developers for feature requests, reporting problems, and other questions.
.SH "SEE ALSO"
.PP
Other references and sites of interest to \fBPrivoxy\fR
users:
.PP

http://www.privoxy.org/, 
the \fBPrivoxy\fR Home page. 

http://www.privoxy.org/faq/, 
the \fBPrivoxy\fR FAQ. 

http://sourceforge.net/projects/ijbswa/, 
the Project Page for \fBPrivoxy\fR on 
SourceForge.

http://config.privoxy.org/,
the web-based user interface. \fBPrivoxy\fR must be
running for this to work. Shortcut: http://p.p/

http://www.privoxy.org/actions/, to submit ``misses'' to the developers. 

http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/contrib/, cool
and fun ideas from \fBPrivoxy\fR users.

http://www.junkbusters.com/ht/en/cookies.html,
an explanation how cookies are used to track web users.

http://www.junkbusters.com/ijb.html,
the original Internet Junkbuster.

http://www.waldherr.org/junkbuster/,
Stefan Waldherr's version of Junkbuster, from which \fBPrivoxy\fR was
derived.

http://privacy.net/analyze/, a useful site
to check what information about you is leaked while you browse the web.

http://www.squid-cache.org/, a very popular
caching proxy, which is often used together with \fBPrivoxy\fR.

http://www.privoxy.org/developer-manual/, 
the \fBPrivoxy\fR developer manual. 
.SH "DEVELOPMENT TEAM"

.nf
 Jon Foster
 Andreas Oesterhelt
 Stefan Waldherr
 Thomas Steudten
 Rodney Stromlund
 Rodrigo Barbosa (RPM specfiles)
 Moritz Barsnick
 Hal Burgiss (docs)
 Karsten Hopp (Red Hat)
 Alexander Lazic
 Gábor Lipták
 Guy
 Haroon Rafique
 Roland Rosenfeld (Debian)
 Georg Sauthoff (Gentoo)
 David Schmidt (OS/2, Mac OSX ports)
 Joerg Strohmayer (Amiga)
 Sarantis Paskalis
.fi
.SH "COPYRIGHT AND LICENSE"
.SS "COPYRIGHT"
.PP
Copyright (C) 2001, 2002 by Privoxy Developers <developers@privoxy.org>
.PP
Some source code is based on code Copyright (C) 1997 by Anonymous Coders
and Junkbusters, Inc. and licensed under the \fIGNU General Public
License\fR.
.SS "LICENSE"
.PP
\fBPrivoxy\fR is free software; you can
redistribute it and/or modify it under the terms of the 
\fIGNU General Public
License\fR, version 2, as published by the Free Software Foundation.
.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 
\fIGNU General Public License\fR for
more details, which is available from the Free Software Foundation, Inc, 59
Temple Place - Suite 330, Boston, MA  02111-1307, USA.
.PP
You should have received a copy of the  \fIGNU General Public License\fR
along with this program; if not, write to the  Free Software
Foundation, Inc. 59 Temple Place - Suite 330
Boston, MA 02111-1307
USA