New peer option `-mobile': follow rapid IP address and port changes.

[tripe] / server / tripe-admin.5.in

diff --git a/server/tripe-admin.5.in b/server/tripe-admin.5.in
index ddfc63f..5b0fe3b 100644 (file)
--- a/server/tripe-admin.5.in
+++ b/server/tripe-admin.5.in
@@ -262,7 +262,7 @@ permitted; if omitted, the default port 4070 is used.  Name resolution
 does not block the main server, but will block the requesting client,
 unless the command is run in the background.
 .PP
-If, on input, no recognised address family token is found, the following
+If, on input, no recognized address family token is found, the following
 tokens are assumed to represent an
 .B INET
 address.  Addresses output by the server always have an address family
@@ -321,7 +321,7 @@ the peer's public key is assumed to be in the file
 option on the command line).  The
 .I address
 is the network address (see above for the format) at which the peer can
-be contacted.  The following options are recognised.
+be contacted.  The following options are recognized.
 .RS
 .\"+opts
 .TP
@@ -348,6 +348,22 @@ or
 for days, hours, minutes, or seconds respectively; if no suffix is
 given, seconds are assumed.
 .TP
+.BI "\-key " tag
+Use the public key
+.I tag
+to authenticate the peer.  The default is to use the key tagged
+.IR peer .
+.TP
+.B "\-mobile"
+The peer is a mobile device, and is likely to change address rapidly.
+If a packet arrives from an unknown address, the server's usual response
+is to log a warning and discard it.  If the server knows of any mobile
+peers, however, it will attempt to decrypt the packet using their keys,
+and if one succeeds, the server will update its idea of the peer's
+address and emit an
+.B NEWADDR
+notification.
+.TP
 .BI "\-tunnel " tunnel
 Use the named tunnel driver, rather than the default.
 .\"-opts
@@ -523,6 +539,12 @@ The tunnel driver used for this peer.
 .B keepalive
 The keepalive interval, in seconds, or zero if no keepalives are to be
 sent.
+.TP
+.B key
+The key tag being used for the peer, as passed to the
+.B ADD
+command.  (You don't get a full key-id, since that might change while
+the daemon's running.)
 .RE
 .SP
 .BI "PING \fR[" options "\fR] " peer
@@ -980,7 +1002,18 @@ is already the tag of an outstanding job.
 .BI "unknown-command " token
 The command
 .I token
-was not recognised.
+was not recognized.
+.SP
+.BI "unknown-jobid " jobid
+(For
+.BR SVCOK ,
+.BR SVCFAIL ,
+and
+.BR SVCINFO .)
+The token
+.I jobid
+is not recognized as identifying an outstanding job.  It may have just
+been cancelled.
 .SP
 .BI "unknown-peer " name
 (For
@@ -1059,6 +1092,12 @@ Key exchange with
 has begun or restarted.  If key exchange keeps failing, this message
 will be repeated periodically.
 .SP
+.BI "NEWADDR " peer " " address
+The given mobile
+.IR peer 's
+IP address has been changed to
+.IR address .
+.SP
 .BI "NEWIFNAME " peer " " old-name " " new-name
 The given
 .IR peer 's
@@ -1413,6 +1452,9 @@ Configuring the Linux TUN/TAP interface failed.
 .BI "TUN " ifname " " tun-name " read-error " ecode " " message
 Reading from the tunnel device failed.
 .SP
+.BI "TUN " ifname " " tun-name " write-error " ecode " " message
+Writing from the tunnel device failed.
+.SP
 .BI "TUN " ifname " slip bad-escape"
 The SLIP driver encountered a escaped byte it wasn't expecting to see.
 The erroneous packet will be ignored.