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