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.99 2002/04/28 16:59:05 swa 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 ><A
125 HREF="index.html#INTRO"
126 ></A
127 ></DT
128 ><DT
129 >1. <A
130 HREF="introduction.html"
131 >Introduction</A
132 ></DT
133 ><DD
134 ><DL
135 ><DT
136 >1.1. <A
137 HREF="introduction.html#FEATURES"
138 >Features</A
139 ></DT
140 ></DL
141 ></DD
142 ><DT
143 >3. <A
144 HREF="installation.html"
145 >Installation</A
146 ></DT
147 ><DD
148 ><DL
149 ><DT
150 >3.1. <A
151 HREF="installation.html#INSTALLATION-PACK-RPM"
152 >Red Hat and SuSE RPMs</A
153 ></DT
154 ><DT
155 >3.2. <A
156 HREF="installation.html#INSTALLATION-DEB"
157 >Debian</A
158 ></DT
159 ><DT
160 >3.3. <A
161 HREF="installation.html#INSTALLATION-PACK-WIN"
162 >Windows</A
163 ></DT
164 ><DT
165 >3.4. <A
166 HREF="installation.html#INSTALLATION-PACK-BINTGZ"
167 >Solaris, NetBSD, FreeBSD, HP-UX</A
168 ></DT
169 ><DT
170 >3.5. <A
171 HREF="installation.html#INSTALLATION-OS2"
172 >OS/2</A
173 ></DT
174 ><DT
175 >3.6. <A
176 HREF="installation.html#INSTALLATION-MAC"
177 >Max OSX</A
178 ></DT
179 ><DT
180 >3.7. <A
181 HREF="installation.html#INSTALLATION-AMIGA"
182 >AmigaOS</A
183 ></DT
184 ></DL
185 ></DD
186 ><DT
187 >4. <A
188 HREF="upgradersnote.html"
189 >Note to Upgraders</A
190 ></DT
191 ><DT
192 >5. <A
193 HREF="quickstart.html"
194 >Quickstart to Using <SPAN
195 CLASS="APPLICATION"
196 >Privoxy</SPAN
197 ></A
198 ></DT
199 ><DT
200 >6. <A
201 HREF="startup.html"
202 >Starting <SPAN
203 CLASS="APPLICATION"
204 >Privoxy</SPAN
205 ></A
206 ></DT
207 ><DD
208 ><DL
209 ><DT
210 >6.1. <A
211 HREF="startup.html#START-REDHATDEBIAN"
212 >RedHat and Debian</A
213 ></DT
214 ><DT
215 >6.2. <A
216 HREF="startup.html#START-SUSE"
217 >SuSE</A
218 ></DT
219 ><DT
220 >6.3. <A
221 HREF="startup.html#START-WINDOWS"
222 >Windows</A
223 ></DT
224 ><DT
225 >6.4. <A
226 HREF="startup.html#START-UNICES"
227 >Solaris, NetBSD, FreeBSD, HP-UX and others</A
228 ></DT
229 ><DT
230 >6.5. <A
231 HREF="startup.html#START-OS2"
232 >OS/2</A
233 ></DT
234 ><DT
235 >6.6. <A
236 HREF="startup.html#START-MACOSX"
237 >MAX OSX</A
238 ></DT
239 ><DT
240 >6.7. <A
241 HREF="startup.html#START-AMIGAOS"
242 >AmigaOS</A
243 ></DT
244 ><DT
245 >6.8. <A
246 HREF="startup.html#CMDOPTIONS"
247 >Command Line Options</A
248 ></DT
249 ></DL
250 ></DD
251 ><DT
252 >7. <A
253 HREF="configuration.html"
254 ><SPAN
255 CLASS="APPLICATION"
256 >Privoxy</SPAN
257 > Configuration</A
258 ></DT
259 ><DD
260 ><DL
261 ><DT
262 >7.1. <A
263 HREF="configuration.html#AEN305"
264 >Controlling <SPAN
265 CLASS="APPLICATION"
266 >Privoxy</SPAN
267 > with Your Web Browser</A
268 ></DT
269 ><DT
270 >7.2. <A
271 HREF="configuration.html#CONFOVERVIEW"
272 >Configuration Files Overview</A
273 ></DT
274 ></DL
275 ></DD
276 ><DT
277 >8. <A
278 HREF="config.html"
279 >The Main Configuration File</A
280 ></DT
281 ><DD
282 ><DL
283 ><DT
284 >8.1. <A
285 HREF="config.html#CONF-LOG-LOC"
286 >Configuration and Log File Locations</A
287 ></DT
288 ><DD
289 ><DL
290 ><DT
291 >8.1.1. <A
292 HREF="config.html#CONFDIR"
293 >confdir</A
294 ></DT
295 ><DT
296 >8.1.2. <A
297 HREF="config.html#LOGDIR"
298 >logdir</A
299 ></DT
300 ><DT
301 >8.1.3. <A
302 HREF="config.html#ACTIONSFILE"
303 >actionsfile</A
304 ></DT
305 ><DT
306 >8.1.4. <A
307 HREF="config.html#FILTERFILE"
308 >filterfile</A
309 ></DT
310 ><DT
311 >8.1.5. <A
312 HREF="config.html#LOGFILE"
313 >logfile</A
314 ></DT
315 ><DT
316 >8.1.6. <A
317 HREF="config.html#JARFILE"
318 >jarfile</A
319 ></DT
320 ><DT
321 >8.1.7. <A
322 HREF="config.html#TRUSTFILE"
323 >trustfile</A
324 ></DT
325 ><DT
326 >8.1.8. <A
327 HREF="config.html#USER-MANUAL"
328 >user-manual</A
329 ></DT
330 ></DL
331 ></DD
332 ><DT
333 >8.2. <A
334 HREF="config.html#LOCAL-SET-UP"
335 >Local Set-up Documentation</A
336 ></DT
337 ><DD
338 ><DL
339 ><DT
340 >8.2.1. <A
341 HREF="config.html#TRUST-INFO-URL"
342 >trust-info-url</A
343 ></DT
344 ><DT
345 >8.2.2. <A
346 HREF="config.html#ADMIN-ADDRESS"
347 >admin-address</A
348 ></DT
349 ><DT
350 >8.2.3. <A
351 HREF="config.html#PROXY-INFO-URL"
352 >proxy-info-url</A
353 ></DT
354 ></DL
355 ></DD
356 ><DT
357 >8.3. <A
358 HREF="config.html#DEBUGGING"
359 >Debugging</A
360 ></DT
361 ><DD
362 ><DL
363 ><DT
364 >8.3.1. <A
365 HREF="config.html#DEBUG"
366 >debug</A
367 ></DT
368 ><DT
369 >8.3.2. <A
370 HREF="config.html#SINGLE-THREADED"
371 >single-threaded</A
372 ></DT
373 ></DL
374 ></DD
375 ><DT
376 >8.4. <A
377 HREF="config.html#ACCESS-CONTROL"
378 >Access Control and Security</A
379 ></DT
380 ><DD
381 ><DL
382 ><DT
383 >8.4.1. <A
384 HREF="config.html#LISTEN-ADDRESS"
385 >listen-address</A
386 ></DT
387 ><DT
388 >8.4.2. <A
389 HREF="config.html#TOGGLE"
390 >toggle</A
391 ></DT
392 ><DT
393 >8.4.3. <A
394 HREF="config.html#ENABLE-REMOTE-TOGGLE"
395 >enable-remote-toggle</A
396 ></DT
397 ><DT
398 >8.4.4. <A
399 HREF="config.html#ENABLE-EDIT-ACTIONS"
400 >enable-edit-actions</A
401 ></DT
402 ><DT
403 >8.4.5. <A
404 HREF="config.html#ACLS"
405 >ACLs: permit-access and deny-access</A
406 ></DT
407 ><DT
408 >8.4.6. <A
409 HREF="config.html#BUFFER-LIMIT"
410 >buffer-limit</A
411 ></DT
412 ></DL
413 ></DD
414 ><DT
415 >8.5. <A
416 HREF="config.html#FORWARDING"
417 >Forwarding</A
418 ></DT
419 ><DD
420 ><DL
421 ><DT
422 >8.5.1. <A
423 HREF="config.html#FORWARD"
424 >forward</A
425 ></DT
426 ><DT
427 >8.5.2. <A
428 HREF="config.html#SOCKS"
429 >forward-socks4 and forward-socks4a</A
430 ></DT
431 ><DT
432 >8.5.3. <A
433 HREF="config.html#ADVANCED-FORWARDING-EXAMPLES"
434 >Advanced Forwarding Examples</A
435 ></DT
436 ></DL
437 ></DD
438 ><DT
439 >8.6. <A
440 HREF="config.html#WINDOWS-GUI"
441 >Windows GUI Options</A
442 ></DT
443 ></DL
444 ></DD
445 ><DT
446 >9. <A
447 HREF="actions-file.html"
448 >Actions Files</A
449 ></DT
450 ><DD
451 ><DL
452 ><DT
453 >9.1. <A
454 HREF="actions-file.html#AEN1299"
455 >Finding the Right Mix</A
456 ></DT
457 ><DT
458 >9.2. <A
459 HREF="actions-file.html#AEN1306"
460 >How to Edit</A
461 ></DT
462 ><DT
463 >9.3. <A
464 HREF="actions-file.html#AEN1312"
465 >How Actions are Applied to URLs</A
466 ></DT
467 ><DT
468 >9.4. <A
469 HREF="actions-file.html#AEN1326"
470 >Patterns</A
471 ></DT
472 ><DD
473 ><DL
474 ><DT
475 >9.4.1. <A
476 HREF="actions-file.html#AEN1366"
477 >The Domain Pattern</A
478 ></DT
479 ><DT
480 >9.4.2. <A
481 HREF="actions-file.html#AEN1428"
482 >The Path Pattern</A
483 ></DT
484 ></DL
485 ></DD
486 ><DT
487 >9.5. <A
488 HREF="actions-file.html#ACTIONS"
489 >Actions</A
490 ></DT
491 ><DD
492 ><DL
493 ><DT
494 >9.5.1. <A
495 HREF="actions-file.html#ADD-HEADER"
496 ><I
497 CLASS="EMPHASIS"
498 >+add-header</I
499 ></A
500 ></DT
501 ><DT
502 >9.5.2. <A
503 HREF="actions-file.html#BLOCK"
504 ><I
505 CLASS="EMPHASIS"
506 >+block</I
507 ></A
508 ></DT
509 ><DT
510 >9.5.3. <A
511 HREF="actions-file.html#DEANIMATE-GIFS"
512 ><I
513 CLASS="EMPHASIS"
514 >+deanimate-gifs</I
515 ></A
516 ></DT
517 ><DT
518 >9.5.4. <A
519 HREF="actions-file.html#DOWNGRADE-HTTP-VERSION"
520 ><I
521 CLASS="EMPHASIS"
522 >+downgrade-http-version</I
523 ></A
524 ></DT
525 ><DT
526 >9.5.5. <A
527 HREF="actions-file.html#FAST-REDIRECTS"
528 ><I
529 CLASS="EMPHASIS"
530 >+fast-redirects</I
531 ></A
532 ></DT
533 ><DT
534 >9.5.6. <A
535 HREF="actions-file.html#FILTER"
536 ><I
537 CLASS="EMPHASIS"
538 >+filter</I
539 ></A
540 ></DT
541 ><DT
542 >9.5.7. <A
543 HREF="actions-file.html#HIDE-FORWARDED-FOR-HEADERS"
544 ><I
545 CLASS="EMPHASIS"
546 >+hide-forwarded-for-headers</I
547 ></A
548 ></DT
549 ><DT
550 >9.5.8. <A
551 HREF="actions-file.html#HIDE-FROM-HEADER"
552 ><I
553 CLASS="EMPHASIS"
554 >+hide-from-header</I
555 ></A
556 ></DT
557 ><DT
558 >9.5.9. <A
559 HREF="actions-file.html#HIDE-REFERER"
560 ><I
561 CLASS="EMPHASIS"
562 >+hide-referer</I
563 ></A
564 ></DT
565 ><DT
566 >9.5.10. <A
567 HREF="actions-file.html#HIDE-USER-AGENT"
568 ><I
569 CLASS="EMPHASIS"
570 >+hide-user-agent</I
571 ></A
572 ></DT
573 ><DT
574 >9.5.11. <A
575 HREF="actions-file.html#HANDLE-AS-IMAGE"
576 ><I
577 CLASS="EMPHASIS"
578 >+handle-as-image</I
579 ></A
580 ></DT
581 ><DT
582 >9.5.12. <A
583 HREF="actions-file.html#SET-IMAGE-BLOCKER"
584 ><I
585 CLASS="EMPHASIS"
586 >+set-image-blocker</I
587 ></A
588 ></DT
589 ><DT
590 >9.5.13. <A
591 HREF="actions-file.html#LIMIT-CONNECT"
592 ><I
593 CLASS="EMPHASIS"
594 >+limit-connect</I
595 ></A
596 ></DT
597 ><DT
598 >9.5.14. <A
599 HREF="actions-file.html#PREVENT-COMPRESSION"
600 ><I
601 CLASS="EMPHASIS"
602 >+prevent-compression</I
603 ></A
604 ></DT
605 ><DT
606 >9.5.15. <A
607 HREF="actions-file.html#SESSION-COOKIES-ONLY"
608 ><I
609 CLASS="EMPHASIS"
610 >+session-cookies-only</I
611 ></A
612 ></DT
613 ><DT
614 >9.5.16. <A
615 HREF="actions-file.html#PREVENT-READING-COOKIES"
616 ><I
617 CLASS="EMPHASIS"
618 >+prevent-reading-cookies</I
619 ></A
620 ></DT
621 ><DT
622 >9.5.17. <A
623 HREF="actions-file.html#PREVENT-SETTING-COOKIES"
624 ><I
625 CLASS="EMPHASIS"
626 >+prevent-setting-cookies</I
627 ></A
628 ></DT
629 ><DT
630 >9.5.18. <A
631 HREF="actions-file.html#KILL-POPUP"
632 ><I
633 CLASS="EMPHASIS"
634 >+kill-popups<A
635 NAME="KILL-POPUPS"
636 ></A
637 ></I
638 ></A
639 ></DT
640 ><DT
641 >9.5.19. <A
642 HREF="actions-file.html#SEND-VANILLA-WAFER"
643 ><I
644 CLASS="EMPHASIS"
645 >+send-vanilla-wafer</I
646 ></A
647 ></DT
648 ><DT
649 >9.5.20. <A
650 HREF="actions-file.html#SEND-WAFER"
651 ><I
652 CLASS="EMPHASIS"
653 >+send-wafer</I
654 ></A
655 ></DT
656 ><DT
657 >9.5.21. <A
658 HREF="actions-file.html#AEN2196"
659 >Summary</A
660 ></DT
661 ><DT
662 >9.5.22. <A
663 HREF="actions-file.html#ACT-EXAMPLES"
664 >Sample Actions Files</A
665 ></DT
666 ></DL
667 ></DD
668 ><DT
669 >9.6. <A
670 HREF="actions-file.html#ALIASES"
671 >Aliases</A
672 ></DT
673 ></DL
674 ></DD
675 ><DT
676 >10. <A
677 HREF="filter-file.html"
678 >The Filter File</A
679 ></DT
680 ><DD
681 ><DL
682 ><DT
683 >10.1. <A
684 HREF="filter-file.html#AEN2339"
685 >The <I
686 CLASS="EMPHASIS"
687 >+filter</I
688 > Action</A
689 ></DT
690 ></DL
691 ></DD
692 ><DT
693 >11. <A
694 HREF="templates.html"
695 >Templates</A
696 ></DT
697 ><DT
698 >12. <A
699 HREF="contact.html"
700 >Contacting the Developers, Bug Reporting and Feature
701 Requests</A
702 ></DT
703 ><DD
704 ><DL
705 ><DT
706 >12.1. <A
707 HREF="contact.html#CONTACT-SUPPORT"
708 >Get Support</A
709 ></DT
710 ><DT
711 >12.2. <A
712 HREF="contact.html#CONTACT-BUGS"
713 >Report bugs</A
714 ></DT
715 ><DT
716 >12.3. <A
717 HREF="contact.html#CONTACT-FEATURE"
718 >Request new features</A
719 ></DT
720 ><DT
721 >12.4. <A
722 HREF="contact.html#CONTACT-ADS"
723 >Report ads or other filter problems</A
724 ></DT
725 ><DT
726 >12.5. <A
727 HREF="contact.html#CONTACT-OTHER"
728 >Other</A
729 ></DT
730 ></DL
731 ></DD
732 ><DT
733 >13. <A
734 HREF="copyright.html"
735 >Copyright and History</A
736 ></DT
737 ><DD
738 ><DL
739 ><DT
740 >13.1. <A
741 HREF="copyright.html#AEN2400"
742 >Copyright</A
743 ></DT
744 ><DT
745 >13.2. <A
746 HREF="copyright.html#HISTORY"
747 >History</A
748 ></DT
749 ></DL
750 ></DD
751 ><DT
752 >14. <A
753 HREF="seealso.html"
754 >See Also</A
755 ></DT
756 ><DT
757 >15. <A
758 HREF="appendix.html"
759 >Appendix</A
760 ></DT
761 ><DD
762 ><DL
763 ><DT
764 >15.1. <A
765 HREF="appendix.html#REGEX"
766 >Regular Expressions</A
767 ></DT
768 ><DT
769 >15.2. <A
770 HREF="appendix.html#AEN2625"
771 ><SPAN
772 CLASS="APPLICATION"
773 >Privoxy</SPAN
774 >'s Internal Pages</A
775 ></DT
776 ><DD
777 ><DL
778 ><DT
779 >15.2.1. <A
780 HREF="appendix.html#BOOKMARKLETS"
781 >Bookmarklets</A
782 ></DT
783 ></DL
784 ></DD
785 ><DT
786 >15.3. <A
787 HREF="appendix.html#CHAIN"
788 >Chain of Events</A
789 ></DT
790 ><DT
791 >15.4. <A
792 HREF="appendix.html#ACTIONSANAT"
793 >Anatomy of an Action</A
794 ></DT
795 ></DL
796 ></DD
797 ></DL
798 ></DIV
799 ><DIV
800 CLASS="SECT1"
801 ><H1
802 CLASS="SECT1"
803 ><A
804 NAME="INTRO"
805 ></A
806 ></H1
807 ><P
808 > </P
809 ></DIV
810 ></DIV
811 ><DIV
812 CLASS="NAVFOOTER"
813 ><HR
814 ALIGN="LEFT"
815 WIDTH="100%"><TABLE
816 WIDTH="100%"
817 BORDER="0"
818 CELLPADDING="0"
819 CELLSPACING="0"
820 ><TR
821 ><TD
822 WIDTH="33%"
823 ALIGN="left"
824 VALIGN="top"
825 >&nbsp;</TD
826 ><TD
827 WIDTH="34%"
828 ALIGN="center"
829 VALIGN="top"
830 >&nbsp;</TD
831 ><TD
832 WIDTH="33%"
833 ALIGN="right"
834 VALIGN="top"
835 ><A
836 HREF="introduction.html"
837 >Next</A
838 ></TD
839 ></TR
840 ><TR
841 ><TD
842 WIDTH="33%"
843 ALIGN="left"
844 VALIGN="top"
845 >&nbsp;</TD
846 ><TD
847 WIDTH="34%"
848 ALIGN="center"
849 VALIGN="top"
850 >&nbsp;</TD
851 ><TD
852 WIDTH="33%"
853 ALIGN="right"
854 VALIGN="top"
855 >Introduction</TD
856 ></TR
857 ></TABLE
858 ></DIV
859 ></BODY
860 ></HTML
861 >