+<!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.76b+
-"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
-TITLE="Privoxy 3.0.4 User Manual"
+TITLE="Privoxy 3.0.27 User Manual"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="What's New in this Release"
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"
><TH
COLSPAN="3"
ALIGN="center"
->Privoxy 3.0.4 User Manual</TH
+>Privoxy 3.0.27 User Manual</TH
></TR
><TR
><TD
CLASS="SECT1"
><A
NAME="QUICKSTART"
-></A
->4. Quickstart to Using <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
+>4. Quickstart to Using Privoxy</A
></H1
><P
-> <P
></P
><UL
><LI
HREF="installation.html"
>Installation Section</A
> below for platform specific
- information.
+ information.
</P
></LI
><LI
>, especially the <A
HREF="config.html#ACCESS-CONTROL"
>security-relevant</A
-> options. These are
+> options. These are
off by default.
</P
></LI
CLASS="APPLICATION"
>Privoxy</SPAN
> as HTTP and
- HTTPS (SSL) proxy by setting the proxy configuration for address of
+ 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</TT
CLASS="LITERAL"
>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
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
><P
-> A default installation should provide a reasonable starting point for
+> 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.
+ configuration, but that can be dealt with as the need arises. Little
+ 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
>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
-> behavio
ur, 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
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
></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
- help.
+> on how to report bugs, problems with websites or to get
+ help.
</P
></LI
><LI
</P
></LI
></UL
-></P
><DIV
CLASS="SECT2"
><H2
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"
>Privoxy's</SPAN
>
- array of features. Many of these features are for the technically minded advanced
+ array of features. Many of these features are for the technically minded advanced
user. But, ad and banner blocking is surely common ground for everybody.</P
><P
->
- This section will provide a quick summary of ad blocking so
+> This section will provide a quick summary of ad blocking so
you can get up to speed quickly without having to read the more extensive
information provided below, though this is highly recommended.</P
><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
+ more aggressive you are about it, the more likely you are to block
+ 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"
>"problem"</SPAN
> sites, and to spend more time adjusting the
- configuration to solve these unintended consequences. In short, there is
+ configuration to solve these unintended consequences. In short, there is
not an easy way to eliminate <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>all</I
></SPAN
-> ads. Either take
+> ads. Either take
the easy way and settle for <SPAN
CLASS="emphasis"
><I
>. <SPAN
CLASS="QUOTE"
>"Actions"</SPAN
-> in this context, are
+> in this context, are
the directives we use to tell <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
CLASS="APPLICATION"
>Privoxy's</SPAN
> configuration,
- followed by one or more URLs to which the action should apply. URLs
+ followed by one or more URLs to which the action should apply. URLs
can actually be URL type <A
HREF="actions-file.html#AF-PATTERNS"
>patterns</A
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: <TT
+> The most important actions for basic ad blocking are: <TT
CLASS="LITERAL"
><A
HREF="actions-file.html#BLOCK"
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
>:</P
><P
-> <P
></P
><UL
><LI
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
->'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
HREF="actions-file.html#HANDLE-AS-IMAGE"
>handle-as-image</A
></TT
-> -
+> -
tells <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
for all common image types (e.g. GIF), but there are many situations where this
is not so easy to determine. So we'll force it in these cases. This is particularly
important for ad blocking, since only if we know that it's an image of
- some kind, can we replace it with an image of our choosing, instead of the
+ some kind, can we replace it with an image of our choosing, instead of the
<SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
> <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
CLASS="EMPHASIS"
>pattern</I
></SPAN
-> - a checkerboard pattern, so that an ad
+> - a checkerboard pattern, so that an ad
replacement is obvious. This is the default.
</TD
></TR
></P
></LI
></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
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
+>). This
+ 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
><P
> A quick and simple step by step example:</P
><P
-> <P
></P
><UL
><LI
><P
-> Right click on the ad image to be blocked, then select
+> Right click on the ad image to be blocked, then select
<SPAN
CLASS="QUOTE"
>"<SPAN
>Copy Link Location</SPAN
>"</SPAN
> from the
- pop-up menu.
+ pop-up menu.
</P
></LI
><LI
><P
-> Set your browser to
+> Set your browser to
<A
HREF="http://config.privoxy.org/show-status"
TARGET="_top"
> Find <TT
CLASS="FILENAME"
>user.action</TT
-> in the top section, and click
+> in the top section, and click
on <SPAN
CLASS="QUOTE"
>"<SPAN
>"</SPAN
>:
</P
-><P
-> <DIV
+><DIV
CLASS="FIGURE"
><A
-NAME="AEN507"
+NAME="AEN641"
></A
><P
><B
CLASS="MEDIAOBJECT"
><P
><IMG
-SRC="../images/files-in-use.jpg"></P
+SRC="files-in-use.jpg"></P
></DIV
></DIV
->
- </P
></LI
><LI
><P
HREF="actions-file.html#BLOCK"
>block</A
></TT
-> listed under
+> listed under
<SPAN
CLASS="QUOTE"
>"Actions:"</SPAN
>Insert new section below</SPAN
>"</SPAN
>
- button, and in the new section that just appeared, click the
+ button, and in the new section that just appeared, click the
<SPAN
CLASS="GUIBUTTON"
>Edit</SPAN
</P
></LI
></UL
-></P
><P
-> This is a very crude and simple example. There might be good reasons to use a
+> This is a very crude and simple example. There might be good reasons to use a
wildcard pattern match to include potentially similar images from the same
site. For a more extensive explanation of <SPAN
CLASS="QUOTE"
>"patterns"</SPAN
->, and
+>, and
the entire actions concept, see <A
HREF="actions-file.html"
>the Actions
>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
WIDTH="33%"
ALIGN="right"
VALIGN="top"
->Starting <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-></TD
+>Starting Privoxy</TD
></TR
></TABLE
></DIV
projects / privoxy.git / blobdiff