rework IPv6 address dump logic
[project/odhcpd.git] / README
diff --git a/README b/README
index 58085e3..ebb2d99 100644 (file)
--- a/README
+++ b/README
@@ -34,7 +34,7 @@ prefix delegation and can be used to relay RA, DHCPv6 and NDP between routed
 3. DHCPv4-support
    server: stateless and stateful mode
 
-4. Proxy for Neighbor Discovery messages (solicitations and advertisments)
+4. Proxy for Neighbor Discovery messages (solicitations and advertisements)
    a) support for auto-learning routes to the local routing table
    b) support for marking interfaces "external" not proxying NDP for them
       and only serving NDP for DAD and for traffic to the router itself
@@ -62,6 +62,7 @@ legacy                bool    0                       Enable DHCPv4 if start but
                                                no dhcpv4 option set
 leasefile      string                          DHCP/v6 lease/hostfile
 leasetrigger   string                          Lease trigger script
+loglevel       integer 6                       Syslog level priority (0-7)
 
 
 Sections of type dhcp (configure DHCP / DHCPv6 / RA / NDP service)
@@ -70,7 +71,9 @@ Option                Type    Default                 Description
 interface      string  <name of UCI section>   logical OpenWrt interface
 ifname         string  <resolved from logical> physical network interface
 networkid      string  same as ifname          compat. alias for ifname
-ignore         bool    0                       ignore this interface
+ignore         bool    0                       do not serve this interface
+                                               unless overridden by ra, ndp,
+                                               dhcpv4 or dhcpv6 options
 master         bool    0                       is a master interface
                                                for relaying
 
@@ -85,6 +88,8 @@ ndp           string  disabled                Neighbor Discovery Proxy
 
 dynamicdhcp    bool    1                       dynamically create leases
                                                for DHCPv4 and DHCPv6
+router          list    <local address>         Routers to announce
+                                                accepts IPv4 only
 dns            list    <local address>         DNS servers to announce
                                                accepts IPv4 and IPv6
 domain         list    <local search domain>   Search domains to announce
@@ -100,16 +105,25 @@ ra_management     integer 1                       RA management mode
 ra_offlink     bool    0                       Announce prefixes off-link
 ra_preference  string  medium                  Route(r) preference
                [medium|high|low]
+ra_maxinterval integer 600                     Maximum time allowed between
+                                               sending unsolicited RA
+ra_mininterval integer 200                     Minimum time allowed between
+                                               sending unsolicited RA
+ra_lifetime    integer 1800                    Value to be placed in Router
+                                               Lifetime field of RA
+ra_useleasetime        bool    0                       Use configured leasetime as
+                                               limit for the preferred and
+                                               valid lifetime of a prefix
 ndproxy_routing        bool    1                       Learn routes from NDP
 ndproxy_slave  bool    0                       NDProxy external slave
-ndproxy_static list                            Static NDProxy prefixes
 
 
-Sections of type lease (static leases)
+Sections of type host (static leases)
 Option         Type    Default                 Description
 ip             string                          IP-Address to lease
 mac            string                          MAC-address
 duid           string                          DUID in base16
 hostid         string                          IPv6 host identifier
-hostname       string                          Hostname
+name           string                          Hostname
+leasetime      string                          DHCPv4/v6 leasetime