Just regenerating to get fresh version in place of very dated versions.
[privoxy.git] / doc / webserver / user-manual / index.html
1 <HTML
2 ><HEAD
3 ><TITLE
4 >Privoxy 3.1.1 User Manual</TITLE
5 ><META
6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8 "><LINK
9 REL="NEXT"
10 TITLE="Introduction"
11 HREF="introduction.html"><LINK
12 REL="STYLESHEET"
13 TYPE="text/css"
14 HREF="../p_doc.css"></HEAD
15 ><BODY
16 CLASS="ARTICLE"
17 BGCOLOR="#EEEEEE"
18 TEXT="#000000"
19 LINK="#0000FF"
20 VLINK="#840084"
21 ALINK="#0000FF"
22 ><DIV
23 CLASS="ARTICLE"
24 ><DIV
25 CLASS="TITLEPAGE"
26 ><H1
27 CLASS="TITLE"
28 ><A
29 NAME="AEN2">Privoxy 3.1.1 User Manual</H1
30 ><P
31 CLASS="PUBDATE"
32 > <SUB
33 > <A
34 HREF="copyright.html"
35 >Copyright</A
36 > © 2001, 2002 by 
37  <A
38 HREF="http://www.privoxy.org/"
39 TARGET="_top"
40 >Privoxy Developers</A
41 >
42  </SUB
43 ><BR></P
44 ><P
45 CLASS="PUBDATE"
46 >$Id: user-manual.sgml,v 2.2 2002/09/05 05:45:30 hal9 Exp $<BR></P
47 ><DIV
48 ><DIV
49 CLASS="ABSTRACT"
50 ><A
51 NAME="AEN9"><P
52 ></P
53 ><P
54 >  The <I
55 CLASS="CITETITLE"
56 >User Manual</I
57 > gives users information on how to
58   install, configure and use <A
59 HREF="http://www.privoxy.org/"
60 TARGET="_top"
61 ><SPAN
62 CLASS="APPLICATION"
63 >Privoxy</SPAN
64 ></A
65 >.
66  </P
67 ><P
68 > <SPAN
69 CLASS="APPLICATION"
70 >Privoxy</SPAN
71 > is a web proxy with advanced filtering
72  capabilities for protecting privacy, filtering web page content, managing
73  cookies, controlling access, and removing ads, banners, pop-ups and other
74  obnoxious Internet junk. <SPAN
75 CLASS="APPLICATION"
76 >Privoxy</SPAN
77 > has a very
78  flexible configuration and can be customized to suit individual needs and
79  tastes. <SPAN
80 CLASS="APPLICATION"
81 >Privoxy</SPAN
82 > has application for both
83  stand-alone systems and multi-user networks.</P
84 ><P
85 > <SPAN
86 CLASS="APPLICATION"
87 >Privoxy</SPAN
88 > is based on <SPAN
89 CLASS="APPLICATION"
90 >Internet
91  Junkbuster</SPAN
92 > (tm).</P
93 ><P
94 >  You can find the latest version of the <I
95 CLASS="CITETITLE"
96 >User Manual</I
97 > at  <A
98 HREF="http://www.privoxy.org/user-manual/"
99 TARGET="_top"
100 >http://www.privoxy.org/user-manual/</A
101 >.
102   Please see the <A
103 HREF="contact.html"
104 >Contact section</A
105 > on how to
106   contact the developers.
107  </P
108 ><P
109 ></P
110 ></DIV
111 ></DIV
112 ><HR></DIV
113 ><DIV
114 CLASS="TOC"
115 ><DL
116 ><DT
117 ><B
118 >Table of Contents</B
119 ></DT
120 ><DT
121 >1. <A
122 HREF="introduction.html"
123 >Introduction</A
124 ></DT
125 ><DD
126 ><DL
127 ><DT
128 >1.1. <A
129 HREF="introduction.html#FEATURES"
130 >Features</A
131 ></DT
132 ></DL
133 ></DD
134 ><DT
135 >2. <A
136 HREF="installation.html"
137 >Installation</A
138 ></DT
139 ><DD
140 ><DL
141 ><DT
142 >2.1. <A
143 HREF="installation.html#INSTALLATION-PACKAGES"
144 >Binary Packages</A
145 ></DT
146 ><DD
147 ><DL
148 ><DT
149 >2.1.1. <A
150 HREF="installation.html#INSTALLATION-PACK-RPM"
151 >Red Hat, SuSE and Conectiva RPMs</A
152 ></DT
153 ><DT
154 >2.1.2. <A
155 HREF="installation.html#INSTALLATION-DEB"
156 >Debian</A
157 ></DT
158 ><DT
159 >2.1.3. <A
160 HREF="installation.html#INSTALLATION-PACK-WIN"
161 >Windows</A
162 ></DT
163 ><DT
164 >2.1.4. <A
165 HREF="installation.html#INSTALLATION-PACK-BINTGZ"
166 >Solaris, NetBSD, FreeBSD, HP-UX</A
167 ></DT
168 ><DT
169 >2.1.5. <A
170 HREF="installation.html#INSTALLATION-OS2"
171 >OS/2</A
172 ></DT
173 ><DT
174 >2.1.6. <A
175 HREF="installation.html#INSTALLATION-MAC"
176 >Mac OSX</A
177 ></DT
178 ><DT
179 >2.1.7. <A
180 HREF="installation.html#INSTALLATION-AMIGA"
181 >AmigaOS</A
182 ></DT
183 ><DT
184 >2.1.8. <A
185 HREF="installation.html#INSTALLATTION-GENTOO"
186 >Gentoo</A
187 ></DT
188 ></DL
189 ></DD
190 ><DT
191 >2.2. <A
192 HREF="installation.html#INSTALLATION-SOURCE"
193 >Building from Source</A
194 ></DT
195 ><DT
196 >2.3. <A
197 HREF="installation.html#INSTALLATION-KEEPUPDATED"
198 >Keeping your Installation Up-to-Date</A
199 ></DT
200 ></DL
201 ></DD
202 ><DT
203 >3. <A
204 HREF="upgradersnote.html"
205 >Note to Upgraders</A
206 ></DT
207 ><DT
208 >4. <A
209 HREF="quickstart.html"
210 >Quickstart to Using <SPAN
211 CLASS="APPLICATION"
212 >Privoxy</SPAN
213 ></A
214 ></DT
215 ><DD
216 ><DL
217 ><DT
218 >4.1. <A
219 HREF="quickstart.html#QUICKSTART-AD-BLOCKING"
220 >Quickstart to Ad Blocking</A
221 ></DT
222 ></DL
223 ></DD
224 ><DT
225 >5. <A
226 HREF="startup.html"
227 >Starting <SPAN
228 CLASS="APPLICATION"
229 >Privoxy</SPAN
230 ></A
231 ></DT
232 ><DD
233 ><DL
234 ><DT
235 >5.1. <A
236 HREF="startup.html#START-REDHAT"
237 >Red Hat and Conectiva</A
238 ></DT
239 ><DT
240 >5.2. <A
241 HREF="startup.html#START-DEBIAN"
242 >Debian</A
243 ></DT
244 ><DT
245 >5.3. <A
246 HREF="startup.html#START-SUSE"
247 >SuSE</A
248 ></DT
249 ><DT
250 >5.4. <A
251 HREF="startup.html#START-WINDOWS"
252 >Windows</A
253 ></DT
254 ><DT
255 >5.5. <A
256 HREF="startup.html#START-UNICES"
257 >Solaris, NetBSD, FreeBSD, HP-UX and others</A
258 ></DT
259 ><DT
260 >5.6. <A
261 HREF="startup.html#START-OS2"
262 >OS/2</A
263 ></DT
264 ><DT
265 >5.7. <A
266 HREF="startup.html#START-MACOSX"
267 >Mac OSX</A
268 ></DT
269 ><DT
270 >5.8. <A
271 HREF="startup.html#START-AMIGAOS"
272 >AmigaOS</A
273 ></DT
274 ><DT
275 >5.9. <A
276 HREF="startup.html#START-GENTOO"
277 >Gentoo</A
278 ></DT
279 ><DT
280 >5.10. <A
281 HREF="startup.html#CMDOPTIONS"
282 >Command Line Options</A
283 ></DT
284 ></DL
285 ></DD
286 ><DT
287 >6. <A
288 HREF="configuration.html"
289 ><SPAN
290 CLASS="APPLICATION"
291 >Privoxy</SPAN
292 > Configuration</A
293 ></DT
294 ><DD
295 ><DL
296 ><DT
297 >6.1. <A
298 HREF="configuration.html#AEN582"
299 >Controlling <SPAN
300 CLASS="APPLICATION"
301 >Privoxy</SPAN
302 > with Your Web Browser</A
303 ></DT
304 ><DT
305 >6.2. <A
306 HREF="configuration.html#CONFOVERVIEW"
307 >Configuration Files Overview</A
308 ></DT
309 ></DL
310 ></DD
311 ><DT
312 >7. <A
313 HREF="config.html"
314 >The Main Configuration File</A
315 ></DT
316 ><DD
317 ><DL
318 ><DT
319 >7.1. <A
320 HREF="config.html#CONF-LOG-LOC"
321 >Configuration and Log File Locations</A
322 ></DT
323 ><DD
324 ><DL
325 ><DT
326 >7.1.1. <A
327 HREF="config.html#CONFDIR"
328 >confdir</A
329 ></DT
330 ><DT
331 >7.1.2. <A
332 HREF="config.html#LOGDIR"
333 >logdir</A
334 ></DT
335 ><DT
336 >7.1.3. <A
337 HREF="config.html#ACTIONSFILE"
338 >actionsfile</A
339 ></DT
340 ><DT
341 >7.1.4. <A
342 HREF="config.html#FILTERFILE"
343 >filterfile</A
344 ></DT
345 ><DT
346 >7.1.5. <A
347 HREF="config.html#LOGFILE"
348 >logfile</A
349 ></DT
350 ><DT
351 >7.1.6. <A
352 HREF="config.html#JARFILE"
353 >jarfile</A
354 ></DT
355 ><DT
356 >7.1.7. <A
357 HREF="config.html#TRUSTFILE"
358 >trustfile</A
359 ></DT
360 ></DL
361 ></DD
362 ><DT
363 >7.2. <A
364 HREF="config.html#LOCAL-SET-UP"
365 >Local Set-up Documentation</A
366 ></DT
367 ><DD
368 ><DL
369 ><DT
370 >7.2.1. <A
371 HREF="config.html#USER-MANUAL"
372 >user-manual</A
373 ></DT
374 ><DT
375 >7.2.2. <A
376 HREF="config.html#TRUST-INFO-URL"
377 >trust-info-url</A
378 ></DT
379 ><DT
380 >7.2.3. <A
381 HREF="config.html#ADMIN-ADDRESS"
382 >admin-address</A
383 ></DT
384 ><DT
385 >7.2.4. <A
386 HREF="config.html#PROXY-INFO-URL"
387 >proxy-info-url</A
388 ></DT
389 ></DL
390 ></DD
391 ><DT
392 >7.3. <A
393 HREF="config.html#DEBUGGING"
394 >Debugging</A
395 ></DT
396 ><DD
397 ><DL
398 ><DT
399 >7.3.1. <A
400 HREF="config.html#DEBUG"
401 >debug</A
402 ></DT
403 ><DT
404 >7.3.2. <A
405 HREF="config.html#SINGLE-THREADED"
406 >single-threaded</A
407 ></DT
408 ></DL
409 ></DD
410 ><DT
411 >7.4. <A
412 HREF="config.html#ACCESS-CONTROL"
413 >Access Control and Security</A
414 ></DT
415 ><DD
416 ><DL
417 ><DT
418 >7.4.1. <A
419 HREF="config.html#LISTEN-ADDRESS"
420 >listen-address</A
421 ></DT
422 ><DT
423 >7.4.2. <A
424 HREF="config.html#TOGGLE"
425 >toggle</A
426 ></DT
427 ><DT
428 >7.4.3. <A
429 HREF="config.html#ENABLE-REMOTE-TOGGLE"
430 >enable-remote-toggle</A
431 ></DT
432 ><DT
433 >7.4.4. <A
434 HREF="config.html#ENABLE-EDIT-ACTIONS"
435 >enable-edit-actions</A
436 ></DT
437 ><DT
438 >7.4.5. <A
439 HREF="config.html#ACLS"
440 >ACLs: permit-access and deny-access</A
441 ></DT
442 ><DT
443 >7.4.6. <A
444 HREF="config.html#BUFFER-LIMIT"
445 >buffer-limit</A
446 ></DT
447 ></DL
448 ></DD
449 ><DT
450 >7.5. <A
451 HREF="config.html#FORWARDING"
452 >Forwarding</A
453 ></DT
454 ><DD
455 ><DL
456 ><DT
457 >7.5.1. <A
458 HREF="config.html#FORWARD"
459 >forward</A
460 ></DT
461 ><DT
462 >7.5.2. <A
463 HREF="config.html#SOCKS"
464 >forward-socks4 and forward-socks4a</A
465 ></DT
466 ><DT
467 >7.5.3. <A
468 HREF="config.html#ADVANCED-FORWARDING-EXAMPLES"
469 >Advanced Forwarding Examples</A
470 ></DT
471 ></DL
472 ></DD
473 ><DT
474 >7.6. <A
475 HREF="config.html#WINDOWS-GUI"
476 >Windows GUI Options</A
477 ></DT
478 ></DL
479 ></DD
480 ><DT
481 >8. <A
482 HREF="actions-file.html"
483 >Actions Files</A
484 ></DT
485 ><DD
486 ><DL
487 ><DT
488 >8.1. <A
489 HREF="actions-file.html#AEN1645"
490 >Finding the Right Mix</A
491 ></DT
492 ><DT
493 >8.2. <A
494 HREF="actions-file.html#AEN1652"
495 >How to Edit</A
496 ></DT
497 ><DT
498 >8.3. <A
499 HREF="actions-file.html#ACTIONS-APPLY"
500 >How Actions are Applied to URLs</A
501 ></DT
502 ><DT
503 >8.4. <A
504 HREF="actions-file.html#AF-PATTERNS"
505 >Patterns</A
506 ></DT
507 ><DD
508 ><DL
509 ><DT
510 >8.4.1. <A
511 HREF="actions-file.html#AEN1716"
512 >The Domain Pattern</A
513 ></DT
514 ><DT
515 >8.4.2. <A
516 HREF="actions-file.html#AEN1778"
517 >The Path Pattern</A
518 ></DT
519 ></DL
520 ></DD
521 ><DT
522 >8.5. <A
523 HREF="actions-file.html#ACTIONS"
524 >Actions</A
525 ></DT
526 ><DD
527 ><DL
528 ><DT
529 >8.5.1. <A
530 HREF="actions-file.html#ADD-HEADER"
531 >add-header</A
532 ></DT
533 ><DT
534 >8.5.2. <A
535 HREF="actions-file.html#BLOCK"
536 >block</A
537 ></DT
538 ><DT
539 >8.5.3. <A
540 HREF="actions-file.html#CRUNCH-INCOMING-COOKIES"
541 >crunch-incoming-cookies</A
542 ></DT
543 ><DT
544 >8.5.4. <A
545 HREF="actions-file.html#CRUNCH-OUTGOING-COOKIES"
546 >crunch-outgoing-cookies</A
547 ></DT
548 ><DT
549 >8.5.5. <A
550 HREF="actions-file.html#DEANIMATE-GIFS"
551 >deanimate-gifs</A
552 ></DT
553 ><DT
554 >8.5.6. <A
555 HREF="actions-file.html#DOWNGRADE-HTTP-VERSION"
556 >downgrade-http-version</A
557 ></DT
558 ><DT
559 >8.5.7. <A
560 HREF="actions-file.html#FAST-REDIRECTS"
561 >fast-redirects</A
562 ></DT
563 ><DT
564 >8.5.8. <A
565 HREF="actions-file.html#FILTER"
566 >filter</A
567 ></DT
568 ><DT
569 >8.5.9. <A
570 HREF="actions-file.html#HANDLE-AS-IMAGE"
571 >handle-as-image</A
572 ></DT
573 ><DT
574 >8.5.10. <A
575 HREF="actions-file.html#HIDE-FORWARDED-FOR-HEADERS"
576 >hide-forwarded-for-headers</A
577 ></DT
578 ><DT
579 >8.5.11. <A
580 HREF="actions-file.html#HIDE-FROM-HEADER"
581 >hide-from-header</A
582 ></DT
583 ><DT
584 >8.5.12. <A
585 HREF="actions-file.html#HIDE-REFERRER"
586 >hide-referrer</A
587 ></DT
588 ><DT
589 >8.5.13. <A
590 HREF="actions-file.html#HIDE-USER-AGENT"
591 >hide-user-agent</A
592 ></DT
593 ><DT
594 >8.5.14. <A
595 HREF="actions-file.html#KILL-POPUPS"
596 >kill-popups<A
597 NAME="KILL-POPUP"
598 ></A
599 ></A
600 ></DT
601 ><DT
602 >8.5.15. <A
603 HREF="actions-file.html#LIMIT-CONNECT"
604 >limit-connect</A
605 ></DT
606 ><DT
607 >8.5.16. <A
608 HREF="actions-file.html#PREVENT-COMPRESSION"
609 >prevent-compression</A
610 ></DT
611 ><DT
612 >8.5.17. <A
613 HREF="actions-file.html#SEND-VANILLA-WAFER"
614 >send-vanilla-wafer</A
615 ></DT
616 ><DT
617 >8.5.18. <A
618 HREF="actions-file.html#SEND-WAFER"
619 >send-wafer</A
620 ></DT
621 ><DT
622 >8.5.19. <A
623 HREF="actions-file.html#SESSION-COOKIES-ONLY"
624 >session-cookies-only</A
625 ></DT
626 ><DT
627 >8.5.20. <A
628 HREF="actions-file.html#SET-IMAGE-BLOCKER"
629 >set-image-blocker</A
630 ></DT
631 ><DT
632 >8.5.21. <A
633 HREF="actions-file.html#AEN2706"
634 >Summary</A
635 ></DT
636 ></DL
637 ></DD
638 ><DT
639 >8.6. <A
640 HREF="actions-file.html#ALIASES"
641 >Aliases</A
642 ></DT
643 ><DT
644 >8.7. <A
645 HREF="actions-file.html#ACT-EXAMPLES"
646 >Actions Files Tutorial</A
647 ></DT
648 ><DD
649 ><DL
650 ><DT
651 >8.7.1. <A
652 HREF="actions-file.html#AEN2758"
653 >default.action</A
654 ></DT
655 ><DT
656 >8.7.2. <A
657 HREF="actions-file.html#AEN2915"
658 >user.action</A
659 ></DT
660 ></DL
661 ></DD
662 ></DL
663 ></DD
664 ><DT
665 >9. <A
666 HREF="filter-file.html"
667 >The Filter File</A
668 ></DT
669 ><DD
670 ><DL
671 ><DT
672 >9.1. <A
673 HREF="filter-file.html#AEN3018"
674 >Filter File Tutorial</A
675 ></DT
676 ></DL
677 ></DD
678 ><DT
679 >10. <A
680 HREF="templates.html"
681 >Templates</A
682 ></DT
683 ><DT
684 >11. <A
685 HREF="contact.html"
686 >Contacting the Developers, Bug Reporting and Feature
687 Requests</A
688 ></DT
689 ><DD
690 ><DL
691 ><DT
692 >11.1. <A
693 HREF="contact.html#CONTACT-SUPPORT"
694 >Get Support</A
695 ></DT
696 ><DT
697 >11.2. <A
698 HREF="contact.html#CONTACT-BUGS"
699 >Report Bugs</A
700 ></DT
701 ><DT
702 >11.3. <A
703 HREF="contact.html#CONTACT-FEATURE"
704 >Request New Features</A
705 ></DT
706 ><DT
707 >11.4. <A
708 HREF="contact.html#CONTACT-ADS"
709 >Report Ads or Other Actions-Related Problems</A
710 ></DT
711 ><DT
712 >11.5. <A
713 HREF="contact.html#CONTACT-OTHER"
714 >Other</A
715 ></DT
716 ></DL
717 ></DD
718 ><DT
719 >12. <A
720 HREF="copyright.html"
721 ><SPAN
722 CLASS="APPLICATION"
723 >Privoxy</SPAN
724 > Copyright, License and History</A
725 ></DT
726 ><DD
727 ><DL
728 ><DT
729 >12.1. <A
730 HREF="copyright.html#AEN3220"
731 >License</A
732 ></DT
733 ><DT
734 >12.2. <A
735 HREF="copyright.html#HISTORY"
736 >History</A
737 ></DT
738 ><DT
739 >12.3. <A
740 HREF="copyright.html#AUTHORS"
741 >Authors</A
742 ></DT
743 ></DL
744 ></DD
745 ><DT
746 >13. <A
747 HREF="seealso.html"
748 >See Also</A
749 ></DT
750 ><DT
751 >14. <A
752 HREF="appendix.html"
753 >Appendix</A
754 ></DT
755 ><DD
756 ><DL
757 ><DT
758 >14.1. <A
759 HREF="appendix.html#REGEX"
760 >Regular Expressions</A
761 ></DT
762 ><DT
763 >14.2. <A
764 HREF="appendix.html#AEN3474"
765 ><SPAN
766 CLASS="APPLICATION"
767 >Privoxy</SPAN
768 >'s Internal Pages</A
769 ></DT
770 ><DD
771 ><DL
772 ><DT
773 >14.2.1. <A
774 HREF="appendix.html#BOOKMARKLETS"
775 >Bookmarklets</A
776 ></DT
777 ></DL
778 ></DD
779 ><DT
780 >14.3. <A
781 HREF="appendix.html#CHAIN"
782 >Chain of Events</A
783 ></DT
784 ><DT
785 >14.4. <A
786 HREF="appendix.html#ACTIONSANAT"
787 >Anatomy of an Action</A
788 ></DT
789 ></DL
790 ></DD
791 ></DL
792 ></DIV
793 ></DIV
794 ><DIV
795 CLASS="NAVFOOTER"
796 ><HR
797 ALIGN="LEFT"
798 WIDTH="100%"><TABLE
799 SUMMARY="Footer navigation table"
800 WIDTH="100%"
801 BORDER="0"
802 CELLPADDING="0"
803 CELLSPACING="0"
804 ><TR
805 ><TD
806 WIDTH="33%"
807 ALIGN="left"
808 VALIGN="top"
809 >&nbsp;</TD
810 ><TD
811 WIDTH="34%"
812 ALIGN="center"
813 VALIGN="top"
814 >&nbsp;</TD
815 ><TD
816 WIDTH="33%"
817 ALIGN="right"
818 VALIGN="top"
819 ><A
820 HREF="introduction.html"
821 ACCESSKEY="N"
822 >Next</A
823 ></TD
824 ></TR
825 ><TR
826 ><TD
827 WIDTH="33%"
828 ALIGN="left"
829 VALIGN="top"
830 >&nbsp;</TD
831 ><TD
832 WIDTH="34%"
833 ALIGN="center"
834 VALIGN="top"
835 >&nbsp;</TD
836 ><TD
837 WIDTH="33%"
838 ALIGN="right"
839 VALIGN="top"
840 >Introduction</TD
841 ></TR
842 ></TABLE
843 ></DIV
844 ></BODY
845 ></HTML
846 >