Rebuild for 3.0.17 stable
[privoxy.git] / doc / webserver / user-manual / quickstart.html
index 5bfc1c9..c81f013 100644 (file)
@@ -1,23 +1,28 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
 <HTML
 ><HEAD
 ><TITLE
 >Quickstart to Using Privoxy</TITLE
 ><META
 NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
 REL="HOME"
-TITLE="Privoxy 3.0.3 User Manual"
+TITLE="Privoxy 3.0.17 User Manual"
 HREF="index.html"><LINK
 REL="PREVIOUS"
-TITLE="Note to Upgraders"
-HREF="upgradersnote.html"><LINK
+TITLE="What's New in this Release"
+HREF="whatsnew.html"><LINK
 REL="NEXT"
 TITLE="Starting Privoxy"
 HREF="startup.html"><LINK
 REL="STYLESHEET"
 TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+HREF="../p_doc.css"><META
+HTTP-EQUIV="Content-Type"
+CONTENT="text/html;
+charset=ISO-8859-1">
+<LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
+</head
 ><BODY
 CLASS="SECT1"
 BGCOLOR="#EEEEEE"
@@ -37,7 +42,7 @@ CELLSPACING="0"
 ><TH
 COLSPAN="3"
 ALIGN="center"
->Privoxy 3.0.3 User Manual</TH
+>Privoxy 3.0.17 User Manual</TH
 ></TR
 ><TR
 ><TD
@@ -45,7 +50,7 @@ WIDTH="10%"
 ALIGN="left"
 VALIGN="bottom"
 ><A
-HREF="upgradersnote.html"
+HREF="whatsnew.html"
 ACCESSKEY="P"
 >Prev</A
 ></TD
@@ -74,10 +79,7 @@ CLASS="SECT1"
 CLASS="SECT1"
 ><A
 NAME="QUICKSTART"
->4. Quickstart to Using <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-></A
+>4. Quickstart to Using Privoxy</A
 ></H1
 ><P
 > <P
@@ -85,15 +87,6 @@ CLASS="APPLICATION"
 ><UL
 ><LI
 ><P
->   If upgrading, from versions before 2.9.16, please back up any configuration
-   files. See the <A
-HREF="upgradersnote.html"
->Note to Upgraders</A
-> Section.
- </P
-></LI
-><LI
-><P
 >  Install <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
@@ -142,29 +135,31 @@ CLASS="APPLICATION"
 CLASS="APPLICATION"
 >Privoxy</SPAN
 > as HTTP and
-   HTTPS (SSL) proxy by setting the proxy configuration for address of
-   <VAR
+   HTTPS (SSL)  <A
+HREF="http://en.wikipedia.org/wiki/Proxy_server"
+TARGET="_top"
+>proxy</A
+>
+   by setting the proxy configuration for address of
+   <TT
 CLASS="LITERAL"
->127.0.0.1</VAR
-> and port <VAR
+>127.0.0.1</TT
+> and port <TT
 CLASS="LITERAL"
->8118</VAR
+>8118</TT
 >.
-   (<SPAN
-CLASS="APPLICATION"
->Junkbuster</SPAN
-> and earlier versions of
    <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> used port 8000.) See the section <A
-HREF="startup.html"
->Starting <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-></A
-> below
-   for more details on this.
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>DO NOT</I
+></SPAN
+> activate proxying for <TT
+CLASS="LITERAL"
+>FTP</TT
+> or 
+   any protocols besides HTTP and HTTPS (SSL) unless you intend to prevent your
+   browser from using these protocols.
   </P
 ></LI
 ><LI
@@ -173,8 +168,13 @@ CLASS="APPLICATION"
     If using <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
-> to manage cookies, you should 
-    remove any currently stored cookies too.
+> to manage 
+    <A
+HREF="http://en.wikipedia.org/wiki/Browser_cookie"
+TARGET="_top"
+>cookies</A
+>,
+    you should remove any currently stored cookies too.
   </P
 ></LI
 ><LI
@@ -182,7 +182,14 @@ CLASS="APPLICATION"
 >   A default installation should provide a reasonable starting point for 
    most. There will undoubtedly be occasions where you will want to adjust the
    configuration, but that can be dealt with as the need arises. Little 
