projects / privoxy.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Rebuild for 3.0.17 stable
[privoxy.git] / doc / webserver / user-manual / quickstart.html
diff --git a/doc/webserver/user-manual/quickstart.html b/doc/webserver/user-manual/quickstart.html
index c462858..c81f013 100644 (file)
--- a/doc/webserver/user-manual/quickstart.html
+++ b/doc/webserver/user-manual/quickstart.html
@@ -1,13 +1,13 @@
+<!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"
 <HTML
 ><HEAD
 ><TITLE
 >Quickstart to Using Privoxy</TITLE
 ><META
 NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
-"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
 REL="HOME"
 REL="HOME"
-TITLE="Privoxy 3.0.5 User Manual"
+TITLE="Privoxy 3.0.17 User Manual"
 HREF="index.html"><LINK
 REL="PREVIOUS"
 TITLE="What's New in this Release"
 HREF="index.html"><LINK
 REL="PREVIOUS"
 TITLE="What's New in this Release"
@@ -17,7 +17,10 @@ TITLE="Starting Privoxy"
 HREF="startup.html"><LINK
 REL="STYLESHEET"
 TYPE="text/css"
 HREF="startup.html"><LINK
 REL="STYLESHEET"
 TYPE="text/css"
-HREF="../p_doc.css">
+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
 <LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
 </head
 ><BODY
@@ -39,7 +42,7 @@ CELLSPACING="0"
 ><TH
 COLSPAN="3"
 ALIGN="center"
 ><TH
 COLSPAN="3"
 ALIGN="center"
->Privoxy 3.0.5 User Manual</TH
+>Privoxy 3.0.17 User Manual</TH
 ></TR
 ><TR
 ><TD
 ></TR
 ><TR
 ><TD
@@ -76,8 +79,8 @@ CLASS="SECT1"
 CLASS="SECT1"
 ><A
 NAME="QUICKSTART"
 CLASS="SECT1"
 ><A
 NAME="QUICKSTART"
-></A
->4. Quickstart to Using Privoxy</H1
+>4. Quickstart to Using Privoxy</A
+></H1
 ><P
 > <P
 ></P
 ><P
 > <P
 ></P
@@ -155,7 +158,8 @@ CLASS="EMPHASIS"
 CLASS="LITERAL"
 >FTP</TT
 > or 
 CLASS="LITERAL"
 >FTP</TT
 > or 
-   any protocols besides HTTP and HTTPS (SSL)! It won't work!
+   any protocols besides HTTP and HTTPS (SSL) unless you intend to prevent your
+   browser from using these protocols.
   </P
 ></LI
 ><LI
   </P
 ></LI
 ><LI
@@ -178,7 +182,14 @@ TARGET="_top"
 >   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 
 >   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
   </P
 ><P
 >   See the <A
@@ -223,7 +234,7 @@ HREF="appendix.html#ACTIONSANAT"
 >Troubleshooting: Anatomy of an
     Action</A
 >"</SPAN
 >Troubleshooting: Anatomy of an
     Action</A
 >"</SPAN
-> has hints how to understand and debug actions that
+> has hints on how to understand and debug actions that
     <SPAN
 CLASS="QUOTE"
 >"misbehave"</SPAN
     <SPAN
 CLASS="QUOTE"
 >"misbehave"</SPAN
@@ -232,19 +243,6 @@ CLASS="QUOTE"
 ></LI
 ><LI
 ><P
 ></LI
 ><LI
 ><P
->   For easy access to <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
->'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
 >   Please see the section <A
 HREF="contact.html"
 >Contacting the
@@ -266,8 +264,8 @@ CLASS="SECT2"
 CLASS="SECT2"
 ><A
 NAME="QUICKSTART-AD-BLOCKING"
 CLASS="SECT2"
 ><A
 NAME="QUICKSTART-AD-BLOCKING"
-></A
->4.1. Quickstart to Ad Blocking</H2
+>4.1. Quickstart to Ad Blocking</A
+></H2
 ><P
 > Ad blocking is but one of <SPAN
 CLASS="APPLICATION"
 ><P
 > Ad blocking is but one of <SPAN
 CLASS="APPLICATION"
@@ -283,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 
 ><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"
  extreme ad free browsing, be prepared to deal with more
  <SPAN
 CLASS="QUOTE"
@@ -374,9 +373,14 @@ 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
  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
 ><P
-> The actions we need to know about for ad blocking are:  <TT
+> The most important actions for basic ad blocking are:  <TT
 CLASS="LITERAL"
 ><A
 HREF="actions-file.html#BLOCK"
 CLASS="LITERAL"
 ><A
 HREF="actions-file.html#BLOCK"
@@ -388,7 +392,14 @@ CLASS="LITERAL"
 HREF="actions-file.html#HANDLE-AS-IMAGE"
 >handle-as-image</A
 ></TT
 HREF="actions-file.html#HANDLE-AS-IMAGE"
 >handle-as-image</A
 ></TT
->, and
+>, 
+ <TT
+CLASS="LITERAL"
+><A
+HREF="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT"
+>handle-as-empty-document</A
+></TT
+>,and
  <TT
 CLASS="LITERAL"
 ><A
  <TT
 CLASS="LITERAL"
 ><A
@@ -408,15 +419,17 @@ CLASS="LITERAL"
 HREF="actions-file.html#BLOCK"
 >block</A
 ></TT
 HREF="actions-file.html#BLOCK"
 >block</A
 ></TT
-> - 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
+> - 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
 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
 ></LI
 ><LI
@@ -457,6 +470,23 @@ CLASS="QUOTE"
 >   <TT
 CLASS="LITERAL"
 ><A
 >   <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
 ></TT
 HREF="actions-file.html#SET-IMAGE-BLOCKER"
 >set-image-blocker</A
 ></TT
@@ -561,6 +591,40 @@ CLASS="EMPHASIS"
 ></UL
 ></P
 ><P
 ></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"
 > The quickest way to adjust any of these settings is with your browser through
  the special <SPAN
 CLASS="APPLICATION"
@@ -575,8 +639,23 @@ HREF="http://p.p/"
 TARGET="_top"
 >http://p.p/show-status</A
 >). This 
 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
 CLASS="QUOTE"
 >"actions"</SPAN
 > file, and click
@@ -648,7 +727,7 @@ CLASS="GUIBUTTON"
 >  <DIV
 CLASS="FIGURE"
 ><A
 >  <DIV
 CLASS="FIGURE"
 ><A
-NAME="AEN565"
+NAME="AEN675"
 ></A
 ><P
 ><B
 ></A
 ><P
 ><B
@@ -787,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
 >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
 ></DIV
 ></DIV
 ><DIV
@@ -849,4 +940,4 @@ VALIGN="top"
 ></DIV
 ></BODY
 ></HTML
 ></DIV
 ></BODY
 ></HTML
->
\ No newline at end of file
+>
The official Privoxy git repository