This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: privoxy-man-page.sgml,v 2.5 2006/07/18 14:48:51 david__schmidt Exp $
+ $Id: privoxy-man-page.sgml,v 2.33 2009/10/10 05:48:55 fabiankeil Exp $
- Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
+ Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/
See LICENSE.
========================================================================
<!entity copyright SYSTEM "copyright.sgml">
<!entity license SYSTEM "license.sgml">
<!entity authors SYSTEM "p-authors.sgml">
-<!entity p-version "3.0.4">
-<!entity p-status "BETA">
+<!entity p-version "3.0.16">
+<!entity p-status "UNRELEASED">
<!entity % p-not-stable "INCLUDE">
<!entity % p-stable "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 -->
+<!entity % seealso-extra "IGNORE"> <!-- for excluding sections of seealso -->
]>
<refentry id="privoxy">
<refentryinfo>
- <date>2006-08-24</date>
+ <date>2009-02-15</date>
</refentryinfo>
<refmeta>
<refentrytitle>privoxy</refentrytitle>
<arg><option>--pidfile </option><replaceable class="parameter">pidfile</replaceable></arg>
<arg><option>--user </option><replaceable class="parameter">user[.group]</replaceable></arg>
<arg><option>--chroot</option></arg>
+ <arg><option>--pre-chroot-nslookup </option><replaceable class="parameter">hostname</replaceable></arg>
<arg><replaceable class="parameter">configfile</replaceable></arg>
- <command> (UNIX)</command>
</cmdsynopsis>
- <cmdsynopsis>
- <command>privoxy.exe</command>
- <arg><replaceable class="parameter">configfile</replaceable></arg>
- <command> (Windows)</command>
- </cmdsynopsis>
</refsynopsisdiv>
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>--pre-chroot-nslookup <replaceable class="parameter">hostname</replaceable></term>
+ <listitem>
+ <para>
+ Initialize the resolver library using <replaceable class="parameter">hostname</replaceable>
+ before chroot'ing. On some systems this reduces the number of files
+ that must be copied into the chroot tree.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
<para>
If the <filename>configfile</filename> is not specified on the command line,
<command>Privoxy</command> will look for a file named
- <filename>config</filename> in the current directory (except on Win32 where
- it will try <filename>config.txt</filename>). If no
+ <filename>config</filename> in the current directory. If no
<filename>configfile</filename> is found, <command>Privoxy</command> will
fail to start.
</para>
<!-- ~~~~~ New section ~~~~~ -->
<refsect1><title>Installation and Usage</title>
<para>
- Browsers must be individually configured to use <command>Privoxy</command> as
- a HTTP proxy. The default setting is for localhost, on port 8118
- (configurable in the main config file). To set the HTTP proxy in Netscape
- and Mozilla, go through: <command>Edit</command>;
- <command>Preferences</command>; <command>Advanced</command>;
- <command>Proxies</command>; <command>Manual Proxy Configuration</command>;
- <command>View</command>.
+ Browsers can either be individually configured to use
+ <command>Privoxy</command> as a HTTP proxy (recommended),
+ or <command>Privoxy</command> can be combined with a packet
+ filter to build an intercepting proxy
+ (see <filename>config</filename>). The default setting is for
+ localhost, on port 8118 (configurable in the main config file). To set the
+ HTTP proxy in Firefox, go through: <command>Tools</command>;
+ <command>Options</command>; <command>General</command>;
+ <command>Connection Settings</command>;
+ <command>Manual Proxy Configuration</command>.
</para>
<para>
For Internet Explorer, go through: <command>Tools</command>;
The Secure (SSL) Proxy should also be set to the same values, otherwise
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.
+ HTTPS presents some limitations, and not all features will work with HTTPS
+ connections.
</para>
<para>
<para>
<command>Privoxy</command> can be configured with the various configuration
files. The default configuration files are: <filename>config</filename>,
- <filename>default.filter</filename>, and
+ <filename>default.filter</filename>, <filename>default.action</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>, and <filename>user.filter</filename> for
- locally defined filters. 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.
+ be used for locally defined exceptions to the default rules in
+ <filename>match-all.action</filename> and <filename>default.action</filename>,
+ and <filename>user.filter</filename> for locally defined filters. These are
+ well commented. On Unix and Unix-like systems, these are located in
+ <filename>/etc/privoxy/</filename> by default.
</para>
-<para>
- See the <ulink
- url="http://www.privoxy.org/user-manual/">user-manual</ulink> for a complete
- explanation of general usage, configuration options, new features and notes for
- upgrading.
+<para>
+ <command>Privoxy</command> uses the concept of <command>actions</command>
+ in order to manipulate the data stream between the browser and remote sites.
+ There are various actions available with specific functions for such things
+ as blocking web sites, managing cookies, etc. These actions can be invoked
+ individually or combined, and used against individual URLs, or groups of URLs
+ that can be defined using wildcards and regular expressions. The result is
+ that the user has greatly enhanced control and freedom.
</para>
<para>
The actions list (ad blocks, etc) can also be configured with your
- web browser at <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>.
+ web browser at <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
+ (assuming the configuration allows it).
<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, and does not require Internet access.
</para>
-</refsect1>
-
-
-<!-- ~~~~~ New section ~~~~~ -->
-<refsect1><title>Sample Configuration</title>
<para>
- 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}}
-
- # Useful aliases
- +crunch-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
- -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
- +imageblock = +block +handle-as-image
-
- # Fragile sites should have the minimum changes
- fragile = -block -deanimate-gifs -fast-redirects -filter \
- -hide-referer -prevent-cookies -kill-popups
-
- ## Turn some actions on ################################
- { \
- -add-header \
- -block \
- -content-type-overwrite \
- -crunch-if-none-match \
- +crunch-incoming-cookies \
- +crunch-outgoing-cookies \
- +crunch-server-header {no-cache} \
- +deanimate-gifs{last} \
- -downgrade-http-version \
- -fast-redirects \
- -force-text-mode \
- -filter{html-annoyances} \
- -filter{js-annoyances} \
- +filter{content-cookies} \
- +filter{webbugs} \
- -filter{banners-by-size} \
- -handle-as-empty-document \
- +hide-accept-language{en-ca} \
- +hide-content-disposition {block} \
- +hide-forwarded-for-headers \
- +hide-from-header{block} \
- +hide-if-modified-since {-1} \
- +hide-referrer{forge} \
- -hide-user-agent \
- -handle-as-image \
- -inspect-jpegs \
- -kill-popups \
- +set-image-blocker{pattern} \
- -limit-connect \
- +overwrite-last-modified {randomize} \
- +prevent-compression \
- +session-cookies-only \
- +treat-forbidden-connects-like-blocks \
- -crunch-cookies \
- }
- / # '/' 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
-
- # 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.
-
-</literallayout>
-
-<para>
- Then for a <filename>user.action</filename>, we would put local,
- narrowly defined exceptions:
-</para>
-
-<literallayout>
- # Re-define aliases as needed here
- {{alias}}
-
- # Useful aliases
- -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
-
- # Set personal exceptions to the policies in default.action #######
-
- # 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>
- See the comments in the configuration files themselves, or the
- <citetitle>user-manual</citetitle>
- for explanations of the above syntax, and other <command>Privoxy</command>
- configuration options.
+ See the <ulink
+ url="http://www.privoxy.org/user-manual/"><citetitle>User Manual</citetitle></ulink> for a detailed
+ explanation of installation, general usage, all configuration options, new
+ features and notes on upgrading.
</para>
-
</refsect1>
+
<!-- ~~~~~ New section ~~~~~ -->
<refsect1><title>Files</title>
<!-- this is a cheesy way to do this, but WTF. -->
<literallayout>
<filename>/usr/sbin/privoxy</filename>
<filename>/etc/privoxy/config</filename>
+ <filename>/etc/privoxy/match-all.action</filename>
<filename>/etc/privoxy/default.action</filename>
- <filename>/etc/privoxy/standard.action</filename>
<filename>/etc/privoxy/user.action</filename>
<filename>/etc/privoxy/default.filter</filename>
<filename>/etc/privoxy/user.filter</filename>
<para>
Various other files should be included, but may vary depending on platform
- and build configuration. More documentation should be included in the local
+ and build configuration. Additional documentation should be included in the local
documentation directory.
</para>
<refsect1><title>Notes</title>
<![%p-not-stable;[
<para>
- This is a &p-status; version of <command>Privoxy</command>. Not
+ This is a &p-status; version of <command>Privoxy</command>. Not
all features are well tested.
</para>]]>
<para>