- Kill obsolete REDIRECT_URL code
[privoxy.git] / config
1 #  Sample Configuration file for Privoxy
2
3 #
4 # $Id: config,v 1.34 2002/04/22 12:34:09 oes Exp $
5 #
6 ###################################################################
7 #                                                                 #
8 #                     Table of Contents                           #
9 #                                                                 #
10 #       I. INTRODUCTION                                           #
11 #      II. FORMAT OF THE CONFIGURATION FILE                       #
12 #                                                                 #
13 #       1. CONFIGURATION AND LOG FILE LOCATIONS                   #
14 #       2. LOCAL SET-UP DOCUMENTATION                             #
15 #       3. DEBUGGING                                              #
16 #       4. ACCESS CONTROL AND SECURITY                            #
17 #       5. FORWARDING                                             #
18 #       6. WINDOWS GUI OPTIONS                                    #
19 #                                                                 #
20 ###################################################################
21
22 #  I. INTRODUCTION
23 #  ===============
24 #
25 #  This file holds the Privoxy configuration.  If you modify this
26 #  file, you will need to send a couple of requests to the proxy
27 #  before any changes take effect.
28 #
29 #  When starting Privoxy on Unix systems, give the name of this
30 #  file as an argument.  On Windows systems, Privoxy will look for
31 #  this file with the name 'config.txt' in the same directory where
32 #  Privoxy is installed.
33 #
34
35 #  II. FORMAT OF THE CONFIGURATION FILE
36 #  ====================================
37 #
38 #  Configuration lines consist of an initial keyword followed by a list
39 #  of values, all separated by whitespace (any number of spaces or
40 #  tabs).  For example,
41 #
42 #  actionsfile default.action
43 #
44 #  Indicates that the actionsfile is named 'default.action'.
45 #
46 #  The '#' indicates a comment.  Any part of a line following a '#' is
47 #  ignored, except if the '#' is preceded by a '\'.
48 #
49 #  Thus, by placing a # at the start of an existing configuration line,
50 #  you can make it a comment and it will be treated as if it weren't there. 
51 #  This is called "commenting out" an option and can be useful.
52 #
53 #  Note that commenting out and option and leaving it at its default
54 #  are two completely different things! Most options behave very
55 #  differently when unset. See the the "Effect if unset" explanation
56 #  in each option's description for details.
57 #
58 #  Long lines can be continued on the next line by using a `\' as
59 #  the last character.
60 #
61
62 #   1. CONFIGURATION AND LOG FILE LOCATIONS
63 #   =======================================
64 #
65 #  Privoxy can (and normally does) use a number of other files for
66 #  additional configuration and logging. This section of the
67 #  configuration file tells Privoxy where to find those other files.
68
69 #  1.1. confdir
70 #  ============
71
72 #  Specifies:
73 #     
74 #      The directory where the other configuration files are located
75 #     
76 #  Type of value:
77 #     
78 #      Path name
79 #     
80 #  Default value:
81 #     
82 #      /etc/privoxy (Unix) or Privoxy installation dir (Windows)
83 #     
84 #  Effect if unset:
85 #     
86 #      Mandatory
87 #     
88 #  Notes:
89 #     
90 #      No trailing "/", please
91 #     
92 #      When development goes modular and multi-user, the blocker,
93 #      filter, and per-user config will be stored in subdirectories of
94 #      "confdir". For now, the configuration directory structure is
95 #      flat, except for confdir/templates, where the HTML templates for
96 #      CGI output reside (e.g. Privoxy's 404 error page).
97 #  
98 confdir .
99
100
101 #  1.2. logdir
102 #  ===========
103 #  
104 #  Specifies:
105 #     
106 #      The directory where all logging takes place (i.e. where logfile
107 #      and jarfile are located)
108 #     
109 #  Type of value:
110 #     
111 #      Path name
112 #     
113 #  Default value:
114 #     
115 #      /var/log/privoxy (Unix) or Privoxy installation dir (Windows)
116 #     
117 #  Effect if unset:
118 #     
119 #      Mandatory
120 #     
121 #  Notes:
122 #    
123 #      No trailing "/", please
124 #
125 logdir .
126
127
128 #  1.3. actionsfile
129 #  ================ 
130 #  
131 #  Specifies:
132 #     
133 #      The actions file to use
134 #     
135 #  Type of value:
136 #     
137 #      File name, relative to confdir, without the .action (Unix)
138 #      or .action.txt (Windows) extension.
139 #     
140 #  Default values:
141 #      standard  # Internal purpose, recommended
142 #      default   # Main actions file
143 #      user      # User customizations
144 #     
145 #  Effect if unset:
146 #     
147 #      No action is taken at all. Simple neutral proxying.
148 #     
149 #  Notes:
150 #      Multiple actionsfile lines are OK and are in fact recommended!
151 #
152 #      The default values include standard.action, which is used for
153 #      internal purposes and should be loaded, default.action, which
154 #      is the "main" actions file maintained by the developers, and
155 #      user.action, where you can make your personal additions.
156 #     
157 #      There is no point in using Privoxy without an actions file.
158 #
159 actionsfile standard  # Internal purpose, recommended
160 actionsfile default   # Main actions file
161 actionsfile user      # User customizations
162
163
164 #  1.4. filterfile
165 #  ===============
166 #  
167 #  Specifies:
168 #     
169 #      The filter file to use
170 #     
171 #  Type of value:
172 #     
173 #      File name, relative to confdir
174 #     
175 #  Default value:
176 #     
177 #      default.filter (Unix) or default.filter.txt (Windows)
178 #    
179 #  Effect if unset:
180 #     
181 #      No textual content filtering takes place, i.e. all +filter{name}
182 #      actions in the actions file are turned off
183 #     
184 #  Notes:
185 #     
186 #      The "default.filter" file contains content modification rules
187 #      that use "regular expressions". These rules permit powerful
188 #      changes on the content of Web pages, e.g., you could disable your
189 #      favorite JavaScript annoyances, re-write the actual displayed
190 #      text, or just have some fun replacing "Microsoft" with
191 #      "MicroSuck" wherever it appears on a Web page.
192
193 filterfile default.filter
194
195
196 #  1.5. logfile
197 #  ============
198 #  
199 #  Specifies:
200 #     
201 #      The log file to use
202 #     
203 #  Type of value:
204 #     
205 #      File name, relative to logdir
206 #     
207 #  Default value:
208 #     
209 #      logfile (Unix) or privoxy.log (Windows)
210 #     
211 #  Effect if unset:
212 #     
213 #      No log file is used, all log messages go to the console
214 #      (stderr).
215 #     
216 #  Notes:
217 #     
218 #      The windows version will additionally log to the console.
219 #     
220 #      The logfile is where all logging and error messages are written.
221 #      The level of detail and number of messages are set with the debug
222 #      option (see below). The logfile can be useful for tracking down a
223 #      problem with Privoxy (e.g., it's not blocking an ad you think it
224 #      should block) but in most cases you probably will never look at
225 #      it.
226 #     
227 #      Your logfile will grow indefinitely, and you will probably want
228 #      to periodically remove it. On Unix systems, you can do this with
229 #      a cron job (see "man cron"). For Red Hat, a logrotate script has
230 #      been included.
231 #    
232 #      On SuSE Linux systems, you can place a line like
233 #      "/var/log/privoxy.* +1024k 644 nobody.nogroup" in /etc/logfiles,
234 #      with the effect that cron.daily will automatically archive, gzip,
235 #      and empty the log, when it exceeds 1M size.
236 #    
237
238 logfile logfile
239
240
241 #  1.6. jarfile
242 #  ============
243 #  
244 #  Specifies:
245 #     
246 #      The file to store intercepted cookies in
247 #     
248 #  Type of value:
249 #     
250 #      File name, relative to logdir
251 #     
252 #  Default value:
253 #     
254 #      jarfile (Unix) or privoxy.jar (Windows)
255 #     
256 #  Effect if unset:
257 #     
258 #      Intercepted cookies are not stored at all.
259 #     
260 #  Notes:
261 #     
262 #      The jarfile may grow to ridiculous sizes over time.
263
264 jarfile jarfile
265
266
267 #  1.7. trustfile
268 #  ==============
269 #  
270 #  Specifies:
271 #     
272 #      The trust file to use
273 #     
274 #  Type of value:
275 #     
276 #      File name, relative to confdir
277 #     
278 #  Default value:
279 #     
280 #      Unset (commented out). When activated: trust (Unix) or trust.txt
281 #      (Windows)
282 #     
283 #  Effect if unset:
284 #    
285 #      The whole trust mechanism is turned off.
286 #     
287 #  Notes:
288 #     
289 #      The trust mechanism is an experimental feature for building
290 #      white-lists and should be used with care. It is NOT recommended
291 #      for the casual user.
292 #     
293 #      If you specify a trust file, Privoxy will only allow access to
294 #      sites that are named in the trustfile. You can also mark sites as
295 #      trusted referrers (with +), with the effect that access to
296 #      untrusted sites will be granted, if a link from a trusted
297 #      referrer was used. The link target will then be added to the
298 #      "trustfile". Possible applications include limiting Internet
299 #      access for children.
300 #     
301 #      If you use + operator in the trust file, it may grow considerably
302 #      over time.
303 #  
304 #trustfile trust
305
306
307 #  2. LOCAL SET-UP DOCUMENTATION
308 #  =============================
309 #  
310 #  If you intend to operate Privoxy for more users that just yourself,
311 #  it might be a good idea to let them know how to reach you, what you
312 #  block and why you do that, your policies etc.
313 #  
314 #
315 #  2.1. trust-info-url
316 #  ===================
317 #  
318 #  Specifies:
319 #     
320 #      A URL to be displayed in the error page that users will see if
321 #      access to an untrusted page is denied.
322 #     
323 #  Type of value:
324 #     
325 #      URL
326 #     
327 #  Default value:
328 #     
329 #      Two example URL are provided
330 #     
331 #  Effect if unset:
332 #     
333 #      No links are displayed on the "untrusted" error page.
334 #     
335 #  Notes:
336 #    
337 #      The value of this option only matters if the experimental trust
338 #      mechanism has been activated. (See trustfile above.)
339 #     
340 #      If you use the trust mechanism, it is a good idea to write up
341 #      some on-line documentation about your trust policy and to specify
342 #      the URL(s) here. Use multiple times for multiple URLs.
343 #     
344 #      The URL(s) should be added to the trustfile as well, so users
345 #      don't end up locked out from the information on why they were
346 #      locked out in the first place!
347 #    
348 trust-info-url http://www.example.com/why_we_block.html
349 trust-info-url http://www.example.com/what_we_allow.html
350
351
352 #  2.2. admin-address
353 #  ==================
354 #  
355 #  Specifies:
356 #     
357 #      An email address to reach the proxy administrator.
358 #     
359 #  Type of value:
360 #     
361 #      Email address
362 #     
363 #  Default value:
364 #     
365 #      Unset
366 #     
367 #  Effect if unset:
368 #     
369 #      No email address is displayed on error pages and the CGI user
370 #      interface.
371 #     
372 #  Notes:
373 #     
374 #      Highly recommended for multi-user installations.
375 #
376 #      If both admin-address and proxy-info-url are unset, the whole
377 #      "Local Privoxy Support" box on all generated pages will not be
378 #      shown.
379 #
380 #admin-address privoxy-admin@example.com
381
382
383 #  2.3. proxy-info-url
384 #  ===================
385 #  
386 #  Specifies:
387 #     
388 #      A URL to documentation about the local Privoxy setup,
389 #      configuration or policies.
390 #     
391 #  Type of value:
392 #     
393 #      URL
394 #     
395 #  Default value:
396 #     
397 #      Unset
398 #     
399 #  Effect if unset:
400 #     
401 #      No link to local documentation is displayed on error pages and
402 #      the CGI user interface.
403 #     
404 #  Notes:
405 #     
406 #      If both admin-address and proxy-info-url are unset, the whole
407 #      "Local Privoxy Support" box on all generated pages will not be
408 #      shown.
409 #     
410 #      This URL shouldn't be blocked ;-)
411 #  
412 #proxy-info-url http://www.example.com/proxy-service.html
413
414
415 #  3. DEBUGGING
416 #  ============
417 #  
418 #  These options are mainly useful when tracing a problem. Note that you
419 #  might also want to invoke Privoxy with the --no-daemon command line
420 #  option when debugging.
421
422
423 #  3.1. debug
424 #  ==========
425 #  
426 #  Specifies:
427 #     
428 #      Key values that determine what information gets logged.
429 #     
430 #  Type of value:
431 #     
432 #      Integer values
433 #     
434 #  Default value:
435 #     
436 #      12289 (i.e.: URLs plus warnings and errors)
437 #     
438 #  Effect if unset:
439 #     
440 #      Nothing gets logged.
441 #     
442 #  Notes:
443 #     
444 #      The available debug levels are:
445 #     
446 #        debug         1 # show each GET/POST/CONNECT request             
447 #        debug         2 # show each connection status                    
448 #        debug         4 # show I/O status                                
449 #        debug         8 # show header parsing                            
450 #        debug        16 # log all data into the logfile                  
451 #        debug        32 # debug force feature                            
452 #        debug        64 # debug regular expression filter                
453 #        debug       128 # debug fast redirects                           
454 #        debug       256 # debug GIF de-animation                         
455 #        debug       512 # Common Log Format                              
456 #        debug      1024 # debug kill pop-ups                             
457 #        debug      4096 # Startup banner and warnings               
458 #        debug      8192 # Non-fatal errors                               
459 #                                                                         
460 #     
461 #      To select multiple debug levels, you can either add them or use
462 #      multiple debug lines.
463 #    
464 #      A debug level of 1 is informative because it will show you each
465 #      request as it happens. 1, 4096 and 8192 are highly recommended so
466 #      that you will notice when things go wrong. The other levels are
467 #      probably only of interest if you are hunting down a specific
468 #      problem. They can produce a hell of an output (especially 16).
469 #     
470 #      The reporting of fatal errors (i.e. ones which crash Privoxy) is
471 #      always on and cannot be disabled.
472 #     
473 #      If you want to use CLF (Common Log Format), you should set "debug
474 #      512" ONLY and not enable anything else.
475 #  
476 debug   1    # show each GET/POST/CONNECT request
477 debug   4096 # Startup banner and warnings
478 debug   8192 # Errors - *we highly recommended enabling this*
479
480
481 #  3.2. single-threaded
482 #  ====================
483 #  
484 #  Specifies:
485 #     
486 #      Whether to run only one server thread
487 #     
488 #  Type of value:
489 #     
490 #      None
491 #     
492 #  Default value:
493 #    
494 #      Unset
495 #    
496 #  Effect if unset:
497 #     
498 #      Multi-threaded (or, where unavailable: forked) operation, i.e.
499 #      the ability to serve multiple requests simultaneously.
500 #     
501 #  Notes:
502 #     
503 #      This option is only there for debug purposes and you should never
504 #      need to use it. It will drastically reduce performance.
505 #    
506 #single-threaded
507
508
509 #  4. ACCESS CONTROL AND SECURITY
510 #  ==============================
511 #  
512 #  This section of the config file controls the security-relevant
513 #  aspects of Privoxy's configuration.
514
515
516 #  4.1. listen-address
517 #  ===================
518 #  
519 #  Specifies:
520 #     
521 #      The IP address and TCP port on which Privoxy will listen for
522 #      client requests.
523 #     
524 #  Type of value:
525 #     
526 #      [IP-Address]:Port
527 #     
528 #  Default value:
529 #     
530 #      localhost:8118
531 #     
532 #  Effect if unset:
533 #     
534 #      Bind to localhost (127.0.0.1), port 8118. This is suitable and
535 #      recommended for home users who run Privoxy on the same machine as
536 #      their browser.
537 #    
538 #  Notes:
539 #     
540 #      You will need to configure your browser(s) to this proxy address
541 #      and port.
542 #     
543 #      If you already have another service running on port 8118, or if
544 #      you want to serve requests from other machines (e.g. on your
545 #      local network) as well, you will need to override the default.
546 #     
547 #      If you leave out the IP address, Privoxy will bind to all
548 #      interfaces (addresses) on your machine and may become reachable
549 #      from the Internet. In that case, consider using access control
550 #      lists (acl's) (see "ACLs" below), or a firewall.
551 #     
552 #  Example:
553 #     
554 #      Suppose you are running Privoxy on a machine which has the
555 #      address 192.168.0.1 on your local private network (192.168.0.0)
556 #      and has another outside connection with a different address. You
557 #      want it to serve requests from inside only:
558 #     
559 #        listen-address  192.168.0.1:8118                                 
560 #                                                                        
561 listen-address 127.0.0.1:8118
562
563  
564 #  4.2. toggle
565 #  ===========
566 #  
567 #  Specifies:
568 #     
569 #      Initial state of "toggle" status
570 #     
571 #  Type of value:
572 #     
573 #      1 or 0
574 #     
575 #  Default value:
576 #     
577 #      1
578 #     
579 #  Effect if unset:
580 #     
581 #      Act as if toggled on
582 #     
583 #  Notes:
584 #    
585 #      If set to 0, Privoxy will start in "toggled off" mode, i.e.
586 #      behave like a normal, content-neutral proxy. See
587 #      enable-remote-toggle below. This is not really useful anymore,
588 #      since toggling is much easier via the web interface then via
589 #      editing the conf file.
590 #     
591 #      The windows version will only display the toggle icon in the
592 #      system tray if this option is present.
593 #    
594
595 toggle 1
596
597
598 #  4.3. enable-remote-toggle
599 #  =========================
600 #  
601 #  Specifies:
602 #     
603 #      Whether or not the web-based toggle feature may be used
604 #     
605 #  Type of value:
606 #     
607 #      0 or 1
608 #     
609 #  Default value:
610 #     
611 #      1
612 #     
613 #  Effect if unset:
614 #     
615 #      The web-based toggle feature is disabled.
616 #     
617 #  Notes:
618 #     
619 #      When toggled off, Privoxy acts like a normal, content-neutral
620 #      proxy, i.e. it acts as if none of the actions applied to any
621 #      URL.
622 #     
623 #      For the time being, access to the toggle feature can not be
624 #      controlled separately by "ACLs" or HTTP authentication, so that
625 #      everybody who can access Privoxy (see "ACLs" and listen-address
626 #      above) can toggle it for all users. So this option is not
627 #      recommended for multi-user environments with untrusted users.
628 #     
629 #      Note that you must have compiled Privoxy with support for this
630 #      feature, otherwise this option has no effect.
631 #    
632 enable-remote-toggle 1
633
634
635 #  4.4. enable-edit-actions
636 #  ========================
637 #  
638 #  Specifies:
639 #     
640 #      Whether or not the web-based actions file editor may be used
641 #     
642 #  Type of value:
643 #     
644 #      0 or 1
645 #     
646 #  Default value:
647 #     
648 #      1
649 #     
650 #  Effect if unset:
651 #     
652 #      The web-based actions file editor is disabled.
653 #     
654 #  Notes:
655 #     
656 #      For the time being, access to the editor can not be controlled
657 #      separately by "ACLs" or HTTP authentication, so that everybody
658 #      who can access Privoxy (see "ACLs" and listen-address above) can
659 #      modify its configuration for all users. So this option is not
660 #      recommended for multi-user environments with untrusted users.
661 #     
662 #      Note that you must have compiled Privoxy with support for this
663 #      feature, otherwise this option has no effect.
664 #    
665 enable-edit-actions 1
666
667
668 #  4.5. ACLs: permit-access and deny-access
669 #  ========================================
670 #  
671 #  Specifies:
672 #     
673 #      Who can access what.
674 #     
675 #  Type of value:
676 #     
677 #      src_addr[/src_masklen] [dst_addr[/dst_masklen]]
678 #     
679 #      Where src_addr and dst_addr are IP addresses in dotted decimal
680 #      notation or valid DNS names, and src_masklen and dst_masklen are
681 #      subnet masks in CIDR notation, i.e. integer values from 2 to 32
682 #      representing the length (in bits) of the network address. The
683 #      masks and the whole destination part are optional.
684 #    
685 #  Default value:
686 #     
687 #      Unset
688 #     
689 #  Effect if unset:
690 #     
691 #      Don't restrict access further than implied by listen-address
692 #     
693 #  Notes:
694 #     
695 #      Access controls are included at the request of ISPs and systems
696 #      administrators, and are not usually needed by individual users.
697 #      For a typical home user, it will normally suffice to ensure that
698 #      Privoxy only listens on the localhost or internal (home) network
699 #      address by means of the listen-address option.
700 #     
701 #      Please see the warnings in the FAQ that this proxy is not
702 #      intended to be a substitute for a firewall or to encourage anyone
703 #      to defer addressing basic security weaknesses.
704 #     
705 #      Multiple ACL lines are OK. If any ACLs are specified, then the
706 #      Privoxy talks only to IP addresses that match at least one
707 #      permit-access line and don't match any subsequent deny-access
708 #      line. In other words, the last match wins, with the default being
709 #      deny-access.
710 #     
711 #      If Privoxy is using a forwarder (see forward below) for a
712 #      particular destination URL, the dst_addr that is examined is the
713 #      address of the forwarder and NOT the address of the ultimate
714 #      target. This is necessary because it may be impossible for the
715 #      local Privoxy to determine the IP address of the ultimate target
716 #      (that's often what gateways are used for).
717 #     
718 #      You should prefer using IP addresses over DNS names, because the
719 #      address lookups take time. All DNS names must resolve! You can
720 #      not use domain patterns like "*.org" or partial domain names. If
721 #      a DNS name resolves to multiple IP addresses, only the first one
722 #      is used.
723 #     
724 #      Denying access to particular sites by ACL may have undesired side
725 #      effects if the site in question is hosted on a machine which also
726 #      hosts other sites.
727 #     
728 #  Examples:
729 #     
730 #      Explicitly define the default behavior if no ACL and
731 #      listen-address are set: "localhost" is OK. The absence of a
732 #      dst_addr implies that all destination addresses are OK:
733 #     
734 #        permit-access  localhost                                         
735 #                                                                        
736 #    
737 #      Allow any host on the same class C subnet as www.privoxy.org
738 #      access to nothing but www.example.com:
739 #     
740 #        permit-access  www.privoxy.org/24 www.example.com/32             
741 #                                                                         
742 #     
743 #      Allow access from any host on the 26-bit subnet 192.168.45.64 to
744 #      anywhere, with the exception that 192.168.45.73 may not access
745 #      www.dirty-stuff.example.com:
746 #     
747 #        permit-access  192.168.45.64/26                                  
748 #        deny-access    192.168.45.73    www.dirty-stuff.example.com      
749 #                                                                        
750
751
752 #  4.6. buffer-limit
753 #  =================
754 #  
755 #  Specifies:
756 #     
757 #      Maximum size of the buffer for content filtering.
758 #     
759 #  Type of value:
760 #     
761 #      Size in Kbytes
762 #     
763 #  Default value:
764 #     
765 #      4096
766 #     
767 #  Effect if unset:
768 #     
769 #      Use a 4MB (4096 KB) limit.
770 #     
771 #  Notes:
772 #     
773 #      For content filtering, i.e. the +filter and +deanimate-gif
774 #      actions, it is necessary that Privoxy buffers the entire document
775 #      body. This can be potentially dangerous, since a server could
776 #      just keep sending data indefinitely and wait for your RAM to
777 #      exhaust -- with nasty consequences. Hence this option.
778 #     
779 #      When a document buffer size reaches the buffer-limit, it is
780 #      flushed to the client unfiltered and no further attempt to filter
781 #      the rest of the document is made. Remember that there may be
782 #      multiple threads running, which might require up to buffer-limit
783 #      Kbytes each, unless you have enabled "single-threaded" above.
784 #    
785 buffer-limit 4096
786
787
788 #  5. FORWARDING
789 #  =============
790 #  
791 #  This feature allows routing of HTTP requests through a chain of
792 #  multiple proxies. It can be used to better protect privacy and
793 #  confidentiality when accessing specific domains by routing requests
794 #  to those domains through an anonymous public proxy (see e.g.
795 #  http://www.multiproxy.org/anon_list.htm) Or to use a caching proxy to
796 #  speed up browsing. Or chaining to a parent proxy may be necessary
797 #  because the machine that Privoxy runs on has no direct Internet
798 #  access.
799 #  
800 #  Also specified here are SOCKS proxies. Privoxy supports the SOCKS 4
801 #  and SOCKS 4A protocols.
802
803
804
805 #  5.1. forward
806 #  ============
807 #
808 #  Specifies:
809 #     
810 #      To which parent HTTP proxy specific requests should be routed.
811 #     
812 #  Type of value:
813 #     
814 #      target_domain[:port] http_parent[:port]
815 #     
816 #      Where target_domain is a domain name pattern (see the chapter on
817 #      domain matching in the actions file), http_parent is the address
818 #      of the parent HTTP proxy as an IP addresses in dotted decimal
819 #      notation or as a valid DNS name (or "." to denote "no
820 #      forwarding", and the optional port parameters are TCP ports, i.e.
821 #      integer values from 1 to 64535
822 #     
823 #  Default value:
824 #     
825 #      Unset
826 #     
827 #  Effect if unset:
828 #     
829 #      Don't use parent HTTP proxies.
830 #     
831 #  Notes:
832 #     
833 #      If http_parent is ".", then requests are not forwarded to another
834 #      HTTP proxy but are made directly to the web servers.
835 #     
836 #      Multiple lines are OK, they are checked in sequence, and the last
837 #      match wins.
838 #     
839 #  Examples:
840 #    
841 #      Everything goes to an example anonymizing proxy, except SSL on
842 #      port 443 (which it doesn't handle):
843 #     
844 #        forward   .*     anon-proxy.example.org:8080                     
845 #        forward   :443   .                                               
846 #                                                                         
847 #     
848 #      Everything goes to our example ISP's caching proxy, except for
849 #      requests to that ISP's sites:
850 #     
851 #        forward   .*.                caching-proxy.example-isp.net:8000  
852 #        forward   .example-isp.net   .                                   
853 #                                                                         
854
855
856 #  5.2. forward-socks4 and forward-socks4a
857 #  =======================================
858 #
859 #  Specifies:
860 #     
861 #      Through which SOCKS proxy (and to which parent HTTP proxy)
862 #      specific requests should be routed.
863 #     
864 #  Type of value:
865 #     
866 #      target_domain[:port] socks_proxy[:port] http_parent[:port]
867 #     
868 #      Where target_domain is a domain name pattern (see the chapter on
869 #      domain matching in the actions file), http_parent and socks_proxy
870 #      are IP addresses in dotted decimal notation or valid DNS names
871 #      (http_parent may be "." to denote "no HTTP forwarding"), and the
872 #      optional port parameters are TCP ports, i.e. integer values from
873 #      1 to 64535
874 #     
875 #  Default value:
876 #     
877 #      Unset
878 #     
879 #  Effect if unset:
880 #     
881 #      Don't use SOCKS proxies.
882 #     
883 #  Notes:
884 #     
885 #      Multiple lines are OK, they are checked in sequence, and the last
886 #      match wins.
887 #     
888 #      The difference between forward-socks4 and forward-socks4a is that
889 #      in the SOCKS 4A protocol, the DNS resolution of the target
890 #      hostname happens on the SOCKS server, while in SOCKS 4 it happens
891 #      locally.
892 #    
893 #      If http_parent is ".", then requests are not forwarded to another
894 #      HTTP proxy but are made (HTTP-wise) directly to the web servers,
895 #      albeit through a SOCKS proxy.
896 #     
897 #  Examples:
898 #     
899 #      From the company example.com, direct connections are made to all
900 #      "internal" domains, but everything outbound goes through their
901 #      ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
902 #      the Internet.
903 #     
904 #        forward-socks4a   .*.           socks-gw.example.com:1080  www-cache.example-isp.net:8080 
905 #        forward           .example.com   .
906 #                                                                                                  
907 #    
908 #      A rule that uses a SOCKS 4 gateway for all destinations but no
909 #      HTTP parent looks like this:
910 #     
911 #        forward-socks4   .*.            socks-gw.example.com:1080  .     
912 #                                                                         
913 #      See the user manual for more advanced examples.
914 #    
915
916
917 #  6. WINDOWS GUI OPTIONS
918 #  ======================
919 #  
920 #  Privoxy has a number of options specific to the Windows GUI
921 #  interface:
922 #  
923 #  If "activity-animation" is set to 1, the Privoxy icon will animate
924 #  when "Privoxy" is active. To turn off, set to 0.
925
926 #activity-animation 1
927
928 #  If "log-messages" is set to 1, Privoxy will log messages to the
929 #  console window:
930
931 #log-messages 1
932    
933 #  If "log-buffer-size" is set to 1, the size of the log buffer, i.e.
934 #  the amount of memory used for the log messages displayed in the
935 #  console window, will be limited to "log-max-lines" (see below).
936 #  
937 #  Warning: Setting this to 0 will result in the buffer to grow
938 #  infinitely and eat up all your memory!
939
940 #log-buffer-size 1
941
942 #  log-max-lines is the maximum number of lines held in the log buffer.
943 #  See above.
944
945 #log-max-lines 200
946
947 #  If "log-highlight-messages" is set to 1, Privoxy will highlight
948 #  portions of the log messages with a bold-faced font:
949
950 #log-highlight-messages 1
951 #    
952  
953 #  The font used in the console window:
954
955 #log-font-name Comic Sans MS
956 #    
957  
958 #  Font size used in the console window:
959
960 #log-font-size 8
961 #    
962  
963 #  "show-on-task-bar" controls whether or not Privoxy will appear as a
964 #  button on the Task bar when minimized:
965
966 #show-on-task-bar 0
967 #    
968  
969 #  If "close-button-minimizes" is set to 1, the Windows close button
970 #  will minimize Privoxy instead of closing the program (close with the
971 #  exit option on the File menu).
972
973 #close-button-minimizes 1
974 #    
975  
976 #  The "hide-console" option is specific to the MS-Win console version
977 #  of Privoxy. If this option is used, Privoxy will disconnect from and
978 #  hide the command console.
979
980 #hide-console
981 #