This is mostly proposed copyright/licensing additions and changes. Docs

[privoxy.git] / doc / webserver / user-manual / index.html

diff --git a/doc/webserver/user-manual/index.html b/doc/webserver/user-manual/index.html
index 879f9ed..ea08e98 100644 (file)
--- a/doc/webserver/user-manual/index.html
+++ b/doc/webserver/user-manual/index.html
@@ -29,27 +29,23 @@ CLASS="TITLE"
 NAME="AEN2"
 >Privoxy User Manual</A
 ></H1
-><DIV
-CLASS="AUTHORGROUP"
-><A
-NAME="AEN5"
-></A
-><H3
-CLASS="AUTHOR"
-><A
-NAME="AEN6"
-></A
-></H3
-><DIV
-CLASS="AFFILIATION"
-><SPAN
-CLASS="ORGNAME"
->By: Privoxy Developers<BR></SPAN
-></DIV
-></DIV
 ><P
 CLASS="PUBDATE"
->$Id: user-manual.sgml,v 1.70 2002/04/08 20:53:56 swa Exp $<BR></P
+> <SUB
+> <A
+HREF="copyright.html"
+>Copyright</A
+> © 2001, 2002 by 
+ <A
+HREF="http://www.privoxy.org"
+TARGET="_top"
+>Privoxy Developers</A
+>
+ </SUB
+><BR></P
+><P
+CLASS="PUBDATE"
+>$Id: user-manual.sgml,v 1.105 2002/05/05 20:26:02 hal9 Exp $<BR></P
 ><DIV
 ><DIV
 CLASS="ABSTRACT"
@@ -59,15 +55,16 @@ NAME="AEN9"
 ><P
 ></P
 ><P
-> 
- </P
-><P
 >  The user manual gives users information on how to install, configure and use
-  <SPAN
+  <A
+HREF="http://www.privoxy.org/"
+TARGET="_top"
+><SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
+></A
 >.
-  </P
+ </P
 ><P
 > <SPAN
 CLASS="APPLICATION"
@@ -89,35 +86,24 @@ CLASS="APPLICATION"
 > <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
-> is based on the code of the 
- <SPAN
-CLASS="APPLICATION"
->Internet Junkbuster</SPAN
-> (tm).
- <SPAN
+> is based on <SPAN
 CLASS="APPLICATION"
->Junkbuster</SPAN
-> 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.</P
-><P
-> <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> continues the
- <SPAN
-CLASS="APPLICATION"
->Junkbuster</SPAN
-> tradition, but adds many 
- refinements, enhancements and new features.</P
+>Internet
+ Junkbuster</SPAN
+> (tm).</P
 ><P
 >  You can find the latest version of the user manual at  <A
 HREF="http://www.privoxy.org/user-manual/"
 TARGET="_top"
 >http://www.privoxy.org/user-manual/</A
->. Please see the Contact section on how to contact the developers.
-  </P
+>.
+  Please see the <A
+HREF="contact.html"
+TARGET="_top"
+>Contact section</A
+> on how to
+  contact the developers.
+ </P
 ><P
 ></P
 ></DIV
@@ -131,11 +117,6 @@ CLASS="TOC"
 >Table of Contents</B
 ></DT
 ><DT
-><A
-HREF="index.html#INTRO"
-></A
-></DT
-><DT
 >1. <A
 HREF="introduction.html"
 >Introduction</A
@@ -144,55 +125,75 @@ HREF="introduction.html"
 ><DL
 ><DT
 >1.1. <A
-HREF="introduction.html#AEN37"
->New Features</A
+HREF="introduction.html#FEATURES"
+>Features</A
 ></DT
 ></DL
 ></DD
 ><DT
->3. <A
+>2. <A
 HREF="installation.html"
 >Installation</A
 ></DT
 ><DD
 ><DL
 ><DT
->3.1. <A
-HREF="installation.html#INSTALLATION-SOURCE"
->Source</A
+>2.1. <A
+HREF="installation.html#INSTALLATION-PACKAGES"
+>Binary Packages</A
 ></DT
 ><DD
 ><DL
 ><DT
->3.1.1. <A
-HREF="installation.html#INSTALLATION-RH"
->Red Hat</A
+>2.1.1. <A
+HREF="installation.html#INSTALLATION-PACK-RPM"
+>Red Hat and SuSE RPMs</A
 ></DT
 ><DT
