doc/webserver/man-page/privoxy-man-page.html

   1
   2 <HTML><HEAD><TITLE>Manpage of PRIVOXY</TITLE>
   3 <LINK REL="STYLESHEET" TYPE="text/css" HREF="../p_doc.css"></HEAD><BODY>
   4 <H1>PRIVOXY</H1>
   5 Section:  (1)<BR>Updated: 25 April 2002<BR><A HREF="#index">Index</A>
   6 <HR>
   7
   8 <A NAME="lbAB">&nbsp;</A>
   9 <H2>NAME</H2>
  10
  11 privoxy - Privacy Enhancing Proxy
  12 <A NAME="lbAC">&nbsp;</A>
  13 <H2>SYNOPSIS</H2>
  14
  15 <P>
  16 <B>privoxy</B> [<B>--help</B>]  [<B>--version</B>]  [<B>--no-daemon</B>]  [<B>--pidfile </B><I>pidfile</I><B></B>]  [<B>--user </B><I>user[.group]</I><B></B>]  [<B></B><I>configfile</I><B></B>] <B>(UNIX)</B>
  17 <P>
  18 <P>
  19 <B>privoxy.exe</B> [<B></B><I>configfile</I><B></B>] <B>(Windows)</B>
  20 <P>
  21 <A NAME="lbAD">&nbsp;</A>
  22 <H2>OPTIONS</H2>
  23
  24 <P>
  25
  26 <B>Privoxy</B> may be invoked with the following command line
  27 options:
  28 <DL COMPACT>
  29 <DT><B>--help</B><DD>
  30 Print brief usage info and exit.
  31 <DT><B>--version</B><DD>
  32 Print version info and exit.
  33 <DT><B>--no-daemon</B><DD>
  34 Don't  become  a daemon, i.e. don't fork and become process group
  35 leader, don't detach from controlling tty, and do all logging there.
  36 <DT><B>--pidfile </B><I>pidfile</I><B></B><DD>
  37 On startup, write the process ID to <I>pidfile</I>.
  38 Delete the <I>pidfile</I> on exit.
  39 Failiure to create or delete the <I>pidfile</I>
  40 is non-fatal. If no <B>--pidfile</B> option is given, no PID file will be used.
  41 <DT><B>--user </B><I>user[.group]</I><B></B><DD>
  42 After (optionally) writing the PID file, assume the user ID of
  43 <I>user</I> and the GID of
  44 <I>group</I>, or, if the optional
  45 <I>group</I> was not given, the default group of
  46 <I>user</I>. Exit if the privileges are not
  47 sufficient to do so.
  48 </DL>
  49 <P>
  50
  51 If the <I>configfile</I> is not specified on  the  command  line,
  52 <B>Privoxy</B>  will  look for a file named
  53 <I>config</I> in the current directory (except on Win32 where
  54 it will try <I>config.txt</I>). If no
  55 <I>configfile</I> is found, <B>Privoxy</B> will
  56 fail to start.
  57 <A NAME="lbAE">&nbsp;</A>
  58 <H2>DESCRIPTION</H2>
  59
  60 <P>
  61
  62 <B>Privoxy</B> is a web proxy with advanced filtering
  63 capabilities for protecting privacy, filtering web page content, managing
  64 cookies, controlling access, and removing ads, banners, pop-ups and other
  65 obnoxious Internet junk. <B>Privoxy</B> has a very
  66 flexible configuration and can be customized to suit individual needs and
  67 tastes. <B>Privoxy</B> has application for both
  68 stand-alone systems and multi-user networks.
  69 <P>
  70
  71 <B>Privoxy</B> is based on <B>Internet
  72 Junkbuster</B> (tm).
  73 <A NAME="lbAF">&nbsp;</A>
  74 <H2>INSTALLATION AND USAGE</H2>
  75
  76 <P>
  77
  78 Browsers must be individually configured to use <B>Privoxy</B> as
  79 a HTTP proxy.  The default setting is  for  localhost,  on port  8118
  80 (configurable in the main config file).  To set the HTTP proxy in Netscape
  81 and Mozilla, go through:  <B>Edit</B>;
  82 <B>Preferences</B>;  <B>Advanced</B>;
  83 <B>Proxies</B>;  <B>Manual Proxy Configuration</B>;
  84 <B>View</B>.
  85 <P>
  86
  87 For Internet Explorer, go through: <B>Tools</B>;
  88 <B>Internet Properties</B>; <B>Connections</B>;
  89 <B>LAN Settings</B>.
  90 <P>
  91
  92 The Secure (SSL) Proxy should also be set to the same values, otherwise
  93 https: URLs will not be proxied.
  94 <P>
  95
  96 For other browsers, check the documentation.
  97 <A NAME="lbAG">&nbsp;</A>
  98 <H2>CONFIGURATION</H2>
  99
 100 <P>
 101
 102 <B>Privoxy</B> can be configured with the various configuration
 103 files. The default configuration files are: <I>config</I>,
 104 <I>default.filter</I>, and
 105 <I>default.action</I>. <I>user.action</I> should
 106 be used for locally defined exceptions to the default rules of
 107 <I>default.action</I> These are all well commented.  On Unix
 108 and Unix-like systems, these are located in
 109 <I>/etc/privoxy/</I> by default. On Windows, OS/2 and AmigaOS,
 110 these files are in the same directory as the <B>Privoxy</B>
 111 executable.
 112 <P>
 113
 114 The name and number of configuration files has changed from previous
 115 versions, and is subject to change as development progresses. In fact, the
 116 configuration itself is changed  and  much more sophisticated. See the
 117 user-manual for a
 118 brief explanation of all configuration options.
 119 <P>
 120
 121 The actions list (ad blocks, etc) can also be configured with your
 122 web browser at <A HREF="http://ijbswa.sourceforge.net/config.">http://ijbswa.sourceforge.net/config.</A>
 123 <B>Privoxy's</B> configuration parameters  can also  be viewed at
 124 the same page. In addition, <B>Privoxy</B> can be toggled on/off.
 125 This is an internal page.
 126 <A NAME="lbAH">&nbsp;</A>
 127 <H2>SAMPLE CONFIGURATION</H2>
 128
 129 <P>
 130
 131 A brief example of what a simple <I>default.action</I>
 132 configuration might look like:
 133 <P>
 134 <PRE>
 135  # Define a few useful custom aliases for later use
 136  {{alias}}
 137
 138  # Useful aliases
 139  +prevent-cookies = +prevent-setting-cookies +prevent-reading-cookies
 140  -prevent-cookies = -prevent-setting-cookies -prevent-reading-cookies
 141  +imageblock      = +block +handle-as-image
 142
 143  # Fragile sites should have the minimum changes
 144  fragile     = -block -deanimate-gifs -fast-redirects -filter \
 145                -hide-referer -prevent-cookies -kill-popups
 146
 147  ## Turn some actions on ################################
 148  { \
 149  -add-header \
 150  -block \
 151  +deanimate-gifs{last} \
 152  -downgrade-http-version \
 153  -fast-redirects \
 154  +filter{html-annoyances} \
 155  +filter{js-annoyances} \
 156  +filter{content-cookies} \
 157  +filter{webbugs} \
 158  +filter{banners-by-size} \
 159  +hide-forwarded-for-headers \
 160  +hide-from-header{block} \
 161  +hide-referrer{forge} \
 162  -hide-user-agent \
 163  -handle-as-image \
 164  +set-image-blocker{pattern} \
 165  -limit-connect \
 166  +prevent-compression \
 167  +session-cookies-only \
 168  +prevent-reading-cookies \
 169  +prevent-setting-cookies \
 170  -kill-popups \
 171  }
 172  /   # Match all URLs
 173
 174  # Block, and treat these URL patterns as if they were 'images'.
 175  {+imageblock}
 176   .ad.doubleclick.net
 177   .a[0-9].yimg.com/(?:(?!/i/).)*$
 178   ad.*.doubleclick.net
 179
 180  # Block any URLs that match these patterns
 181  {+block}
 182   ad*.
 183   .*ads.
 184   banner?.
 185   /.*count(er)?\.(pl|cgi|exe|dll|asp|php[34]?)
 186   /(?:.*/)?(publicite|werbung|rekla(ma|me|am)|maino(kset|nta|s)?)/
 187   .hitbox.com
 188
 189  # Make exceptions for these harmless ones that would be
 190  # caught by +block above.
 191  {-block}
 192   adsl.
 193   advice.
 194   .*downloads.
 195 </PRE>
 196
 197 <P>
 198
 199 Then for a <I>user.action</I>, we would put local,
 200 narrowly defined exceptions:
 201 <P>
 202 <PRE>
 203  # Set personal exceptions to the policies in default.action #######
 204
 205  # Sites where we want persistant cookies
 206  {-prevent-reading-cookies -prevent-setting-cookies -session-cookies-only}
 207   .redhat.com
 208   .sun.com
 209   .msdn.microsoft.com
 210
 211  {-block -fast-redirects}
 212   .forbes.com
 213 </PRE>
 214
 215 <P>
 216
 217 See the comments in the configuration files themselves, or the
 218 <I>user-manual</I>
 219 for explanations of the above syntax, and other <B>Privoxy</B>
 220 configuration options.
 221 <A NAME="lbAI">&nbsp;</A>
 222 <H2>FILES</H2>
 223
 224 <P>
 225 <PRE>
 226
 227  <I>/usr/sbin/privoxy</I>
 228  <I>/etc/privoxy/config</I>
 229  <I>/etc/privoxy/default.action</I>
 230  <I>/etc/privoxy/standard.action</I>
 231  <I>/etc/privoxy/user.action</I>
 232  <I>/etc/privoxy/default.filter</I>
 233  <I>/etc/privoxy/trust</I>
 234  <I>/etc/privoxy/templates/*</I>
 235  <I>/var/log/privoxy/logfile</I>
 236 </PRE>
 237
 238 <P>
 239
 240 Various other files should be included, but may vary depending on platform
 241 and build configuration. More documentation should be included in the local
 242 documentation directory, though is not complete at this time.
 243 <A NAME="lbAJ">&nbsp;</A>
 244 <H2>SIGNALS</H2>
 245
 246 <P>
 247
 248 <B>Privoxy</B> terminates on the <B>SIGINT</B>,
 249 <B>SIGTERM</B> and <B>SIGABRT</B> signals. Log
 250 rotation scripts may cause a re-opening of the logfile by sending a
 251 <B>SIGHUP</B> to <B>Privoxy</B>. Note that unlike
 252 other daemons,  <B>Privoxy</B> does not need to be made aware of
 253 config file changes by <B>SIGHUP</B> -- it will detect them
 254 automatically.
 255 <A NAME="lbAK">&nbsp;</A>
 256 <H2>NOTES</H2>
 257
 258 <P>
 259
 260 This is a beta version of <B>Privoxy</B>. Not
 261 all features are well tested.
 262 <P>
 263
 264 Please see the <I>user-manual</I> on how to contact the
 265 developers for feature requests, reporting problems, and other questions.
 266 <A NAME="lbAL">&nbsp;</A>
 267 <H2>SEE ALSO</H2>
 268
 269 <P>
 270
 271 Other references and sites of interest to <B>Privoxy</B>
 272 users:
 273 <P>
 274
 275 <P>
 276 <A HREF="http://www.privoxy.org/,">http://www.privoxy.org/,</A>
 277 The <B>Privoxy</B> Home page.
 278 <P>
 279 <A HREF="http://sourceforge.net/projects/ijbswa,">http://sourceforge.net/projects/ijbswa,</A>
 280 the Project Page for <B>Privoxy</B> on
 281 Sourceforge.
 282 <P>
 283 <A HREF="http://p.p/,">http://p.p/,</A> access
 284 <B>Privoxy</B> from your browser. Alternately,
 285 <A HREF="http://config.privoxy.org">http://config.privoxy.org</A>
 286 may work in some situations where the first does not.
 287 <P>
 288 <A HREF="http://p.p/">http://p.p/</A>
 289 to submit ``misses'' to the developers.
 290 <P>
 291 <A HREF="http://www.junkbusters.com/ht/en/cookies.html">http://www.junkbusters.com/ht/en/cookies.html</A>
 292 <P>
 293 <A HREF="http://www.waldherr.org/junkbuster/">http://www.waldherr.org/junkbuster/</A>
 294 <P>
 295 <A HREF="http://privacy.net/analyze/">http://privacy.net/analyze/</A>
 296 <P>
 297 <A HREF="http://www.squid-cache.org/">http://www.squid-cache.org/</A>
 298 <A NAME="lbAM">&nbsp;</A>
 299 <H2>DEVELOPMENT TEAM</H2>
 300
 301 <P>
 302 <PRE>
 303  Jon Foster
 304  Andreas Oesterhelt
 305  Stefan Waldherr
 306  Thomas Steudten
 307  Rodney Stromlund
 308  Rodrigo Barbosa (RPM specfiles)
 309  Hal Burgiss (docs)
 310  Alexander Lazic
 311  G&#225;bor Lipt&#225;k
 312  Guy
 313  Haroon Rafique
 314  David Schmidt (OS/2, Mac OSX ports)
 315  Joerg Strohmayer
 316  Sarantis Paskalis
 317 </PRE>
 318
 319 <A NAME="lbAN">&nbsp;</A>
 320 <H2>COPYRIGHT AND LICENSE</H2>
 321
 322 <P>
 323
 324 <B>Privoxy</B> is free software; you can
 325 redistribute it and/or modify it under the terms of the GNU General Public
 326 License as published by the Free Software Foundation; either version 2 of the
 327 License, or (at your option) any later version.
 328 <P>
 329
 330 This program is distributed in the hope that it will be useful, but WITHOUT
 331 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 332 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 333 more details, which is available from the Free Software Foundation, Inc, 59
 334 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 335 <P>
 336
 337 You should have received a copy of the GNU General Public License
 338 along with this program; if not, write to the Free Software Foundation, Inc.,
 339 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
 340 <P>
 341
 342 <HR>
 343 <A NAME="index">&nbsp;</A><H2>Index</H2>
 344 <DL>
 345 <DT><A HREF="#lbAB">NAME</A><DD>
 346 <DT><A HREF="#lbAC">SYNOPSIS</A><DD>
 347 <DT><A HREF="#lbAD">OPTIONS</A><DD>
 348 <DT><A HREF="#lbAE">DESCRIPTION</A><DD>
 349 <DT><A HREF="#lbAF">INSTALLATION AND USAGE</A><DD>
 350 <DT><A HREF="#lbAG">CONFIGURATION</A><DD>
 351 <DT><A HREF="#lbAH">SAMPLE CONFIGURATION</A><DD>
 352 <DT><A HREF="#lbAI">FILES</A><DD>
 353 <DT><A HREF="#lbAJ">SIGNALS</A><DD>
 354 <DT><A HREF="#lbAK">NOTES</A><DD>
 355 <DT><A HREF="#lbAL">SEE ALSO</A><DD>
 356 <DT><A HREF="#lbAM">DEVELOPMENT TEAM</A><DD>
 357 <DT><A HREF="#lbAN">COPYRIGHT AND LICENSE</A><DD>
 358 </DL>
 359 <HR>
 360 This document was created by
 361 man2html,
 362 using the manual pages.<BR>
 363 Time: 14:43:58 GMT, April 25, 2002
 364 </BODY>
 365 </HTML>