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