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