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