This is mostly proposed copyright/licensing additions and changes. Docs
[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.105 2002/05/05 20:26:02 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 and SuSE 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 ><DT
205 >5. <A
206 HREF="startup.html"
207 >Starting <SPAN
208 CLASS="APPLICATION"
209 >Privoxy</SPAN
210 ></A
211 ></DT
212 ><DD
213 ><DL
214 ><DT
215 >5.1. <A
216 HREF="startup.html#START-REDHATDEBIAN"
217 >RedHat and Debian</A
218 ></DT
219 ><DT
220 >5.2. <A
221 HREF="startup.html#START-SUSE"
222 >SuSE</A
223 ></DT
224 ><DT
225 >5.3. <A
226 HREF="startup.html#START-WINDOWS"
227 >Windows</A
228 ></DT
229 ><DT
230 >5.4. <A
231 HREF="startup.html#START-UNICES"
232 >Solaris, NetBSD, FreeBSD, HP-UX and others</A
233 ></DT
234 ><DT
235 >5.5. <A
236 HREF="startup.html#START-OS2"
237 >OS/2</A
238 ></DT
239 ><DT
240 >5.6. <A
241 HREF="startup.html#START-MACOSX"
242 >MAX OSX</A
243 ></DT
244 ><DT
245 >5.7. <A
246 HREF="startup.html#START-AMIGAOS"
247 >AmigaOS</A
248 ></DT
249 ><DT
250 >5.8. <A
251 HREF="startup.html#CMDOPTIONS"
252 >Command Line Options</A
253 ></DT
254 ></DL
255 ></DD
256 ><DT
257 >6. <A
258 HREF="configuration.html"
259 ><SPAN
260 CLASS="APPLICATION"
261 >Privoxy</SPAN
262 > Configuration</A
263 ></DT
264 ><DD
265 ><DL
266 ><DT
267 >6.1. <A
268 HREF="configuration.html#AEN346"
269 >Controlling <SPAN
270 CLASS="APPLICATION"
271 >Privoxy</SPAN
272 > with Your Web Browser</A
273 ></DT
274 ><DT
275 >6.2. <A
276 HREF="configuration.html#CONFOVERVIEW"
277 >Configuration Files Overview</A
278 ></DT
279 ></DL
280 ></DD
281 ><DT
282 >7. <A
283 HREF="config.html"
284 >The Main Configuration File</A
285 ></DT
286 ><DD
287 ><DL
288 ><DT
289 >7.1. <A
290 HREF="config.html#CONF-LOG-LOC"
291 >Configuration and Log File Locations</A
292 ></DT
293 ><DD
294 ><DL
295 ><DT
296 >7.1.1. <A
297 HREF="config.html#CONFDIR"
298 >confdir</A
299 ></DT
300 ><DT
301 >7.1.2. <A
302 HREF="config.html#LOGDIR"
303 >logdir</A
304 ></DT
305 ><DT
306 >7.1.3. <A
307 HREF="config.html#ACTIONSFILE"
308 >actionsfile</A
309 ></DT
310 ><DT
311 >7.1.4. <A
312 HREF="config.html#FILTERFILE"
313 >filterfile</A
314 ></DT
315 ><DT
316 >7.1.5. <A
317 HREF="config.html#LOGFILE"
318 >logfile</A
319 ></DT
320 ><DT
321 >7.1.6. <A
322 HREF="config.html#JARFILE"
323 >jarfile</A
324 ></DT
325 ><DT
326 >7.1.7. <A
327 HREF="config.html#TRUSTFILE"
328 >trustfile</A
329 ></DT
330 ></DL
331 ></DD
332 ><DT
333 >7.2. <A
334 HREF="config.html#LOCAL-SET-UP"
335 >Local Set-up Documentation</A
336 ></DT
337 ><DD
338 ><DL
339 ><DT
340 >7.2.1. <A
341 HREF="config.html#USER-MANUAL"
342 >user-manual</A
343 ></DT
344 ><DT
345 >7.2.2. <A
346 HREF="config.html#TRUST-INFO-URL"
347 >trust-info-url</A
348 ></DT
349 ><DT
350 >7.2.3. <A
351 HREF="config.html#ADMIN-ADDRESS"
352 >admin-address</A
353 ></DT
354 ><DT
355 >7.2.4. <A
356 HREF="config.html#PROXY-INFO-URL"
357 >proxy-info-url</A
358 ></DT
359 ></DL
360 ></DD
361 ><DT
362 >7.3. <A
363 HREF="config.html#DEBUGGING"
364 >Debugging</A
365 ></DT
366 ><DD
367 ><DL
368 ><DT
369 >7.3.1. <A
370 HREF="config.html#DEBUG"
371 >debug</A
372 ></DT
373 ><DT
374 >7.3.2. <A
375 HREF="config.html#SINGLE-THREADED"
376 >single-threaded</A
377 ></DT
378 ></DL
379 ></DD
380 ><DT
381 >7.4. <A
382 HREF="config.html#ACCESS-CONTROL"
383 >Access Control and Security</A
384 ></DT
385 ><DD
386 ><DL
387 ><DT
388 >7.4.1. <A
389 HREF="config.html#LISTEN-ADDRESS"
390 >listen-address</A
391 ></DT
392 ><DT
393 >7.4.2. <A
394 HREF="config.html#TOGGLE"
395 >toggle</A
396 ></DT
397 ><DT
398 >7.4.3. <A
399 HREF="config.html#ENABLE-REMOTE-TOGGLE"
400 >enable-remote-toggle</A
401 ></DT
402 ><DT
403 >7.4.4. <A
404 HREF="config.html#ENABLE-EDIT-ACTIONS"
405 >enable-edit-actions</A
406 ></DT
407 ><DT
408 >7.4.5. <A
409 HREF="config.html#ACLS"
410 >ACLs: permit-access and deny-access</A
411 ></DT
412 ><DT
413 >7.4.6. <A
414 HREF="config.html#BUFFER-LIMIT"
415 >buffer-limit</A
416 ></DT
417 ></DL
418 ></DD
419 ><DT
420 >7.5. <A
421 HREF="config.html#FORWARDING"
422 >Forwarding</A
423 ></DT
424 ><DD
425 ><DL
426 ><DT
427 >7.5.1. <A
428 HREF="config.html#FORWARD"
429 >forward</A
430 ></DT
431 ><DT
432 >7.5.2. <A
433 HREF="config.html#SOCKS"
434 >forward-socks4 and forward-socks4a</A
435 ></DT
436 ><DT
437 >7.5.3. <A
438 HREF="config.html#ADVANCED-FORWARDING-EXAMPLES"
439 >Advanced Forwarding Examples</A
440 ></DT
441 ></DL
442 ></DD
443 ><DT
444 >7.6. <A
445 HREF="config.html#WINDOWS-GUI"
446 >Windows GUI Options</A
447 ></DT
448 ></DL
449 ></DD
450 ><DT
451 >8. <A
452 HREF="actions-file.html"
453 >Actions Files</A
454 ></DT
455 ><DD
456 ><DL
457 ><DT
458 >8.1. <A
459 HREF="actions-file.html#AEN1378"
460 >Finding the Right Mix</A
461 ></DT
462 ><DT
463 >8.2. <A
464 HREF="actions-file.html#AEN1385"
465 >How to Edit</A
466 ></DT
467 ><DT
468 >8.3. <A
469 HREF="actions-file.html#AEN1394"
470 >How Actions are Applied to URLs</A
471 ></DT
472 ><DT
473 >8.4. <A
474 HREF="actions-file.html#AEN1408"
475 >Patterns</A
476 ></DT
477 ><DD
478 ><DL
479 ><DT
480 >8.4.1. <A
481 HREF="actions-file.html#AEN1448"
482 >The Domain Pattern</A
483 ></DT
484 ><DT
485 >8.4.2. <A
486 HREF="actions-file.html#AEN1510"
487 >The Path Pattern</A
488 ></DT
489 ></DL
490 ></DD
491 ><DT
492 >8.5. <A
493 HREF="actions-file.html#ACTIONS"
494 >Actions</A
495 ></DT
496 ><DD
497 ><DL
498 ><DT
499 >8.5.1. <A
500 HREF="actions-file.html#ADD-HEADER"
501 ><I
502 CLASS="EMPHASIS"
503 >+add-header</I
504 ></A
505 ></DT
506 ><DT
507 >8.5.2. <A
508 HREF="actions-file.html#BLOCK"
509 ><I
510 CLASS="EMPHASIS"
511 >+block</I
512 ></A
513 ></DT
514 ><DT
515 >8.5.3. <A
516 HREF="actions-file.html#DEANIMATE-GIFS"
517 ><I
518 CLASS="EMPHASIS"
519 >+deanimate-gifs</I
520 ></A
521 ></DT
522 ><DT
523 >8.5.4. <A
524 HREF="actions-file.html#DOWNGRADE-HTTP-VERSION"
525 ><I
526 CLASS="EMPHASIS"
527 >+downgrade-http-version</I
528 ></A
529 ></DT
530 ><DT
531 >8.5.5. <A
532 HREF="actions-file.html#FAST-REDIRECTS"
533 ><I
534 CLASS="EMPHASIS"
535 >+fast-redirects</I
536 ></A
537 ></DT
538 ><DT
539 >8.5.6. <A
540 HREF="actions-file.html#FILTER"
541 ><I
542 CLASS="EMPHASIS"
543 >+filter</I
544 ></A
545 ></DT
546 ><DT
547 >8.5.7. <A
548 HREF="actions-file.html#HIDE-FORWARDED-FOR-HEADERS"
549 ><I
550 CLASS="EMPHASIS"
551 >+hide-forwarded-for-headers</I
552 ></A
553 ></DT
554 ><DT
555 >8.5.8. <A
556 HREF="actions-file.html#HIDE-FROM-HEADER"
557 ><I
558 CLASS="EMPHASIS"
559 >+hide-from-header</I
560 ></A
561 ></DT
562 ><DT
563 >8.5.9. <A
564 HREF="actions-file.html#HIDE-REFERER"
565 ><I
566 CLASS="EMPHASIS"
567 >+hide-referer</I
568 ></A
569 ></DT
570 ><DT
571 >8.5.10. <A
572 HREF="actions-file.html#HIDE-USER-AGENT"
573 ><I
574 CLASS="EMPHASIS"
575 >+hide-user-agent</I
576 ></A
577 ></DT
578 ><DT
579 >8.5.11. <A
580 HREF="actions-file.html#HANDLE-AS-IMAGE"
581 ><I
582 CLASS="EMPHASIS"
583 >+handle-as-image</I
584 ></A
585 ></DT
586 ><DT
587 >8.5.12. <A
588 HREF="actions-file.html#SET-IMAGE-BLOCKER"
589 ><I
590 CLASS="EMPHASIS"
591 >+set-image-blocker</I
592 ></A
593 ></DT
594 ><DT
595 >8.5.13. <A
596 HREF="actions-file.html#LIMIT-CONNECT"
597 ><I
598 CLASS="EMPHASIS"
599 >+limit-connect</I
600 ></A
601 ></DT
602 ><DT
603 >8.5.14. <A
604 HREF="actions-file.html#PREVENT-COMPRESSION"
605 ><I
606 CLASS="EMPHASIS"
607 >+prevent-compression</I
608 ></A
609 ></DT
610 ><DT
611 >8.5.15. <A
612 HREF="actions-file.html#SESSION-COOKIES-ONLY"
613 ><I
614 CLASS="EMPHASIS"
615 >+session-cookies-only</I
616 ></A
617 ></DT
618 ><DT
619 >8.5.16. <A
620 HREF="actions-file.html#PREVENT-READING-COOKIES"
621 ><I
622 CLASS="EMPHASIS"
623 >+prevent-reading-cookies</I
624 ></A
625 ></DT
626 ><DT
627 >8.5.17. <A
628 HREF="actions-file.html#PREVENT-SETTING-COOKIES"
629 ><I
630 CLASS="EMPHASIS"
631 >+prevent-setting-cookies</I
632 ></A
633 ></DT
634 ><DT
635 >8.5.18. <A
636 HREF="actions-file.html#KILL-POPUP"
637 ><I
638 CLASS="EMPHASIS"
639 >+kill-popups<A
640 NAME="KILL-POPUPS"
641 ></A
642 ></I
643 ></A
644 ></DT
645 ><DT
646 >8.5.19. <A
647 HREF="actions-file.html#SEND-VANILLA-WAFER"
648 ><I
649 CLASS="EMPHASIS"
650 >+send-vanilla-wafer</I
651 ></A
652 ></DT
653 ><DT
654 >8.5.20. <A
655 HREF="actions-file.html#SEND-WAFER"
656 ><I
657 CLASS="EMPHASIS"
658 >+send-wafer</I
659 ></A
660 ></DT
661 ><DT
662 >8.5.21. <A
663 HREF="actions-file.html#AEN2289"
664 >Summary</A
665 ></DT
666 ><DT
667 >8.5.22. <A
668 HREF="actions-file.html#ACT-EXAMPLES"
669 >Sample Actions Files</A
670 ></DT
671 ></DL
672 ></DD
673 ><DT
674 >8.6. <A
675 HREF="actions-file.html#ALIASES"
676 >Aliases</A
677 ></DT
678 ></DL
679 ></DD
680 ><DT
681 >9. <A
682 HREF="filter-file.html"
683 >The Filter File</A
684 ></DT
685 ><DD
686 ><DL
687 ><DT
688 >9.1. <A
689 HREF="filter-file.html#AEN2432"
690 >The <I
691 CLASS="EMPHASIS"
692 >+filter</I
693 > Action</A
694 ></DT
695 ></DL
696 ></DD
697 ><DT
698 >10. <A
699 HREF="templates.html"
700 >Templates</A
701 ></DT
702 ><DT
703 >11. <A
704 HREF="contact.html"
705 >Contacting the Developers, Bug Reporting and Feature
706 Requests</A
707 ></DT
708 ><DD
709 ><DL
710 ><DT
711 >11.1. <A
712 HREF="contact.html#CONTACT-SUPPORT"
713 >Get Support</A
714 ></DT
715 ><DT
716 >11.2. <A
717 HREF="contact.html#CONTACT-BUGS"
718 >Report bugs</A
719 ></DT
720 ><DT
721 >11.3. <A
722 HREF="contact.html#CONTACT-FEATURE"
723 >Request new features</A
724 ></DT
725 ><DT
726 >11.4. <A
727 HREF="contact.html#CONTACT-ADS"
728 >Report ads or other filter problems</A
729 ></DT
730 ><DT
731 >11.5. <A
732 HREF="contact.html#CONTACT-OTHER"
733 >Other</A
734 ></DT
735 ></DL
736 ></DD
737 ><DT
738 >12. <A
739 HREF="copyright.html"
740 ><SPAN
741 CLASS="APPLICATION"
742 >Privoxy</SPAN
743 > Copyright, License and History</A
744 ></DT
745 ><DD
746 ><DL
747 ><DT
748 >12.1. <A
749 HREF="copyright.html#AEN2498"
750 >License</A
751 ></DT
752 ><DT
753 >12.2. <A
754 HREF="copyright.html#HISTORY"
755 >History</A
756 ></DT
757 ></DL
758 ></DD
759 ><DT
760 >13. <A
761 HREF="seealso.html"
762 >See Also</A
763 ></DT
764 ><DT
765 >14. <A
766 HREF="appendix.html"
767 >Appendix</A
768 ></DT
769 ><DD
770 ><DL
771 ><DT
772 >14.1. <A
773 HREF="appendix.html#REGEX"
774 >Regular Expressions</A
775 ></DT
776 ><DT
777 >14.2. <A
778 HREF="appendix.html#AEN2732"
779 ><SPAN
780 CLASS="APPLICATION"
781 >Privoxy</SPAN
782 >'s Internal Pages</A
783 ></DT
784 ><DD
785 ><DL
786 ><DT
787 >14.2.1. <A
788 HREF="appendix.html#BOOKMARKLETS"
789 >Bookmarklets</A
790 ></DT
791 ></DL
792 ></DD
793 ><DT
794 >14.3. <A
795 HREF="appendix.html#CHAIN"
796 >Chain of Events</A
797 ></DT
798 ><DT
799 >14.4. <A
800 HREF="appendix.html#ACTIONSANAT"
801 >Anatomy of an Action</A
802 ></DT
803 ></DL
804 ></DD
805 ></DL
806 ></DIV
807 ></DIV
808 ><DIV
809 CLASS="NAVFOOTER"
810 ><HR
811 ALIGN="LEFT"
812 WIDTH="100%"><TABLE
813 WIDTH="100%"
814 BORDER="0"
815 CELLPADDING="0"
816 CELLSPACING="0"
817 ><TR
818 ><TD
819 WIDTH="33%"
820 ALIGN="left"
821 VALIGN="top"
822 >&nbsp;</TD
823 ><TD
824 WIDTH="34%"
825 ALIGN="center"
826 VALIGN="top"
827 >&nbsp;</TD
828 ><TD
829 WIDTH="33%"
830 ALIGN="right"
831 VALIGN="top"
832 ><A
833 HREF="introduction.html"
834 >Next</A
835 ></TD
836 ></TR
837 ><TR
838 ><TD
839 WIDTH="33%"
840 ALIGN="left"
841 VALIGN="top"
842 >&nbsp;</TD
843 ><TD
844 WIDTH="34%"
845 ALIGN="center"
846 VALIGN="top"
847 >&nbsp;</TD
848 ><TD
849 WIDTH="33%"
850 ALIGN="right"
851 VALIGN="top"
852 >Introduction</TD
853 ></TR
854 ></TABLE
855 ></DIV
856 ></BODY
857 ></HTML
858 >