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