-   to no initial configuration is required in most cases.
+   to no initial configuration is required in most cases, you may want
+   to enable the
+   <A
+HREF="config.html#ENABLE-EDIT-ACTIONS"
+TARGET="_top"
+>web-based action editor</A
+> though.
+   Be sure to read the warnings first.
   </P
 ><P
 >   See the <A
@@ -190,16 +197,24 @@ HREF="configuration.html"
 >Configuration section</A
 > for more
    configuration options, and how to customize your installation.
- </P
+   You might also want to look at the <A
+HREF="quickstart.html#QUICKSTART-AD-BLOCKING"
+>next section</A
+> for a quick
+   introduction to how <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> blocks ads and
+   banners.</P
 ></LI
 ><LI
 ><P
->    If you experience ads that slipped through, innocent images that are
+>    If you experience ads that slip through, innocent images that are
     blocked, or otherwise feel the need to fine-tune
     <SPAN
 CLASS="APPLICATION"
 >Privoxy's</SPAN
-> behaviour, take a look at the <A
+> behavior, take a look at the <A
 HREF="actions-file.html"
 >actions files</A
 >. As a quick start, you might
@@ -216,10 +231,10 @@ TARGET="_top"
 CLASS="QUOTE"
 >"<A
 HREF="appendix.html#ACTIONSANAT"
->Anatomy of an
+>Troubleshooting: Anatomy of an
     Action</A
 >"</SPAN
-> has hints how to debug actions that
+> has hints on how to understand and debug actions that
     <SPAN
 CLASS="QUOTE"
 >"misbehave"</SPAN
@@ -228,27 +243,17 @@ CLASS="QUOTE"
 ></LI
 ><LI
 ><P
->   For easy access to Privoxy's most important controls, drag the provided
-   <A
-HREF="appendix.html#BOOKMARKLETS"
->Bookmarklets</A
-> into your browser's
-   personal toolbar.
-  </P
-></LI
-><LI
-><P
 >   Please see the section <A
 HREF="contact.html"
 >Contacting the
    Developers</A
-> on how to report bugs or problems with websites or to get
+> on how to report bugs, problems with websites or to get
    help. 
   </P
 ></LI
 ><LI
 ><P
->   Now enjoy surfing with enhanced comfort and privacy!
+>   Now enjoy surfing with enhanced control, comfort and privacy!
   </P
 ></LI
 ></UL
@@ -276,7 +281,8 @@ CLASS="APPLICATION"
 ><P
 > First a bit of a warning ... blocking ads is much like blocking SPAM: the
  more aggressive you are about it, the more likely you are to block 
- things that were not intended. So there is a trade off here. If you want
+ things that were not intended. And the more likely that some things 
+ may not work as intended. So there is a trade off here. If you want
  extreme ad free browsing, be prepared to deal with more
  <SPAN
 CLASS="QUOTE"
@@ -367,27 +373,39 @@ CLASS="APPLICATION"
  original page's HTML content. An ad image for instance, is just an URL
  embedded in the page somewhere. The image itself may be on the same server,
  or a server somewhere else on the Internet. Complex web pages will have many
- such embedded URLs.</P
+ such embedded URLs. <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> can deal with each URL individually, so, for
+ instance, the main page text is not touched, but images from such-and-such
+ server are blocked.</P
 ><P
-> The actions we need to know about for ad blocking are:  <VAR
+> The most important actions for basic ad blocking are:  <TT
 CLASS="LITERAL"
 ><A
 HREF="actions-file.html#BLOCK"
 >block</A
-></VAR
->, <VAR
+></TT
+>, <TT
 CLASS="LITERAL"
 ><A
 HREF="actions-file.html#HANDLE-AS-IMAGE"
 >handle-as-image</A
-></VAR
->, and
- <VAR
+></TT
+>, 
+ <TT
+CLASS="LITERAL"
+><A
+HREF="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT"
+>handle-as-empty-document</A
+></TT
+>,and
+ <TT
 CLASS="LITERAL"
 ><A
 HREF="actions-file.html#SET-IMAGE-BLOCKER"
 >set-image-blocker</A
-></VAR
+></TT
 >:</P
 ><P
 > <P
