1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "http://www.w3.org/TR/html4/loose.dtd">
5 <title>Privoxy 3.0.26 User Manual</title>
6 <meta name="GENERATOR" content=
7 "Modular DocBook HTML Stylesheet Version 1.79">
8 <link rel="NEXT" title="Introduction" href="introduction.html">
9 <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
11 <link rel="STYLESHEET" type="text/css" href="p_doc.css">
13 <body class="ARTICLE" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink=
14 "#840084" alink="#0000FF">
16 <div class="TITLEPAGE">
17 <h1 class="TITLE"><a name="AEN2" id="AEN2">Privoxy 3.0.26 User
19 <p class="PUBDATE"><sub><a href="copyright.html">Copyright</a> �
20 2001-2016 by <a href="https://www.privoxy.org/" target="_top">Privoxy
21 Developers</a></sub><br></p>
22 <p class="PUBDATE">$Id: user-manual.sgml,v 2.216 2016/08/26 12:27:34
23 fabiankeil Exp $<br></p>
25 <div class="ABSTRACT">
26 <a name="AEN9" id="AEN9"></a>
27 <p>The <i class="CITETITLE">Privoxy User Manual</i> gives users
28 information on how to install, configure and use <a href=
29 "https://www.privoxy.org/" target="_top">Privoxy</a>.</p>
30 <p>Privoxy is a non-caching web proxy with advanced filtering
31 capabilities for enhancing privacy, modifying web page data and
32 HTTP headers, controlling access, and removing ads and other
33 obnoxious Internet junk. Privoxy has a flexible configuration and
34 can be customized to suit individual needs and tastes. It has
35 application for both stand-alone systems and multi-user
37 <p>Privoxy is Free Software and licensed under the GNU GPLv2.</p>
38 <p>Privoxy is an associated project of Software in the Public
40 <p>Helping hands and donations are welcome:</p>
44 "https://www.privoxy.org/faq/general.html#PARTICIPATE" target=
45 "_top">https://www.privoxy.org/faq/general.html#PARTICIPATE</a></p>
48 <p><a href="https://www.privoxy.org/faq/general.html#DONATE"
50 "_top">https://www.privoxy.org/faq/general.html#DONATE</a></p>
53 <p>You can find the latest version of the <i class=
54 "CITETITLE">Privoxy User Manual</i> at <a href=
55 "https://www.privoxy.org/user-manual/" target=
56 "_top">https://www.privoxy.org/user-manual/</a>. Please see the
57 <a href="contact.html">Contact section</a> on how to contact the
65 <dt><b>Table of Contents</b></dt>
66 <dt>1. <a href="introduction.html">Introduction</a></dt>
69 <dt>1.1. <a href="introduction.html#FEATURES">Features</a></dt>
72 <dt>2. <a href="installation.html">Installation</a></dt>
75 <dt>2.1. <a href="installation.html#INSTALLATION-PACKAGES">Binary
80 "installation.html#INSTALLATION-DEB">Debian and
83 "installation.html#INSTALLATION-PACK-WIN">Windows</a></dt>
85 "installation.html#INSTALLATION-OS2">OS/2</a></dt>
86 <dt>2.1.4. <a href="installation.html#INSTALLATION-MAC">Mac
89 "installation.html#OS-X-INSTALL-FROM-PACKAGE">Installation
90 from ready-built package</a></dt>
92 "installation.html#OS-X-INSTALL-FROM-SOURCE">Installation
95 "installation.html#INSTALLATION-FREEBSD">FreeBSD</a></dt>
98 <dt>2.2. <a href="installation.html#INSTALLATION-SOURCE">Building
101 "installation.html#INSTALLATION-KEEPUPDATED">Keeping your
102 Installation Up-to-Date</a></dt>
105 <dt>3. <a href="whatsnew.html">What's New in this Release</a></dt>
108 <dt>3.1. <a href="whatsnew.html#UPGRADERSNOTE">Note to
112 <dt>4. <a href="quickstart.html">Quickstart to Using Privoxy</a></dt>
116 "quickstart.html#QUICKSTART-AD-BLOCKING">Quickstart to Ad
120 <dt>5. <a href="startup.html">Starting Privoxy</a></dt>
123 <dt>5.1. <a href="startup.html#START-DEBIAN">Debian</a></dt>
124 <dt>5.2. <a href="startup.html#START-FREEBSD">FreeBSD and
126 <dt>5.3. <a href="startup.html#START-WINDOWS">Windows</a></dt>
127 <dt>5.4. <a href="startup.html#START-UNICES">Generic instructions
128 for Unix derivates (Solaris, NetBSD, HP-UX etc.)</a></dt>
129 <dt>5.5. <a href="startup.html#START-OS2">OS/2</a></dt>
130 <dt>5.6. <a href="startup.html#START-MACOSX">Mac OS X</a></dt>
131 <dt>5.7. <a href="startup.html#CMDOPTIONS">Command Line
135 <dt>6. <a href="configuration.html">Privoxy Configuration</a></dt>
139 "configuration.html#CONTROL-WITH-WEBBROWSER">Controlling Privoxy
140 with Your Web Browser</a></dt>
141 <dt>6.2. <a href="configuration.html#CONFOVERVIEW">Configuration
142 Files Overview</a></dt>
145 <dt>7. <a href="config.html">The Main Configuration File</a></dt>
148 <dt>7.1. <a href="config.html#LOCAL-SET-UP">Local Set-up
149 Documentation</a></dt>
153 "config.html#USER-MANUAL">user-manual</a></dt>
155 "config.html#TRUST-INFO-URL">trust-info-url</a></dt>
157 "config.html#ADMIN-ADDRESS">admin-address</a></dt>
159 "config.html#PROXY-INFO-URL">proxy-info-url</a></dt>
162 <dt>7.2. <a href="config.html#CONF-LOG-LOC">Configuration and Log
163 File Locations</a></dt>
166 <dt>7.2.1. <a href="config.html#CONFDIR">confdir</a></dt>
167 <dt>7.2.2. <a href="config.html#TEMPLDIR">templdir</a></dt>
169 "config.html#TEMPORARY-DIRECTORY">temporary-directory</a></dt>
170 <dt>7.2.4. <a href="config.html#LOGDIR">logdir</a></dt>
172 "config.html#ACTIONSFILE">actionsfile</a></dt>
174 "config.html#FILTERFILE">filterfile</a></dt>
175 <dt>7.2.7. <a href="config.html#LOGFILE">logfile</a></dt>
176 <dt>7.2.8. <a href="config.html#TRUSTFILE">trustfile</a></dt>
179 <dt>7.3. <a href="config.html#DEBUGGING">Debugging</a></dt>
182 <dt>7.3.1. <a href="config.html#DEBUG">debug</a></dt>
184 "config.html#SINGLE-THREADED">single-threaded</a></dt>
185 <dt>7.3.3. <a href="config.html#HOSTNAME">hostname</a></dt>
188 <dt>7.4. <a href="config.html#ACCESS-CONTROL">Access Control and
193 "config.html#LISTEN-ADDRESS">listen-address</a></dt>
194 <dt>7.4.2. <a href="config.html#TOGGLE">toggle</a></dt>
196 "config.html#ENABLE-REMOTE-TOGGLE">enable-remote-toggle</a></dt>
198 "config.html#ENABLE-REMOTE-HTTP-TOGGLE">enable-remote-http-toggle</a></dt>
200 "config.html#ENABLE-EDIT-ACTIONS">enable-edit-actions</a></dt>
202 "config.html#ENFORCE-BLOCKS">enforce-blocks</a></dt>
203 <dt>7.4.7. <a href="config.html#ACLS">ACLs: permit-access and
206 "config.html#BUFFER-LIMIT">buffer-limit</a></dt>
208 "config.html#ENABLE-PROXY-AUTHENTICATION-FORWARDING">enable-proxy-authentication-forwarding</a></dt>
211 <dt>7.5. <a href="config.html#FORWARDING">Forwarding</a></dt>
214 <dt>7.5.1. <a href="config.html#FORWARD">forward</a></dt>
215 <dt>7.5.2. <a href="config.html#SOCKS">forward-socks4,
216 forward-socks4a, forward-socks5 and forward-socks5t</a></dt>
218 "config.html#ADVANCED-FORWARDING-EXAMPLES">Advanced
219 Forwarding Examples</a></dt>
221 "config.html#FORWARDED-CONNECT-RETRIES">forwarded-connect-retries</a></dt>
224 <dt>7.6. <a href="config.html#MISC">Miscellaneous</a></dt>
228 "config.html#ACCEPT-INTERCEPTED-REQUESTS">accept-intercepted-requests</a></dt>
230 "config.html#ALLOW-CGI-REQUEST-CRUNCHING">allow-cgi-request-crunching</a></dt>
232 "config.html#SPLIT-LARGE-FORMS">split-large-forms</a></dt>
234 "config.html#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</a></dt>
236 "config.html#TOLERATE-PIPELINING">tolerate-pipelining</a></dt>
238 "config.html#DEFAULT-SERVER-TIMEOUT">default-server-timeout</a></dt>
240 "config.html#CONNECTION-SHARING">connection-sharing</a></dt>
242 "config.html#SOCKET-TIMEOUT">socket-timeout</a></dt>
244 "config.html#MAX-CLIENT-CONNECTIONS">max-client-connections</a></dt>
246 "config.html#HANDLE-AS-EMPTY-DOC-RETURNS-OK">handle-as-empty-doc-returns-ok</a></dt>
248 "config.html#ENABLE-COMPRESSION">enable-compression</a></dt>
250 "config.html#COMPRESSION-LEVEL">compression-level</a></dt>
252 "config.html#CLIENT-HEADER-ORDER">client-header-order</a></dt>
254 "config.html#CLIENT-SPECIFIC-TAG">client-specific-tag</a></dt>
256 "config.html#CLIENT-TAG-LIFETIME">client-tag-lifetime</a></dt>
258 "config.html#TRUST-X-FORWARDED-FOR">trust-x-forwarded-for</a></dt>
261 <dt>7.7. <a href="config.html#WINDOWS-GUI">Windows GUI
265 <dt>8. <a href="actions-file.html">Actions Files</a></dt>
268 <dt>8.1. <a href="actions-file.html#RIGHT-MIX">Finding the Right
270 <dt>8.2. <a href="actions-file.html#HOW-TO-EDIT">How to
272 <dt>8.3. <a href="actions-file.html#ACTIONS-APPLY">How Actions
273 are Applied to Requests</a></dt>
275 "actions-file.html#AF-PATTERNS">Patterns</a></dt>
278 <dt>8.4.1. <a href="actions-file.html#HOST-PATTERN">The Host
280 <dt>8.4.2. <a href="actions-file.html#PATH-PATTERN">The Path
282 <dt>8.4.3. <a href="actions-file.html#TAG-PATTERN">The
283 Request Tag Pattern</a></dt>
285 "actions-file.html#NEGATIVE-TAG-PATTERNS">The Negative
286 Request Tag Patterns</a></dt>
287 <dt>8.4.5. <a href="actions-file.html#CLIENT-TAG-PATTERN">The
288 Client Tag Pattern</a></dt>
291 <dt>8.5. <a href="actions-file.html#ACTIONS">Actions</a></dt>
295 "actions-file.html#ADD-HEADER">add-header</a></dt>
296 <dt>8.5.2. <a href="actions-file.html#BLOCK">block</a></dt>
298 "actions-file.html#CHANGE-X-FORWARDED-FOR">change-x-forwarded-for</a></dt>
300 "actions-file.html#CLIENT-HEADER-FILTER">client-header-filter</a></dt>
302 "actions-file.html#CLIENT-HEADER-TAGGER">client-header-tagger</a></dt>
304 "actions-file.html#CONTENT-TYPE-OVERWRITE">content-type-overwrite</a></dt>
306 "actions-file.html#CRUNCH-CLIENT-HEADER">crunch-client-header</a></dt>
308 "actions-file.html#CRUNCH-IF-NONE-MATCH">crunch-if-none-match</a></dt>
310 "actions-file.html#CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</a></dt>
312 "actions-file.html#CRUNCH-SERVER-HEADER">crunch-server-header</a></dt>
314 "actions-file.html#CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</a></dt>
316 "actions-file.html#DEANIMATE-GIFS">deanimate-gifs</a></dt>
318 "actions-file.html#DOWNGRADE-HTTP-VERSION">downgrade-http-version</a></dt>
320 "actions-file.html#EXTERNAL-FILTER">external-filter</a></dt>
322 "actions-file.html#FAST-REDIRECTS">fast-redirects</a></dt>
324 "actions-file.html#FILTER">filter</a></dt>
326 "actions-file.html#FORCE-TEXT-MODE">force-text-mode</a></dt>
328 "actions-file.html#FORWARD-OVERRIDE">forward-override</a></dt>
330 "actions-file.html#HANDLE-AS-EMPTY-DOCUMENT">handle-as-empty-document</a></dt>
332 "actions-file.html#HANDLE-AS-IMAGE">handle-as-image</a></dt>
334 "actions-file.html#HIDE-ACCEPT-LANGUAGE">hide-accept-language</a></dt>
336 "actions-file.html#HIDE-CONTENT-DISPOSITION">hide-content-disposition</a></dt>
338 "actions-file.html#HIDE-IF-MODIFIED-SINCE">hide-if-modified-since</a></dt>
340 "actions-file.html#HIDE-FROM-HEADER">hide-from-header</a></dt>
342 "actions-file.html#HIDE-REFERRER">hide-referrer</a></dt>
344 "actions-file.html#HIDE-USER-AGENT">hide-user-agent</a></dt>
346 "actions-file.html#LIMIT-CONNECT">limit-connect</a></dt>
348 "actions-file.html#LIMIT-COOKIE-LIFETIME">limit-cookie-lifetime</a></dt>
350 "actions-file.html#PREVENT-COMPRESSION">prevent-compression</a></dt>
352 "actions-file.html#OVERWRITE-LAST-MODIFIED">overwrite-last-modified</a></dt>
354 "actions-file.html#REDIRECT">redirect</a></dt>
356 "actions-file.html#SERVER-HEADER-FILTER">server-header-filter</a></dt>
358 "actions-file.html#SERVER-HEADER-TAGGER">server-header-tagger</a></dt>
360 "actions-file.html#SESSION-COOKIES-ONLY">session-cookies-only</a></dt>
362 "actions-file.html#SET-IMAGE-BLOCKER">set-image-blocker</a></dt>
364 "actions-file.html#SUMMARY">Summary</a></dt>
367 <dt>8.6. <a href="actions-file.html#ALIASES">Aliases</a></dt>
368 <dt>8.7. <a href="actions-file.html#ACT-EXAMPLES">Actions Files
373 "actions-file.html#MATCH-ALL">match-all.action</a></dt>
375 "actions-file.html#DEFAULT-ACTION">default.action</a></dt>
377 "actions-file.html#USER-ACTION">user.action</a></dt>
382 <dt>9. <a href="filter-file.html">Filter Files</a></dt>
385 <dt>9.1. <a href="filter-file.html#FILTER-FILE-TUT">Filter File
387 <dt>9.2. <a href="filter-file.html#PREDEFINED-FILTERS">The
388 Pre-defined Filters</a></dt>
390 "filter-file.html#EXTERNAL-FILTER-SYNTAX">External filter
394 <dt>10. <a href="templates.html">Privoxy's Template Files</a></dt>
395 <dt>11. <a href="contact.html">Contacting the Developers, Bug
396 Reporting and Feature Requests</a></dt>
399 <dt>11.1. <a href="contact.html#SUFFICIENT-INFORMATION">Please
400 provide sufficient information</a></dt>
401 <dt>11.2. <a href="contact.html#CONTACT-SUPPORT">Get
403 <dt>11.3. <a href="contact.html#REPORTING">Reporting
407 <dt>11.3.1. <a href="contact.html#CONTACT-ADS">Reporting Ads
408 or Other Configuration Problems</a></dt>
409 <dt>11.3.2. <a href="contact.html#CONTACT-BUGS">Reporting
413 <dt>11.4. <a href="contact.html#SECURITY-CONTACT">Reporting
414 security problems</a></dt>
415 <dt>11.5. <a href="contact.html#MAILING-LISTS">Mailing
417 <dt>11.6. <a href="contact.html#SF-TRACKERS">SourceForge support
421 <dt>12. <a href="copyright.html">Privoxy Copyright, License and
425 <dt>12.1. <a href="copyright.html#LICENSE">License</a></dt>
426 <dt>12.2. <a href="copyright.html#HISTORY">History</a></dt>
427 <dt>12.3. <a href="copyright.html#AUTHORS">Authors</a></dt>
430 <dt>13. <a href="seealso.html">See Also</a></dt>
431 <dt>14. <a href="appendix.html">Appendix</a></dt>
434 <dt>14.1. <a href="appendix.html#REGEX">Regular
436 <dt>14.2. <a href="appendix.html#INTERNAL-PAGES">Privoxy's
437 Internal Pages</a></dt>
438 <dt>14.3. <a href="appendix.html#CHAIN">Chain of Events</a></dt>
439 <dt>14.4. <a href="appendix.html#ACTIONSANAT">Troubleshooting:
440 Anatomy of an Action</a></dt>
446 <div class="NAVFOOTER">
447 <hr align="left" width="100%">
448 <table summary="Footer navigation table" width="100%" border="0"
449 cellpadding="0" cellspacing="0">
451 <td width="33%" align="left" valign="top"> </td>
452 <td width="34%" align="center" valign="top"> </td>
453 <td width="33%" align="right" valign="top"><a href=
454 "introduction.html" accesskey="N">Next</a></td>
457 <td width="33%" align="left" valign="top"> </td>
458 <td width="34%" align="center" valign="top"> </td>
459 <td width="33%" align="right" valign="top">Introduction</td>