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