->3.1.2. <A
-HREF="installation.html#INSTALLATION-SUSE"
->SuSE</A
+>2.1.2. <A
+HREF="installation.html#INSTALLATION-DEB"
+>Debian</A
 ></DT
 ><DT
->3.1.3. <A
+>2.1.3. <A
+HREF="installation.html#INSTALLATION-PACK-WIN"
+>Windows</A
+></DT
+><DT
+>2.1.4. <A
+HREF="installation.html#INSTALLATION-PACK-BINTGZ"
+>Solaris, NetBSD, FreeBSD, HP-UX</A
+></DT
+><DT
+>2.1.5. <A
 HREF="installation.html#INSTALLATION-OS2"
 >OS/2</A
 ></DT
 ><DT
->3.1.4. <A
-HREF="installation.html#INSTALLATION-WIN"
->Windows</A
+>2.1.6. <A
+HREF="installation.html#INSTALLATION-MAC"
+>Max OSX</A
 ></DT
 ><DT
->3.1.5. <A
-HREF="installation.html#INSTALLATION-OTHER"
->Other</A
+>2.1.7. <A
+HREF="installation.html#INSTALLATION-AMIGA"
+>AmigaOS</A
 ></DT
 ></DL
 ></DD
+><DT
+>2.2. <A
+HREF="installation.html#INSTALLATION-SOURCE"
+>Building from Source</A
+></DT
 ></DL
 ></DD
 ><DT
+>3. <A
+HREF="upgradersnote.html"
+>Note to Upgraders</A
+></DT
+><DT
 >4. <A
 HREF="quickstart.html"
 >Quickstart to Using <SPAN
@@ -200,17 +201,60 @@ CLASS="APPLICATION"
 >Privoxy</SPAN
 ></A
 ></DT
+><DT
+>5. <A
+HREF="startup.html"
+>Starting <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+></A
+></DT
 ><DD
 ><DL
 ><DT
->4.1. <A
-HREF="quickstart.html#AEN230"
+>5.1. <A
+HREF="startup.html#START-REDHATDEBIAN"
+>RedHat and Debian</A
+></DT
+><DT
+>5.2. <A
+HREF="startup.html#START-SUSE"
+>SuSE</A
+></DT
+><DT
+>5.3. <A
+HREF="startup.html#START-WINDOWS"
+>Windows</A
+></DT
+><DT
+>5.4. <A
+HREF="startup.html#START-UNICES"
+>Solaris, NetBSD, FreeBSD, HP-UX and others</A
+></DT
+><DT
+>5.5. <A
+HREF="startup.html#START-OS2"
+>OS/2</A
+></DT
+><DT
+>5.6. <A
+HREF="startup.html#START-MACOSX"
+>MAX OSX</A
+></DT
+><DT
+>5.7. <A
+HREF="startup.html#START-AMIGAOS"
+>AmigaOS</A
+></DT
+><DT
+>5.8. <A
+HREF="startup.html#CMDOPTIONS"
 >Command Line Options</A
 ></DT
 ></DL
 ></DD
 ><DT
->5. <A
+>6. <A
 HREF="configuration.html"
 ><SPAN
 CLASS="APPLICATION"
@@ -220,133 +264,518 @@ CLASS="APPLICATION"
 ><DD
 ><DL
 ><DT
->5.1. <A
-HREF="configuration.html#AEN275"
+>6.1. <A
+HREF="configuration.html#AEN346"
 >Controlling <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
 > with Your Web Browser</A
 ></DT
 ><DT
->5.2. <A
-HREF="configuration.html#AEN293"
+>6.2. <A
+HREF="configuration.html#CONFOVERVIEW"
 >Configuration Files Overview</A
 ></DT
+></DL
+></DD
 ><DT
->5.3. <A
-HREF="configuration.html#AEN324"
+>7. <A
+HREF="config.html"
 >The Main Configuration File</A
 ></DT
 ><DD
 ><DL
 ><DT
->5.3.1. <A
-HREF="configuration.html#AEN357"
->Defining Other Configuration Files</A
+>7.1. <A
+HREF="config.html#CONF-LOG-LOC"
+>Configuration and Log File Locations</A
+></DT
+><DD
+><DL
+><DT
+>7.1.1. <A
+HREF="config.html#CONFDIR"
+>confdir</A
+></DT
+><DT
+>7.1.2. <A
+HREF="config.html#LOGDIR"
+>logdir</A
+></DT
+><DT
+>7.1.3. <A
+HREF="config.html#ACTIONSFILE"
+>actionsfile</A
+></DT
+><DT
+>7.1.4. <A
+HREF="config.html#FILTERFILE"
+>filterfile</A
+></DT
+><DT
+>7.1.5. <A
+HREF="config.html#LOGFILE"
+>logfile</A
 ></DT
 ><DT
