1
--- deadwood-2.9.07/doc/Deadwood.ej 2010-09-08 21:54:51.000000000 -0700
2
+++ deadwood-3.0.01/doc/Deadwood.ej 2010-09-23 10:09:50.000000000 -0700
4
<h1>COMMAND LINE ARGUMENTS</h1>
6
Deadwood has a single optional command line argument: The location
7
-of the configuration file that Deadwood uses specified with the "-f" flag.
8
+of the configuration file that Deadwood uses, specified with the "-f" flag.
9
If this is not defined, Deadwood uses the file "/etc/dwood3rc" as the
13
the cache in a subdirectory). All other symbols become a '_'
18
+This file is read and written as the user Deadwood runs as.
21
This is the directory the program will run from.
24
value is not used on Windows systems.
27
-Whether resource record rotation is enabled. This this has a value
28
+Whether resource record rotation is enabled. If this has a value
29
of 1, resource record rotation is enabled, otherwise resource record
34
Resource record rotation is usually desirable, since it allows DNS to
35
act like a crude load balancer. However, on heavily loaded systems it
36
-may be desirable to disable to disbale it to reduce CPU usage.
37
+may be desirable to disable it to reduce CPU usage.
42
cache to disk or reading the cache from disk, higher values of
43
this will slow down cache reading/writing.
47
+The amount of memory each cache entry uses is variable depending on the
48
+operating system used and the size of memory allocation pages assigned.
49
+In Windows XP, for example, each entry uses approximately four kilobytes
50
+of memory and Deadwood has an overhead of approximately 512 kilobytes.
51
+So, if there are 512 cache elements, Deadwood uses approximately 2.5
52
+megabytes of memory, and if there are 1024 cache elements, Deadwood uses
53
+approximately 4.5 megabytes of memory. Again, these numbers are for
54
+Windows XP and other operating systems will have different memory allocation
58
This is the maximum number of pending remote UDP connections
59
Deadwood can have. The default value for this is 32.
61
scale, it may eventually become possible to make this have a value of
64
-The default value is 1: An A (IPv4 IP) record.
65
+The default value is 1: An A (IPv4 IP) record. This parameter has <b>not</b>
66
+been tested; use at your own risk.
68
<h2>random_seed_file</h2>
69
This is a file that contains random numbers, and
73
<h2>recursive_acl</h2>
74
-This is a list of who is allowed to use the
75
-load balancer, in "ip/mask" format. Mask must be a number between
76
+This is a list of who is allowed to use Deadwood to perform DNS recursion,
77
+in "ip/mask" format. Mask must be a number between
78
0 and 32 (for IPv6, between 0 and 128). For example, "127.0.0.1/8"
79
allows local connections.
83
<h2>upstream_port</h2>
84
This is the port Deadwood uses to connect or send packets to the
85
-upstream server. The default value for this is 53; the standard
86
+upstream servers. The default value for this is 53; the standard
89
<h2>upstream_servers</h2>
91
values log more messages. The default value for this is 3.
93
<h1>ip/mask format of IPs</h1>
94
-Deadwood uses both standard ip/netmask formats to specify IPs.
95
+Deadwood uses a standard ip/netmask formats to specify IPs.
96
An ip is in dotted-decimal format, e.g. "10.1.2.3" (or in ipv6
97
format when ipv6 support is compiled in).
100
The netmask is used to specify a range of IPs.
101
-The netmask can be in one of two formats: A single number between
102
+The netmask is a single number between
103
1 and 32 (128 when ipv6 support is compiled in), which indicates the
104
-number of leading "1" bits in the netmask, or a 4-digit
105
-dotted-decimal netmask.
106
+number of leading "1" bits in the netmask.
109
<b>10.1.1.1/24</b> indicates that any ip from 10.1.1.0 to 10.1.1.255
113
-<b>10.1.1.1/255.255.255.0</b> is identical to 10.1.1.1/24
116
<b>10.2.3.4/16</b> indicates that any ip from 10.2.0.0 to 10.2.255.255
120
-<b>10.2.3.4/255.255.0.0</b> is identical to 10.2.3.4/16
123
<b>127.0.0.0/8</b> indicates that any ip with "127" as the first
124
octet (number) will match.
127
-<b>127.0.0.0/255.0.0.0</b> is identical to 127.0.0.0/8
130
The netmask is optional, and, if not present, indicates that only
131
a single IP will match.