1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "http://www.w3.org/TR/html4/loose.dtd">
6 <title>Privoxy 3.0.21 User Manual</title>
7 <meta name="GENERATOR" content=
8 "Modular DocBook HTML Stylesheet Version 1.79">
9 <link rel="NEXT" title="Introduction" href="introduction.html">
10 <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
11 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
12 <link rel="STYLESHEET" type="text/css" href="p_doc.css">
15 <body class="ARTICLE" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink=
16 "#840084" alink="#0000FF">
18 <div class="TITLEPAGE">
19 <h1 class="TITLE"><a name="AEN2" id="AEN2">Privoxy 3.0.21 User
22 <p class="PUBDATE"><sub><a href="copyright.html">Copyright</a> ©
23 2001-2013 by <a href="http://www.privoxy.org/" target="_top">Privoxy
24 Developers</a></sub><br></p>
26 <p class="PUBDATE">$Id: user-manual.sgml,v 2.174 2013/03/02 14:39:24
27 fabiankeil Exp $<br></p>
30 <div class="ABSTRACT">
31 <a name="AEN9" id="AEN9"></a>
33 <p>The <i class="CITETITLE">Privoxy User Manual</i> gives users
34 information on how to install, configure and use <a href=
35 "http://www.privoxy.org/" target="_top">Privoxy</a>.</p>
37 <p>Privoxy is a non-caching web proxy with advanced filtering
38 capabilities for enhancing privacy, modifying web page data and
39 HTTP headers, controlling access, and removing ads and other
40 obnoxious Internet junk. Privoxy has a flexible configuration and
41 can be customized to suit individual needs and tastes. It has
42 application for both stand-alone systems and multi-user
45 <p>Privoxy is Free Software and licensed under the GNU GPLv2.</p>
47 <p>Privoxy is an associated project of Software in the Public
50 <p>Helping hands and donations are welcome:</p>
55 "http://www.privoxy.org/faq/general.html#PARTICIPATE" target=
56 "_top">http://www.privoxy.org/faq/general.html#PARTICIPATE</a></p>
60 <p><a href="http://www.privoxy.org/faq/general.html#DONATE"
62 "_top">http://www.privoxy.org/faq/general.html#DONATE</a></p>
66 <p>You can find the latest version of the <i class=
67 "CITETITLE">Privoxy User Manual</i> at <a href=
68 "http://www.privoxy.org/user-manual/" target=
69 "_top">http://www.privoxy.org/user-manual/</a>. Please see the
70 <a href="contact.html">Contact section</a> on how to contact the
79 <dt><b>Table of Contents</b></dt>
81 <dt>1. <a href="introduction.html">Introduction</a></dt>
85 <dt>1.1. <a href="introduction.html#FEATURES">Features</a></dt>
89 <dt>2. <a href="installation.html">Installation</a></dt>
93 <dt>2.1. <a href="installation.html#INSTALLATION-PACKAGES">Binary
99 "installation.html#INSTALLATION-DEB">Debian and
103 "installation.html#INSTALLATION-PACK-WIN">Windows</a></dt>
106 "installation.html#INSTALLATION-OS2">OS/2</a></dt>
108 <dt>2.1.4. <a href="installation.html#INSTALLATION-MAC">Mac
112 "installation.html#OS-X-INSTALL-FROM-PACKAGE">Installation
113 from ready-built package</a></dt>
116 "installation.html#OS-X-INSTALL-FROM-SOURCE">Installation
120 "installation.html#INSTALLATION-FREEBSD">FreeBSD</a></dt>
124 <dt>2.2. <a href="installation.html#INSTALLATION-SOURCE">Building
128 "installation.html#INSTALLATION-KEEPUPDATED">Keeping your
129 Installation Up-to-Date</a></dt>
133 <dt>3. <a href="whatsnew.html">What's New in this Release</a></dt>
137 <dt>3.1. <a href="whatsnew.html#UPGRADERSNOTE">Note to
142 <dt>4. <a href="quickstart.html">Quickstart to Using Privoxy</a></dt>
147 "quickstart.html#QUICKSTART-AD-BLOCKING">Quickstart to Ad
152 <dt>5. <a href="startup.html">Starting Privoxy</a></dt>
156 <dt>5.1. <a href="startup.html#START-DEBIAN">Debian</a></dt>
158 <dt>5.2. <a href="startup.html#START-WINDOWS">Windows</a></dt>
160 <dt>5.3. <a href="startup.html#START-UNICES">Solaris, NetBSD,
161 FreeBSD, HP-UX and others</a></dt>
163 <dt>5.4. <a href="startup.html#START-OS2">OS/2</a></dt>
165 <dt>5.5. <a href="startup.html#START-MACOSX">Mac OS X</a></dt>
167 <dt>5.6. <a href="startup.html#CMDOPTIONS">Command Line
172 <dt>6. <a href="configuration.html">Privoxy Configuration</a></dt>
176 <dt>6.1. <a href="configuration.html#AEN1078">Controlling Privoxy
177 with Your Web Browser</a></dt>
179 <dt>6.2. <a href="configuration.html#CONFOVERVIEW">Configuration
180 Files Overview</a></dt>
184 <dt>7. <a href="config.html">The Main Configuration File</a></dt>
188 <dt>7.1. <a href="config.html#LOCAL-SET-UP">Local Set-up
189 Documentation</a></dt>
194 "config.html#USER-MANUAL">user-manual</a></dt>
197 "config.html#TRUST-INFO-URL">trust-info-url</a></dt>
200 "config.html#ADMIN-ADDRESS">admin-address</a></dt>
203 "config.html#PROXY-INFO-URL">proxy-info-url</a></dt>
207 <dt>7.2. <a href="config.html#CONF-LOG-LOC">Configuration and Log
208 File Locations</a></dt>
212 <dt>7.2.1. <a href="config.html#CONFDIR">confdir</a></dt>
214 <dt>7.2.2. <a href="config.html#TEMPLDIR">templdir</a></dt>
216 <dt>7.2.3. <a href="config.html#LOGDIR">logdir</a></dt>
219 "config.html#ACTIONSFILE">actionsfile</a></dt>
222 "config.html#FILTERFILE">filterfile</a></dt>
224 <dt>7.2.6. <a href="config.html#LOGFILE">logfile</a></dt>
226 <dt>7.2.7. <a href="config.html#TRUSTFILE">trustfile</a></dt>
230 <dt>7.3. <a href="config.html#DEBUGGING">Debugging</a></dt>
234 <dt>7.3.1. <a href="config.html#DEBUG">debug</a></dt>
237 "config.html#SINGLE-THREADED">single-threaded</a></dt>
239 <dt>7.3.3. <a href="config.html#HOSTNAME">hostname</a></dt>
243 <dt>7.4. <a href="config.html#ACCESS-CONTROL">Access Control and
249 "config.html#LISTEN-ADDRESS">listen-address</a></dt>
251 <dt>7.4.2. <a href="config.html#TOGGLE">toggle</a></dt>
254 "config.html#ENABLE-REMOTE-TOGGLE">enable-remote-toggle</a></dt>
257 "config.html#ENABLE-REMOTE-HTTP-TOGGLE">enable-remote-http-toggle</a></dt>
260 "config.html#ENABLE-EDIT-ACTIONS">enable-edit-actions</a></dt>
263 "config.html#ENFORCE-BLOCKS">enforce-blocks</a></dt>
265 <dt>7.4.7. <a href="config.html#ACLS">ACLs: permit-access and
269 "config.html#BUFFER-LIMIT">buffer-limit</a></dt>
272 "config.html#ENABLE-PROXY-AUTHENTICATION-FORWARDING">enable-proxy-authentication-forwarding</a></dt>
276 <dt>7.5. <a href="config.html#FORWARDING">Forwarding</a></dt>
280 <dt>7.5.1. <a href="config.html#FORWARD">forward</a></dt>
282 <dt>7.5.2. <a href="config.html#SOCKS">forward-socks4,
283 forward-socks4a, forward-socks5 and forward-socks5t</a></dt>
286 "config.html#ADVANCED-FORWARDING-EXAMPLES">Advanced
287 Forwarding Examples</a></dt>
290 "config.html#FORWARDED-CONNECT-RETRIES">forwarded-connect-retries</a></dt>
294 <dt>7.6. <a href="config.html#MISC">Miscellaneous</a></dt>
299 "config.html#ACCEPT-INTERCEPTED-REQUESTS">accept-intercepted-requests</a></dt>
302 "config.html#ALLOW-CGI-REQUEST-CRUNCHING">allow-cgi-request-crunching</a></dt>
305 "config.html#SPLIT-LARGE-FORMS">split-large-forms</a></dt>
308 "config.html#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</a></dt>
311 "config.html#TOLERATE-PIPELINING">tolerate-pipelining</a></dt>
314 "config.html#DEFAULT-SERVER-TIMEOUT">default-server-timeout</a></dt>
317 "config.html#CONNECTION-SHARING">connection-sharing</a></dt>
320 "config.html#SOCKET-TIMEOUT">socket-timeout</a></dt>
323 "config.html#MAX-CLIENT-CONNECTIONS">max-client-connections</a></dt>
326 "config.html#HANDLE-AS-EMPTY-DOC-RETURNS-OK">handle-as-empty-doc-returns-ok</a></dt>
329 "config.html#ENABLE-COMPRESSION">enable-compression</a></dt>
332 "config.html#COMPRESSION-LEVEL">compression-level</a></dt>
335 "config.html#CLIENT-HEADER-ORDER">client-header-order</a></dt>
339 <dt>7.7. <a href="config.html#WINDOWS-GUI">Windows GUI
344 <dt>8. <a href="actions-file.html">Actions Files</a></dt>
348 <dt>8.1. <a href="actions-file.html#AEN2957">Finding the Right
351 <dt>8.2. <a href="actions-file.html#AEN2964">How to Edit</a></dt>
353 <dt>8.3. <a href="actions-file.html#ACTIONS-APPLY">How Actions
354 are Applied to Requests</a></dt>
357 "actions-file.html#AF-PATTERNS">Patterns</a></dt>
361 <dt>8.4.1. <a href="actions-file.html#AEN3076">The Domain
364 <dt>8.4.2. <a href="actions-file.html#AEN3152">The Path
367 <dt>8.4.3. <a href="actions-file.html#TAG-PATTERN">The Tag
372 <dt>8.5. <a href="actions-file.html#ACTIONS">Actions</a></dt>
377 "actions-file.html#ADD-HEADER">add-header</a></dt>
379 <dt>8.5.2. <a href="actions-file.html#BLOCK">block</a></dt>
382 "actions-file.html#CHANGE-X-FORWARDED-FOR">change-x-forwarded-for</a></dt>
385 "actions-file.html#CLIENT-HEADER-FILTER">client-header-filter</a></dt>
388 "actions-file.html#CLIENT-HEADER-TAGGER">client-header-tagger</a></dt>
391 "actions-file.html#CONTENT-TYPE-OVERWRITE">content-type-overwrite</a></dt>
394 "actions-file.html#CRUNCH-CLIENT-HEADER">crunch-client-header</a></dt>
397 "actions-file.html#CRUNCH-IF-NONE-MATCH">crunch-if-none-match</a></dt>
400 "actions-file.html#CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</a></dt>
403 "actions-file.html#CRUNCH-SERVER-HEADER">crunch-server-header</a></dt>
406 "actions-file.html#CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</a></dt>
409 "actions-file.html#DEANIMATE-GIFS">deanimate-gifs</a></dt>
412 "actions-file.html#DOWNGRADE-HTTP-VERSION">downgrade-http-version</a></dt>
415 "actions-file.html#FAST-REDIRECTS">fast-redirects</a></dt>
418 "actions-file.html#FILTER">filter</a></dt>
421 "actions-file.html#FORCE-TEXT-MODE">force-text-mode</a></dt>
424 "actions-file.html#FORWARD-OVERRIDE">forward-override</a></dt>
427 "actions-file.html#HANDLE-AS-EMPTY-DOCUMENT">handle-as-empty-document</a></dt>
430 "actions-file.html#HANDLE-AS-IMAGE">handle-as-image</a></dt>
433 "actions-file.html#HIDE-ACCEPT-LANGUAGE">hide-accept-language</a></dt>
436 "actions-file.html#HIDE-CONTENT-DISPOSITION">hide-content-disposition</a></dt>
439 "actions-file.html#HIDE-IF-MODIFIED-SINCE">hide-if-modified-since</a></dt>
442 "actions-file.html#HIDE-FROM-HEADER">hide-from-header</a></dt>
445 "actions-file.html#HIDE-REFERRER">hide-referrer</a></dt>
448 "actions-file.html#HIDE-USER-AGENT">hide-user-agent</a></dt>
451 "actions-file.html#LIMIT-CONNECT">limit-connect</a></dt>
454 "actions-file.html#LIMIT-COOKIE-LIFETIME">limit-cookie-lifetime</a></dt>
457 "actions-file.html#PREVENT-COMPRESSION">prevent-compression</a></dt>
460 "actions-file.html#OVERWRITE-LAST-MODIFIED">overwrite-last-modified</a></dt>
463 "actions-file.html#REDIRECT">redirect</a></dt>
466 "actions-file.html#SERVER-HEADER-FILTER">server-header-filter</a></dt>
469 "actions-file.html#SERVER-HEADER-TAGGER">server-header-tagger</a></dt>
472 "actions-file.html#SESSION-COOKIES-ONLY">session-cookies-only</a></dt>
475 "actions-file.html#SET-IMAGE-BLOCKER">set-image-blocker</a></dt>
478 "actions-file.html#AEN4827">Summary</a></dt>
482 <dt>8.6. <a href="actions-file.html#ALIASES">Aliases</a></dt>
484 <dt>8.7. <a href="actions-file.html#ACT-EXAMPLES">Actions Files
490 "actions-file.html#AEN4891">match-all.action</a></dt>
493 "actions-file.html#AEN4913">default.action</a></dt>
496 "actions-file.html#AEN5026">user.action</a></dt>
502 <dt>9. <a href="filter-file.html">Filter Files</a></dt>
506 <dt>9.1. <a href="filter-file.html#AEN5181">Filter File
509 <dt>9.2. <a href="filter-file.html#PREDEFINED-FILTERS">The
510 Pre-defined Filters</a></dt>
514 <dt>10. <a href="templates.html">Privoxy's Template Files</a></dt>
516 <dt>11. <a href="contact.html">Contacting the Developers, Bug
517 Reporting and Feature Requests</a></dt>
521 <dt>11.1. <a href="contact.html#SUFFICIENT-INFORMATION">Please
522 provide sufficient information</a></dt>
524 <dt>11.2. <a href="contact.html#CONTACT-SUPPORT">Get
527 <dt>11.3. <a href="contact.html#REPORTING">Reporting
532 <dt>11.3.1. <a href="contact.html#CONTACT-ADS">Reporting Ads
533 or Other Configuration Problems</a></dt>
535 <dt>11.3.2. <a href="contact.html#CONTACT-BUGS">Reporting
540 <dt>11.4. <a href="contact.html#CONTACT-FEATURE">Request New
543 <dt>11.5. <a href="contact.html#MAILING-LISTS">Mailing
548 <dt>12. <a href="copyright.html">Privoxy Copyright, License and
553 <dt>12.1. <a href="copyright.html#LICENSE">License</a></dt>
555 <dt>12.2. <a href="copyright.html#HISTORY">History</a></dt>
557 <dt>12.3. <a href="copyright.html#AUTHORS">Authors</a></dt>
561 <dt>13. <a href="seealso.html">See Also</a></dt>
563 <dt>14. <a href="appendix.html">Appendix</a></dt>
567 <dt>14.1. <a href="appendix.html#REGEX">Regular
570 <dt>14.2. <a href="appendix.html#AEN5902">Privoxy's Internal
576 "appendix.html#BOOKMARKLETS">Bookmarklets</a></dt>
580 <dt>14.3. <a href="appendix.html#CHAIN">Chain of Events</a></dt>
582 <dt>14.4. <a href="appendix.html#ACTIONSANAT">Troubleshooting:
583 Anatomy of an Action</a></dt>
590 <div class="NAVFOOTER">
591 <hr align="left" width="100%">
593 <table summary="Footer navigation table" width="100%" border="0"
594 cellpadding="0" cellspacing="0">
596 <td width="33%" align="left" valign="top"> </td>
598 <td width="34%" align="center" valign="top"> </td>
600 <td width="33%" align="right" valign="top"><a href=
601 "introduction.html" accesskey="N">Next</a></td>
605 <td width="33%" align="left" valign="top"> </td>
607 <td width="34%" align="center" valign="top"> </td>
609 <td width="33%" align="right" valign="top">Introduction</td>