->5.3.2. <A
-HREF="configuration.html#AEN450"
->Other Configuration Options</A
+>7.1.6. <A
+HREF="config.html#JARFILE"
+>jarfile</A
 ></DT
 ><DT
->5.3.3. <A
-HREF="configuration.html#AEN587"
->Access Control List (ACL)</A
+>7.1.7. <A
+HREF="config.html#TRUSTFILE"
+>trustfile</A
 ></DT
+></DL
+></DD
 ><DT
->5.3.4. <A
-HREF="configuration.html#FORWARDING"
+>7.2. <A
+HREF="config.html#LOCAL-SET-UP"
+>Local Set-up Documentation</A
+></DT
+><DD
+><DL
+><DT
+>7.2.1. <A
+HREF="config.html#USER-MANUAL"
+>user-manual</A
+></DT
+><DT
+>7.2.2. <A
+HREF="config.html#TRUST-INFO-URL"
+>trust-info-url</A
+></DT
+><DT
+>7.2.3. <A
+HREF="config.html#ADMIN-ADDRESS"
+>admin-address</A
+></DT
+><DT
+>7.2.4. <A
+HREF="config.html#PROXY-INFO-URL"
+>proxy-info-url</A
+></DT
+></DL
+></DD
+><DT
+>7.3. <A
+HREF="config.html#DEBUGGING"
+>Debugging</A
+></DT
+><DD
+><DL
+><DT
+>7.3.1. <A
+HREF="config.html#DEBUG"
+>debug</A
+></DT
+><DT
+>7.3.2. <A
+HREF="config.html#SINGLE-THREADED"
+>single-threaded</A
+></DT
+></DL
+></DD
+><DT
+>7.4. <A
+HREF="config.html#ACCESS-CONTROL"
+>Access Control and Security</A
+></DT
+><DD
+><DL
+><DT
+>7.4.1. <A
+HREF="config.html#LISTEN-ADDRESS"
+>listen-address</A
+></DT
+><DT
+>7.4.2. <A
+HREF="config.html#TOGGLE"
+>toggle</A
+></DT
+><DT
+>7.4.3. <A
+HREF="config.html#ENABLE-REMOTE-TOGGLE"
+>enable-remote-toggle</A
+></DT
+><DT
+>7.4.4. <A
+HREF="config.html#ENABLE-EDIT-ACTIONS"
+>enable-edit-actions</A
+></DT
+><DT
+>7.4.5. <A
+HREF="config.html#ACLS"
+>ACLs: permit-access and deny-access</A
+></DT
+><DT
+>7.4.6. <A
+HREF="config.html#BUFFER-LIMIT"
+>buffer-limit</A
+></DT
+></DL
+></DD
+><DT
+>7.5. <A
+HREF="config.html#FORWARDING"
 >Forwarding</A
 ></DT
+><DD
+><DL
+><DT
+>7.5.1. <A
+HREF="config.html#FORWARD"
+>forward</A
+></DT
+><DT
+>7.5.2. <A
+HREF="config.html#SOCKS"
+>forward-socks4 and forward-socks4a</A
+></DT
+><DT
+>7.5.3. <A
+HREF="config.html#ADVANCED-FORWARDING-EXAMPLES"
+>Advanced Forwarding Examples</A
+></DT
+></DL
+></DD
 ><DT
->5.3.5. <A
-HREF="configuration.html#AEN785"
+>7.6. <A
+HREF="config.html#WINDOWS-GUI"
 >Windows GUI Options</A
 ></DT
 ></DL
 ></DD
 ><DT
->5.4. <A
-HREF="configuration.html#ACTIONSFILE"
->The Actions File</A
+>8. <A
+HREF="actions-file.html"
+>Actions Files</A
+></DT
+><DD
+><DL
+><DT
+>8.1. <A
+HREF="actions-file.html#AEN1378"
+>Finding the Right Mix</A
+></DT
+><DT
+>8.2. <A
+HREF="actions-file.html#AEN1385"
+>How to Edit</A
+></DT
+><DT
+>8.3. <A
+HREF="actions-file.html#AEN1394"
+>How Actions are Applied to URLs</A
+></DT
+><DT
+>8.4. <A
+HREF="actions-file.html#AEN1408"
+>Patterns</A
 ></DT
 ><DD
 ><DL
 ><DT
