X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fwebserver%2Fuser-manual%2Fquickstart.html;h=c17cca0658197e61b53d8d568a0fe13fef9ce9ac;hp=bf78fa6b8e36ad8f0e3a1491afccc4ab3065aee9;hb=6d810395712f0337682205c4ea304009c86c128f;hpb=e3c12117d30c2f42bd47c929099f95295f2c3404 diff --git a/doc/webserver/user-manual/quickstart.html b/doc/webserver/user-manual/quickstart.html index bf78fa6b..c17cca06 100644 --- a/doc/webserver/user-manual/quickstart.html +++ b/doc/webserver/user-manual/quickstart.html @@ -1,943 +1,516 @@ - -Quickstart to Using Privoxy - -
Privoxy 3.0.16 User Manual
PrevNext

4. Quickstart to Using Privoxy

4.1. Quickstart to Ad Blocking

Ad blocking is but one of Privoxy's - 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.

- 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.

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 - "problem" sites, and to spend more time adjusting the - configuration to solve these unintended consequences. In short, there is - not an easy way to eliminate all ads. Either take - the easy way and settle for most ads blocked with the - default configuration, or jump in and tweak it for your personal surfing - habits and preferences.

Secondly, a brief explanation of Privoxy's - "actions". "Actions" in this context, are - the directives we use to tell Privoxy to perform - some task relating to HTTP transactions (i.e. web browsing). We tell - Privoxy to take some "action". Each - action has a unique name and function. While there are many potential - actions in Privoxy's - arsenal, only a few are used for ad blocking. Actions, and action - configuration files, are explained in depth below.

Actions are specified in Privoxy's configuration, - followed by one or more URLs to which the action should apply. URLs - can actually be URL type patterns 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.

When you connect to a website, the full URL will either match one or more - of the sections as defined in Privoxy's configuration, - or not. If so, then Privoxy 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. Privoxy 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.

The most important actions for basic ad blocking are: block, handle-as-image, - handle-as-empty-document,and - set-image-blocker:

Advanced users will eventually want to explore Privoxy - filters as well. Filters - are very different from blocks. - A "block" 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 "no-no" for - "nasty-word". 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.

The quickest way to adjust any of these settings is with your browser through - the special Privoxy editor at http://config.privoxy.org/show-status - (shortcut: http://p.p/show-status). This - is an internal page, and does not require Internet access.

Note that as of Privoxy 3.0.7 beta the - action editor is disabled by default. Check the - enable-edit-actions - section in the configuration file to learn why and in which - cases it's safe to enable again.

If you decided to enable the action editor, select the appropriate - "actions" file, and click - "Edit". It is best to put personal or - local preferences in user.action since this is not - meant to be overwritten during upgrades, and will over-ride the settings in - other files. Here you can insert new "actions", and URLs for ad - blocking or other purposes, and make other adjustments to the configuration. - Privoxy will detect these changes automatically.

A quick and simple step by step example:

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 "patterns", and - the entire actions concept, see the Actions - section.

For advanced users who want to hand edit their config files, you might want - to now go to the Actions Files Tutorial. - The ideas explained therein also apply to the web-based editor.

There are also various - filters that can be used for ad blocking - (filters are a special subset of actions). These - fall into the "advanced" usage category, and are explained in - depth in later sections.


PrevHomeNext
What's New in this Release Starting Privoxy
\ No newline at end of file + + + + + + Quickstart to Using Privoxy + + + + + + + + + + + + +
+

+ 4. Quickstart to Using Privoxy +

+

+

+ + +
+

+ 4.1. Quickstart to Ad Blocking +

+

+ Ad blocking is but one of Privoxy's 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. +

+

+ 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. +

+

+ 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 + "problem" sites, and to spend more time + adjusting the configuration to solve these unintended consequences. + In short, there is not an easy way to eliminate all ads. Either take the + easy way and settle for most ads blocked with the default + configuration, or jump in and tweak it for your personal surfing + habits and preferences. +

+

+ Secondly, a brief explanation of Privoxy's "actions". "Actions" in + this context, are the directives we use to tell Privoxy to perform some task relating to HTTP + transactions (i.e. web browsing). We tell Privoxy to take some "action". Each action has a unique name and + function. While there are many potential actions in Privoxy's arsenal, only a few are used for ad + blocking. Actions, and action configuration files, are + explained in depth below. +

+

+ Actions are specified in Privoxy's + configuration, followed by one or more URLs to which the action + should apply. URLs can actually be URL type patterns 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. +

+

+ When you connect to a website, the full URL will either match one + or more of the sections as defined in Privoxy's configuration, or not. If so, then + Privoxy 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. Privoxy 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. +

+

+ The most important actions for basic ad blocking are: block, handle-as-image, handle-as-empty-document,and + set-image-blocker: +

+

+

+ + +

+ Advanced users will eventually want to explore Privoxy filters as well. Filters are + very different from blocks. A "block" 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 "no-no" for "nasty-word". + 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. +

+

+ The quickest way to adjust any of these settings is with your + browser through the special Privoxy editor at http://config.privoxy.org/show-status (shortcut: http://p.p/show-status). This + is an internal page, and does not require Internet access. +

+

+ Note that as of Privoxy 3.0.7 beta + the action editor is disabled by default. Check the enable-edit-actions + section in the configuration file to learn why and in which + cases it's safe to enable again. +

+

+ If you decided to enable the action editor, select the appropriate + "actions" file, and click "Edit". It is best to + put personal or local preferences in user.action since this is not meant to be + overwritten during upgrades, and will over-ride the settings in + other files. Here you can insert new "actions", and URLs for ad blocking or other + purposes, and make other adjustments to the configuration. Privoxy will detect these changes + automatically. +

+

+ A quick and simple step by step example: +

+

+

+ + +

+ 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 "patterns", and the entire actions + concept, see the Actions section. +

+

+ For advanced users who want to hand edit their config files, you + might want to now go to the Actions Files Tutorial. The + ideas explained therein also apply to the web-based editor. +

+

+ There are also various filters that can be used for ad + blocking (filters are a special subset of actions). These fall into + the "advanced" usage category, and are + explained in depth in later sections. +

+
+
+ + + +