<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
-<!entity % dummy "INCLUDE">
+<!entity % dummy "IGNORE">
<!entity supported SYSTEM "supported.sgml">
<!entity p-intro SYSTEM "privoxy.sgml">
<!entity contacting SYSTEM "contacting.sgml">
<!entity buildsource SYSTEM "buildsource.sgml">
-<!entity p-version "2.9.13">
+<!entity p-version "3.0.25">
<!entity p-status "beta">
<!entity % p-not-stable "INCLUDE">
<!entity % p-stable "IGNORE">
File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
Purpose : README for Privoxy
-
- $Id: readme.sgml,v 1.4 2002/04/06 05:07:29 hal9 Exp $
- Written by and Copyright (C) 2001 the SourceForge
- Privoxy team. http://www.privoxy.org/
-
- Based on the Internet Junkbuster originally written
- by and Copyright (C) 1997 Anonymous Coders and
- Junkbusters Corporation. http://www.junkbusters.com
+ $Id: readme.sgml,v 2.59 2016/05/22 12:42:11 fabiankeil Exp $
+ Copyright (C) 2001-2011 Privoxy Developers https://www.privoxy.org/
+ See LICENSE.
========================================================================
- NOTE: Please read developer-manual/documentation.html before touching
+ NOTE: Please read developer-manual/documentation.html before touching
anything in this, or other Privoxy documentation. You have been warned!
- Failure to abide by this rule will result in the revocation of your license
+ Failure to abide by this rule will result in the revocation of your license
to live a peaceful existence!
========================================================================
===================================================================
- READ: Document Note: This file generates the README in the top level
- source directory. It is generated as only a plain text file. The
- current markup is not suitable for other formats. Build from
- Makefile with 'make readme'.
+ READ: Document Note: This file generates the README in the top level
+ source directory. It is generated as only a plain text file. The
+ current markup is not suitable for other formats. Build from
+ Makefile with 'make dok-readme'.
===================================================================
READ:
======================================================================
NOTE: The left margin spacing is *important* when using 'literallayout'
- WYSISWYG!!! Don't mess this up!!! Careful with linebreaks too, ie
+ WYSISWYG!!! Don't mess this up!!! Careful with linebreaks too, ie
the para tag forces a linebreak. Tags need to be carefully placed as a result
- to avoid extra blank lines, etc.
+ to avoid extra blank lines, etc.
======================================================================
- For stable releases, change
-
- entity % p-not-stable "INCLUDE"
-
- to
-
- entity % p-not-stable "IGNORE"
-
+ For stable releases, change
+
+ entity % p-not-stable "INCLUDE"
+
+ to
+
+ entity % p-not-stable "IGNORE"
+
in the DTD at the top. This will toggle various text 'off'. BOTH
- MUST be toggled in this case or you will get both text referencing
+ MUST be toggled in this case or you will get both text referencing
stable and unstable versions. You only want one or the other!
-->
-
<article id="index">
-
+<artheader>
<![%dummy;[
<para>
<comment>
</comment>
</para>
]]>
-
+<abstract>
<para>
<literal>
<msgtext>
<literallayout>
-
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
*
* Purpose : README file to give a short intro.
*
- * Copyright : Written by and Copyright (C) 2001 the SourceForge
- * Privoxy team. http://www.privoxy.org/
+ * Copyright : Written by and Copyright (C) 2001-2011 the
+ * Privoxy team. https://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
- * by and Copyright (C) 1997 Anonymous Coders and
+ * by and Copyright (C) 1997 Anonymous Coders and
* Junkbusters Corporation. http://www.junkbusters.com
*
- * This program is free software; you can redistribute it
+ * 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
* The GNU General Public License should be included with
* this file. If not, you can view it at
* http://www.gnu.org/copyleft/gpl.html
- * or write to the Free Software Foundation, Inc., 59
- * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * or write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
+ * USA
*
*********************************************************************/
- </literallayout>
- </msgtext>
- </literal>
+</literallayout>
+</msgtext>
+</literal>
</para>
<para>
<!-- include some conditional text -->
This README is included with <![%p-not-stable;[ the development version of]]>
- Privoxy &p-version;<![%p-not-stable;[, which will eventually become Privoxy v3.0 (and soon we
- hope!)]]>. See http://www.privoxy.org/ for more information. The current code
- level is &p-status;<![%p-not-stable;[, and seems stable to us :)]]>.
+ Privoxy &p-version;. See https://www.privoxy.org/ for more information. The current code maturity
+ level is <quote>&p-status;</quote><![%p-not-stable;[, but seems stable to us :)]]>.
</para>
+</abstract>
+</artheader>
<!-- Include privoxy.sgml boilerplate: -->
&p-intro;
<!-- end boilerplate -->
+<!-- ~~~~~ New section ~~~~~ -->
+<sect1 id="changes" ><title>CHANGES</title>
<para>
- <LiteralLayout>
-
- IMPORTANT CHANGES
-------------------</LiteralLayout>
+ For a list of changes in this release, please have a
+ look at the "ChangeLog", the "What's New" section or
+ the "Upgrader's Notes" in <citetitle>the User Manual</citetitle>.
</para>
-<para>
- NEWS! As of 03/24/02, the name of this project has been changed from
- ijbswa/Junkbuster to Privoxy. This is reflected in many of the included
- files.
-</para>
-<para>
- WARNING! If upgrading from earlier versions of this project via RPM packages,
- the new package will delete any previously installed 'Junkbuster' packages.
-</para>
-<para>
- IMPORTANT! READ! Configuration Change as of 17 Mar 2002: The default listening
- port is now 8118 due to conflicts with port 8000 assignment. You will need to
- change your browser if upgrading!!! And maybe firewall, etc.
-</para>
-
-<para>
- <LiteralLayout>
- INSTALL
---------</LiteralLayout>
-</para>
-
-<!-- include buildsource.sgml boilerplate: -->
- &buildsource;
-<!-- end boilderplate -->
+</sect1>
+<!-- ~~~~~ New section ~~~~~ -->
+<sect1 id="install" ><title>INSTALL</title>
<para>
- <LiteralLayout>
-
- RUN
----- </LiteralLayout>
+ See the <filename>INSTALL</filename> file in this directory, for installing
+ from raw source, and the <citetitle>User Manual</citetitle>, for all other
+ installation types.
</para>
+</sect1>
+<!-- ~~~~~ New section ~~~~~ -->
+<sect1 id="run"><title>RUN</title>
<para>
- privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE]
- [--user USER[.GROUP]] [config_file]
+ privoxy [--help] [--version]
+ [--no-daemon] [--pidfile PIDFILE] [--user USER[.GROUP]] [--chroot] [--pre-chroot-nslookup
+ HOSTNAME ][config_file]
</para>
<para>
- See the man page or user-manual for a brief explanation of each option.
+ See the man page or <citetitle>User Manual</citetitle> for an explanation of each option, and
+ other configuration and usage issues.
</para>
<para>
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.
</para>
-<para>
- Or for Red Hat: /etc/rc.d/init.d/privoxy start
-</para>
-<para>
- Or for SuSE: /etc/rc.d/privoxy start
-</para>
-
-<para>
- <LiteralLayout>
+</sect1>
- CONFIGURATION
--------------- </LiteralLayout>
-</para>
+<!-- ~~~~~ New section ~~~~~ -->
+<sect1 id="configuration"><title>CONFIGURATION</title>
<para>
- See: 'config', 'default.action', and 'default.filter'. There are several
- actions files included. These are all well commented. Most of the magic is in
- '*.action', and there are several of these included with varying degrees of
- aggressiveness. On Unix-like systems, these files are installed in
+ See: 'config', 'default.action', 'user.action', 'default.filter', and
+ 'user.filter'. 'user.action' and 'user.filter' are 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 typically 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/.
+ There are many significant changes and advances from earlier versions. The
+ <citetitle>User Manual</citetitle> has an explanation of all configuration
+ options, and examples: https://www.privoxy.org/user-manual/.
</para>
<para>
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.
+ 127.0.0.1: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.
</para>
<para>
- The default.action file can be configured via the web interface accessed via
+ The actions list can be configured via the web interface accessed via
http://p.p/, as well other options.
</para>
<![%p-not-stable;[
development process.
</para>
]]>
+</sect1>
+<!-- ~~~~~ New section ~~~~~ -->
+<sect1 id="documentation"><title>DOCUMENTATION</title>
<para>
- <LiteralLayout>
-
- DOCUMENTATION
---------------</LiteralLayout>
There should be documentation in the 'doc' subdirectory<![%p-not-stable;[, but it
- is not completed at this point]]>. In particular, see the user-manual there,
- the faq, and those interested in Privoxy development, should look at
- developer-manual.
+ may not be completed at this point]]>. In particular, see the
+ <citetitle>User Manual</citetitle> there,
+ the <citetitle>FAQ</citetitle>, and those interested in Privoxy development, should look at
+ <citetitle>developer-manual</citetitle>.
</para>
<para>
<![%p-not-stable;[
may still be either comments in the source code, or the included
configuration files. ]]>The source and configuration files are all well
commented. The main configuration files are: 'config', 'default.action', and
- 'default.filter'<![%p-not-stable;[ in the toplevel source directory]]>. There
- are several *.action files included, with varying levels of aggressiveness.
+ 'default.filter'<![%p-not-stable;[ in the top-level source directory]]>.
</para>
<para>
- Included documentation may vary according to platform and packager.
-</para>
-
-<para>
- <LiteralLayout>
-
- CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
---------------------------------------------------------------</LiteralLayout>
+ Included documentation may vary according to platform and packager. All
+ documentation is posted on https://www.privoxy.org, in case you don't have it,
+ or can't find it.
</para>
+</sect1>
+<!-- ~~~~~ New section ~~~~~ -->
+<sect1 id="contact"><title>CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS</title>
<!-- Include contacting.sgml boilerplate: -->
- &contacting;
+ &contacting;
<!-- end boilerplate -->
+</sect1>
-<para>
- <LiteralLayout>
- -------------------------------------------------------------------------
- ijbswa-developers@lists.sourceforge.net
- </LiteralLayout>
-</para>
-<para>
- $Id: readme.sgml,v 1.4 2002/04/06 05:07:29 hal9 Exp $
-</para>
+<!-- <para> -->
+<!-- $Id: readme.sgml,v 2.59 2016/05/22 12:42:11 fabiankeil Exp $ -->
+<!-- </para> -->
</article>
projects / privoxy.git / blobdiff