1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
5 >The Main Configuration File</TITLE
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
10 TITLE="Privoxy 3.0.3 User Manual"
11 HREF="index.html"><LINK
13 TITLE="Privoxy Configuration"
14 HREF="configuration.html"><LINK
17 HREF="actions-file.html"><LINK
20 HREF="../p_doc.css"></HEAD
31 SUMMARY="Header navigation table"
40 >Privoxy 3.0.3 User Manual</TH
48 HREF="configuration.html"
62 HREF="actions-file.html"
77 >7. The Main Configuration File</A
80 > Again, the main configuration file is named <TT
84 Linux/Unix/BSD and OS/2, and <TT
88 Configuration lines consist of an initial keyword followed by a list of
89 values, all separated by whitespace (any number of spaces or tabs). For
100 >confdir /etc/privoxy</I
107 > Assigns the value <VAR
114 > and thus indicates that the configuration
115 directory is named <SPAN
117 >"/etc/privoxy/"</SPAN
120 > All options in the config file except for <VAR
127 > are optional. Watch out in the below description
128 for what happens if you leave them unset.</P
130 > The main config file controls all aspects of <SPAN
134 operation that are not location dependent (i.e. they apply universally, no matter
135 where you may be surfing).</P
142 >7.1. Configuration and Log File Locations</A
148 > can (and normally does) use a number of
149 other files for additional configuration, help and logging.
150 This section of the configuration file tells <SPAN
154 where to find those other files. </P
156 > The user running <SPAN
160 permission for all configuration files, and write permission to any files
161 that would be modified, such as log files and actions files.</P
179 >The directory where the other configuration files are located</P
191 >/etc/privoxy (Unix) <SPAN
200 > installation dir (Windows) </P
203 >Effect if unset:</DT
227 > When development goes modular and multi-user, the blocker, filter, and
228 per-user config will be stored in subdirectories of <SPAN
232 For now, the configuration directory structure is flat, except for
235 >confdir/templates</TT
236 >, where the HTML templates for CGI
237 output reside (e.g. <SPAN
263 > The directory where all logging takes place (i.e. where <TT
283 >/var/log/privoxy (Unix) <SPAN
292 > installation dir (Windows) </P
295 >Effect if unset:</DT
328 >7.1.3. actionsfile</A
331 NAME="DEFAULT.ACTION"
334 NAME="STANDARD.ACTION"
349 HREF="actions-file.html"
358 >File name, relative to <VAR
377 CLASS="LITERALLAYOUT"
378 > standard # Internal purposes, no editing recommended</P
385 CLASS="LITERALLAYOUT"
386 > default # Main actions file</P
393 CLASS="LITERALLAYOUT"
394 > user # User customizations</P
404 >Effect if unset:</DT
407 > No actions are taken at all. Simple neutral proxying.
417 > lines are permitted, and are in fact recommended!
421 The default values include standard.action, which is used for internal
422 purposes and should be loaded, default.action, which is the
426 > actions file maintained by the developers, and
430 >, where you can make your personal additions.
434 Actions files are where all the per site and per URL configuration is done for
435 ad blocking, cookie management, privacy considerations, etc.
436 There is no point in using <SPAN
440 least one actions file.
452 >7.1.4. filterfile</A
455 NAME="DEFAULT.FILTER"
467 HREF="filter-file.html"
476 >File name, relative to <VAR
485 >default.filter (Unix) <SPAN
491 > default.filter.txt (Windows)</P
494 >Effect if unset:</DT
497 > No textual content filtering takes place, i.e. all
501 HREF="actions-file.html#FILTER"
508 actions in the actions files are turned neutral.
516 HREF="filter-file.html"
518 > contains content modification
520 HREF="appendix.html#REGEX"
521 >regular expressions</A
522 >. These rules permit
523 powerful changes on the content of Web pages, e.g., you could disable your favorite
524 JavaScript annoyances, re-write the actual displayed text, or just have some
532 it appears on a Web page.
539 HREF="actions-file.html#FILTER"
546 actions rely on the relevant filter (<VAR
550 to be defined in the filter file!
553 > A pre-defined filter file called <TT
557 a bunch of handy filters for common problems is included in the distribution.
558 See the section on the <VAR
561 HREF="actions-file.html#FILTER"
588 > The log file to use
595 >File name, relative to <VAR
604 >logfile (Unix) <SPAN
610 > privoxy.log (Windows)</P
613 >Effect if unset:</DT
616 > No log file is used, all log messages go to the console (<VAR
626 > The logfile is where all logging and error messages are written. The level
627 of detail and number of messages are set with the <VAR
631 option (see below). The logfile can be useful for tracking down a problem with
635 > (e.g., it's not blocking an ad you
636 think it should block) but in most cases you probably will never look at it.
639 > Your logfile will grow indefinitely, and you will probably want to
640 periodically remove it. On Unix systems, you can do this with a cron job
644 >). For Red Hat, a <B
648 script has been included.
651 > On SuSE Linux systems, you can place a line like <SPAN
654 +1024k 644 nobody.nogroup"</SPAN
659 the effect that cron.daily will automatically archive, gzip, and empty the
660 log, when it exceeds 1M size.
663 > Any log files must be writable by whatever user <SPAN
667 is being run as (default on UNIX, user id is <SPAN
693 > The file to store intercepted cookies in
700 >File name, relative to <VAR
709 >jarfile (Unix) <SPAN
715 > privoxy.jar (Windows)</P
718 >Effect if unset:</DT
721 > Intercepted cookies are not stored at all.
728 > The jarfile may grow to ridiculous sizes over time.
751 > The trust file to use
758 >File name, relative to <VAR
771 >Unset (commented out)</I
773 >. When activated: trust (Unix) <SPAN
779 > trust.txt (Windows)</P
782 >Effect if unset:</DT
785 > The entire trust mechanism is turned off.
792 > The trust mechanism is an experimental feature for building white-lists and should
793 be used with care. It is <SPAN
799 > recommended for the casual user.
802 > If you specify a trust file, <SPAN
806 access to sites that are specified in the trustfile. Sites can be listed
813 > character limits access to this site
814 only (and any sub-paths within this site), e.g.
817 >~www.example.com</VAR
821 > Or, you can designate sites as <SPAN
825 >trusted referrers</I
828 prepending the name with a <VAR
831 > character. The effect is that
832 access to untrusted sites will be granted -- but only if a link from this
833 trusted referrer was used. The link target will then be added to the
837 > so that future, direct accesses will be granted.
838 Sites added via this mechanism do not become trusted referrers themselves
839 (i.e. they are added with a <VAR
845 > If you use the <VAR
848 > operator in the trust file, it may grow
849 considerably over time.
852 > It is recommended that <SPAN
858 >--disable-force</VAR
861 >--disable-toggle</VAR
865 > --disable-editor</VAR
866 > options, if this feature is to be
870 > Possible applications include limiting Internet access for children.
883 >7.2. Local Set-up Documentation</A
886 > If you intend to operate <SPAN
890 than just yourself, it might be a good idea to let them know how to reach
891 you, what you block and why you do that, your policies, etc.
899 >7.2.1. user-manual</A
910 > Location of the <SPAN
920 >A fully qualified URI</P
935 >Effect if unset:</DT
939 HREF="http://www.privoxy.org/user-manual/"
941 >http://www.privoxy.org/<VAR
946 will be used, where <VAR
959 > The User Manual URI is used for help links from some of the internal CGI pages.
960 The manual itself is normally packaged with the binary distributions, so you probably want
961 to set this to a locally installed copy. For multi-user setups, you could provide a copy on
962 a local webserver for all your users and use the corresponding URL here.
968 > Unix, in local filesystem:
979 >  user-manual  file:///usr/share/doc/privoxy-3.0.3/user-manual/</PRE
986 > Windows, in local filesystem, <SPAN
992 > use forward slash notation:
1003 >  user-manual  file:/c:/some-dir/privoxy-3.0.3/user-manual/</PRE
1010 > Windows, UNC notation (with forward slashes):
1021 >  user-manual  file://///some-server/some-path/privoxy-3.0.3/user-manual/</PRE
1028 > Any platform, on local webserver (called <SPAN
1030 >"local-webserver"</SPAN
1042 >  user-manual  http://local-webserver/privoxy-user-manual/</PRE
1067 > If set, this option should be <SPAN
1071 >the first option in the config
1074 >, because it is used while the config file is being read.
1089 NAME="TRUST-INFO-URL"
1090 >7.2.2. trust-info-url</A
1095 CLASS="VARIABLELIST"
1101 > A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
1114 >Two example URL are provided</P
1117 >Effect if unset:</DT
1120 > No links are displayed on the "untrusted" error page.
1127 > The value of this option only matters if the experimental trust mechanism has been
1129 HREF="config.html#TRUSTFILE"
1140 > If you use the trust mechanism, it is a good idea to write up some on-line
1141 documentation about your trust policy and to specify the URL(s) here.
1142 Use multiple times for multiple URLs.
1145 > The URL(s) should be added to the trustfile as well, so users don't end up
1146 locked out from the information on why they were locked out in the first place!
1157 NAME="ADMIN-ADDRESS"
1158 >7.2.3. admin-address</A
1163 CLASS="VARIABLELIST"
1169 > An email address to reach the proxy administrator.
1191 >Effect if unset:</DT
1194 > No email address is displayed on error pages and the CGI user interface.
1206 >proxy-info-url</VAR
1208 are unset, the whole "Local Privoxy Support" box on all generated pages will
1220 NAME="PROXY-INFO-URL"
1221 >7.2.4. proxy-info-url</A
1226 CLASS="VARIABLELIST"
1232 > A URL to documentation about the local <SPAN
1236 configuration or policies.
1258 >Effect if unset:</DT
1261 > No link to local documentation is displayed on error pages and the CGI user interface.
1273 >proxy-info-url</VAR
1275 are unset, the whole "Local Privoxy Support" box on all generated pages will
1279 > This URL shouldn't be blocked ;-)
1295 > These options are mainly useful when tracing a problem.
1296 Note that you might also want to invoke
1304 command line option when debugging.
1317 CLASS="VARIABLELIST"
1323 > Key values that determine what information gets logged to the
1325 HREF="config.html#LOGFILE"
1346 >12289 (i.e.: URLs plus informational and warning messages)</P
1349 >Effect if unset:</DT
1352 > Nothing gets logged.
1359 > The available debug levels are:
1369 CLASS="PROGRAMLISTING"
1370 > debug 1 # show each GET/POST/CONNECT request
1371 debug 2 # show each connection status
1372 debug 4 # show I/O status
1373 debug 8 # show header parsing
1374 debug 16 # log all data into the logfile
1375 debug 32 # debug force feature
1376 debug 64 # debug regular expression filter
1377 debug 128 # debug fast redirects
1378 debug 256 # debug GIF de-animation
1379 debug 512 # Common Log Format
1380 debug 1024 # debug kill pop-ups
1381 debug 2048 # CGI user interface
1382 debug 4096 # Startup banner and warnings.
1383 debug 8192 # Non-fatal errors</PRE
1390 > To select multiple debug levels, you can either add them or use
1397 > A debug level of 1 is informative because it will show you each request
1398 as it happens. <SPAN
1402 >1, 4096 and 8192 are highly recommended</I
1405 so that you will notice when things go wrong. The other levels are probably
1406 only of interest if you are hunting down a specific problem. They can produce
1407 a hell of an output (especially 16).
1411 > The reporting of <SPAN
1417 > errors (i.e. ones which crash
1421 >) is always on and cannot be disabled.
1424 > If you want to use CLF (Common Log Format), you should set <SPAN
1434 > and not enable anything else.
1445 NAME="SINGLE-THREADED"
1446 >7.3.2. single-threaded</A
1451 CLASS="VARIABLELIST"
1457 > Whether to run only one server thread
1485 >Effect if unset:</DT
1488 > Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1489 serve multiple requests simultaneously.
1496 > This option is only there for debug purposes and you should never
1497 need to use it. <SPAN
1501 >It will drastically reduce performance.</I
1515 NAME="ACCESS-CONTROL"
1516 >7.4. Access Control and Security</A
1519 > This section of the config file controls the security-relevant aspects
1530 NAME="LISTEN-ADDRESS"
1531 >7.4.1. listen-address</A
1536 CLASS="VARIABLELIST"
1542 > The IP address and TCP port on which <SPAN
1546 listen for client requests.
1568 >Effect if unset:</DT
1571 > Bind to 127.0.0.1 (localhost), port 8118. This is suitable and recommended for
1572 home users who run <SPAN
1575 > on the same machine as
1583 > You will need to configure your browser(s) to this proxy address and port.
1586 > If you already have another service running on port 8118, or if you want to
1587 serve requests from other machines (e.g. on your local network) as well, you
1588 will need to override the default.
1591 > If you leave out the IP address, <SPAN
1595 bind to all interfaces (addresses) on your machine and may become reachable
1596 from the Internet. In that case, consider using <A
1597 HREF="config.html#ACLS"
1598 >access control lists</A
1599 > (ACL's, see below), and/or
1606 > to untrusted users, you will
1607 also want to turn off the <VAR
1610 HREF="config.html#ENABLE-EDIT-ACTIONS"
1611 >enable-edit-actions</A
1617 HREF="config.html#ENABLE-REMOTE-TOGGLE"
1618 >enable-remote-toggle</A
1628 > Suppose you are running <SPAN
1632 a machine which has the address 192.168.0.1 on your local private network
1633 (192.168.0.0) and has another outside connection with a different address.
1634 You want it to serve requests from inside only:
1644 CLASS="PROGRAMLISTING"
1645 > listen-address 192.168.0.1:8118</PRE
1666 CLASS="VARIABLELIST"
1672 > Initial state of "toggle" status
1688 >Effect if unset:</DT
1691 > Act as if toggled on
1698 > If set to 0, <SPAN
1704 >"toggled off"</SPAN
1705 > mode, i.e. behave like a normal, content-neutral
1706 proxy where all ad blocking, filtering, etc are disabled. See
1709 >enable-remote-toggle</VAR
1710 > below. This is not really useful
1711 anymore, since toggling is much easier via <A
1712 HREF="http://config.privoxy.org/toggle"
1714 >the web interface</A
1722 > The windows version will only display the toggle icon in the system tray
1723 if this option is present.
1734 NAME="ENABLE-REMOTE-TOGGLE"
1735 >7.4.3. enable-remote-toggle</A
1740 CLASS="VARIABLELIST"
1746 > Whether or not the <A
1747 HREF="http://config.privoxy.org/toggle"
1767 >Effect if unset:</DT
1770 > The web-based toggle feature is disabled.
1777 > When toggled off, <SPAN
1780 > acts like a normal,
1781 content-neutral proxy, i.e. it acts as if none of the actions applied to
1785 > For the time being, access to the toggle feature can <SPAN
1792 controlled separately by <SPAN
1795 > or HTTP authentication,
1796 so that everybody who can access <SPAN
1805 >listen-address</VAR
1807 toggle it for all users. So this option is <SPAN
1814 for multi-user environments with untrusted users.
1817 > Note that you must have compiled <SPAN
1821 support for this feature, otherwise this option has no effect.
1832 NAME="ENABLE-EDIT-ACTIONS"
1833 >7.4.4. enable-edit-actions</A
1838 CLASS="VARIABLELIST"
1844 > Whether or not the <A
1845 HREF="http://config.privoxy.org/show-status"
1865 >Effect if unset:</DT
1868 > The web-based actions file editor is disabled.
1875 > For the time being, access to the editor can <SPAN
1882 controlled separately by <SPAN
1885 > or HTTP authentication,
1886 so that everybody who can access <SPAN
1895 >listen-address</VAR
1897 modify its configuration for all users. So this option is <SPAN
1904 > for multi-user environments with untrusted users.
1907 > Note that you must have compiled <SPAN
1911 support for this feature, otherwise this option has no effect.
1923 >7.4.5. ACLs: permit-access and deny-access</A
1926 NAME="PERMIT-ACCESS"
1934 CLASS="VARIABLELIST"
1940 > Who can access what.
1970 > are IP addresses in dotted decimal notation or valid
1978 > are subnet masks in CIDR notation, i.e. integer
1979 values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
1980 destination part are optional.
1996 >Effect if unset:</DT
1999 > Don't restrict access further than implied by <VAR
2001 >listen-address</VAR
2009 > Access controls are included at the request of ISPs and systems
2010 administrators, and <SPAN
2014 >are not usually needed by individual users</I
2017 For a typical home user, it will normally suffice to ensure that
2021 > only listens on the localhost
2022 (127.0.0.1) or internal (home) network address by means of the
2024 HREF="config.html#LISTEN-ADDRESS"
2036 > Please see the warnings in the FAQ that this proxy is not intended to be a substitute
2037 for a firewall or to encourage anyone to defer addressing basic security
2041 > Multiple ACL lines are OK.
2042 If any ACLs are specified, then the <SPAN
2046 talks only to IP addresses that match at least one <VAR
2050 and don't match any subsequent <VAR
2053 > line. In other words, the
2054 last match wins, with the default being <VAR
2063 > is using a forwarder (see <VAR
2067 for a particular destination URL, the <VAR
2071 that is examined is the address of the forwarder and <SPAN
2078 of the ultimate target. This is necessary because it may be impossible for the local
2082 > to determine the IP address of the
2083 ultimate target (that's often what gateways are used for).
2086 > You should prefer using IP addresses over DNS names, because the address lookups take
2087 time. All DNS names must resolve! You can <SPAN
2093 > use domain patterns
2097 > or partial domain names. If a DNS name resolves to multiple
2098 IP addresses, only the first one is used.
2101 > Denying access to particular sites by ACL may have undesired side effects
2102 if the site in question is hosted on a machine which also hosts other sites.
2109 > Explicitly define the default behavior if no ACL and
2112 >listen-address</VAR
2117 is OK. The absence of a <VAR
2127 > destination addresses are OK:
2138 > permit-access localhost</PRE
2145 > Allow any host on the same class C subnet as www.privoxy.org access to
2146 nothing but www.example.com:
2157 > permit-access www.privoxy.org/24 www.example.com/32</PRE
2164 > Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
2165 with the exception that 192.168.45.73 may not access www.dirty-stuff.example.com:
2176 > permit-access 192.168.45.64/26
2177 deny-access 192.168.45.73 www.dirty-stuff.example.com</PRE
2193 >7.4.6. buffer-limit</A
2198 CLASS="VARIABLELIST"
2204 > Maximum size of the buffer for content filtering.
2220 >Effect if unset:</DT
2223 > Use a 4MB (4096 KB) limit.
2230 > For content filtering, i.e. the <VAR
2236 >+deanimate-gif</VAR
2237 > actions, it is necessary that
2241 > buffers the entire document body.
2242 This can be potentially dangerous, since a server could just keep sending
2243 data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
2247 > When a document buffer size reaches the <VAR
2251 flushed to the client unfiltered and no further attempt to
2252 filter the rest of the document is made. Remember that there may be multiple threads
2253 running, which might require up to <VAR
2263 >, unless you have enabled <SPAN
2265 >"single-threaded"</SPAN
2283 > This feature allows routing of HTTP requests through a chain of
2285 It can be used to better protect privacy and confidentiality when
2286 accessing specific domains by routing requests to those domains
2287 through an anonymous public proxy (see e.g. <A
2288 HREF="http://www.multiproxy.org/anon_list.htm"
2290 >http://www.multiproxy.org/anon_list.htm</A
2292 Or to use a caching proxy to speed up browsing. Or chaining to a parent
2293 proxy may be necessary because the machine that <SPAN
2297 runs on has no direct Internet access.</P
2299 > Also specified here are SOCKS proxies. <SPAN
2303 supports the SOCKS 4 and SOCKS 4A protocols.</P
2315 CLASS="VARIABLELIST"
2321 > To which parent HTTP proxy specific requests should be routed.
2330 >target_pattern</VAR
2343 >target_pattern</VAR
2345 HREF="actions-file.html#AF-PATTERNS"
2348 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <VAR
2363 is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
2364 optionally followed by its listening port (default: 8080).
2365 Use a single dot (<VAR
2370 >"no forwarding"</SPAN
2387 >Effect if unset:</DT
2390 > Don't use parent HTTP proxies.
2403 >, then requests are not
2404 forwarded to another HTTP proxy but are made directly to the web servers.
2407 > Multiple lines are OK, they are checked in sequence, and the last match wins.
2414 > Everything goes to an example anonymizing proxy, except SSL on port 443 (which it doesn't handle):
2425 > forward / anon-proxy.example.org:8080
2433 > Everything goes to our example ISP's caching proxy, except for requests
2434 to that ISP's sites:
2445 > forward / caching-proxy.example-isp.net:8000
2446 forward .example-isp.net .</PRE
2462 >7.5.2. forward-socks4 and forward-socks4a</A
2465 NAME="FORWARD-SOCKS4"
2468 NAME="FORWARD-SOCKS4A"
2473 CLASS="VARIABLELIST"
2479 > Through which SOCKS proxy (and to which parent HTTP proxy) specific requests should be routed.
2488 >target_pattern</VAR
2508 >target_pattern</VAR
2510 HREF="actions-file.html#AF-PATTERNS"
2513 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <VAR
2528 are IP addresses in dotted decimal notation or valid DNS names (<VAR
2537 >"no HTTP forwarding"</SPAN
2538 >), and the optional
2542 > parameters are TCP ports, i.e. integer values from 1 to 64535
2558 >Effect if unset:</DT
2561 > Don't use SOCKS proxies.
2568 > Multiple lines are OK, they are checked in sequence, and the last match wins.
2571 > The difference between <VAR
2573 >forward-socks4</VAR
2576 >forward-socks4a</VAR
2578 is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
2579 server, while in SOCKS 4 it happens locally.
2588 >, then requests are not
2589 forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
2597 > From the company example.com, direct connections are made to all
2601 > domains, but everything outbound goes through
2602 their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
2614 > forward-socks4a / socks-gw.example.com:1080 www-cache.example-isp.net:8080
2615 forward .example.com .</PRE
2622 > A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
2633 > forward-socks4 / socks-gw.example.com:1080 .</PRE
2648 NAME="ADVANCED-FORWARDING-EXAMPLES"
2649 >7.5.3. Advanced Forwarding Examples</A
2652 > If you have links to multiple ISPs that provide various special content
2653 only to their subscribers, you can configure multiple <SPAN
2657 which have connections to the respective ISPs to act as forwarders to each other, so that
2664 > users can see the internal content of all ISPs.</P
2666 > Assume that host-a has a PPP connection to isp-a.net. And host-b has a PPP connection to
2667 isp-b.net. Both run <SPAN
2671 configuration can look like this:</P
2684 forward .isp-b.net host-b:8118</PRE
2701 forward .isp-a.net host-a:8118</PRE
2707 > Now, your users can set their browser's proxy to use either
2708 host-a or host-b and be able to browse the internal content
2709 of both isp-a and isp-b.</P
2711 > If you intend to chain <SPAN
2718 > locally, then chain as
2721 >browser -> squid -> privoxy</VAR
2722 > is the recommended way. </P
2724 > Assuming that <SPAN
2731 run on the same box, your <SPAN
2734 > configuration could then look like this:</P
2744 > # Define Privoxy as parent proxy (without ICP)
2745 cache_peer 127.0.0.1 parent 8118 7 no-query
2747 # Define ACL for protocol FTP
2750 # Do not forward FTP requests to Privoxy
2751 always_direct allow ftp
2753 # Forward all the rest to Privoxy
2754 never_direct allow all</PRE
2760 > You would then need to change your browser's proxy settings to <SPAN
2763 >'s address and port.
2764 Squid normally uses port 3128. If unsure consult <VAR
2772 > You could just as well decide to only forward requests for Windows executables through
2773 a virus-scanning parent proxy, say, on <VAR
2775 >antivir.example.com</VAR
2787 forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</PRE
2800 >7.6. Windows GUI Options</A
2806 > has a number of options specific to the
2807 Windows GUI interface:</P
2809 NAME="ACTIVITY-ANIMATION"
2814 >"activity-animation"</SPAN
2819 > icon will animate when
2823 > is active. To turn off, set to 0.</P
2828 CLASS="LITERALLAYOUT"
2833 >activity-animation 1</I
2836 </P
2846 >"log-messages"</SPAN
2851 > will log messages to the console
2857 CLASS="LITERALLAYOUT"
2865 </P
2870 NAME="LOG-BUFFER-SIZE"
2876 >"log-buffer-size"</SPAN
2877 > is set to 1, the size of the log buffer,
2878 i.e. the amount of memory used for the log messages displayed in the
2879 console window, will be limited to <SPAN
2881 >"log-max-lines"</SPAN
2884 > Warning: Setting this to 0 will result in the buffer to grow infinitely and
2885 eat up all your memory!</P
2890 CLASS="LITERALLAYOUT"
2895 >log-buffer-size 1</I
2898 </P
2903 NAME="LOG-MAX-LINES"
2908 >log-max-lines</SPAN
2909 > is the maximum number of lines held
2910 in the log buffer. See above.</P
2915 CLASS="LITERALLAYOUT"
2920 >log-max-lines 200</I
2923 </P
2928 NAME="LOG-HIGHLIGHT-MESSAGES"
2933 >"log-highlight-messages"</SPAN
2938 > will highlight portions of the log
2939 messages with a bold-faced font:</P
2944 CLASS="LITERALLAYOUT"
2949 >log-highlight-messages 1</I
2952 </P
2957 NAME="LOG-FONT-NAME"
2960 > The font used in the console window:</P
2965 CLASS="LITERALLAYOUT"
2970 >log-font-name Comic Sans MS</I
2973 </P
2978 NAME="LOG-FONT-SIZE"
2981 > Font size used in the console window:</P
2986 CLASS="LITERALLAYOUT"
2994 </P
2999 NAME="SHOW-ON-TASK-BAR"
3005 >"show-on-task-bar"</SPAN
3006 > controls whether or not
3010 > will appear as a button on the Task bar
3016 CLASS="LITERALLAYOUT"
3021 >show-on-task-bar 0</I
3024 </P
3029 NAME="CLOSE-BUTTON-MINIMIZES"
3034 >"close-button-minimizes"</SPAN
3035 > is set to 1, the Windows close
3036 button will minimize <SPAN
3039 > instead of closing
3040 the program (close with the exit option on the File menu).</P
3045 CLASS="LITERALLAYOUT"
3050 >close-button-minimizes 1</I
3053 </P
3063 >"hide-console"</SPAN
3064 > option is specific to the MS-Win console
3068 >. If this option is used,
3072 > will disconnect from and hide the
3078 CLASS="LITERALLAYOUT"
3086 </P
3097 SUMMARY="Footer navigation table"
3108 HREF="configuration.html"
3126 HREF="actions-file.html"