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