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