Rebuilt HTML for 3.0.20 UNRELEASED with Ian's recent changes
[privoxy.git] / doc / webserver / user-manual / index.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "http://www.w3.org/TR/html4/loose.dtd">
3
4 <html>
5 <head>
6   <title>Privoxy 3.0.20 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">
13   <style type="text/css">
14 body {
15   background-color: #EEEEEE;
16   color: #000000;
17   }
18   :link { color: #0000FF }
19   :visited { color: #840084 }
20   :active { color: #0000FF }
21   hr.c2 {text-align: left}
22   dt.c1 {font-weight: bold}
23   </style>
24 </head>
25
26 <body class="ARTICLE">
27   <div class="ARTICLE">
28     <div class="TITLEPAGE">
29       <h1 class="TITLE"><a name="AEN2" id="AEN2">Privoxy 3.0.20 User
30       Manual</a></h1>
31
32       <p class="PUBDATE"><sub><a href="copyright.html">Copyright</a> &copy;
33       2001-2011 by <a href="http://www.privoxy.org/" target="_top">Privoxy
34       Developers</a></sub><br></p>
35
36       <p class="PUBDATE">$Id: user-manual.sgml,v 2.147 2012/03/11 19:03:42
37       diem Exp $<br></p>
38
39       <div class="ABSTRACT">
40         <a name="AEN9" id="AEN9"></a>
41
42         <p>The <i class="CITETITLE">Privoxy User Manual</i> gives users
43         information on how to install, configure and use <a href=
44         "http://www.privoxy.org/" target="_top">Privoxy</a>.</p>
45
46         <p>Privoxy is a non-caching web proxy with advanced filtering
47         capabilities for enhancing privacy, modifying web page data and HTTP
48         headers, controlling access, and removing ads and other obnoxious
49         Internet junk. Privoxy has a flexible configuration and can be
50         customized to suit individual needs and tastes. It has application
51         for both stand-alone systems and multi-user networks.</p>
52
53         <p>Privoxy is Free Software and licensed under the GNU GPLv2.</p>
54
55         <p>Privoxy is an associated project of Software in the Public
56         Interest (SPI).</p>
57
58         <p>Helping hands and donations are welcome:</p>
59
60         <ul>
61           <li>
62             <p><a href="http://www.privoxy.org/faq/general.html#PARTICIPATE"
63             target=
64             "_top">http://www.privoxy.org/faq/general.html#PARTICIPATE</a></p>
65           </li>
66
67           <li>
68             <p><a href="http://www.privoxy.org/faq/general.html#DONATE"
69             target=
70             "_top">http://www.privoxy.org/faq/general.html#DONATE</a></p>
71           </li>
72         </ul>
73
74         <p>You can find the latest version of the <i class=
75         "CITETITLE">Privoxy User Manual</i> at <a href=
76         "http://www.privoxy.org/user-manual/" target=
77         "_top">http://www.privoxy.org/user-manual/</a>. Please see the
78         <a href="contact.html">Contact section</a> on how to contact the
79         developers.</p>
80       </div>
81       <hr>
82     </div>
83
84     <div class="TOC">
85       <dl>
86         <dt class="c1">Table of Contents</dt>
87
88         <dt>1. <a href="introduction.html">Introduction</a></dt>
89
90         <dd>
91           <dl>
92             <dt>1.1. <a href="introduction.html#FEATURES">Features</a></dt>
93           </dl>
94         </dd>
95
96         <dt>2. <a href="installation.html">Installation</a></dt>
97
98         <dd>
99           <dl>
100             <dt>2.1. <a href="installation.html#INSTALLATION-PACKAGES">Binary
101             Packages</a></dt>
102
103             <dd>
104               <dl>
105                 <dt>2.1.1. <a href=
106                 "installation.html#INSTALLATION-PACK-RPM">Red Hat and Fedora
107                 RPMs</a></dt>
108
109                 <dt>2.1.2. <a href=
110                 "installation.html#INSTALLATION-DEB">Debian and
111                 Ubuntu</a></dt>
112
113                 <dt>2.1.3. <a href=
114                 "installation.html#INSTALLATION-PACK-WIN">Windows</a></dt>
115
116                 <dt>2.1.4. <a href=
117                 "installation.html#INSTALLATION-PACK-BINTGZ">Solaris</a></dt>
118
119                 <dt>2.1.5. <a href=
120                 "installation.html#INSTALLATION-OS2">OS/2</a></dt>
121
122                 <dt>2.1.6. <a href="installation.html#INSTALLATION-MAC">Mac
123                 OS X</a></dt>
124
125                 <dt>2.1.7. <a href=
126                 "installation.html#OS-X-INSTALL-FROM-PACKAGE">Installation
127                 from ready-built package</a></dt>
128
129                 <dt>2.1.8. <a href=
130                 "installation.html#OS-X-INSTALL-FROM-SOURCE">Installation
131                 from source</a></dt>
132
133                 <dt>2.1.9. <a href=
134                 "installation.html#INSTALLATION-AMIGA">AmigaOS</a></dt>
135
136                 <dt>2.1.10. <a href=
137                 "installation.html#INSTALLATION-TBZ">FreeBSD</a></dt>
138
139                 <dt>2.1.11. <a href=
140                 "installation.html#INSTALLATTION-GENTOO">Gentoo</a></dt>
141               </dl>
142             </dd>
143
144             <dt>2.2. <a href="installation.html#INSTALLATION-SOURCE">Building
145             from Source</a></dt>
146
147             <dt>2.3. <a href=
148             "installation.html#INSTALLATION-KEEPUPDATED">Keeping your
149             Installation Up-to-Date</a></dt>
150           </dl>
151         </dd>
152
153         <dt>3. <a href="whatsnew.html">What's New in this Release</a></dt>
154
155         <dd>
156           <dl>
157             <dt>3.1. <a href="whatsnew.html#UPGRADERSNOTE">Note to
158             Upgraders</a></dt>
159           </dl>
160         </dd>
161
162         <dt>4. <a href="quickstart.html">Quickstart to Using Privoxy</a></dt>
163
164         <dd>
165           <dl>
166             <dt>4.1. <a href=
167             "quickstart.html#QUICKSTART-AD-BLOCKING">Quickstart to Ad
168             Blocking</a></dt>
169           </dl>
170         </dd>
171
172         <dt>5. <a href="startup.html">Starting Privoxy</a></dt>
173
174         <dd>
175           <dl>
176             <dt>5.1. <a href="startup.html#START-REDHAT">Red Hat and
177             Fedora</a></dt>
178
179             <dt>5.2. <a href="startup.html#START-DEBIAN">Debian</a></dt>
180
181             <dt>5.3. <a href="startup.html#START-WINDOWS">Windows</a></dt>
182
183             <dt>5.4. <a href="startup.html#START-UNICES">Solaris, NetBSD,
184             FreeBSD, HP-UX and others</a></dt>
185
186             <dt>5.5. <a href="startup.html#START-OS2">OS/2</a></dt>
187
188             <dt>5.6. <a href="startup.html#START-MACOSX">Mac OS X</a></dt>
189
190             <dt>5.7. <a href="startup.html#START-AMIGAOS">AmigaOS</a></dt>
191
192             <dt>5.8. <a href="startup.html#START-GENTOO">Gentoo</a></dt>
193
194             <dt>5.9. <a href="startup.html#CMDOPTIONS">Command Line
195             Options</a></dt>
196           </dl>
197         </dd>
198
199         <dt>6. <a href="configuration.html">Privoxy Configuration</a></dt>
200
201         <dd>
202           <dl>
203             <dt>6.1. <a href="configuration.html#AEN1107">Controlling Privoxy
204             with Your Web Browser</a></dt>
205
206             <dt>6.2. <a href="configuration.html#CONFOVERVIEW">Configuration
207             Files Overview</a></dt>
208           </dl>
209         </dd>
210
211         <dt>7. <a href="config.html">The Main Configuration File</a></dt>
212
213         <dd>
214           <dl>
215             <dt>7.1. <a href="config.html#LOCAL-SET-UP">Local Set-up
216             Documentation</a></dt>
217
218             <dd>
219               <dl>
220                 <dt>7.1.1. <a href=
221                 "config.html#USER-MANUAL">user-manual</a></dt>
222
223                 <dt>7.1.2. <a href=
224                 "config.html#TRUST-INFO-URL">trust-info-url</a></dt>
225
226                 <dt>7.1.3. <a href=
227                 "config.html#ADMIN-ADDRESS">admin-address</a></dt>
228
229                 <dt>7.1.4. <a href=
230                 "config.html#PROXY-INFO-URL">proxy-info-url</a></dt>
231               </dl>
232             </dd>
233
234             <dt>7.2. <a href="config.html#CONF-LOG-LOC">Configuration and Log
235             File Locations</a></dt>
236
237             <dd>
238               <dl>
239                 <dt>7.2.1. <a href="config.html#CONFDIR">confdir</a></dt>
240
241                 <dt>7.2.2. <a href="config.html#TEMPLDIR">templdir</a></dt>
242
243                 <dt>7.2.3. <a href="config.html#LOGDIR">logdir</a></dt>
244
245                 <dt>7.2.4. <a href=
246                 "config.html#ACTIONSFILE">actionsfile</a></dt>
247
248                 <dt>7.2.5. <a href=
249                 "config.html#FILTERFILE">filterfile</a></dt>
250
251                 <dt>7.2.6. <a href="config.html#LOGFILE">logfile</a></dt>
252
253                 <dt>7.2.7. <a href="config.html#TRUSTFILE">trustfile</a></dt>
254               </dl>
255             </dd>
256
257             <dt>7.3. <a href="config.html#DEBUGGING">Debugging</a></dt>
258
259             <dd>
260               <dl>
261                 <dt>7.3.1. <a href="config.html#DEBUG">debug</a></dt>
262
263                 <dt>7.3.2. <a href=
264                 "config.html#SINGLE-THREADED">single-threaded</a></dt>
265
266                 <dt>7.3.3. <a href="config.html#HOSTNAME">hostname</a></dt>
267               </dl>
268             </dd>
269
270             <dt>7.4. <a href="config.html#ACCESS-CONTROL">Access Control and
271             Security</a></dt>
272
273             <dd>
274               <dl>
275                 <dt>7.4.1. <a href=
276                 "config.html#LISTEN-ADDRESS">listen-address</a></dt>
277
278                 <dt>7.4.2. <a href="config.html#TOGGLE">toggle</a></dt>
279
280                 <dt>7.4.3. <a href=
281                 "config.html#ENABLE-REMOTE-TOGGLE">enable-remote-toggle</a></dt>
282
283                 <dt>7.4.4. <a href=
284                 "config.html#ENABLE-REMOTE-HTTP-TOGGLE">enable-remote-http-toggle</a></dt>
285
286                 <dt>7.4.5. <a href=
287                 "config.html#ENABLE-EDIT-ACTIONS">enable-edit-actions</a></dt>
288
289                 <dt>7.4.6. <a href=
290                 "config.html#ENFORCE-BLOCKS">enforce-blocks</a></dt>
291
292                 <dt>7.4.7. <a href="config.html#ACLS">ACLs: permit-access and
293                 deny-access</a></dt>
294
295                 <dt>7.4.8. <a href=
296                 "config.html#BUFFER-LIMIT">buffer-limit</a></dt>
297               </dl>
298             </dd>
299
300             <dt>7.5. <a href="config.html#FORWARDING">Forwarding</a></dt>
301
302             <dd>
303               <dl>
304                 <dt>7.5.1. <a href="config.html#FORWARD">forward</a></dt>
305
306                 <dt>7.5.2. <a href="config.html#SOCKS">forward-socks4,
307                 forward-socks4a and forward-socks5</a></dt>
308
309                 <dt>7.5.3. <a href=
310                 "config.html#ADVANCED-FORWARDING-EXAMPLES">Advanced
311                 Forwarding Examples</a></dt>
312
313                 <dt>7.5.4. <a href=
314                 "config.html#FORWARDED-CONNECT-RETRIES">forwarded-connect-retries</a></dt>
315               </dl>
316             </dd>
317
318             <dt>7.6. <a href="config.html#MISC">Miscellaneous</a></dt>
319
320             <dd>
321               <dl>
322                 <dt>7.6.1. <a href=
323                 "config.html#ACCEPT-INTERCEPTED-REQUESTS">accept-intercepted-requests</a></dt>
324
325                 <dt>7.6.2. <a href=
326                 "config.html#ALLOW-CGI-REQUEST-CRUNCHING">allow-cgi-request-crunching</a></dt>
327
328                 <dt>7.6.3. <a href=
329                 "config.html#SPLIT-LARGE-FORMS">split-large-forms</a></dt>
330
331                 <dt>7.6.4. <a href=
332                 "config.html#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</a></dt>
333
334                 <dt>7.6.5. <a href=
335                 "config.html#DEFAULT-SERVER-TIMEOUT">default-server-timeout</a></dt>
336
337                 <dt>7.6.6. <a href=
338                 "config.html#CONNECTION-SHARING">connection-sharing</a></dt>
339
340                 <dt>7.6.7. <a href=
341                 "config.html#SOCKET-TIMEOUT">socket-timeout</a></dt>
342
343                 <dt>7.6.8. <a href=
344                 "config.html#MAX-CLIENT-CONNECTIONS">max-client-connections</a></dt>
345
346                 <dt>7.6.9. <a href=
347                 "config.html#HANDLE-AS-EMPTY-DOC-RETURNS-OK">handle-as-empty-doc-returns-ok</a></dt>
348
349                 <dt>7.6.10. <a href=
350                 "config.html#ENABLE-COMPRESSION">enable-compression</a></dt>
351
352                 <dt>7.6.11. <a href=
353                 "config.html#COMPRESSION-LEVEL">compression-level</a></dt>
354               </dl>
355             </dd>
356
357             <dt>7.7. <a href="config.html#WINDOWS-GUI">Windows GUI
358             Options</a></dt>
359           </dl>
360         </dd>
361
362         <dt>8. <a href="actions-file.html">Actions Files</a></dt>
363
364         <dd>
365           <dl>
366             <dt>8.1. <a href="actions-file.html#AEN2898">Finding the Right
367             Mix</a></dt>
368
369             <dt>8.2. <a href="actions-file.html#AEN2905">How to Edit</a></dt>
370
371             <dt>8.3. <a href="actions-file.html#ACTIONS-APPLY">How Actions
372             are Applied to Requests</a></dt>
373
374             <dt>8.4. <a href=
375             "actions-file.html#AF-PATTERNS">Patterns</a></dt>
376
377             <dd>
378               <dl>
379                 <dt>8.4.1. <a href="actions-file.html#AEN3017">The Domain
380                 Pattern</a></dt>
381
382                 <dt>8.4.2. <a href="actions-file.html#AEN3093">The Path
383                 Pattern</a></dt>
384
385                 <dt>8.4.3. <a href="actions-file.html#TAG-PATTERN">The Tag
386                 Pattern</a></dt>
387               </dl>
388             </dd>
389
390             <dt>8.5. <a href="actions-file.html#ACTIONS">Actions</a></dt>
391
392             <dd>
393               <dl>
394                 <dt>8.5.1. <a href=
395                 "actions-file.html#ADD-HEADER">add-header</a></dt>
396
397                 <dt>8.5.2. <a href="actions-file.html#BLOCK">block</a></dt>
398
399                 <dt>8.5.3. <a href=
400                 "actions-file.html#CHANGE-X-FORWARDED-FOR">change-x-forwarded-for</a></dt>
401
402                 <dt>8.5.4. <a href=
403                 "actions-file.html#CLIENT-HEADER-FILTER">client-header-filter</a></dt>
404
405                 <dt>8.5.5. <a href=
406                 "actions-file.html#CLIENT-HEADER-TAGGER">client-header-tagger</a></dt>
407
408                 <dt>8.5.6. <a href=
409                 "actions-file.html#CONTENT-TYPE-OVERWRITE">content-type-overwrite</a></dt>
410
411                 <dt>8.5.7. <a href=
412                 "actions-file.html#CRUNCH-CLIENT-HEADER">crunch-client-header</a></dt>
413
414                 <dt>8.5.8. <a href=
415                 "actions-file.html#CRUNCH-IF-NONE-MATCH">crunch-if-none-match</a></dt>
416
417                 <dt>8.5.9. <a href=
418                 "actions-file.html#CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</a></dt>
419
420                 <dt>8.5.10. <a href=
421                 "actions-file.html#CRUNCH-SERVER-HEADER">crunch-server-header</a></dt>
422
423                 <dt>8.5.11. <a href=
424                 "actions-file.html#CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</a></dt>
425
426                 <dt>8.5.12. <a href=
427                 "actions-file.html#DEANIMATE-GIFS">deanimate-gifs</a></dt>
428
429                 <dt>8.5.13. <a href=
430                 "actions-file.html#DOWNGRADE-HTTP-VERSION">downgrade-http-version</a></dt>
431
432                 <dt>8.5.14. <a href=
433                 "actions-file.html#FAST-REDIRECTS">fast-redirects</a></dt>
434
435                 <dt>8.5.15. <a href=
436                 "actions-file.html#FILTER">filter</a></dt>
437
438                 <dt>8.5.16. <a href=
439                 "actions-file.html#FORCE-TEXT-MODE">force-text-mode</a></dt>
440
441                 <dt>8.5.17. <a href=
442                 "actions-file.html#FORWARD-OVERRIDE">forward-override</a></dt>
443
444                 <dt>8.5.18. <a href=
445                 "actions-file.html#HANDLE-AS-EMPTY-DOCUMENT">handle-as-empty-document</a></dt>
446
447                 <dt>8.5.19. <a href=
448                 "actions-file.html#HANDLE-AS-IMAGE">handle-as-image</a></dt>
449
450                 <dt>8.5.20. <a href=
451                 "actions-file.html#HIDE-ACCEPT-LANGUAGE">hide-accept-language</a></dt>
452
453                 <dt>8.5.21. <a href=
454                 "actions-file.html#HIDE-CONTENT-DISPOSITION">hide-content-disposition</a></dt>
455
456                 <dt>8.5.22. <a href=
457                 "actions-file.html#HIDE-IF-MODIFIED-SINCE">hide-if-modified-since</a></dt>
458
459                 <dt>8.5.23. <a href=
460                 "actions-file.html#HIDE-FROM-HEADER">hide-from-header</a></dt>
461
462                 <dt>8.5.24. <a href=
463                 "actions-file.html#HIDE-REFERRER">hide-referrer</a></dt>
464
465                 <dt>8.5.25. <a href=
466                 "actions-file.html#HIDE-USER-AGENT">hide-user-agent</a></dt>
467
468                 <dt>8.5.26. <a href=
469                 "actions-file.html#LIMIT-CONNECT">limit-connect</a></dt>
470
471                 <dt>8.5.27. <a href=
472                 "actions-file.html#PREVENT-COMPRESSION">prevent-compression</a></dt>
473
474                 <dt>8.5.28. <a href=
475                 "actions-file.html#OVERWRITE-LAST-MODIFIED">overwrite-last-modified</a></dt>
476
477                 <dt>8.5.29. <a href=
478                 "actions-file.html#REDIRECT">redirect</a></dt>
479
480                 <dt>8.5.30. <a href=
481                 "actions-file.html#SERVER-HEADER-FILTER">server-header-filter</a></dt>
482
483                 <dt>8.5.31. <a href=
484                 "actions-file.html#SERVER-HEADER-TAGGER">server-header-tagger</a></dt>
485
486                 <dt>8.5.32. <a href=
487                 "actions-file.html#SESSION-COOKIES-ONLY">session-cookies-only</a></dt>
488
489                 <dt>8.5.33. <a href=
490                 "actions-file.html#SET-IMAGE-BLOCKER">set-image-blocker</a></dt>
491
492                 <dt>8.5.34. <a href=
493                 "actions-file.html#AEN4725">Summary</a></dt>
494               </dl>
495             </dd>
496
497             <dt>8.6. <a href="actions-file.html#ALIASES">Aliases</a></dt>
498
499             <dt>8.7. <a href="actions-file.html#ACT-EXAMPLES">Actions Files
500             Tutorial</a></dt>
501
502             <dd>
503               <dl>
504                 <dt>8.7.1. <a href=
505                 "actions-file.html#AEN4789">match-all.action</a></dt>
506
507                 <dt>8.7.2. <a href=
508                 "actions-file.html#AEN4811">default.action</a></dt>
509
510                 <dt>8.7.3. <a href=
511                 "actions-file.html#AEN4924">user.action</a></dt>
512               </dl>
513             </dd>
514           </dl>
515         </dd>
516
517         <dt>9. <a href="filter-file.html">Filter Files</a></dt>
518
519         <dd>
520           <dl>
521             <dt>9.1. <a href="filter-file.html#AEN5079">Filter File
522             Tutorial</a></dt>
523
524             <dt>9.2. <a href="filter-file.html#PREDEFINED-FILTERS">The
525             Pre-defined Filters</a></dt>
526           </dl>
527         </dd>
528
529         <dt>10. <a href="templates.html">Privoxy's Template Files</a></dt>
530
531         <dt>11. <a href="contact.html">Contacting the Developers, Bug
532         Reporting and Feature Requests</a></dt>
533
534         <dd>
535           <dl>
536             <dt>11.1. <a href="contact.html#CONTACT-SUPPORT">Get
537             Support</a></dt>
538
539             <dt>11.2. <a href="contact.html#REPORTING">Reporting
540             Problems</a></dt>
541
542             <dd>
543               <dl>
544                 <dt>11.2.1. <a href="contact.html#CONTACT-ADS">Reporting Ads
545                 or Other Configuration Problems</a></dt>
546
547                 <dt>11.2.2. <a href="contact.html#CONTACT-BUGS">Reporting
548                 Bugs</a></dt>
549               </dl>
550             </dd>
551
552             <dt>11.3. <a href="contact.html#CONTACT-FEATURE">Request New
553             Features</a></dt>
554
555             <dt>11.4. <a href="contact.html#MAILING-LISTS">Mailing
556             Lists</a></dt>
557           </dl>
558         </dd>
559
560         <dt>12. <a href="copyright.html">Privoxy Copyright, License and
561         History</a></dt>
562
563         <dd>
564           <dl>
565             <dt>12.1. <a href="copyright.html#AEN5561">License</a></dt>
566
567             <dt>12.2. <a href="copyright.html#HISTORY">History</a></dt>
568
569             <dt>12.3. <a href="copyright.html#AUTHORS">Authors</a></dt>
570           </dl>
571         </dd>
572
573         <dt>13. <a href="seealso.html">See Also</a></dt>
574
575         <dt>14. <a href="appendix.html">Appendix</a></dt>
576
577         <dd>
578           <dl>
579             <dt>14.1. <a href="appendix.html#REGEX">Regular
580             Expressions</a></dt>
581
582             <dt>14.2. <a href="appendix.html#AEN5814">Privoxy's Internal
583             Pages</a></dt>
584
585             <dd>
586               <dl>
587                 <dt>14.2.1. <a href=
588                 "appendix.html#BOOKMARKLETS">Bookmarklets</a></dt>
589               </dl>
590             </dd>
591
592             <dt>14.3. <a href="appendix.html#CHAIN">Chain of Events</a></dt>
593
594             <dt>14.4. <a href="appendix.html#ACTIONSANAT">Troubleshooting:
595             Anatomy of an Action</a></dt>
596           </dl>
597         </dd>
598       </dl>
599     </div>
600   </div>
601
602   <div class="NAVFOOTER">
603     <hr class="c2" width="100%">
604
605     <table summary="Footer navigation table" width="100%" border="0"
606     cellpadding="0" cellspacing="0">
607       <tr>
608         <td width="33%" align="left" valign="top">&nbsp;</td>
609
610         <td width="34%" align="center" valign="top">&nbsp;</td>
611
612         <td width="33%" align="right" valign="top"><a href=
613         "introduction.html" accesskey="N">Next</a></td>
614       </tr>
615
616       <tr>
617         <td width="33%" align="left" valign="top">&nbsp;</td>
618
619         <td width="34%" align="center" valign="top">&nbsp;</td>
620
621         <td width="33%" align="right" valign="top">Introduction</td>
622       </tr>
623     </table>
624   </div>
625 </body>
626 </html>