This is mostly proposed copyright/licensing additions and changes. Docs
[privoxy.git] / doc / webserver / man-page / privoxy-man-page.html
index 0001a86..be1b7c7 100644 (file)
@@ -2,7 +2,7 @@
 <HTML><HEAD><TITLE>Manpage of PRIVOXY</TITLE>
 <LINK REL="STYLESHEET" TYPE="text/css" HREF="../p_doc.css"></HEAD><BODY>
 <H1>PRIVOXY</H1>
-Section:  (1)<BR>Updated: 24 April 2002<BR><A HREF="#index">Index</A>
+Section:  (1)<BR>Updated: 09 May 2002<BR><A HREF="#index">Index</A>
 <HR>
 
 <A NAME="lbAB">&nbsp;</A>
@@ -101,11 +101,14 @@ For other browsers, check the documentation.
 
 <B>Privoxy</B> can be configured with the various configuration
 files. The default configuration files are: <I>config</I>,
-<I>default.action</I>, and
-<I>default.filter</I>. These are well commented.  On Unix and
-Unix-like systems, these are located in <I>/etc/privoxy/</I> by
-default. On Windows, OS/2 and AmigaOS, these files are in the same directory
-as the <B>Privoxy</B> executable.
+<I>default.filter</I>, and
+<I>default.action</I>. <I>user.action</I> should 
+be used for locally defined exceptions to the default rules of
+<I>default.action</I> These are all well commented.  On Unix
+and Unix-like systems, these are located in
+<I>/etc/privoxy/</I> by default. On Windows, OS/2 and AmigaOS,
+these files are in the same directory as the <B>Privoxy</B>
+executable.
 <P>
 
 The name and number of configuration files has changed from previous
@@ -125,99 +128,88 @@ This is an internal page.
 
 <P>
 
-A brief example of what a <I>default.action</I> configuration
-might look like:
+A brief example of what a simple <I>default.action</I>
+configuration might look like:
 <P>
 <PRE>
-
  # Define a few useful custom aliases for later use
  {{alias}}
 
- # Don't accept cookies
- +no-cookies = +no-cookies-set +no-cookies-read
-
- # Do accept cookies
- -no-cookies = -no-cookies-set -no-cookies-read
+ # Useful aliases
+ +prevent-cookies = +prevent-setting-cookies +prevent-reading-cookies
+ -prevent-cookies = -prevent-setting-cookies -prevent-reading-cookies
+ +imageblock      = +block +handle-as-image
 
- # Treat these blocked URLs as images.
- +imageblock = +block +image
+ # Fragile sites should have the minimum changes
+ fragile     = -block -deanimate-gifs -fast-redirects -filter \
+               -hide-referer -prevent-cookies -kill-popups
 
- # Define page filters we want to use.
- myfilters = +filter{html-annoyances} +filter{js-annoyances}\
-             +filter{no-popups} +filter{webbugs}
-
- ## Default Policies (actions) ############################
+ ## Turn some actions on ################################
  { \
-  -block \
-  -downgrade \
-  +fast-redirects \
-  myfilters \
-  +no-compression \
-  +hide-forwarded \
-  +hide-from{block} \
-  +hide-referer{forge} \
-  -hide-user-agent \
-  -image \
-  +image-blocker{blank} \
-  +no-cookies-keep \
-  -no-cookies-read \
-  -no-cookies-set \
-  +no-popups \
-  -vanilla-wafer \
-  -wafer \
+ -add-header \
+ -block \
+ +deanimate-gifs{last} \
+ -downgrade-http-version \
+ -fast-redirects \
+ +filter{html-annoyances} \
+ +filter{js-annoyances} \
+ +filter{content-cookies} \
+ +filter{webbugs} \
+ +filter{banners-by-size} \
+ +hide-forwarded-for-headers \
+ +hide-from-header{block} \
+ +hide-referrer{forge} \
+ -hide-user-agent \
+ -handle-as-image \
+ +set-image-blocker{pattern} \
+ -limit-connect \
+ +prevent-compression \
+ +session-cookies-only \
+ +prevent-reading-cookies \
+ +prevent-setting-cookies \
+ -kill-popups \
  }
- /
+ /   # Match all URLs
+ # Block, and treat these URL patterns as if they were 'images'.
+ {+imageblock}
+  .ad.doubleclick.net
+  .a[0-9].yimg.com/(?:(?!/i/).)*$
+  ad.*.doubleclick.net
+
+ # Block any URLs that match these patterns
+ {+block}
+  ad*.
+  .*ads.
+  banner?.
+  /.*count(er)?\.(pl|cgi|exe|dll|asp|php[34]?)
+  /(?:.*/)?(publicite|werbung|rekla(ma|me|am)|maino(kset|nta|s)?)/
+  .hitbox.com 
+
+ # Make exceptions for these harmless ones that would be 
+ # caught by +block above.
+ {-block}
+  adsl.
+  advice.
+  .*downloads.
+</PRE>
+
+<P>
 