@@ -395,31 +413,33 @@ HREF="actions-file.html#SET-IMAGE-BLOCKER"
 ><UL
 ><LI
 ><P
->   <VAR
+>   <TT
 CLASS="LITERAL"
 ><A
 HREF="actions-file.html#BLOCK"
 >block</A
-></VAR
-> - this action stops
-   any contact between your browser and any URL patterns that match this
-   action's configuration. It can be used for blocking ads, but also anything
-   that is determined to be unwanted. By itself, it simply stops any
-   communication with the remote server and sends <SPAN
+></TT
+> - this is perhaps 
+   the single most used action, and is particularly important for ad blocking.
+   This action stops any contact between your browser and any URL patterns
+   that match this action's configuration. It can be used for blocking ads,
+   but also anything that is determined to be unwanted. By itself, it simply
+   stops any communication with the remote server and sends
+   <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
->'s
-   own built-in BLOCKED page instead to let you now what has happened.
+>'s own built-in BLOCKED page instead to
+   let you now what has happened (with some exceptions, see below).
   </P
 ></LI
 ><LI
 ><P
->   <VAR
+>   <TT
 CLASS="LITERAL"
 ><A
 HREF="actions-file.html#HANDLE-AS-IMAGE"
 >handle-as-image</A
-></VAR
+></TT
 > - 
    tells <SPAN
 CLASS="APPLICATION"
@@ -447,24 +467,41 @@ CLASS="QUOTE"
 ></LI
 ><LI
 ><P
->   <VAR
+>   <TT
+CLASS="LITERAL"
+><A
+HREF="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT"
+>handle-as-empty-document</A
+></TT
+> - 
+   sends an empty document instead of <SPAN
+CLASS="APPLICATION"
+>Privoxy's</SPAN
+> 
+   normal BLOCKED HTML page. This is useful for file types that are neither 
+   HTML nor images, such as blocking JavaScript files.
+  </P
+></LI
+><LI
+><P
+>   <TT
 CLASS="LITERAL"
 ><A
 HREF="actions-file.html#SET-IMAGE-BLOCKER"
 >set-image-blocker</A
-></VAR
+></TT
 > - tells
    <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
 > what to display in place of an ad image that
    has hit a block rule. For this to come into play, the URL must match a
-   <VAR
+   <TT
 CLASS="LITERAL"
 ><A
 HREF="actions-file.html#BLOCK"
 >block</A
-></VAR
+></TT
 > action somewhere in the
    configuration, <SPAN
 CLASS="emphasis"
@@ -473,12 +510,12 @@ CLASS="EMPHASIS"
 >and</I
 ></SPAN
 >, it must also match an
-   <VAR
+   <TT
 CLASS="LITERAL"
 ><A
 HREF="actions-file.html#HANDLE-AS-IMAGE"
 >handle-as-image</A
-></VAR
+></TT
 > action.
   </P
 ><P
@@ -554,6 +591,40 @@ CLASS="EMPHASIS"
 ></UL
 ></P
 ><P
+> Advanced users will eventually want to explore <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>
+ <TT
+CLASS="LITERAL"
+><A
+HREF="actions-file.html#FILTER"
+>filters</A
+></TT
+> as well. Filters 
+ are very different from <TT
+CLASS="LITERAL"
+><A
+HREF="actions-file.html#BLOCK"
+>blocks</A
+></TT
+>.
+ A <SPAN
+CLASS="QUOTE"
+>"block"</SPAN
+> blocks a site, page, or unwanted contented. Filters
+ are a way of filtering or modifying what is actually on the page. An example
+ filter usage: a text replacement of <SPAN
+CLASS="QUOTE"
+>"no-no"</SPAN
+> for
+ <SPAN
+CLASS="QUOTE"
+>"nasty-word"</SPAN
+>. That is a very simple example. This process can be
+ used for ad blocking, but it is more in the realm of advanced usage and has
+ some pitfalls to be wary off.</P
+><P
 > The quickest way to adjust any of these settings is with your browser through
  the special <SPAN
 CLASS="APPLICATION"
@@ -568,8 +639,23 @@ HREF="http://p.p/"
 TARGET="_top"
 >http://p.p/show-status</A
 >). This 
