X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=3ba2f0063363e024f6c61bb3cd130968bfe5616d;hp=91b0b627cf7716bdfac8b714e31d93bd0ab8187b;hb=2d07f84175fe3b83bf3d5ba79058768e0d0ec0a4;hpb=f5e64b537f21ec76c6a1665277d78b6dc8f861d2 diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index 91b0b627..3ba2f006 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -32,7 +32,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: user-manual.sgml,v 1.128 2002/07/25 21:51:24 hal9 Exp $ + $Id: user-manual.sgml,v 1.123.2.18 2002/08/22 23:47:58 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -47,18 +47,18 @@
-Privoxy User Manual +Privoxy &p-version; User Manual Copyright &my-copy; 2001, 2002 by - Privoxy Developers + Privoxy Developers -$Id: user-manual.sgml,v 1.128 2002/07/25 21:51:24 hal9 Exp $ +$Id: user-manual.sgml,v 1.123.2.18 2002/08/22 23:47:58 hal9 Exp $ -Max OSX - - Unzip the downloaded package (you can either double-click on the file - in the finder, or on the desktop if you downloaded it there). Then, - double-click on the package installer icon and follow the installation - process. - Privoxy will be installed in the subdirectory - /Applications/Privoxy.app. - Privoxy will set itself up to start - automatically on system bring-up via - /System/Library/StartupItems/Privoxy. +Mac OSX + + Unzip the downloaded file (you can either double-click on the file + from the finder, or from the desktop if you downloaded it there). + Then, double-click on the package installer icon named + Privoxy.pkg + and follow the installation process. + Privoxy will be installed in the folder + /Library/Privoxy. + It will start automatically whenever you start up. To prevent it from + starting automatically, remove or rename the folder + /Library/StartupItems/Privoxy. + + + To start Privoxy by hand, double-click on + StartPrivoxy.command in the + /Library/Privoxy folder. + Or, type this command in the Terminal: + + + + /Library/Privoxy/StartPrivoxy.command + + + + You will be prompted for the administrator password. @@ -300,6 +315,28 @@ automatically start Privoxy in the boot process. remove this directory. + + +Gentoo + + Gentoo source packages (Ebuilds) for Privoxy are + contained in the Gentoo Portage Tree (they are not on the download page, + but there is a Gentoo section, where you can see when a new + Privoxy Version is added to the Portage Tree). + + + Before installing Privoxy under Gentoo just do + first emerge rsync to get the latest changes from the + Portage tree. With emerge privoxy you install the latest + version. + + + Configuration files are in /etc/privoxy, the + documentation is in /usr/share/doc/privoxy-&p-version; + and the Log directory is in /var/log/privoxy. + + + @@ -325,6 +362,33 @@ automatically start Privoxy in the boot process. + +Keeping your Installation Up-to-Date + + As user feedback comes in and development continues, we will make updated versions + of both the main actions file (as a separate + package) and the software itself (including the actions file) available for + download. + + + + If you wish to receive an email notification whenever we release updates of + Privoxy or the actions file, subscribe + to our announce mailing list, ijbswa-announce@lists.sourceforge.net. + + + + In order not to loose your personal changes and adjustments when updating + to the latest default.action file we strongly + recommend that you use user.action for your + customization of Privoxy. See the Chapter on actions files for details. + + + + @@ -928,16 +992,21 @@ Example Unix startup command: -MAX OSX +Mac OSX During installation, Privoxy is configured to - start automatically when the system restarts. You can start it manually - through the Terminal with these commands: + start automatically when the system restarts. To start Privoxy by hand, + double-click on the StartPrivoxy.command icon in the + /Library/Privoxy folder. Or, type this command + in the Terminal: - cd /Applications/Privoxy.app - ./privoxy + /Library/Privoxy/StartPrivoxy.command + + + + You will be prompted for the administrator password. @@ -955,6 +1024,29 @@ Example Unix startup command: + +Gentoo + + A script is again used. It will use the file /etc/privoxy/config + as its main configuration file. + + + + /etc/init.d/privoxy start + + + + Note that Privoxy is not automatically started at + boot time by default. You can change this with the rc-update + command. + + + + rc-update add privoxy default + + + + @@ -1182,6 +1274,9 @@ must find a better place for this paragraph         ▪  Toggle Privoxy on or off + +         ▪  Documentation + @@ -1362,8 +1457,8 @@ must find a better place for this paragraph provide a base level of functionality for Privoxy's array of features. So it is a set of broad rules that should work reasonably well for users everywhere. - This is the file that the developers are keeping updated, and making - available to users. + This is the file that the developers are keeping updated, and making available to users. @@ -1481,9 +1576,9 @@ must find a better place for this paragraph the same URL set the same action differently, the last match wins. If not, the effects are aggregated. E.g. a URL might match a regular section with a heading line of { - +handle-as-image }, + +handle-as-image }, then later another one with just { - +block }, resulting + +block }, resulting in both actions to apply. @@ -2335,8 +2430,9 @@ problem-host.example.com Effect: - Text documents, including HTML and JavaScript, to which this action applies, are filtered on-the-fly - through the specified regular expression based substitutions. + Text documents, including HTML and JavaScript, to which this action + applies, are filtered on-the-fly through the specified regular expression + based substitutions. @@ -2426,6 +2522,14 @@ problem-host.example.com +filter{banners-by-size} # Kill banners based on their size for this page (very efficient!) + + + +filter{banners-by-link} # Kill banners based on the link they are contained in (experimental) + + + + +filter{img-reorder} # Reorder attributes in <img> tags to make the banners-by-* filters more effective + +filter{content-cookies} # Kill cookies that come sneaking in the HTML or JS content @@ -2462,6 +2566,10 @@ problem-host.example.com +filter{crude-parental} # Kill all web pages that contain the words "sex" or "warez" + + + +filter{js-events} # Kill all JS event bindings (Radically destructive! Only for extra nasty sites) + @@ -3687,8 +3795,11 @@ shop = mercy-for-cookies -filter{popups} -kill-popups -filter{fun} \ +filter{nimda} \ +filter{banners-by-size} \ + -filter{banners-by-link} \ + -filter{img-reorder} \ -filter{shockwave-flash} \ -filter{crude-parental} \ + -filter{js-events} \ -handle-as-image \ +hide-forwarded-for-headers \ +hide-from-header{block} \ @@ -4353,7 +4464,7 @@ s|(<script.*)document\.referrer(.*</script>)|$1"Not Your Business!"$2|U # The status bar is for displaying link targets, not pointless blahblah # -s/window\.status\s*=\s*['"].*?['"]/dUmMy=1/ig +s/window\.status\s*=\s*(['"]).*?\1/dUmMy=1/ig @@ -4362,7 +4473,10 @@ s/window\.status\s*=\s*['"].*?['"]/dUmMy=1/ig or more whitespace. The ? in .*? makes this matching of arbitrary text ungreedy. (Note that the U option is not set). The ['"] construct means: a single - or a double quote. + or a double quote. Finally, \1 is + a backreference to the first parenthesis just like $1 above, + with the difference that in the pattern, a backslash indicates + a backreference, whereas in the substitute, it's the dollar. @@ -4378,7 +4492,7 @@ s/window\.status\s*=\s*['"].*?['"]/dUmMy=1/ig # Kill OnUnload popups. Yummy. Test: http://www.zdnet.com/zdsubs/yahoo/tree/yfs.html # -s/(<body .*)onunload(.*>)/$1never$2/iU +s/(<body [^>]*)onunload(.*>)/$1never$2/iU @@ -4389,7 +4503,11 @@ s/(<body .*)onunload(.*>)/$1never$2/iU This job replaces the onunload attribute in <body> tags with the dummy word never. Note that the i option makes the pattern matching - case-insensitive. + case-insensitive. Also note that ungreedy matching alone doesn't always guarantee + a minimal match: In the first parenthesis, we had to use [^>]* + instead of .* to prevent the match from exceeding the + <body> tag if it doesn't contain OnUnload, but the page's + content does. @@ -4419,6 +4537,8 @@ s/microsoft(?!\.com)/MicroSuck/ig # s* industry[ -]leading \ | cutting[ -]edge \ +| customer[ -]focused \ +| market[ -]driven \ | award[ -]winning # Comments are OK, too! \ | high[ -]performance \ | solutions[ -]based \ @@ -4431,7 +4551,7 @@ s* industry[ -]leading \ The x option in this job turns on extended syntax, and allows for - e.g. the liberal use of (non-interpreted!) whitespace for nicer formatting. + e.g. the liberal use of (non-interpreted!) whitespace for nicer formatting. @@ -5005,7 +5125,7 @@ Requests Credit: The site which gave us the general idea for these bookmarklets is - www.bookmarklets.com. They + www.bookmarklets.com. They have more information about bookmarklets. @@ -5085,7 +5205,7 @@ Requests First, the server headers are read and processed to determine, among other things, the MIME type (document type) and encoding. The headers are then - filtered as deterimined by the + filtered as determined by the +crunch-incoming-cookies, +session-cookies-only, and +downgrade-http-version @@ -5159,7 +5279,7 @@ Requests One quick test to see if Privoxy is causing a problem or not, is to disable it temporarily. This should be the first troubleshooting step. See the Bookmarklets section on a quick - and easy way to do this (be sure to flush caches afterward!). Looking at the + and easy way to do this (be sure to flush caches afterward!). Looking at the logs is a good idea too. @@ -5456,7 +5576,7 @@ In file: user.action [ View ] [ Edit ]{+filter} actions. These + One likely cause would be one of the {+filter} actions. These tend to be harder to troubleshoot. Try adding the URL for the site to one of aliases that turn off +filter: @@ -5533,19 +5653,49 @@ In file: user.action [ View ] [ Edit ] beta -> stable now. + Revision 1.123.2.7 2002/06/09 00:29:34 hal9 + Touch ups on filtering, in actions section and Anatomy. - Revision 1.125 2002/06/03 00:28:17 hal9 - Sync with various changes from 3.0 branch. Add two new files for config stuff. + Revision 1.123.2.6 2002/06/06 23:11:03 hal9 + Fix broken link. Linkchecked all docs. Revision 1.123.2.5 2002/05/29 02:01:02 hal9 This is break out of the entire config section from u-m, so it can