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