Rebuild HTML docs for 3.0.22 UNSTABLE
[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.22 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.22 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.182 2014/05/05 10:08:43
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-FREEBSD">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-DEBIAN">Debian</a></dt>
157
158             <dt>5.2. <a href="startup.html#START-WINDOWS">Windows</a></dt>
159
160             <dt>5.3. <a href="startup.html#START-UNICES">Solaris, NetBSD,
161             FreeBSD, HP-UX and others</a></dt>
162
163             <dt>5.4. <a href="startup.html#START-OS2">OS/2</a></dt>
164
165             <dt>5.5. <a href="startup.html#START-MACOSX">Mac OS X</a></dt>
166
167             <dt>5.6. <a href="startup.html#CMDOPTIONS">Command Line
168             Options</a></dt>
169           </dl>
170         </dd>
171
172         <dt>6. <a href="configuration.html">Privoxy Configuration</a></dt>
173
174         <dd>
175           <dl>
176             <dt>6.1. <a href="configuration.html#AEN1080">Controlling Privoxy
177             with Your Web Browser</a></dt>
178
179             <dt>6.2. <a href="configuration.html#CONFOVERVIEW">Configuration
180             Files Overview</a></dt>
181           </dl>
182         </dd>
183
184         <dt>7. <a href="config.html">The Main Configuration File</a></dt>
185
186         <dd>
187           <dl>
188             <dt>7.1. <a href="config.html#LOCAL-SET-UP">Local Set-up
189             Documentation</a></dt>
190
191             <dd>
192               <dl>
193                 <dt>7.1.1. <a href=
194                 "config.html#USER-MANUAL">user-manual</a></dt>
195
196                 <dt>7.1.2. <a href=
197                 "config.html#TRUST-INFO-URL">trust-info-url</a></dt>
198
199                 <dt>7.1.3. <a href=
200                 "config.html#ADMIN-ADDRESS">admin-address</a></dt>
201
202                 <dt>7.1.4. <a href=
203                 "config.html#PROXY-INFO-URL">proxy-info-url</a></dt>
204               </dl>
205             </dd>
206
207             <dt>7.2. <a href="config.html#CONF-LOG-LOC">Configuration and Log
208             File Locations</a></dt>
209
210             <dd>
211               <dl>
212                 <dt>7.2.1. <a href="config.html#CONFDIR">confdir</a></dt>
213
214                 <dt>7.2.2. <a href="config.html#TEMPLDIR">templdir</a></dt>
215
216                 <dt>7.2.3. <a href="config.html#LOGDIR">logdir</a></dt>
217
218                 <dt>7.2.4. <a href=
219                 "config.html#ACTIONSFILE">actionsfile</a></dt>
220
221                 <dt>7.2.5. <a href=
222                 "config.html#FILTERFILE">filterfile</a></dt>
223
224                 <dt>7.2.6. <a href="config.html#LOGFILE">logfile</a></dt>
225
226                 <dt>7.2.7. <a href="config.html#TRUSTFILE">trustfile</a></dt>
227               </dl>
228             </dd>
229
230             <dt>7.3. <a href="config.html#DEBUGGING">Debugging</a></dt>
231
232             <dd>
233               <dl>
234                 <dt>7.3.1. <a href="config.html#DEBUG">debug</a></dt>
235
236                 <dt>7.3.2. <a href=
237                 "config.html#SINGLE-THREADED">single-threaded</a></dt>
238
239                 <dt>7.3.3. <a href="config.html#HOSTNAME">hostname</a></dt>
240               </dl>
241             </dd>
242
243             <dt>7.4. <a href="config.html#ACCESS-CONTROL">Access Control and
244             Security</a></dt>
245
246             <dd>
247               <dl>
248                 <dt>7.4.1. <a href=
249                 "config.html#LISTEN-ADDRESS">listen-address</a></dt>
250
251                 <dt>7.4.2. <a href="config.html#TOGGLE">toggle</a></dt>
252
253                 <dt>7.4.3. <a href=
254                 "config.html#ENABLE-REMOTE-TOGGLE">enable-remote-toggle</a></dt>
255
256                 <dt>7.4.4. <a href=
257                 "config.html#ENABLE-REMOTE-HTTP-TOGGLE">enable-remote-http-toggle</a></dt>
258
259                 <dt>7.4.5. <a href=
260                 "config.html#ENABLE-EDIT-ACTIONS">enable-edit-actions</a></dt>
261
262                 <dt>7.4.6. <a href=
263                 "config.html#ENFORCE-BLOCKS">enforce-blocks</a></dt>
264
265                 <dt>7.4.7. <a href="config.html#ACLS">ACLs: permit-access and
266                 deny-access</a></dt>
267
268                 <dt>7.4.8. <a href=
269                 "config.html#BUFFER-LIMIT">buffer-limit</a></dt>
270
271                 <dt>7.4.9. <a href=
272                 "config.html#ENABLE-PROXY-AUTHENTICATION-FORWARDING">enable-proxy-authentication-forwarding</a></dt>
273               </dl>
274             </dd>
275
276             <dt>7.5. <a href="config.html#FORWARDING">Forwarding</a></dt>
277
278             <dd>
279               <dl>
280                 <dt>7.5.1. <a href="config.html#FORWARD">forward</a></dt>
281
282                 <dt>7.5.2. <a href="config.html#SOCKS">forward-socks4,
283                 forward-socks4a, forward-socks5 and forward-socks5t</a></dt>
284
285                 <dt>7.5.3. <a href=
286                 "config.html#ADVANCED-FORWARDING-EXAMPLES">Advanced
287                 Forwarding Examples</a></dt>
288
289                 <dt>7.5.4. <a href=
290                 "config.html#FORWARDED-CONNECT-RETRIES">forwarded-connect-retries</a></dt>
291               </dl>
292             </dd>
293
294             <dt>7.6. <a href="config.html#MISC">Miscellaneous</a></dt>
295
296             <dd>
297               <dl>
298                 <dt>7.6.1. <a href=
299                 "config.html#ACCEPT-INTERCEPTED-REQUESTS">accept-intercepted-requests</a></dt>
300
301                 <dt>7.6.2. <a href=
302                 "config.html#ALLOW-CGI-REQUEST-CRUNCHING">allow-cgi-request-crunching</a></dt>
303
304                 <dt>7.6.3. <a href=
305                 "config.html#SPLIT-LARGE-FORMS">split-large-forms</a></dt>
306
307                 <dt>7.6.4. <a href=
308                 "config.html#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</a></dt>
309
310                 <dt>7.6.5. <a href=
311                 "config.html#TOLERATE-PIPELINING">tolerate-pipelining</a></dt>
312
313                 <dt>7.6.6. <a href=
314                 "config.html#DEFAULT-SERVER-TIMEOUT">default-server-timeout</a></dt>
315
316                 <dt>7.6.7. <a href=
317                 "config.html#CONNECTION-SHARING">connection-sharing</a></dt>
318
319                 <dt>7.6.8. <a href=
320                 "config.html#SOCKET-TIMEOUT">socket-timeout</a></dt>
321
322                 <dt>7.6.9. <a href=
323                 "config.html#MAX-CLIENT-CONNECTIONS">max-client-connections</a></dt>
324
325                 <dt>7.6.10. <a href=
326                 "config.html#HANDLE-AS-EMPTY-DOC-RETURNS-OK">handle-as-empty-doc-returns-ok</a></dt>
327
328                 <dt>7.6.11. <a href=
329                 "config.html#ENABLE-COMPRESSION">enable-compression</a></dt>
330
331                 <dt>7.6.12. <a href=
332                 "config.html#COMPRESSION-LEVEL">compression-level</a></dt>
333
334                 <dt>7.6.13. <a href=
335                 "config.html#CLIENT-HEADER-ORDER">client-header-order</a></dt>
336               </dl>
337             </dd>
338
339             <dt>7.7. <a href="config.html#WINDOWS-GUI">Windows GUI
340             Options</a></dt>
341           </dl>
342         </dd>
343
344         <dt>8. <a href="actions-file.html">Actions Files</a></dt>
345
346         <dd>
347           <dl>
348             <dt>8.1. <a href="actions-file.html#AEN2962">Finding the Right
349             Mix</a></dt>
350
351             <dt>8.2. <a href="actions-file.html#AEN2969">How to Edit</a></dt>
352
353             <dt>8.3. <a href="actions-file.html#ACTIONS-APPLY">How Actions
354             are Applied to Requests</a></dt>
355
356             <dt>8.4. <a href=
357             "actions-file.html#AF-PATTERNS">Patterns</a></dt>
358
359             <dd>
360               <dl>
361                 <dt>8.4.1. <a href="actions-file.html#HOST-PATTERN">The Host
362                 Pattern</a></dt>
363
364                 <dt>8.4.2. <a href="actions-file.html#AEN3163">The Path
365                 Pattern</a></dt>
366
367                 <dt>8.4.3. <a href="actions-file.html#TAG-PATTERN">The Tag
368                 Pattern</a></dt>
369
370                 <dt>8.4.4. <a href=
371                 "actions-file.html#NEGATIVE-TAG-PATTERNS">The Negative Tag
372                 Patterns</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#AEN4847">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#AEN4911">match-all.action</a></dt>
495
496                 <dt>8.7.2. <a href=
497                 "actions-file.html#AEN4933">default.action</a></dt>
498
499                 <dt>8.7.3. <a href=
500                 "actions-file.html#AEN5046">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#AEN5208">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#SUFFICIENT-INFORMATION">Please
526             provide sufficient information</a></dt>
527
528             <dt>11.2. <a href="contact.html#CONTACT-SUPPORT">Get
529             Support</a></dt>
530
531             <dt>11.3. <a href="contact.html#REPORTING">Reporting
532             Problems</a></dt>
533
534             <dd>
535               <dl>
536                 <dt>11.3.1. <a href="contact.html#CONTACT-ADS">Reporting Ads
537                 or Other Configuration Problems</a></dt>
538
539                 <dt>11.3.2. <a href="contact.html#CONTACT-BUGS">Reporting
540                 Bugs</a></dt>
541               </dl>
542             </dd>
543
544             <dt>11.4. <a href="contact.html#CONTACT-FEATURE">Request New
545             Features</a></dt>
546
547             <dt>11.5. <a href="contact.html#MAILING-LISTS">Mailing
548             Lists</a></dt>
549           </dl>
550         </dd>
551
552         <dt>12. <a href="copyright.html">Privoxy Copyright, License and
553         History</a></dt>
554
555         <dd>
556           <dl>
557             <dt>12.1. <a href="copyright.html#LICENSE">License</a></dt>
558
559             <dt>12.2. <a href="copyright.html#HISTORY">History</a></dt>
560
561             <dt>12.3. <a href="copyright.html#AUTHORS">Authors</a></dt>
562           </dl>
563         </dd>
564
565         <dt>13. <a href="seealso.html">See Also</a></dt>
566
567         <dt>14. <a href="appendix.html">Appendix</a></dt>
568
569         <dd>
570           <dl>
571             <dt>14.1. <a href="appendix.html#REGEX">Regular
572             Expressions</a></dt>
573
574             <dt>14.2. <a href="appendix.html#AEN5929">Privoxy's Internal
575             Pages</a></dt>
576
577             <dd>
578               <dl>
579                 <dt>14.2.1. <a href=
580                 "appendix.html#BOOKMARKLETS">Bookmarklets</a></dt>
581               </dl>
582             </dd>
583
584             <dt>14.3. <a href="appendix.html#CHAIN">Chain of Events</a></dt>
585
586             <dt>14.4. <a href="appendix.html#ACTIONSANAT">Troubleshooting:
587             Anatomy of an Action</a></dt>
588           </dl>
589         </dd>
590       </dl>
591     </div>
592   </div>
593
594   <div class="NAVFOOTER">
595     <hr align="left" width="100%">
596
597     <table summary="Footer navigation table" width="100%" border="0"
598     cellpadding="0" cellspacing="0">
599       <tr>
600         <td width="33%" align="left" valign="top">&nbsp;</td>
601
602         <td width="34%" align="center" valign="top">&nbsp;</td>
603
604         <td width="33%" align="right" valign="top"><a href=
605         "introduction.html" accesskey="N">Next</a></td>
606       </tr>
607
608       <tr>
609         <td width="33%" align="left" valign="top">&nbsp;</td>
610
611         <td width="34%" align="center" valign="top">&nbsp;</td>
612
613         <td width="33%" align="right" valign="top">Introduction</td>
614       </tr>
615     </table>
616   </div>
617 </body>
618 </html>