From 2d07f84175fe3b83bf3d5ba79058768e0d0ec0a4 Mon Sep 17 00:00:00 2001 From: hal9 Date: Thu, 5 Sep 2002 05:45:30 +0000 Subject: [PATCH] Syncing with 3.0. This should be it for doc sources. Not all builds tested yet. No new content, just catching up. --- doc/source/announce.sgml | 18 ++- doc/source/authors.sgml | 2 +- doc/source/buildsource.sgml | 11 +- doc/source/config.sgml | 4 +- doc/source/license.sgml | 3 +- doc/source/newfeatures.sgml | 3 +- doc/source/p-config.sgml | 66 ++++---- doc/source/privoxy-man-page.sgml | 16 +- doc/source/readme.sgml | 44 ++++-- doc/source/supported.sgml | 4 +- doc/source/user-manual.sgml | 254 ++++++++++++++++++++++++------- 11 files changed, 310 insertions(+), 115 deletions(-) diff --git a/doc/source/announce.sgml b/doc/source/announce.sgml index c3e31416..4d262c91 100644 --- a/doc/source/announce.sgml +++ b/doc/source/announce.sgml @@ -19,7 +19,7 @@ Purpose : Announcement text - $Id: announce.sgml,v 1.3 2002/06/05 00:31:55 hal9 Exp $ + $Id: announce.sgml,v 1.1.2.2 2002/08/30 02:52:11 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -38,7 +38,7 @@ press release packages can contain both formats for those that might prefer HTML ready announce text. - This will probably require some hand editing before and after processing. + This may require a small bit of hand editing before processing. The intention is to minimize this as much as possible. To create: make announce @@ -58,9 +58,15 @@ Announcing Privoxy - v.&p-version;, and release candidate for - v3.0 stable. + v.&p-version;. + + + + &p-intro; @@ -91,7 +97,7 @@ Download location: - http://sourceforge.net/projects/ijbswa/ + http://sourceforge.net/project/showfiles.php?group_id=11118 @@ -102,6 +108,6 @@ -Privoxy Developers +Privoxy Developers developers@privoxy.org diff --git a/doc/source/authors.sgml b/doc/source/authors.sgml index c6f3e6bf..d9df2320 100644 --- a/doc/source/authors.sgml +++ b/doc/source/authors.sgml @@ -3,7 +3,7 @@ Purpose : AUTHORS file for Privoxy - $Id: authors.sgml,v 1.9 2002/06/05 00:31:55 hal9 Exp $ + $Id: authors.sgml,v 1.8 2002/05/10 01:48:19 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers diff --git a/doc/source/buildsource.sgml b/doc/source/buildsource.sgml index a4620b48..957d54b5 100644 --- a/doc/source/buildsource.sgml +++ b/doc/source/buildsource.sgml @@ -3,7 +3,7 @@ Purpose : Entity included in other project documents. - $Id: buildsource.sgml,v 1.9 2002/05/10 01:48:19 hal9 Exp $ + $Id: buildsource.sgml,v 1.9.2.1 2002/08/25 17:10:55 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -19,6 +19,7 @@ user-manual README + INSTALL --> @@ -80,6 +81,14 @@ + + + The make install target is temporary quite broken! It is + recommended to use a binary package, or do a source build, and manually + install the components. Sorry. + + + If you have gnu make, you can have the first four steps automatically done for you by just typing: diff --git a/doc/source/config.sgml b/doc/source/config.sgml index 173ac124..28920ae8 100644 --- a/doc/source/config.sgml +++ b/doc/source/config.sgml @@ -8,11 +8,11 @@ ]> diff --git a/doc/source/newfeatures.sgml b/doc/source/newfeatures.sgml index d8e95531..9f1c209d 100644 --- a/doc/source/newfeatures.sgml +++ b/doc/source/newfeatures.sgml @@ -3,7 +3,7 @@ Purpose : Entity included in other project documents. - $Id: newfeatures.sgml,v 1.11 2002/06/03 00:28:17 hal9 Exp $ + $Id: newfeatures.sgml,v 1.10 2002/05/15 03:54:29 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -19,7 +19,6 @@ user-manual faq - announce.sgml --> diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml index e1313b2e..e626a6f1 100644 --- a/doc/source/p-config.sgml +++ b/doc/source/p-config.sgml @@ -3,7 +3,7 @@ Purpose : Used with other docs and files only. - $Id: p-config.sgml,v 1.2 2002/06/03 00:28:17 hal9 Exp $ + $Id: p-config.sgml,v 1.1.2.8 2002/08/22 23:15:21 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -95,10 +95,10 @@ Sample Configuration File for Privoxy v&p-version; -Copyright (C) 2001, 2002 Privoxy Developers http://privoxy.org + $Id: p-config.sgml,v 1.1.2.8 2002/08/22 23:15:21 hal9 Exp $ -$Id: p-config.sgml,v 1.2 2002/06/03 00:28:17 hal9 Exp $ +Copyright (C) 2001, 2002 Privoxy Developers http://privoxy.org @@ -928,6 +928,7 @@ actionsfile debug 256 # debug GIF de-animation debug 512 # Common Log Format debug 1024 # debug kill pop-ups + debug 2048 # CGI user interface debug 4096 # Startup banner and warnings. debug 8192 # Non-fatal errors @@ -958,7 +959,7 @@ actionsfile @@debug 1 # show each GET/POST/CONNECT request]]> @@debug 4096 # Startup banner and warnings]]> -@@debug 8192 # Errors - *we highly recommended enabling this]]> +@@debug 8192 # Errors - *we highly recommended enabling this*]]> @@ -1507,17 +1508,17 @@ ACLs: permit-access and deny-access Type of value: - target_domain[:port] - http_parent[/port] + target_pattern + http_parent[:port] - Where target_domain is a domain name pattern (see the - chapter on domain matching in the default.action file), - http_parent is the address of the parent HTTP proxy - as an IP addresses in dotted decimal notation or as a valid DNS name (or . to denote - no forwarding, and the optional - port parameters are TCP ports, i.e. integer - values from 1 to 64535 + where target_pattern is a URL pattern + that specifies to which requests (i.e. URLs) this forward rule shall apply. Use / to + denote all URLs. + http_parent[:port] + is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded, + optionally followed by its listening port (default: 8080). + Use a single dot (.) to denote no forwarding. @@ -1555,7 +1556,7 @@ ACLs: permit-access and deny-access - forward .* anon-proxy.example.org:8080 + forward / anon-proxy.example.org:8080 forward :443 . @@ -1565,7 +1566,7 @@ ACLs: permit-access and deny-access - forward .*. caching-proxy.example-isp.net:8000 + forward / caching-proxy.example-isp.net:8000 forward .example-isp.net . @@ -1594,13 +1595,14 @@ forward-socks4 and forward-socks4a Type of value: - target_domain[:port] - socks_proxy[/port] - http_parent[/port] + target_pattern + socks_proxy[:port] + http_parent[:port] - Where target_domain is a domain name pattern (see the - chapter on domain matching in the default.action file), + where target_pattern is a URL pattern + that specifies to which requests (i.e. URLs) this forward rule shall apply. Use / to + denote all URLs. http_parent and socks_proxy are IP addresses in dotted decimal notation or valid DNS names (http_parent may be . to denote no HTTP forwarding), and the optional @@ -1651,7 +1653,7 @@ forward-socks4 and forward-socks4a - forward-socks4a .*. socks-gw.example.com:1080 www-cache.example-isp.net:8080 + forward-socks4a / socks-gw.example.com:1080 www-cache.example-isp.net:8080 forward .example.com . @@ -1660,7 +1662,7 @@ forward-socks4 and forward-socks4a - forward-socks4 .*. socks-gw.example.com:1080 . + forward-socks4 / socks-gw.example.com:1080 . @@ -1691,7 +1693,7 @@ forward-socks4 and forward-socks4a - forward .*. . + forward / . forward .isp-b.net host-b:8118 @@ -1702,7 +1704,7 @@ forward-socks4 and forward-socks4a - forward .*. . + forward / . forward .isp-a.net host-a:8118 @@ -1744,6 +1746,17 @@ forward-socks4 and forward-socks4a Squid normally uses port 3128. If unsure consult http_port in squid.conf. + + You could just as well decide to only forward requests for Windows executables through + a virus-scanning parent proxy, say, on antivir.example.com, port 8010: + + + + + forward / . + forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010 + + ]]> @@ -1978,14 +1991,15 @@ forward-socks4 and forward-socks4a - + + + ]]> diff --git a/doc/source/privoxy-man-page.sgml b/doc/source/privoxy-man-page.sgml index 800759c9..6f509cfb 100644 --- a/doc/source/privoxy-man-page.sgml +++ b/doc/source/privoxy-man-page.sgml @@ -5,7 +5,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: privoxy-man-page.sgml,v 2.1 2002/07/29 22:08:41 jongfoster Exp $ + $Id: privoxy-man-page.sgml,v 1.13.2.4 2002/08/26 16:26:58 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -79,13 +79,13 @@ pidfile user[.group] configfile - (UNIX) +  (UNIX) privoxy.exe configfile - (Windows) +  (Windows) @@ -196,6 +196,7 @@ https: URLs will not be proxied. Note: Privoxy can only proxy HTTP and HTTPS traffic. Do not try it with FTP or other protocols. + For other browsers, check the documentation. @@ -385,12 +386,9 @@ Notes - This is a &p-status; version of Privoxy. Buyer beware! Do - not use in production situations.]]> -]]> -]]> + This is a &p-status; version of Privoxy. Not + all features are well tested. +]]> Please see the User Manual on how to contact the developers for feature requests, reporting problems, and other questions. diff --git a/doc/source/readme.sgml b/doc/source/readme.sgml index 2882344e..7af842f3 100644 --- a/doc/source/readme.sgml +++ b/doc/source/readme.sgml @@ -19,14 +19,16 @@ Purpose : README for Privoxy - $Id: readme.sgml,v 1.19 2002/07/25 21:51:25 hal9 Exp $ + $Id: readme.sgml,v 1.16.2.4 2002/08/25 17:12:20 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. ======================================================================== NOTE: Please read developer-manual/documentation.html before touching - anything in this, or other Privoxy documentation. + anything in this, or other Privoxy documentation. You have been warned! + Failure to abide by this rule will result in the revocation of your license + to live a peaceful existence! ======================================================================== =================================================================== @@ -45,6 +47,18 @@ to avoid extra blank lines, etc. ====================================================================== + For stable releases, change + + entity % p-not-stable "INCLUDE" + + to + + entity % p-not-stable "IGNORE" + + in the DTD at the top. This will toggle various text 'off'. BOTH + MUST be toggled in this case or you will get both text referencing + stable and unstable versions. You only want one or the other! + -->
@@ -102,13 +116,10 @@ This README is included with - Privoxy &p-version;. - See http://www.privoxy.org/ for more information. The current code - level is &p-status;. - + Privoxy &p-version;. See http://www.privoxy.org/ for more information. The current code + level is &p-status;. + @@ -118,6 +129,11 @@ IMPORTANT CHANGES + + REALLY BIG NEWS! August 2002: The long-awaited, oft-delayed stable version + of Privoxy 3.0 is finally released! This is way behind schedule, but better + late than never. The developers all hope the wait was worth it. + NEWS! As of 03/24/02, the name of this project has been changed from ijbswa/Junkbuster to Privoxy. This is reflected in many of the included @@ -202,21 +218,23 @@ DOCUMENTATION There should be documentation in the 'doc' subdirectory. In particular, see the User Manual there, + is not completed at this point]]>. In particular, see the User Manual there, the FAQ, and those interested in Privoxy development, should look at developer-manual. The source and configuration files are all well commented. The main configuration files are: 'config', 'default.action', and 'default.filter'. - Included documentation may vary according to platform and packager. + Included documentation may vary according to platform and packager. All + documentation is posted on http://www.privoxy.org, in case you don't have it, + or can't find it. @@ -234,7 +252,7 @@ - +
diff --git a/doc/source/supported.sgml b/doc/source/supported.sgml index 947177d4..81dcc9fb 100644 --- a/doc/source/supported.sgml +++ b/doc/source/supported.sgml @@ -25,8 +25,8 @@ --> At present, Privoxy is known to run on - Windows(95, 98, ME, 2000, XP), Linux (RedHat, SuSE, Debian, Conectiva, Gentoo), - Mac OSX, OS/2, AmigaOS, BeOS, FreeBSD, NetBSD, Solaris, and many more + Windows(95, 98, ME, 2000, XP), Linux (RedHat, SuSE, Debian, Conectiva, Gentoo, + Slackware), Mac OSX, OS/2, AmigaOS, BeOS, FreeBSD, NetBSD, Solaris, and more flavors of Unix. 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 -- 2.39.2