<!entity license SYSTEM "license.sgml">
<!entity p-authors SYSTEM "p-authors.sgml">
<!entity config SYSTEM "p-config.sgml">
-<!entity p-version "2.9.16">
-<!entity p-status "beta">
+<!entity p-version SYSTEM "doc_version.tmp">
+<!entity p-status SYSTEM "doc_status.tmp">
<!entity % p-authors-formal "INCLUDE"> <!-- include additional text, etc -->
-<!entity % p-not-stable "INCLUDE">
+<!entity % p-not-stable "IGNORE">
<!entity % p-stable "IGNORE">
<!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
<!entity % p-doc "INCLUDE"> <!-- and we are a formal doc -->
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: user-manual.sgml,v 1.123.2.11 2002/07/26 15:20:31 oes Exp $
+ $Id: user-manual.sgml,v 1.128 2002/07/25 21:51:24 hal9 Exp $
Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
See LICENSE.
<article id="index">
<artheader>
-<title>Privoxy &p-version; User Manual</title>
+<title>Privoxy User Manual</title>
<pubdate>
<subscript>
<!-- Completely the wrong markup, but very little is allowed -->
<!-- in this part of an article. FIXME -->
<link linkend="copyright">Copyright</link> &my-copy; 2001, 2002 by
- <ulink url="http://www.privoxy.org/">Privoxy Developers</ulink>
+ <ulink url="http://www.privoxy.org">Privoxy Developers</ulink>
</subscript>
</pubdate>
-<pubdate>$Id: user-manual.sgml,v 1.123.2.11 2002/07/26 15:20:31 oes Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.128 2002/07/25 21:51:24 hal9 Exp $</pubdate>
<!--
</sect3>
<!-- ~~~~~ New section ~~~~~ -->
-<sect3 id="installation-mac"><title>Mac OSX</title>
+<sect3 id="installation-mac"><title>Max OSX</title>
<para>
Unzip the downloaded package (you can either double-click on the file
- in the finder, or on the desktop if you downloaded it there). The
- Privoxy.pkg package should appear after unzipping. Then,
- double-click on that Privoxy.pkg package installer icon and follow
- the installation process.
- <application>Privoxy</application> will be installed in the folder
- <literal>/Library/Privoxy</literal>.
- It will run automatically whenever you start up. To prevent it from
- running automatically, remove or rename the folder
- <literal>/Library/StartupItems/Privoxy</literal>.
-</para>
-<para>
- To run Privoxy by hand, double-click on
- <literal>RunPrivoxy.command</literal>.
- To run Privoxy from Terminal, execute
- <literal>/Library/Privoxy/RunPrivoxy.command</literal>.
+ 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.
+ <application>Privoxy</application> will be installed in the subdirectory
+ <literal>/Applications/Privoxy.app</literal>.
+ <application>Privoxy</application> will set itself up to start
+ automatically on system bring-up via
+ <literal>/System/Library/StartupItems/Privoxy</literal>.
</para>
</sect3>
<!-- end boilerplate -->
</sect2>
-<!-- ~~~~~ New section ~~~~~ -->
-<sect2 id="installation-keepupdated"><title>Keeping your Installation Up-to-Date</title>
-<para>
- As user feedback comes in and development continues, we will make updated versions
- of both the software and the main <link linkend="actions-file">actions file</link>
- (<literal>default.action</literal>) available for download.
-</para>
-
-<para>
- If you wish to receive an email notification whenever we release updates of
- <application>Privoxy</application> or the actions file, <ulink
- url="http://lists.sourceforge.net/lists/listinfo/ijbswa-announce/">subscribe
- to our announce mailing list</ulink>, ijbswa-announce@lists.sourceforge.net.
-</para>
-
-<para>
- Both can be downloaded from the <ulink
- url="http://sourceforge.net/project/showfiles.php?group_id=11118">files
- section</ulink> on <ulink url="http://sourceforge.net/">SourceForge</ulink>.
-</para>
-
-<para>
- In order not to loose your personal changes and adjustments when updating
- to the latest <literal>default.action</literal> file we <emphasis>strongly
- recommend</emphasis> that you use <literal>user.action</literal> for your
- customization of <application>Privoxy</application>. See the <link
- linkend="actions-file">Chapter on actions files</link> for details.
-</para>
-
-</sect2>
-
</sect1>
</sect2>
<sect2 id="start-macosx">
-<title>Mac OSX</title>
+<title>MAX OSX</title>
<para>
During installation, <application>Privoxy</application> is configured to
- start automatically when the system restarts. To run Privoxy by hand,
- double-click on the <literal>RunPrivoxy.command</literal> icon in the
- <literal>/Library/Privoxy</literal> folder. Or, type this command
- in the Terminal:
+ start automatically when the system restarts. You can start it manually
+ through the Terminal with these commands:
</para>
<para>
<screen>
- /Library/Privoxy/RunPrivoxy.command
- </screen>
-</para>
-<para>
- If you are not logged in as an administrator, you will be asked for the
- administrator password when starting <application>Privoxy</application>
- by hand.
+ cd /Applications/Privoxy.app
+ ./privoxy</screen>
</para>
</sect2>
provide a base level of functionality for
<application>Privoxy's</application> 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 <link
- linkend="installation-keepupdated">making available to users</link>.
+ This is the file that the developers are keeping updated, and making
+ available to users.
</para>
</listitem>
<listitem>
<term>Effect:</term>
<listitem>
<para>
- 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.
</para>
</listitem>
</varlistentry>
<anchor id="filter-banners-by-size">
<screen>+filter{banners-by-size} # Kill banners based on their size for this page (<emphasis>very</emphasis> efficient!)</screen>
</para>
- <para>
- <anchor id="filter-banners-by-link">
- <screen>+filter{banners-by-link} # Kill banners based on the link they are contained in (experimental)</screen>
- </para>
- <para>
- <anchor id="filter-img-reorder">
- <screen>+filter{img-reorder} # Reorder attributes in <img> tags to make the banners-by-* filters more effective</screen>
- </para>
<para>
<anchor id="filter-content-cookies">
<screen>+filter{content-cookies} # Kill cookies that come sneaking in the HTML or JS content</screen>
<anchor id="filter-crude-parental">
<screen>+filter{crude-parental} # Kill all web pages that contain the words "sex" or "warez"</screen>
</para>
- <para>
- <anchor id="filter-js-events">
- <screen>+filter{js-events} # Kill all JS event bindings (<emphasis>Radically destructive!</emphasis> Only for extra nasty sites) </screen>
- </para>
</listitem>
</varlistentry>
</variablelist>
-<link linkend="FILTER-FUN">filter{fun}</link> \
+<link linkend="FILTER-NIMDA">filter{nimda}</link> \
+<link linkend="FILTER-BANNERS-BY-SIZE">filter{banners-by-size}</link> \
- -<link linkend="FILTER-BANNERS-BY-LINK">filter{banners-by-link}</link> \
- -<link linkend="FILTER-IMG-REORDER">filter{img-reorder}</link> \
-<link linkend="FILTER-SHOCKWAVE-FLASH">filter{shockwave-flash}</link> \
-<link linkend="FILTER-CRUDE-PARENTAL">filter{crude-parental}</link> \
- -<link linkend="FILTER-JS-EVENTS">filter{js-events}</link> \
-<link linkend="HANDLE-AS-IMAGE">handle-as-image</link> \
+<link linkend="HIDE-FORWARDED-FOR-HEADERS">hide-forwarded-for-headers</link> \
+<link linkend="HIDE-FROM-HEADER">hide-from-header{block}</link> \
<screen>
# The status bar is for displaying link targets, not pointless blahblah
#
-s/window\.status\s*=\s*(['"]).*?\1/dUmMy=1/ig</screen>
+s/window\.status\s*=\s*['"].*?['"]/dUmMy=1/ig</screen>
</para>
<para>
or more whitespace</quote>. The <literal>?</literal> in <literal>.*?</literal>
makes this matching of arbitrary text ungreedy. (Note that the <literal>U</literal>
option is not set). The <literal>['"]</literal> construct means: <quote>a single
- <emphasis>or</emphasis> a double quote</quote>. Finally, <literal>\1</literal> is
- a backreference to the first parenthesis just like <literal>$1</literal> above,
- with the difference that in the <emphasis>pattern</emphasis>, a backslash indicates
- a backreference, whereas in the <emphasis>substitute</emphasis>, it's the dollar.
+ <emphasis>or</emphasis> a double quote</quote>.
</para>
<para>
<screen>
# Kill OnUnload popups. Yummy. Test: http://www.zdnet.com/zdsubs/yahoo/tree/yfs.html
#
-s/(<body [^>]*)onunload(.*>)/$1never$2/iU</screen>
+s/(<body .*)onunload(.*>)/$1never$2/iU</screen>
</para>
<para>
This job replaces the <quote>onunload</quote> attribute in
<quote><body></quote> tags with the dummy word <literal>never</literal>.
Note that the <literal>i</literal> option makes the pattern matching
- case-insensitive. Also note that ungreedy matching alone doesn't always guarantee
- a minimal match: In the first parenthesis, we had to use <literal>[^>]*</literal>
- instead of <literal>.*</literal> to prevent the match from exceeding the
- <body> tag if it doesn't contain <quote>OnUnload</quote>, but the page's
- content does.
+ case-insensitive.
</para>
<para>
#
s* industry[ -]leading \
| cutting[ -]edge \
-| customer[ -]focused \
-| market[ -]driven \
| award[ -]winning # Comments are OK, too! \
| high[ -]performance \
| solutions[ -]based \
<para>
The <literal>x</literal> 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.
</para>
<para>
One quick test to see if <application>Privoxy</application> is causing a problem
or not, is to disable it temporarily. This should be the first troubleshooting
step. See <link linkend="bookmarklets">the Bookmarklets</link> 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.
</para>
was. If you don't get this kind of match, then it means one of the default
rules in the first section is causing the problem. This would require some
guesswork, and maybe a little trial and error to isolate the offending rule.
- One likely cause would be one of the <quote>{+filter}</quote> actions. These
+ One likely cause would be one of the <quote>{+filter}</quote> actions. These
tend to be harder to troubleshoot. Try adding the URL for the site to one of
aliases that turn off <quote>+filter</quote>:
</para>
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: user-manual.sgml,v $
- Revision 1.123.2.11 2002/07/26 15:20:31 oes
- - Added version info to title
- - Added info on new filters
- - Revised parts of the filter file tutorial
- - Added info on where to get updated actions files
-
- Revision 1.123.2.10 2002/07/25 21:42:29 hal9
- Add brief notes on not proxying non-HTTP protocols.
-
- Revision 1.123.2.9 2002/07/11 03:40:28 david__schmidt
-
- Updated Mac OSX sections due to installation location change
+ Revision 1.128 2002/07/25 21:51:24 hal9
+ Warnings on non-HTTP traffic.
- Revision 1.123.2.8 2002/06/09 16:36:32 hal9
- Clarifications on filtering and MIME. Hardcode 'latest release' in index.html.
+ Revision 1.127 2002/06/09 16:37:31 hal9
+ Sync with filtering clarifications in 3.0 branch.
- Revision 1.123.2.7 2002/06/09 00:29:34 hal9
- Touch ups on filtering, in actions section and Anatomy.
+ Revision 1.126 2002/06/05 00:31:55 hal9
+ Mass commit for new entities, most significantly so docs can read version
+ and code status info from tmp files, so perl is no longer used. Also, docs can
+ differentiate on alpha -> beta -> stable now.
- Revision 1.123.2.6 2002/06/06 23:11:03 hal9
- Fix broken link. Linkchecked all docs.
+ 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.5 2002/05/29 02:01:02 hal9
This is break out of the entire config section from u-m, so it can