- is an internal page, and does not require Internet access. Select the
- appropriate <SPAN
+ is an internal page, and does not require Internet access.</P
+><P
+> Note that as of <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> 3.0.7 beta the
+ action editor is disabled by default. Check the
+ <A
+HREF="config.html#ENABLE-EDIT-ACTIONS"
+TARGET="_top"
+>enable-edit-actions
+  section in the configuration file</A
+> to learn why and in which
+ cases it's safe to enable again.</P
+><P
+> If you decided to enable the action editor, select the appropriate
+ <SPAN
 CLASS="QUOTE"
 >"actions"</SPAN
 > file, and click
@@ -641,7 +727,7 @@ CLASS="GUIBUTTON"
 >  <DIV
 CLASS="FIGURE"
 ><A
-NAME="AEN389"
+NAME="AEN675"
 ></A
 ><P
 ><B
@@ -651,7 +737,7 @@ NAME="AEN389"
 CLASS="MEDIAOBJECT"
 ><P
 ><IMG
-SRC="../images/files-in-use.jpg"></P
+SRC="files-in-use.jpg"></P
 ></DIV
 ></DIV
 >
@@ -660,12 +746,12 @@ SRC="../images/files-in-use.jpg"></P
 ><LI
 ><P
 >   You should have a section with only
-   <VAR
+   <TT
 CLASS="LITERAL"
 ><A
 HREF="actions-file.html#BLOCK"
 >block</A
-></VAR
+></TT
 > listed under 
    <SPAN
 CLASS="QUOTE"
@@ -687,12 +773,12 @@ CLASS="QUOTE"
 >"Actions:"</SPAN
 >.
    This will bring up a list of all actions. Find
-   <VAR
+   <TT
 CLASS="LITERAL"
 ><A
 HREF="actions-file.html#BLOCK"
 >block</A
-></VAR
+></TT
 > near the top, and click
    in the <SPAN
 CLASS="QUOTE"
@@ -709,12 +795,12 @@ CLASS="GUIBUTTON"
 ></LI
 ><LI
 ><P
->   Now, in the <VAR
+>   Now, in the <TT
 CLASS="LITERAL"
 ><A
 HREF="actions-file.html#BLOCK"
 >block</A
-></VAR
+></TT
 > actions section,
    click the <SPAN
 CLASS="QUOTE"
@@ -730,9 +816,9 @@ CLASS="GUIMENUITEM"
 >Copy Link Location</SPAN
 >"</SPAN
 >.
-   Remove the <VAR
+   Remove the <TT
 CLASS="LITERAL"
->http://</VAR
+>http://</TT
 > at the beginning of the URL. Then, click
    <SPAN
 CLASS="QUOTE"
@@ -780,6 +866,18 @@ HREF="actions-file.html#ACT-EXAMPLES"
 >Actions Files Tutorial</A
 >.
  The ideas explained therein also apply to the web-based editor.</P
+><P
+> There are also various 
+ <A
+HREF="actions-file.html#FILTER"
+>filters</A
+> that can be used for ad blocking 
+ (filters are a special subset of actions). These 
+ fall into the <SPAN
+CLASS="QUOTE"
+>"advanced"</SPAN
+> usage category, and are explained in
+ depth in later sections. </P
 ></DIV
 ></DIV
 ><DIV
@@ -798,7 +896,7 @@ WIDTH="33%"
 ALIGN="left"
 VALIGN="top"
 ><A
-HREF="upgradersnote.html"
+HREF="whatsnew.html"
 ACCESSKEY="P"
 >Prev</A
 ></TD
@@ -826,7 +924,7 @@ ACCESSKEY="N"
 WIDTH="33%"
 ALIGN="left"
 VALIGN="top"
->Note to Upgraders</TD
+>What's New in this Release</TD
 ><TD
 WIDTH="34%"
 ALIGN="center"
@@ -836,13 +934,10 @@ VALIGN="top"
 WIDTH="33%"
 ALIGN="right"
 VALIGN="top"
->Starting <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-></TD
+>Starting Privoxy</TD
 ></TR
 ></TABLE
 ></DIV
 ></BODY
 ></HTML
->
\ No newline at end of file
+>