->5.4.1. <A
-HREF="configuration.html#AEN887"
->URL Domain and Path Syntax</A
+>8.4.1. <A
+HREF="actions-file.html#AEN1448"
+>The Domain Pattern</A
+></DT
+><DT
+>8.4.2. <A
+HREF="actions-file.html#AEN1510"
+>The Path Pattern</A
 ></DT
+></DL
+></DD
 ><DT
->5.4.2. <A
-HREF="configuration.html#AEN963"
+>8.5. <A
+HREF="actions-file.html#ACTIONS"
 >Actions</A
 ></DT
+><DD
+><DL
+><DT
+>8.5.1. <A
+HREF="actions-file.html#ADD-HEADER"
+><I
+CLASS="EMPHASIS"
+>+add-header</I
+></A
+></DT
+><DT
+>8.5.2. <A
+HREF="actions-file.html#BLOCK"
+><I
+CLASS="EMPHASIS"
+>+block</I
+></A
+></DT
+><DT
+>8.5.3. <A
+HREF="actions-file.html#DEANIMATE-GIFS"
+><I
+CLASS="EMPHASIS"
+>+deanimate-gifs</I
+></A
+></DT
+><DT
+>8.5.4. <A
+HREF="actions-file.html#DOWNGRADE-HTTP-VERSION"
+><I
+CLASS="EMPHASIS"
+>+downgrade-http-version</I
+></A
+></DT
+><DT
+>8.5.5. <A
+HREF="actions-file.html#FAST-REDIRECTS"
+><I
+CLASS="EMPHASIS"
+>+fast-redirects</I
+></A
+></DT
+><DT
+>8.5.6. <A
+HREF="actions-file.html#FILTER"
+><I
+CLASS="EMPHASIS"
+>+filter</I
+></A
+></DT
+><DT
+>8.5.7. <A
+HREF="actions-file.html#HIDE-FORWARDED-FOR-HEADERS"
+><I
+CLASS="EMPHASIS"
+>+hide-forwarded-for-headers</I
+></A
+></DT
+><DT
+>8.5.8. <A
+HREF="actions-file.html#HIDE-FROM-HEADER"
+><I
+CLASS="EMPHASIS"
+>+hide-from-header</I
+></A
+></DT
+><DT
+>8.5.9. <A
+HREF="actions-file.html#HIDE-REFERER"
+><I
+CLASS="EMPHASIS"
+>+hide-referer</I
+></A
+></DT
+><DT
+>8.5.10. <A
+HREF="actions-file.html#HIDE-USER-AGENT"
+><I
+CLASS="EMPHASIS"
+>+hide-user-agent</I
+></A
+></DT
+><DT
+>8.5.11. <A
+HREF="actions-file.html#HANDLE-AS-IMAGE"
+><I
+CLASS="EMPHASIS"
+>+handle-as-image</I
+></A
+></DT
+><DT
+>8.5.12. <A
+HREF="actions-file.html#SET-IMAGE-BLOCKER"
+><I
+CLASS="EMPHASIS"
+>+set-image-blocker</I
+></A
+></DT
+><DT
+>8.5.13. <A
+HREF="actions-file.html#LIMIT-CONNECT"
+><I
+CLASS="EMPHASIS"
+>+limit-connect</I
+></A
+></DT
+><DT
+>8.5.14. <A
+HREF="actions-file.html#PREVENT-COMPRESSION"
+><I
+CLASS="EMPHASIS"
+>+prevent-compression</I
+></A
+></DT
+><DT
+>8.5.15. <A
+HREF="actions-file.html#SESSION-COOKIES-ONLY"
+><I
+CLASS="EMPHASIS"
+>+session-cookies-only</I
+></A
+></DT
+><DT
+>8.5.16. <A
+HREF="actions-file.html#PREVENT-READING-COOKIES"
+><I
+CLASS="EMPHASIS"
+>+prevent-reading-cookies</I
+></A
+></DT
+><DT
+>8.5.17. <A
+HREF="actions-file.html#PREVENT-SETTING-COOKIES"
+><I
+CLASS="EMPHASIS"
+>+prevent-setting-cookies</I
+></A
+></DT
+><DT
+>8.5.18. <A
+HREF="actions-file.html#KILL-POPUP"
+><I
+CLASS="EMPHASIS"
+>+kill-popups<A
+NAME="KILL-POPUPS"
+></A
+></I
+></A
+></DT
+><DT
+>8.5.19. <A
+HREF="actions-file.html#SEND-VANILLA-WAFER"
+><I
+CLASS="EMPHASIS"
+>+send-vanilla-wafer</I
+></A
+></DT
+><DT
+>8.5.20. <A
+HREF="actions-file.html#SEND-WAFER"
+><I
+CLASS="EMPHASIS"
+>+send-wafer</I
+></A
+></DT
 ><DT
