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