+<!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.64
-"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
-TITLE="Privoxy User Manual"
+TITLE="Privoxy 3.0.17 User Manual"
HREF="index.html"><LINK
REL="PREVIOUS"
-TITLE="Installation"
-HREF="installation.html"><LINK
+TITLE="What's New in this Release"
+HREF="whatsnew.html"><LINK
REL="NEXT"
-TITLE="Privoxy Configuration"
-HREF="configuration.html"><LINK
+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"
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
><TH
COLSPAN="3"
ALIGN="center"
->Privoxy User Manual</TH
+>Privoxy 3.0.17 User Manual</TH
></TR
><TR
><TD
ALIGN="left"
VALIGN="bottom"
><A
-HREF="installation.html"
+HREF="whatsnew.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
ALIGN="right"
VALIGN="bottom"
><A
-HREF="configuration.html"
+HREF="startup.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
CLASS="SECT1"
><A
NAME="QUICKSTART"
->4. Quickstart to Using <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-></A
+>4. Quickstart to Using Privoxy</A
></H1
-><DIV
-CLASS="SECT2"
-><H2
-CLASS="SECT2"
-><A
-NAME="UPGRADERSNOTE"
->4.1. Note to Upgraders</A
-></H2
-><P
-> There are very significant changes from older versions of
- <SPAN
-CLASS="APPLICATION"
->Junkbuster</SPAN
-> to the current
- <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
->. Configuration is substantially
- changed. <SPAN
-CLASS="APPLICATION"
->Junkbuster 2.0.x</SPAN
-> and earlier
- configuration files will not migrate. The functionality of the old
- <TT
-CLASS="FILENAME"
->blockfile</TT
->, <TT
-CLASS="FILENAME"
->cookiefile</TT
-> and
- <TT
-CLASS="FILENAME"
->imagelist</TT
->, are now combined into the
- <SPAN
-CLASS="QUOTE"
->"actions file"</SPAN
-> (<TT
-CLASS="FILENAME"
->default.action</TT
->
- for most installations).</P
-><P
-> A <SPAN
-CLASS="QUOTE"
->"filter file"</SPAN
-> (typically <TT
-CLASS="FILENAME"
->default.filter</TT
->)
- is new as of <SPAN
-CLASS="APPLICATION"
->Privoxy 2.9.x</SPAN
->, and provides some
- of the new sophistication (explained below). <TT
-CLASS="FILENAME"
->config</TT
-> is
- much the same as before.</P
-><P
-> If upgrading from a 2.0.x version, you will have to use the new config
- files, and possibly adapt any personal rules from your older files.
- When porting personal rules over from the old <TT
-CLASS="FILENAME"
->blockfile</TT
->
- to the new actions file, please note that even the pattern syntax has
- changed. If upgrading from 2.9.x development versions, it is still
- recommended to use the new configuration files.</P
-><P
-> A quick list of things to be aware of before upgrading: </P
><P
> <P
></P
><UL
><LI
><P
-> The default listening port is now 8118 due to a conflict with another
- service (NAS).
+> Install <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>. See the <A
+HREF="installation.html"
+>Installation Section</A
+> below for platform specific
+ information.
+ </P
+></LI
+><LI
+><P
+> Advanced users and those who want to offer <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>
+ service to more than just their local machine should check the <A
+HREF="config.html"
+>main config file</A
+>, especially the <A
+HREF="config.html#ACCESS-CONTROL"
+>security-relevant</A
+> options. These are
+ off by default.
</P
></LI
><LI
><P
->
- Some installers may remove earlier versions completely. Save any
- important configuration files!
+> Start <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>, if the installation program has
+ not done this already (may vary according to platform). See the section
+ <A
+HREF="startup.html"
+>Starting <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+></A
+>.
</P
></LI
><LI
><P
-> <SPAN
+> Set your browser to use <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> is controllable with a web browser
-HREF="http://config.privoxy.org/"
+> as HTTP and
+HREF="http://en.wikipedia.org/wiki/Proxy_server"
TARGET="_top"
->http://config.privoxy.org/</A
+>proxy</A
>
- (Shortcut: <A
-HREF="http://p.p/"
-TARGET="_top"
->http://p.p/</A
->). Many
- aspects of configuration can be done here, including temporarily disabling
+ by setting the proxy configuration for address of
+ <TT
+CLASS="LITERAL"
+>127.0.0.1</TT
+> and port <TT
+CLASS="LITERAL"
+>8118</TT
+>.
<SPAN
+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
+><P
+> Flush your browser's disk and memory caches, to remove any cached ad images.
+ If using <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
->.
+> 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
-> The primary configuration file for cookie management, ad and banner
- blocking, and many other aspects of <SPAN
+> 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, 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
+HREF="configuration.html"
+>Configuration section</A
+> for more
+ configuration options, and how to customize your installation.
+ 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 slip through, innocent images that are
+ blocked, or otherwise feel the need to fine-tune
+ <SPAN
+CLASS="APPLICATION"
+>Privoxy's</SPAN
+> behavior, take a look at the <A
+HREF="actions-file.html"
+>actions files</A
+>. As a quick start, you might
+ find the <A
+HREF="actions-file.html#ACT-EXAMPLES"
+>richly commented examples</A
>
- configuration is <TT
-CLASS="FILENAME"
->default.action</TT
->. It is strongly
- recommended to become familiar with the new actions concept below,
- before modifying this file.
+ helpful. You can also view and edit the actions files through the <A
+HREF="http://config.privoxy.org"
+TARGET="_top"
+>web-based user interface</A
+>. The
+ Appendix <SPAN
+CLASS="QUOTE"
+>"<A
+HREF="appendix.html#ACTIONSANAT"
+>Troubleshooting: Anatomy of an
+ Action</A
+>"</SPAN
+> has hints on how to understand and debug actions that
+ <SPAN
+CLASS="QUOTE"
+>"misbehave"</SPAN
+>.
</P
></LI
><LI
><P
->
- Some installers may not automatically start
- <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> after installation.
+> Please see the section <A
+HREF="contact.html"
+>Contacting the
+ Developers</A
+> on how to report bugs, problems with websites or to get
+ help.
+ </P
+></LI
+><LI
+><P
+> Now enjoy surfing with enhanced control, comfort and privacy!
</P
></LI
></UL
></P
-></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
-NAME="STARTUP"
->4.2. Starting <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-></A
+NAME="QUICKSTART-AD-BLOCKING"
+>4.1. Quickstart to Ad Blocking</A
></H2
><P
-> Before launching <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> for the first time, you
- will want to configure your browser(s) to use <SPAN
+> Ad blocking is but one of <SPAN
CLASS="APPLICATION"
->Privoxy</SPAN
+>Privoxy's</SPAN
>
- as a HTTP and HTTPS proxy. The default is localhost for the proxy address,
- and port 8118 (earlier versions used port 8000). This is the one
- configuration step that must be done! </P
+ 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
>
- With <SPAN
+ 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. 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
+ not an easy way to eliminate <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>all</I
+></SPAN
+> ads. Either take
+ the easy way and settle for <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>most</I
+></SPAN
+> ads blocked with the
+ default configuration, or jump in and tweak it for your personal surfing
+ habits and preferences.</P
+><P
+> Secondly, a brief explanation of <SPAN
CLASS="APPLICATION"
->Netscape</SPAN
-> (and
+>Privoxy's </SPAN
+>
<SPAN
+CLASS="QUOTE"
+>"actions"</SPAN
+>. <SPAN
+CLASS="QUOTE"
+>"Actions"</SPAN
+> in this context, are
+ the directives we use to tell <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> to perform
+ some task relating to HTTP transactions (i.e. web browsing). We tell
+ <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> to take some <SPAN
+CLASS="QUOTE"
+>"action"</SPAN
+>. Each
+ action has a unique name and function. While there are many potential
+ <SPAN
+CLASS="APPLICATION"
+>actions</SPAN
+> in <SPAN
CLASS="APPLICATION"
->Mozilla</SPAN
->), this can be set under <TT
+>Privoxy's</SPAN
+>
+ arsenal, only a few are used for ad blocking. <A
+HREF="actions-file.html#ACTIONS"
+>Actions</A
+>, and <A
+HREF="actions-file.html"
+>action
+ configuration files</A
+>, are explained in depth below.</P
+><P
+> Actions are specified in <SPAN
+CLASS="APPLICATION"
+>Privoxy's</SPAN
+> configuration,
+ 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
+> that use
+ wildcards so they can apply potentially to a range of similar URLs. The
+ actions, together with the URL patterns are called a section.</P
+><P
+> When you connect to a website, the full URL will either match one or more
+ of the sections as defined in <SPAN
+CLASS="APPLICATION"
+>Privoxy's</SPAN
+> configuration,
+ or not. If so, then <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> will perform the
+ respective actions. If not, then nothing special happens. Furthermore, web
+ pages may contain embedded, secondary URLs that your web browser will
+ use to load additional components of the page, as it parses the
+ 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. <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 most important actions for basic ad blocking are: <TT
CLASS="LITERAL"
->Edit
- -> Preferences -> Advanced -> Proxies -> HTTP Proxy</TT
->.
- For <SPAN
+><A
+HREF="actions-file.html#BLOCK"
+>block</A
+></TT
+>, <TT
+CLASS="LITERAL"
+><A
+HREF="actions-file.html#HANDLE-AS-IMAGE"
+>handle-as-image</A
+></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
+></TT
+>:</P
+><P
+> <P
+></P
+><UL
+><LI
+><P
+> <TT
+CLASS="LITERAL"
+><A
+HREF="actions-file.html#BLOCK"
+>block</A
+></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"
->Internet Explorer</SPAN
->: <TT
+>Privoxy</SPAN
+>'s own built-in BLOCKED page instead to
+ let you now what has happened (with some exceptions, see below).
+ </P
+></LI
+><LI
+><P
+> <TT
CLASS="LITERAL"
->Tools ->
- Internet Properties -> Connections -> LAN Setting</TT
->. Then,
- check <SPAN
+><A
+HREF="actions-file.html#HANDLE-AS-IMAGE"
+>handle-as-image</A
+></TT
+> -
+ tells <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> to treat this URL as an image.
+ <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>'s default configuration already does this
+ 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
+ <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> BLOCKED page (which would only result in
+ a <SPAN
CLASS="QUOTE"
->"Use Proxy"</SPAN
-> and fill in the appropriate info (Address:
- localhost, Port: 8118). Include if HTTPS proxy support too.</P
+>"broken image"</SPAN
+> icon). There are some limitations to this
+ though. For instance, you can't just brute-force an image substitution for
+ an entire HTML page in most situations.
+ </P
+></LI
+><LI
><P
-> After doing this, flush your browser's disk and memory caches to force a
- re-reading of all pages and to get rid of any ads that may be cached. You
- are now ready to start enjoying the benefits of using
- <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</SPAN
->!</P
+>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
-> <SPAN
+> <TT
+CLASS="LITERAL"
+><A
+HREF="actions-file.html#SET-IMAGE-BLOCKER"
+>set-image-blocker</A
+></TT
+> - tells
+ <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> is typically started by specifying the
- main configuration file to be used on the command line. Example Unix startup
- command:</P
+> 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
+ <TT
+CLASS="LITERAL"
+><A
+HREF="actions-file.html#BLOCK"
+>block</A
+></TT
+> action somewhere in the
+ configuration, <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>and</I
+></SPAN
+>, it must also match an
+ <TT
+CLASS="LITERAL"
+><A
+HREF="actions-file.html#HANDLE-AS-IMAGE"
+>handle-as-image</A
+></TT
+> action.
+ </P
+><P
+> The configuration options on what to display instead of the ad are:
+ </P
><P
-> <TABLE
+></P
+><TABLE
BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
+><TBODY
><TR
><TD
-><PRE
-CLASS="SCREEN"
->
- # /usr/sbin/privoxy /etc/privoxy/config
-
- </PRE
-></TD
+> <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>pattern</I
+></SPAN
+> - a checkerboard pattern, so that an ad
+ replacement is obvious. This is the default.
+ </TD
></TR
+></TBODY
></TABLE
-></P
-><P
-> See <A
-HREF="quickstart.html#CMDOPTIONS"
->below</A
-> for other command line options.</P
><P
-> An init script is provided for SuSE and Red Hat.</P
+></P
><P
-> For for SuSE: <B
-CLASS="COMMAND"
->rcprivoxy start</B
></P
+><TABLE
+BORDER="0"
+><TBODY
+><TR
+><TD
+> <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>blank</I
+></SPAN
+> - A very small empty GIF image is displayed.
+ This is the so-called <SPAN
+CLASS="QUOTE"
+>"invisible"</SPAN
+> configuration option.
+ </TD
+></TR
+></TBODY
+></TABLE
><P
-> For Red Hat and Debian: <B
-CLASS="COMMAND"
->/etc/rc.d/init.d/privoxy start</B
></P
><P
-> If no configuration file is specified on the command line,
- <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> will look for a file named
- <TT
-CLASS="FILENAME"
->config</TT
-> in the current directory. Except on Win32 where
- it will try <TT
-CLASS="FILENAME"
->config.txt</TT
->. If no file is specified on the
- command line and no default configuration file can be found,
- <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> will fail to start.</P
+></P
+><TABLE
+BORDER="0"
+><TBODY
+><TR
+><TD
+> <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>http://<URL></I
+></SPAN
+> - A redirect to any image anywhere
+ of the user's choosing (advanced usage).
+ </TD
+></TR
+></TBODY
+></TABLE
><P
-> The included default configuration files should give a reasonable starting
- point. Most of the per site configuration is done in the
- <SPAN
-CLASS="QUOTE"
->"actions"</SPAN
-> files. These are where various cookie actions are
- defined, ad and banner blocking, and other aspects of
- <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> configuration. There are several such
- files included, with varying levels of aggressiveness. </P
+></P
+></LI
+></UL
+></P
><P
-> You will probably want to keep an eye out for sites that require persistent
- cookies, and add these to <TT
-CLASS="FILENAME"
->default.action</TT
-> as needed. By
- default, most of these will be accepted only during the current browser
- session (aka <SPAN
-CLASS="QUOTE"
->"session cookies"</SPAN
->), until you add them to the
- configuration. If you want the browser to handle this instead, you will need
- to edit <TT
-CLASS="FILENAME"
->default.action</TT
-> and disable this feature. If you
- use more than one browser, it would make more sense to let
- <SPAN
+> Advanced users will eventually want to explore <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> handle this. In which case, the
- browser(s) should be set to accept all cookies.</P
-><P
-> Another feature where you will probably want to define exceptions for trusted
- sites is the popup-killing (through the <TT
-CLASS="LITERAL"
->+popup</TT
-> and
+>
<TT
CLASS="LITERAL"
->+filter{popups}</TT
-> actions), because your favorite shopping,
- banking, or leisure site may need popups. </P
-><P
-> <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> is HTTP/1.1 compliant, but not all of
- the optional 1.1 features are as yet supported. In the unlikely event that
- you experience inexplicable problems with browsers that use HTTP/1.1 per default
- (like <SPAN
-CLASS="APPLICATION"
->Mozilla</SPAN
-> or recent versions of I.E.), you might
- try to force HTTP/1.0 compatibility. For Mozilla, look under <TT
+><A
+HREF="actions-file.html#FILTER"
+>filters</A
+></TT
+> as well. Filters
+ are very different from <TT
CLASS="LITERAL"
->Edit ->
- Preferences -> Debug -> Networking</TT
+><A
+HREF="actions-file.html#BLOCK"
+>blocks</A
+></TT
>.
- Alternatively, set the <SPAN
+ A <SPAN
CLASS="QUOTE"
->"+downgrade"</SPAN
-> config option in
- <TT
-CLASS="FILENAME"
->default.action</TT
-> which will downgrade your browser's HTTP
- requests from HTTP/1.1 to HTTP/1.0 before processing them.</P
+>"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
-> After running <SPAN
+> The quickest way to adjust any of these settings is with your browser through
+ the special <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> for a while, you can
- start to fine tune the configuration to suit your personal, or site,
- preferences and requirements. There are many, many aspects that can
- be customized. <SPAN
-CLASS="QUOTE"
->"Actions"</SPAN
-> (as specified in <TT
-CLASS="FILENAME"
->default.action</TT
->)
- can be adjusted by pointing your browser to
- <A
-HREF="http://config.privoxy.org/"
+> editor at <A
+HREF="http://config.privoxy.org/show-status"
TARGET="_top"
->http://config.privoxy.org/</A
+>http://config.privoxy.org/show-status</A
>
(shortcut: <A
HREF="http://p.p/"
TARGET="_top"
->http://p.p/</A
->),
- and then follow the link to <SPAN
-CLASS="QUOTE"
->"edit the actions list"</SPAN
->.
- (This is an internal page and does not require Internet access.)</P
+>http://p.p/show-status</A
+>). This
+ is an internal page, and does not require Internet access.</P
><P
-> In fact, various aspects of <SPAN
+> Note that as of <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
->
- configuration can be viewed from this page, including
- current configuration parameters, source code version numbers,
- the browser's request headers, and <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
-> that apply
- to a given URL. In addition to the <TT
-CLASS="FILENAME"
->default.action</TT
-> file
- editor mentioned above, <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> can also
- be turned <SPAN
+> file, and click
+ <SPAN
CLASS="QUOTE"
->"on"</SPAN
-> and <SPAN
+>"<SPAN
+CLASS="GUIBUTTON"
+>Edit</SPAN
+>"</SPAN
+>. It is best to put personal or
+ local preferences in <TT
+CLASS="FILENAME"
+>user.action</TT
+> since this is not
+ meant to be overwritten during upgrades, and will over-ride the settings in
+ other files. Here you can insert new <SPAN
CLASS="QUOTE"
->"off"</SPAN
-> (toggled) from this page.</P
-><P
-> If you encounter problems, try loading the page without
+>"actions"</SPAN
+>, and URLs for ad
+ blocking or other purposes, and make other adjustments to the configuration.
<SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
->. If that helps, enter the URL where
- you have the problems into <A
-HREF="http://p.p/show-url-info"
-TARGET="_top"
->the browser
- based rule tracing utility</A
->. See which rules apply and why, and
- then try turning them off for that site one after the other, until the problem
- is gone. When you have found the culprit, you might want to turn the rest on
- again.</P
-><P
-> If the above paragraph sounds gibberish to you, you might want to <A
-HREF="configuration.html#ACTIONSFILE"
-TARGET="_top"
->read more about the actions concept</A
->
- or even dive deep into the <A
-HREF="appendix.html#ACTIONSANAT"
-TARGET="_top"
->Appendix
- on actions</A
->.</P
+> will detect these changes automatically.</P
><P
-> If you can't get rid of the problem at all, think you've found a bug in
- Privoxy, want to propose a new feature or smarter rules, please see the
- chapter "Contacting the Developers, .." below.</P
-></DIV
-><DIV
-CLASS="SECT2"
-><H2
-CLASS="SECT2"
-><A
-NAME="CMDOPTIONS"
->4.3. Command Line Options</A
-></H2
-><P
-> <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> may be invoked with the following
- command-line options:</P
+> A quick and simple step by step example:</P
><P
> <P
></P
><UL
><LI
><P
-> <I
-CLASS="EMPHASIS"
->--version</I
->
- </P
-><P
-> Print version info and exit. Unix only.
- </P
+> Right click on the ad image to be blocked, then select
+ <SPAN
+CLASS="QUOTE"
+>"<SPAN
+CLASS="GUIMENUITEM"
+>Copy Link Location</SPAN
+>"</SPAN
+> from the
+ pop-up menu.
+ </P
></LI
><LI
><P
-> <I
-CLASS="EMPHASIS"
->--help</I
+> Set your browser to
+ <A
+HREF="http://config.privoxy.org/show-status"
+TARGET="_top"
+>http://config.privoxy.org/show-status</A
>
- </P
-><P
-> Print short usage info and exit. Unix only.
- </P
+ </P
></LI
><LI
><P
-> <I
-CLASS="EMPHASIS"
->--no-daemon</I
->
- </P
+> Find <TT
+CLASS="FILENAME"
+>user.action</TT
+> in the top section, and click
+ on <SPAN
+CLASS="QUOTE"
+>"<SPAN
+CLASS="GUIBUTTON"
+>Edit</SPAN
+>"</SPAN
+>:
+ </P
+><P
+> <DIV
+CLASS="FIGURE"
+><A
+NAME="AEN675"
+></A
><P
-> Don't become a daemon, i.e. don't fork and become process group
- leader, and don't detach from controlling tty. Unix only.
- </P
+><B
+>Figure 1. Actions Files in Use</B
+></P
+><DIV
+CLASS="MEDIAOBJECT"
+><P
+><IMG
+SRC="files-in-use.jpg"></P
+></DIV
+></DIV
+>
+ </P
></LI
><LI
><P
-> <I
-CLASS="EMPHASIS"
->--pidfile FILE</I
+> You should have a section with only
+ <TT
+CLASS="LITERAL"
+><A
+HREF="actions-file.html#BLOCK"
+>block</A
+></TT
+> listed under
+ <SPAN
+CLASS="QUOTE"
+>"Actions:"</SPAN
+>.
+ If not, click a <SPAN
+CLASS="QUOTE"
+>"<SPAN
+CLASS="GUIBUTTON"
+>Insert new section below</SPAN
+>"</SPAN
>
-
- </P
-><P
-> On startup, write the process ID to <I
-CLASS="EMPHASIS"
->FILE</I
->. Delete the
- <I
-CLASS="EMPHASIS"
->FILE</I
-> on exit. Failure to create or delete the
- <I
-CLASS="EMPHASIS"
->FILE</I
-> is non-fatal. If no <I
-CLASS="EMPHASIS"
->FILE</I
+ button, and in the new section that just appeared, click the
+ <SPAN
+CLASS="GUIBUTTON"
+>Edit</SPAN
+> button right under the word <SPAN
+CLASS="QUOTE"
+>"Actions:"</SPAN
+>.
+ This will bring up a list of all actions. Find
+ <TT
+CLASS="LITERAL"
+><A
+HREF="actions-file.html#BLOCK"
+>block</A
+></TT
+> near the top, and click
+ in the <SPAN
+CLASS="QUOTE"
+>"Enabled"</SPAN
+> column, then <SPAN
+CLASS="QUOTE"
+>"<SPAN
+CLASS="GUIBUTTON"
+>Submit</SPAN
+>"</SPAN
>
- option is given, no PID file will be used. Unix only.
+ just below the list.
</P
></LI
><LI
><P
-> <I
-CLASS="EMPHASIS"
->--user USER[.GROUP]</I
->
-
- </P
-><P
-> After (optionally) writing the PID file, assume the user ID of
- <I
-CLASS="EMPHASIS"
->USER</I
->, and if included the GID of GROUP. Exit if the
- privileges are not sufficient to do so. Unix only.
+> Now, in the <TT
+CLASS="LITERAL"
+><A
+HREF="actions-file.html#BLOCK"
+>block</A
+></TT
+> actions section,
+ click the <SPAN
+CLASS="QUOTE"
+>"<SPAN
+CLASS="GUIBUTTON"
+>Add</SPAN
+>"</SPAN
+> button, and paste the URL the
+ browser got from <SPAN
+CLASS="QUOTE"
+>"<SPAN
+CLASS="GUIMENUITEM"
+>Copy Link Location</SPAN
+>"</SPAN
+>.
+ Remove the <TT
+CLASS="LITERAL"
+>http://</TT
+> at the beginning of the URL. Then, click
+ <SPAN
+CLASS="QUOTE"
+>"<SPAN
+CLASS="GUIBUTTON"
+>Submit</SPAN
+>"</SPAN
+> (or
+ <SPAN
+CLASS="QUOTE"
+>"<SPAN
+CLASS="GUIBUTTON"
+>OK</SPAN
+>"</SPAN
+> if in a pop-up window).
</P
></LI
><LI
><P
-> <I
-CLASS="EMPHASIS"
->configfile</I
+> Now go back to the original page, and press <B
+CLASS="KEYCAP"
+>SHIFT-Reload</B
>
- </P
-><P
-> If no <I
-CLASS="EMPHASIS"
->configfile</I
-> is included on the command line,
- <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> will look for a file named
- <SPAN
-CLASS="QUOTE"
->"config"</SPAN
-> in the current directory (except on Win32
- where it will look for <SPAN
-CLASS="QUOTE"
->"config.txt"</SPAN
-> instead). Specify
- full path to avoid confusion. If no config file is found,
- <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> will fail to start.
+ (or flush all browser caches). The image should be gone now.
</P
></LI
></UL
></P
+><P
+> 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
+ the entire actions concept, see <A
+HREF="actions-file.html"
+>the Actions
+ section</A
+>.</P
+><P
+> For advanced users who want to hand edit their config files, you might want
+ to now go to the <A
+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
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
ALIGN="left"
VALIGN="top"
><A
-HREF="installation.html"
+HREF="whatsnew.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
ALIGN="right"
VALIGN="top"
><A
-HREF="configuration.html"
+HREF="startup.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
WIDTH="33%"
ALIGN="left"
VALIGN="top"
->Installation</TD
+>What's New in this Release</TD
><TD
WIDTH="34%"
ALIGN="center"
WIDTH="33%"
ALIGN="right"
VALIGN="top"
-><SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> Configuration</TD
+>Starting Privoxy</TD
></TR
></TABLE
></DIV
></BODY
></HTML
->
\ No newline at end of file
+>
projects / privoxy.git / blobdiff