->5.4.3. <A
-HREF="configuration.html#AEN1285"
+>8.5.21. <A
+HREF="actions-file.html#AEN2289"
+>Summary</A
+></DT
+><DT
+>8.5.22. <A
+HREF="actions-file.html#ACT-EXAMPLES"
+>Sample Actions Files</A
+></DT
+></DL
+></DD
+><DT
+>8.6. <A
+HREF="actions-file.html#ALIASES"
 >Aliases</A
 ></DT
 ></DL
 ></DD
 ><DT
->5.5. <A
-HREF="configuration.html#FILTERFILE"
+>9. <A
+HREF="filter-file.html"
 >The Filter File</A
 ></DT
+><DD
+><DL
 ><DT
->5.6. <A
-HREF="configuration.html#AEN1351"
->Templates</A
+>9.1. <A
+HREF="filter-file.html#AEN2432"
+>The <I
+CLASS="EMPHASIS"
+>+filter</I
+> Action</A
 ></DT
 ></DL
 ></DD
 ><DT
->6. <A
+>10. <A
+HREF="templates.html"
+>Templates</A
+></DT
+><DT
+>11. <A
 HREF="contact.html"
 >Contacting the Developers, Bug Reporting and Feature
 Requests</A
 ></DT
+><DD
+><DL
 ><DT
->7. <A
+>11.1. <A
+HREF="contact.html#CONTACT-SUPPORT"
+>Get Support</A
+></DT
+><DT
+>11.2. <A
+HREF="contact.html#CONTACT-BUGS"
+>Report bugs</A
+></DT
+><DT
+>11.3. <A
+HREF="contact.html#CONTACT-FEATURE"
+>Request new features</A
+></DT
+><DT
+>11.4. <A
+HREF="contact.html#CONTACT-ADS"
+>Report ads or other filter problems</A
+></DT
+><DT
+>11.5. <A
+HREF="contact.html#CONTACT-OTHER"
+>Other</A
+></DT
+></DL
+></DD
+><DT
+>12. <A
 HREF="copyright.html"
->Copyright and History</A
+><SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> Copyright, License and History</A
 ></DT
 ><DD
 ><DL
 ><DT
->7.1. <A
-HREF="copyright.html#AEN1385"
->Copyright</A
+>12.1. <A
+HREF="copyright.html#AEN2498"
+>License</A
 ></DT
 ><DT
->7.2. <A
+>12.2. <A
 HREF="copyright.html#HISTORY"
 >History</A
 ></DT
 ></DL
 ></DD
 ><DT
->8. <A
+>13. <A
 HREF="seealso.html"
 >See Also</A
 ></DT
 ><DT
->9. <A
+>14. <A
 HREF="appendix.html"
 >Appendix</A
 ></DT
 ><DD
 ><DL
 ><DT
->9.1. <A
+>14.1. <A
 HREF="appendix.html#REGEX"
 >Regular Expressions</A
 ></DT
 ><DT
->9.2. <A
-HREF="appendix.html#AEN1587"
+>14.2. <A
+HREF="appendix.html#AEN2732"
 ><SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
@@ -355,14 +784,19 @@ CLASS="APPLICATION"
 ><DD
 ><DL
 ><DT
->9.2.1. <A
+>14.2.1. <A
 HREF="appendix.html#BOOKMARKLETS"
 >Bookmarklets</A
 ></DT
 ></DL
 ></DD
 ><DT
->9.3. <A
+>14.3. <A
+HREF="appendix.html#CHAIN"
+>Chain of Events</A
+></DT
+><DT
+>14.4. <A
 HREF="appendix.html#ACTIONSANAT"
 >Anatomy of an Action</A
 ></DT
@@ -370,17 +804,6 @@ HREF="appendix.html#ACTIONSANAT"
 ></DD
 ></DL
 ></DIV
-><DIV
-CLASS="SECT1"
-><H1
-CLASS="SECT1"
-><A
-NAME="INTRO"
-></A
-></H1
-><P
-> </P
-></DIV
 ></DIV
 ><DIV
 CLASS="NAVFOOTER"