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.24 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.24 User
22 <p class="PUBDATE"><sub><a href="copyright.html">Copyright</a> ©
23 2001-2014 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.199 2016/01/21 15:55:49
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-FREEBSD">FreeBSD and
161 <dt>5.3. <a href="startup.html#START-WINDOWS">Windows</a></dt>
163 <dt>5.4. <a href="startup.html#START-UNICES">Generic instructions
164 for Unix derivates (Solaris, NetBSD, HP-UX etc.)</a></dt>
166 <dt>5.5. <a href="startup.html#START-OS2">OS/2</a></dt>
168 <dt>5.6. <a href="startup.html#START-MACOSX">Mac OS X</a></dt>
170 <dt>5.7. <a href="startup.html#CMDOPTIONS">Command Line
175 <dt>6. <a href="configuration.html">Privoxy Configuration</a></dt>
179 <dt>6.1. <a href="configuration.html#AEN812">Controlling Privoxy
180 with Your Web Browser</a></dt>
182 <dt>6.2. <a href="configuration.html#CONFOVERVIEW">Configuration
183 Files Overview</a></dt>
187 <dt>7. <a href="config.html">The Main Configuration File</a></dt>
191 <dt>7.1. <a href="config.html#LOCAL-SET-UP">Local Set-up
192 Documentation</a></dt>
197 "config.html#USER-MANUAL">user-manual</a></dt>
200 "config.html#TRUST-INFO-URL">trust-info-url</a></dt>
203 "config.html#ADMIN-ADDRESS">admin-address</a></dt>
206 "config.html#PROXY-INFO-URL">proxy-info-url</a></dt>
210 <dt>7.2. <a href="config.html#CONF-LOG-LOC">Configuration and Log
211 File Locations</a></dt>
215 <dt>7.2.1. <a href="config.html#CONFDIR">confdir</a></dt>
217 <dt>7.2.2. <a href="config.html#TEMPLDIR">templdir</a></dt>
220 "config.html#TEMPORARY-DIRECTORY">temporary-directory</a></dt>
222 <dt>7.2.4. <a href="config.html#LOGDIR">logdir</a></dt>
225 "config.html#ACTIONSFILE">actionsfile</a></dt>
228 "config.html#FILTERFILE">filterfile</a></dt>
230 <dt>7.2.7. <a href="config.html#LOGFILE">logfile</a></dt>
232 <dt>7.2.8. <a href="config.html#TRUSTFILE">trustfile</a></dt>
236 <dt>7.3. <a href="config.html#DEBUGGING">Debugging</a></dt>
240 <dt>7.3.1. <a href="config.html#DEBUG">debug</a></dt>
243 "config.html#SINGLE-THREADED">single-threaded</a></dt>
245 <dt>7.3.3. <a href="config.html#HOSTNAME">hostname</a></dt>
249 <dt>7.4. <a href="config.html#ACCESS-CONTROL">Access Control and
255 "config.html#LISTEN-ADDRESS">listen-address</a></dt>
257 <dt>7.4.2. <a href="config.html#TOGGLE">toggle</a></dt>
260 "config.html#ENABLE-REMOTE-TOGGLE">enable-remote-toggle</a></dt>
263 "config.html#ENABLE-REMOTE-HTTP-TOGGLE">enable-remote-http-toggle</a></dt>
266 "config.html#ENABLE-EDIT-ACTIONS">enable-edit-actions</a></dt>
269 "config.html#ENFORCE-BLOCKS">enforce-blocks</a></dt>
271 <dt>7.4.7. <a href="config.html#ACLS">ACLs: permit-access and
275 "config.html#BUFFER-LIMIT">buffer-limit</a></dt>
278 "config.html#ENABLE-PROXY-AUTHENTICATION-FORWARDING">enable-proxy-authentication-forwarding</a></dt>
282 <dt>7.5. <a href="config.html#FORWARDING">Forwarding</a></dt>
286 <dt>7.5.1. <a href="config.html#FORWARD">forward</a></dt>
288 <dt>7.5.2. <a href="config.html#SOCKS">forward-socks4,
289 forward-socks4a, forward-socks5 and forward-socks5t</a></dt>
292 "config.html#ADVANCED-FORWARDING-EXAMPLES">Advanced
293 Forwarding Examples</a></dt>
296 "config.html#FORWARDED-CONNECT-RETRIES">forwarded-connect-retries</a></dt>
300 <dt>7.6. <a href="config.html#MISC">Miscellaneous</a></dt>
305 "config.html#ACCEPT-INTERCEPTED-REQUESTS">accept-intercepted-requests</a></dt>
308 "config.html#ALLOW-CGI-REQUEST-CRUNCHING">allow-cgi-request-crunching</a></dt>
311 "config.html#SPLIT-LARGE-FORMS">split-large-forms</a></dt>
314 "config.html#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</a></dt>
317 "config.html#TOLERATE-PIPELINING">tolerate-pipelining</a></dt>
320 "config.html#DEFAULT-SERVER-TIMEOUT">default-server-timeout</a></dt>
323 "config.html#CONNECTION-SHARING">connection-sharing</a></dt>
326 "config.html#SOCKET-TIMEOUT">socket-timeout</a></dt>
329 "config.html#MAX-CLIENT-CONNECTIONS">max-client-connections</a></dt>
332 "config.html#HANDLE-AS-EMPTY-DOC-RETURNS-OK">handle-as-empty-doc-returns-ok</a></dt>
335 "config.html#ENABLE-COMPRESSION">enable-compression</a></dt>
338 "config.html#COMPRESSION-LEVEL">compression-level</a></dt>
341 "config.html#CLIENT-HEADER-ORDER">client-header-order</a></dt>
345 <dt>7.7. <a href="config.html#WINDOWS-GUI">Windows GUI
350 <dt>8. <a href="actions-file.html">Actions Files</a></dt>
354 <dt>8.1. <a href="actions-file.html#AEN2714">Finding the Right
357 <dt>8.2. <a href="actions-file.html#AEN2721">How to Edit</a></dt>
359 <dt>8.3. <a href="actions-file.html#ACTIONS-APPLY">How Actions
360 are Applied to Requests</a></dt>
363 "actions-file.html#AF-PATTERNS">Patterns</a></dt>
367 <dt>8.4.1. <a href="actions-file.html#HOST-PATTERN">The Host
370 <dt>8.4.2. <a href="actions-file.html#AEN2915">The Path
373 <dt>8.4.3. <a href="actions-file.html#TAG-PATTERN">The Tag
377 "actions-file.html#NEGATIVE-TAG-PATTERNS">The Negative Tag
382 <dt>8.5. <a href="actions-file.html#ACTIONS">Actions</a></dt>
387 "actions-file.html#ADD-HEADER">add-header</a></dt>
389 <dt>8.5.2. <a href="actions-file.html#BLOCK">block</a></dt>
392 "actions-file.html#CHANGE-X-FORWARDED-FOR">change-x-forwarded-for</a></dt>
395 "actions-file.html#CLIENT-HEADER-FILTER">client-header-filter</a></dt>
398 "actions-file.html#CLIENT-HEADER-TAGGER">client-header-tagger</a></dt>
401 "actions-file.html#CONTENT-TYPE-OVERWRITE">content-type-overwrite</a></dt>
404 "actions-file.html#CRUNCH-CLIENT-HEADER">crunch-client-header</a></dt>
407 "actions-file.html#CRUNCH-IF-NONE-MATCH">crunch-if-none-match</a></dt>
410 "actions-file.html#CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</a></dt>
413 "actions-file.html#CRUNCH-SERVER-HEADER">crunch-server-header</a></dt>
416 "actions-file.html#CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</a></dt>
419 "actions-file.html#DEANIMATE-GIFS">deanimate-gifs</a></dt>
422 "actions-file.html#DOWNGRADE-HTTP-VERSION">downgrade-http-version</a></dt>
425 "actions-file.html#EXTERNAL-FILTER">external-filter</a></dt>
428 "actions-file.html#FAST-REDIRECTS">fast-redirects</a></dt>
431 "actions-file.html#FILTER">filter</a></dt>
434 "actions-file.html#FORCE-TEXT-MODE">force-text-mode</a></dt>
437 "actions-file.html#FORWARD-OVERRIDE">forward-override</a></dt>
440 "actions-file.html#HANDLE-AS-EMPTY-DOCUMENT">handle-as-empty-document</a></dt>
443 "actions-file.html#HANDLE-AS-IMAGE">handle-as-image</a></dt>
446 "actions-file.html#HIDE-ACCEPT-LANGUAGE">hide-accept-language</a></dt>
449 "actions-file.html#HIDE-CONTENT-DISPOSITION">hide-content-disposition</a></dt>
452 "actions-file.html#HIDE-IF-MODIFIED-SINCE">hide-if-modified-since</a></dt>
455 "actions-file.html#HIDE-FROM-HEADER">hide-from-header</a></dt>
458 "actions-file.html#HIDE-REFERRER">hide-referrer</a></dt>
461 "actions-file.html#HIDE-USER-AGENT">hide-user-agent</a></dt>
464 "actions-file.html#LIMIT-CONNECT">limit-connect</a></dt>
467 "actions-file.html#LIMIT-COOKIE-LIFETIME">limit-cookie-lifetime</a></dt>
470 "actions-file.html#PREVENT-COMPRESSION">prevent-compression</a></dt>
473 "actions-file.html#OVERWRITE-LAST-MODIFIED">overwrite-last-modified</a></dt>
476 "actions-file.html#REDIRECT">redirect</a></dt>
479 "actions-file.html#SERVER-HEADER-FILTER">server-header-filter</a></dt>
482 "actions-file.html#SERVER-HEADER-TAGGER">server-header-tagger</a></dt>
485 "actions-file.html#SESSION-COOKIES-ONLY">session-cookies-only</a></dt>
488 "actions-file.html#SET-IMAGE-BLOCKER">set-image-blocker</a></dt>
491 "actions-file.html#AEN4654">Summary</a></dt>
495 <dt>8.6. <a href="actions-file.html#ALIASES">Aliases</a></dt>
497 <dt>8.7. <a href="actions-file.html#ACT-EXAMPLES">Actions Files
503 "actions-file.html#AEN4718">match-all.action</a></dt>
506 "actions-file.html#AEN4740">default.action</a></dt>
509 "actions-file.html#AEN4853">user.action</a></dt>
515 <dt>9. <a href="filter-file.html">Filter Files</a></dt>
519 <dt>9.1. <a href="filter-file.html#AEN5021">Filter File
522 <dt>9.2. <a href="filter-file.html#PREDEFINED-FILTERS">The
523 Pre-defined Filters</a></dt>
526 "filter-file.html#EXTERNAL-FILTER-SYNTAX">External filter
531 <dt>10. <a href="templates.html">Privoxy's Template Files</a></dt>
533 <dt>11. <a href="contact.html">Contacting the Developers, Bug
534 Reporting and Feature Requests</a></dt>
538 <dt>11.1. <a href="contact.html#SUFFICIENT-INFORMATION">Please
539 provide sufficient information</a></dt>
541 <dt>11.2. <a href="contact.html#CONTACT-SUPPORT">Get
544 <dt>11.3. <a href="contact.html#REPORTING">Reporting
549 <dt>11.3.1. <a href="contact.html#CONTACT-ADS">Reporting Ads
550 or Other Configuration Problems</a></dt>
552 <dt>11.3.2. <a href="contact.html#CONTACT-BUGS">Reporting
557 <dt>11.4. <a href="contact.html#SECURITY-CONTACT">Reporting
558 security problems</a></dt>
560 <dt>11.5. <a href="contact.html#MAILING-LISTS">Mailing
563 <dt>11.6. <a href="contact.html#SF-TRACKERS">SourceForge support
568 <dt>12. <a href="copyright.html">Privoxy Copyright, License and
573 <dt>12.1. <a href="copyright.html#LICENSE">License</a></dt>
575 <dt>12.2. <a href="copyright.html#HISTORY">History</a></dt>
577 <dt>12.3. <a href="copyright.html#AUTHORS">Authors</a></dt>
581 <dt>13. <a href="seealso.html">See Also</a></dt>
583 <dt>14. <a href="appendix.html">Appendix</a></dt>
587 <dt>14.1. <a href="appendix.html#REGEX">Regular
590 <dt>14.2. <a href="appendix.html#AEN5760">Privoxy's Internal
593 <dt>14.3. <a href="appendix.html#CHAIN">Chain of Events</a></dt>
595 <dt>14.4. <a href="appendix.html#ACTIONSANAT">Troubleshooting:
596 Anatomy of an Action</a></dt>
603 <div class="NAVFOOTER">
604 <hr align="left" width="100%">
606 <table summary="Footer navigation table" width="100%" border="0"
607 cellpadding="0" cellspacing="0">
609 <td width="33%" align="left" valign="top"> </td>
611 <td width="34%" align="center" valign="top"> </td>
613 <td width="33%" align="right" valign="top"><a href=
614 "introduction.html" accesskey="N">Next</a></td>
618 <td width="33%" align="left" valign="top"> </td>
620 <td width="34%" align="center" valign="top"> </td>
622 <td width="33%" align="right" valign="top">Introduction</td>