-------------------------------------------------------------------------------
-Table of Contents
-1. IMPORTANT CHANGES
-2. INSTALL
-3. RUN
-4. CONFIGURATION
-5. DOCUMENTATION
-6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
-
- 6.1. Get Support
- 6.2. Report bugs
- 6.3. Request new features
- 6.4. Report ads or other filter problems
- 6.5. Other
-
Privoxy 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. Privoxy has a
privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
[.GROUP]] [config_file]
-See the man page or user-manual for a brief explanation of each option.
+See the man page or User Manual for an explanation of each option, and other
+configuration and usage issues.
If no config_file is specified on the command line, Privoxy will look for a
file named 'config' in the current directory (except Win32 which will look for
'config.txt'). If no config_file is found, Privoxy will fail to start.
-Or for Red Hat: /etc/rc.d/init.d/privoxy start
+Or for Red Hat based distributions: /etc/rc.d/init.d/privoxy start
Or for SuSE: /etc/rc.d/privoxy start
+Or Debian: /etc/init.d/privoxy start
+
-------------------------------------------------------------------------------
4. CONFIGURATION
See: 'config', 'default.action', 'user.action', and 'default.filter'.
-'user.action' is for personal configuration. These are all well commented. Most
-of the magic is in '*.action' files. 'user.action' should be used for any
-actions customizations. On Unix-like systems, these files are installed in /etc
-/privoxy. On Windows, then wherever the executable itself is installed. There
-are many significant changes and advances since Junkbuster v2.0.x. The
-user-manual has a run down of configuration options, and examples: http://
-www.privoxy.org/user-manual/.
+'user.action' is for personal and local configuration preferences. These are
+all well commented. Most of the magic is in '*.action' files. 'user.action'
+should be used for any actions customizations. On Unix-like systems, these
+files are installed in /etc/privoxy. On Windows, then wherever the executable
+itself is installed. There are many significant changes and advances since
+Junkbuster v2.0.x. The User Manual has an explanation of all configuration
+options, and examples: http://www.privoxy.org/user-manual/.
Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or whatever
you specify in the config file under 'listen-address'. DEFAULT is localhost:
-8118.
+8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it
+with FTP or other protocols for the simple reason it does not work.
The actions list can be configured via the web interface accessed via http://
p.p/, as well other options.
5. DOCUMENTATION
There should be documentation in the 'doc' subdirectory, but it is not
-completed at this point. In particular, see the user-manual there, the faq, and
+completed at this point. In particular, see the User Manual there, the FAQ, and
those interested in Privoxy development, should look at developer-manual.
The most up to date source of information on the current development version,
6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
-We value your feedback. However, to provide you with the best support, please
-note the following sections.
+We value your feedback. In fact, we rely on it to improve Privoxy and its
+configuration. However, please note the following hints, so we can provide you
+with the best support:
-------------------------------------------------------------------------------
6.1. Get Support
-To get support, use the Sourceforge Support Forum:
+For casual users, our support forum at SourceForge is probably best suited:
+http://sourceforge.net/tracker/?group_id=11118&atid=211118
- http://sourceforge.net/tracker/?group_id=11118&atid=211118
+All users are of course welcome to discuss their issues on the users mailing
+list, where the developers also hang around.
-------------------------------------------------------------------------------
-6.2. Report bugs
+6.2. Report Bugs
-To submit bugs, use the Sourceforge Bug Forum:
+Please report all bugs only through our bug tracker: http://sourceforge.net/
+tracker/?group_id=11118&atid=111118.
- http://sourceforge.net/tracker/?group_id=11118&atid=111118.
+Before doing so, please make sure that the bug has not already been submitted
+and observe the additional hints at the top of the submit form.
-Make sure that the bug has not already been submitted. Please try to verify
-that it is a Privoxy bug, and not a browser or site bug first. If you are using
-your own custom configuration, please try the stock configs to see if the
-problem is a configuration related bug. And if not using the latest development
-snapshot, please try the latest one. Or even better, CVS sources. Please be
-sure to include the Privoxy version, platform, browser, any pertinent log data,
-any other relevant details (please be specific) and, if possible, some way to
-reproduce the bug.
+Please try to verify that it is a Privoxy bug, and not a browser or site bug
+first. If unsure, try toggling off Privoxy, and see if the problem persists.
+The appendix of the user manual also has helpful information on action
+debugging. If you are using your own custom configuration, please try the stock
+configs to see if the problem is configuration related.
--------------------------------------------------------------------------------
+If not using the latest version, chances are that the bug has been found and
+fixed in the meantime. We would appreciate if you could take the time to
+upgrade to the latest version (or even the latest CVS snapshot) and verify your
+bug, but this is not required for reporting.
-6.3. Request new features
+-------------------------------------------------------------------------------
-To submit ideas on new features, use the Sourceforge feature request forum:
+6.3. Request New Features
- http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.
+You are welcome to submit ideas on new features or other proposals for
+improvement through our feature request tracker at http://sourceforge.net/
+tracker/?atid=361118&group_id=11118.
-------------------------------------------------------------------------------
-6.4. Report ads or other filter problems
+6.4. Report Ads or Other Actions-Related Problems
-You can also send feedback on websites that Privoxy has problems with. Please
-bookmark the following link: "Privoxy - Submit Filter Feedback". Once you surf
-to a page with problems, use the bookmark to send us feedback. We will look
-into the issue as soon as possible.
+Please send feedback on ads that slipped through, innocent images that were
+blocked, and any other problems relating to the default.action file through our
+actions feedback mechanism located at http://www.privoxy.org/actions/. On this
+page, you will also find a bookmark which will take you back there from any
+troubled site and even pre-fill the form!
New, improved default.action files will occasionally be made available based on
-your feedback. These will be announced on the ijbswa-announce list.
+your feedback. These will be announced on the ijbswa-announce list and
+available from our project page.
-------------------------------------------------------------------------------
6.5. Other
-For any other issues, feel free to use the mailing lists:
-
- http://sourceforge.net/mail/?group_id=11118.
-
-Anyone interested in actively participating in development and related
-discussions can also join the appropriate mailing list. Archives are available,
-too. See the page on Sourceforge.
+For any other issues, feel free to use the mailing lists. Technically
+interested users and people who wish to contribute to the project are also
+welcome on the developers list! You can find an overview of all Privoxy-related
+mailing lists, including list archives, at: http://sourceforge.net/mail/?
+group_id=11118.
.\" <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" "14 May 2002" "Privoxy 2.9.15 beta" ""
+.TH "PRIVOXY" "1" "04 June 2002" "Privoxy 2.9.15 beta" ""
.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\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
+\fBprivoxy.exe\fR [\fB\fIconfigfile\fB\fR ]\fB(Windows)\fR
.SH "OPTIONS"
.PP
\fBLAN Settings\fR.
.PP
The Secure (SSL) Proxy should also be set to the same values, otherwise
-https: URLs will not be proxied.
+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"
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.
+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.
+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
This is a beta version of \fBPrivoxy\fR. Not
all features are well tested.
.PP
-Please see the \fIuser-manual\fR on how to contact the
+Please see the \fIUser Manual\fR on how to contact the
developers for feature requests, reporting problems, and other questions.
.SH "SEE ALSO"
.PP
.PP
http://www.privoxy.org/,
-The \fBPrivoxy\fR Home page.
+the \fBPrivoxy\fR Home page.
-http://sourceforge.net/projects/ijbswa,
+http://www.privoxy.org/faq/,
+the \fBPrivoxy\fR FAQ.
+
+http://sourceforge.net/projects/ijbswa/,
the Project Page for \fBPrivoxy\fR on
-Sourceforge.
+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://p.p/, access
-\fBPrivoxy\fR from your browser. Alternately,
-http://config.privoxy.org
-may work in some situations where the first does not.
+http://www.junkbusters.com/ht/en/cookies.html,
+an explanation how cookies are used to track web users.
-http://p.p/ to submit ``misses'' to the developers.
+http://www.junkbusters.com/ijb.html,
+the original Internet Junkbuster.
-http://www.junkbusters.com/ht/en/cookies.html
+http://www.waldherr.org/junkbuster/,
+Stefan Waldherr's version of Junkbuster, from which \fBPrivoxy\fR was
+derived.
-http://www.waldherr.org/junkbuster/
+http://privacy.net/analyze/, a useful site
+to check what information about you is leaked while you browse the web.
-http://privacy.net/analyze/
+http://www.squid-cache.org/, a very popular
+caching proxy, which is often used together with \fBPrivoxy\fR.
-http://www.squid-cache.org/
+http://www.privoxy.org/developer-manual/,
+the \fBPrivoxy\fR developer manual.
.SH "DEVELOPMENT TEAM"
.nf
Thomas Steudten
Rodney Stromlund
Rodrigo Barbosa (RPM specfiles)
+ Moritz Barsnick
Hal Burgiss (docs)
Alexander Lazic
Gábor Lipták
Guy
Haroon Rafique
+ Roland Rosenfeld
David Schmidt (OS/2, Mac OSX ports)
Joerg Strohmayer
Sarantis Paskalis