comm clientinfo: site: Pass comm-info to comm

[secnet.git] / README

diff --git a/README b/README
index a01156c6d8a9491c12dfa7c946631c930d313f11..424f756ecf682d114c4e9fed8051cccaae2c3166 100644 (file)
--- a/README
+++ b/README
@@ -390,7 +390,7 @@ site: dict argument
     [half key-lifetime, or key-lifetime minus 5 mins (mobile: 12 hours),
      whichever is longer].
   keepalive (bool): if True then attempt always to keep a valid session key.
-    Not actually currently implemented. [false]
+    [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
@@ -444,6 +444,9 @@ site: dict argument
     should be reflected in the local private interface MTU, ie the mtu
     parameter to netlink).  If this parameter is not set, or is set
     to 0, the default is to use the local private link mtu.
+  comm-info (dict): Information for the comm, used when this site
+    wants to transmit.  If the comm does not support this, it is
+    ignored.  (Currently nothing uses this.)
 
 Links involving mobile peers have some different tuning parameter
 default values, which are generally more aggressive about retrying key