- # Now set exceptions to the above defined policies #######
+Then for a <I>user.action</I>, we would put local,
+narrowly defined exceptions:
+<P>
+<PRE>
+ # Set personal exceptions to the policies in default.action #######
 
  # Sites where we want persistant cookies
- {-no-cookies -no-cookies-keep}
+ {-prevent-reading-cookies -prevent-setting-cookies -session-cookies-only}
   .redhat.com
   .sun.com
-  .yahoo.com
   .msdn.microsoft.com
-
- # This site requires cookies AND 'fast-redirects' on
- {-no-cookies -no-cookies-keep -fast-redirects}
-  .nytimes.com
-
- # Add custom headers, and turn off filtering of page source
- {+add-header{X-Privacy: Yes please} #-add-header{*} \
-  +add-header{X-User-Tracking: No thanks!} -filter}
-  privacy.net
-
- # Block, and treat these URLs as 'images'.
- {+imageblock}
-  .ad.preferences.com/image.*
-  .ads.web.aol.com
-  .ad-adex3.flycast.com
-  .ad.doubleclick.net
-  .ln.doubleclick.net
-  .ad.de.doubleclick.net
-  /.*/count\.cgi\?.*df=
-  194.221.183.22[1-7]
-  a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/
-
- # Block any URLs that match these patterns
- {+block}
-  /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\.(gif|jpe?g))
-  /.*/(plain|live|rotate)[-_.]?ads?/
-  /.*/(sponsor)s?[0-9]?/
-  /.*/ad(server|stream|juggler)\.(cgi|pl|dll|exe)
-  /.*/adbanners/
-  /.*/adv((er)?ts?|ertis(ing|ements?))?/
-  /.*/banners?/
-  /.*/popupads/
-  /.*/advert[0-9]+\.jpg
-  /ad_images/
-  /.*/ads/
-  /images/.*/.*_anim\.gif
-  /rotations/ 
-  /.*(ms)?backoff(ice)?.*\.(gif|jpe?g)
-  195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|)
-  .images.nytimes.com
-  .images.yahoo.com/adv/
-  /.*cnnstore\.gif
+ {-block -fast-redirects}
+  .forbes.com
 </PRE>
 
 <P>
@@ -293,8 +285,7 @@ Sourceforge.
 <A HREF="http://config.privoxy.org">http://config.privoxy.org</A>
 may work in some situations where the first does not.
 <P>
-<A HREF="http://p.p/">http://p.p/</A>  
-to submit ``misses'' to the developers. 
+<A HREF="http://p.p/">http://p.p/</A> to submit ``misses'' to the developers. 
 <P>
 <A HREF="http://www.junkbusters.com/ht/en/cookies.html">http://www.junkbusters.com/ht/en/cookies.html</A>
 <P>
@@ -327,24 +318,41 @@ to submit ``misses'' to the developers.
 <A NAME="lbAN">&nbsp;</A>
 <H2>COPYRIGHT AND LICENSE</H2>
 
+<A NAME="lbAO">&nbsp;</A>
+<H3>COPYRIGHT</H3>
+
+<P>
+
+Copyright (C) 2001, 2002 by Privoxy Developers &lt;<A HREF="mailto:developers@privoxy.org">developers@privoxy.org</A>&gt;
+<P>
+
+Some source code is based on code Copyright (C) 1997 by Anonymous Coders
+and Junkbusters, Inc. and licensed under the <I>GNU General Public
+License</I>.
+<A NAME="lbAP">&nbsp;</A>
+<H3>LICENSE</H3>
+
 <P>
 
 <B>Privoxy</B> is free software; you can
-redistribute it and/or modify it under the terms of the GNU General Public
-License as published by the Free Software Foundation; either version 2 of the
-License, or (at your option) any later version.
+redistribute it and/or modify it under the terms of the 
+<I>GNU General Public
+License</I>, version 2, as published by the Free Software Foundation.
 <P>
 
 This program is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+FITNESS FOR A PARTICULAR PURPOSE.  See the 
+<I>GNU General Public License</I> for
 more details, which is available from the Free Software Foundation, Inc, 59
 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 <P>
 
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software Foundation, Inc.,
-59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
+You should have received a copy of the  <I>GNU General Public License</I>
+along with this program; if not, write to the  Free Software
+Foundation, Inc. 59 Temple Place - Suite 330
+Boston, MA 02111-1307
+USA 
 <P>
 
 <HR>
@@ -363,11 +371,15 @@ along with this program; if not, write to the Free Software Foundation, Inc.,
 <DT><A HREF="#lbAL">SEE ALSO</A><DD>
 <DT><A HREF="#lbAM">DEVELOPMENT TEAM</A><DD>
 <DT><A HREF="#lbAN">COPYRIGHT AND LICENSE</A><DD>
+<DL>
+<DT><A HREF="#lbAO">COPYRIGHT</A><DD>
+<DT><A HREF="#lbAP">LICENSE</A><DD>
+</DL>
 </DL>
 <HR>
 This document was created by
 man2html,
 using the manual pages.<BR>
-Time: 05:09:36 GMT, April 24, 2002
+Time: 20:47:35 GMT, May 09, 2002
 </BODY>
 </HTML>