This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: privoxy-man-page.sgml,v 1.7 2002/04/12 23:07:40 hal9 Exp $
+ $Id: privoxy-man-page.sgml,v 2.3 2002/09/05 05:45:30 hal9 Exp $
- Written by and Copyright (C) 2001 the SourceForge
- Privoxy team. http://www.privoxy.org/
-
- Based on the Internet Junkbuster originally written
- by and Copyright (C) 1997 Anonymous Coders and
- Junkbusters Corporation. http://www.junkbusters.com
+ Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
+ See LICENSE.
========================================================================
NOTE: Please read developer-manual/documentation.html before touching
The 'replaceable' and 'command' tags are used here somewhat unconventionally,
since it seems to generate the proper formatting (at least for me :).
- Create man page: 'make man'
-
- Requires docbook2man (short perl script), see CVS
- http://sources.redhat.com/docbook-tools/. Also requires openjade and SGMLSpm
- perl module.
-
For man page references, see:
http://www.linuxdoc.org/HOWTO/mini/DocBook-Install/using.html
http://docbook.org/tdg/en/html/ch02.html#making-refentry
-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"[
-<!entity % dummy "INCLUDE">
+<!entity % dummy "IGNORE">
<!entity p-intro SYSTEM "privoxy.sgml">
<!entity seealso SYSTEM "seealso.sgml">
<!entity copyright SYSTEM "copyright.sgml">
+<!entity license SYSTEM "license.sgml">
<!entity authors SYSTEM "p-authors.sgml">
-<!entity p-version "2.9.14">
-<!entity p-status "beta">
-<!entity % p-not-stable "INCLUDE">
+<!entity p-version SYSTEM "doc_version.tmp">
+<!entity p-status SYSTEM "doc_status.tmp">
+<!entity % p-not-stable "IGNORE">
<!entity % p-stable "IGNORE">
+<!entity % p-alpha "IGNORE">
+<!entity % p-beta "IGNORE">
<!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
<!entity % p-authors-formal "IGNORE"> <!-- exclude additional formating -->
+<!entity my-copy "(C)"> <!-- db2man barfs on copyright symbol -->
]>
<refentry id="privoxy">
<refentryinfo>
- <date>2002-04-11</date>
+ <date>2002-05-14</date>
</refentryinfo>
-
<refmeta>
<refentrytitle>privoxy</refentrytitle>
<manvolnum>1</manvolnum>
- <refmiscinfo>Privoxy &p-version;<![%p-not-stable;[ &p-status;]]></refmiscinfo>
+ <refmiscinfo>
+ Privoxy &p-version;<![%p-not-stable;[ &p-status;]]>
+ </refmiscinfo>
</refmeta>
<refnamediv>
<arg><option>--pidfile </option><replaceable class="parameter">pidfile</replaceable></arg>
<arg><option>--user </option><replaceable class="parameter">user[.group]</replaceable></arg>
<arg><replaceable class="parameter">configfile</replaceable></arg>
- <command>(UNIX)</command>
+ <command> (UNIX)</command>
</cmdsynopsis>
<cmdsynopsis>
<command>privoxy.exe</command>
<arg><replaceable class="parameter">configfile</replaceable></arg>
- <command>(Windows)</command>
+ <command> (Windows)</command>
</cmdsynopsis>
</refsynopsisdiv>
<para>
On startup, write the process ID to <replaceable class="parameter">pidfile</replaceable>.
Delete the <replaceable class="parameter">pidfile</replaceable> on exit.
- Failiure to create or delete the <replaceable class="parameter">pidfile</replaceable>
+ Failure to create or delete the <replaceable class="parameter">pidfile</replaceable>
is non-fatal. If no <command>--pidfile</command> option is given, no PID file will be used.
</para>
</listitem>
</para>
<para>
The Secure (SSL) Proxy should also be set to the same values, otherwise
- https: URLs will not be proxied.
+ https: URLs will not be proxied. Note: <command>Privoxy</command> can only
+ proxy HTTP and HTTPS traffic. Do not try it with FTP or other protocols.
</para>
+
<para>
For other browsers, check the documentation.
</para>
<para>
<command>Privoxy</command> can be configured with the various configuration
files. The default configuration files are: <filename>config</filename>,
- <filename>default.action</filename>, and
- <filename>default.filter</filename>. These are well commented. On Unix and
- Unix-like systems, these are located in <filename>/etc/privoxy/</filename> by
- default. On Windows, OS/2 and AmigaOS, these files are in the same directory
- as the <command>Privoxy</command> executable.
+ <filename>default.filter</filename>, and
+ <filename>default.action</filename>. <filename>user.action</filename> should
+ be used for locally defined exceptions to the default rules of
+ <filename>default.action</filename> These are all well commented. On Unix
+ and Unix-like systems, these are located in
+ <filename>/etc/privoxy/</filename> by default. On Windows, OS/2 and AmigaOS,
+ these files are in the same directory as the <command>Privoxy</command>
+ executable.
</para>
<para>
The name and number of configuration files has changed from previous
- versions, and is subject to change as development progresses. In fact, the
- configuration itself is changed and much more sophisticated. See the
- <ulink url="http://www.privoxy.org/user-manual/">user-manual</ulink> for a
- brief explanation of all configuration options.
+ versions<![%p-not-stable;[, and is subject to change as development
+ progresses]]>. In fact, the configuration itself is changed and much more
+ sophisticated. See the <ulink
+ url="http://www.privoxy.org/user-manual/">user-manual</ulink> for a complete
+ explanation of all configuration options and general usage, and notes for
+ upgrading from <command>Junkbuster</command> and earlier <command>Privoxy</command>
+ versions.
</para>
<para>
The actions list (ad blocks, etc) can also be configured with your
- web browser at <ulink url="http://ijbswa.sourceforge.net/config">http://ijbswa.sourceforge.net/config</ulink>.
+ web browser at <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>.
<command>Privoxy's</command> configuration parameters can also be viewed at
the same page. In addition, <command>Privoxy</command> can be toggled on/off.
- This is an internal page.
+ This is an internal page, and does not require Internet access.
</para>
</refsect1>
<!-- ~~~~~ New section ~~~~~ -->
<refsect1><title>Sample Configuration</title>
<para>
- A brief example of what a <filename>default.action</filename> configuration
- might look like:
+ A brief example of what a simple <filename>default.action</filename>
+ configuration might look like:
</para>
<literallayout>
-
# 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
+ +crunch-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
+ -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-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 \
+ -crunch-cookies \
+ -kill-popups \
}
- /
+ / # '/' Matches *all* URL patterns
+
+ # Block, and treat these URL patterns as if they were 'images'.
+ # We would expect these to be ads.
+ {+imageblock}
+ .ad.doubleclick.net
+ .a[0-9].yimg.com/(?:(?!/i/).)*$
+ ad.*.doubleclick.net
- # Now set exceptions to the above defined policies #######
+ # Block any URLs that match these patterns
+ {+block}
+ ad*.
+ .*ads.
+ banner?.
+ /.*count(er)?\.(pl|cgi|exe|dll|asp|php[34]?)
+ .hitbox.com
+
+ # Make exceptions for these harmless ones that would be
+ # caught by our +block patterns just above.
+ {-block}
+ adsl.
+ advice.
+ .*downloads.
- # Sites where we want persistant cookies
- {-no-cookies -no-cookies-keep}
- .redhat.com
- .sun.com
- .yahoo.com
- .msdn.microsoft.com
+</literallayout>
- # This site requires cookies AND 'fast-redirects' on
- {-no-cookies -no-cookies-keep -fast-redirects}
- .nytimes.com
+<para>
+ Then for a <filename>user.action</filename>, we would put local,
+ narrowly defined exceptions:
+</para>
- # 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
+<literallayout>
+ # Re-define aliases as needed here
+ {{alias}}
- # 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/.*/
+ # Useful aliases
+ -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
+
+ # Set personal exceptions to the policies in default.action #######
- # 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
+ # Sites where we want persistant cookies, so allow *all* cookies
+ {-crunch-cookies -session-cookies-only}
+ .redhat.com
+ .sun.com
+ .msdn.microsoft.com
+
+ # This site breaks easily.
+ {-block -fast-redirects}
+ .forbes.com
</literallayout>
<para>
Various other files should be included, but may vary depending on platform
and build configuration. More documentation should be included in the local
- documentation directory, though is not complete at this time.
+ documentation directory.
</para>
</refsect1>
all features are well tested.
</para>]]>
<para>
- Please see the <citetitle>user-manual</citetitle> on how to contact the
+ Please see the <citetitle>User Manual</citetitle> on how to contact the
developers for feature requests, reporting problems, and other questions.
</para>
<!-- ~~~~~ New section ~~~~~ -->
<refsect1><title>Copyright and License</title>
-<!-- Include seealso.sgml boilerplate: -->
+
+<refsect2><title>Copyright</title>
+<!-- Include copyright.sgml boilerplate: -->
©right;
<!-- end boilerplate -->
+</refsect2>
+
+<refsect2><title>License</title>
+<!-- Include license.sgml boilerplate: -->
+ &license;
+<!-- end boilerplate -->
+</refsect2>
</refsect1>
</refentry>
projects / privoxy.git / blobdiff