Update license headers

[odhcp6c.git] / README

diff --git a/README b/README
index 4af083568ea440f9841e50129ea184881441dfd0..b35425a03a39dd4a4228e4a706c666a1b52759c3 100644 (file)
--- a/README
+++ b/README
@@ -3,7 +3,7 @@ odhcp6c - Embedded DHCPv6 Client
 
 ** Abstract **
 
-odhcp6c is a minimalistic DHCPv6 client for use in embedded Linux systems.
+odhcp6c is a minimal DHCPv6 and RA-client for use in embedded Linux systems.
 
 
 ** Features **
@@ -20,6 +20,9 @@ odhcp6c is a minimalistic DHCPv6 client for use in embedded Linux systems.
 
 4. State script support
 
+5. Support for requesting and parsing Router Advertisements
+       a) parsing of prefixes, routes, MTU and RDNSS options
+
 
 ** Compiling **
 
@@ -36,21 +39,33 @@ The script is called with the following parameters: <interface> <state>
 
 
 States:
+* started              The DHCPv6 client has been started
 * bound                        A suitable server was found and addresses or prefixes acquired          
 * informed             A stateless information request returned updated information
-* timeout              The DHCPv6 operation did not succeed within the defined time
 * updated              Updated information was received from the DHCPv6 server
+* ra-updated   Updated information was received from via Router Advertisement
 * rebound              The DHCPv6 client switched to another server
 * unbound              The DHCPv6 client lost all DHCPv6 servers and will restart
+* stopped              The DHCPv6 client has been stopped
 
 
 Environment:
 * RDNSS                        A space-separated list of recursive DNS servers
 * DOMAINS              A space-separated list of DNS search domains
+* SNTP_IP              A space-separated list of SNTP server IP addresses
+* SNTP_FQDN            A space-separated list of SNTP server FQDNs
+* SIP_IP               A space-separated list of SIP servers
+* SIP_DOMAIN           A space-separated list of SIP domains
 * OPTION_<num> Custom option received as base-16
 * PREFIXES             A space-separated list of prefixes currently assigned
                                Format: <prefix>/<length>,preferred,valid
-* PREFIXES_LOST        A space-separated list of prefixes lost since last update
+* ADDRESSES            A space-separated list of addresses currently assigned
+                               Format: <address>/<length>,preferred,valid
+* RA_ADDRESSES A space-separated list of addresses from RA-prefixes
+                               Format: <address>/<length>,preferred,valid
+* RA_ROUTES            A space-separated list of routes from the RA
+                               Format: <address>/<length>,gateway,valid,metric
+* RA_DNS               A space-separated list of recursive DNS servers from the RA