Keepalives: Document that they're unimplemented; remove vestigial code

[secnet.git] / README

diff --git a/README b/README
index 564b216ce6d57a9a221d9e33f14837677852c58d..73679c2acd3695fd0a4377ffa4c685736cccaca2 100644 (file)
--- a/README
+++ b/README
@@ -290,7 +290,8 @@ site: dict argument
     allowing another attempt [20000]
   renegotiate-time (integer): if we see traffic on the link after this time
     then renegotiate another session key immediately [depends on key-lifetime]
-  keepalive (bool): if True then attempt always to keep a valid session key
+  keepalive (bool): if True then attempt always to keep a valid session key.
+    Not actually currently implemented. [false]
   log-events (string list): types of events to log for this site
     unexpected: unexpected key setup packets (may be late retransmissions)
     setup-init: start of attempt to setup a session key
@@ -317,8 +318,8 @@ Defines:
 null-netlink: dict argument
   name (string): name for netlink device, used in log messages
   networks (string list): networks on the host side of the netlink device
-  exclude-remote-networks (string list): networks that may never be claimed
-    by any remote site using this netlink device
+  remote-networks (string list): networks that may be claimed
+    by the remote site using this netlink device
   local-address (string): IP address of host's tunnel interface
   secnet-address (string): IP address of this netlink device
   ptp-address (string): IP address of the other end of a point-to-point link
@@ -336,7 +337,7 @@ a netlink closure:
   options (string list):
     allow-route: allow packets coming from this tunnel to be routed to
       other tunnels as well as the host (used for mobile devices like laptops)
-    soft-route: remove these routes from the host's routing table when
+    soft: remove these routes from the host's routing table when
       the tunnel link quality is zero
   mtu (integer): default MTU over this link; may be updated by tunnel code