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