admin: New command SETIFNAME to change an interface's recorded name.

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

diff --git a/doc/tripe-admin.5.in b/doc/tripe-admin.5.in
index 4bd8144b31de139f21432296e7347d50467926a3..0d9e7b6641f2a7b9ac667731fab2cd2089abd0a9 100644 (file)
--- a/doc/tripe-admin.5.in
+++ b/doc/tripe-admin.5.in
@@ -425,6 +425,15 @@ or
 if the server has or hasn't (respectively) become a daemon.
 .RE
 .SP
+.BI "SETIFNAME " peer " " new-name
+Informs the server that the
+.IR peer 's
+tunnel-interface name has been changed to
+.IR new-name .
+This is useful if firewalling decisions are made based on interface
+names: a setup script for a particular peer can change the name, and
+then update the server's records so that they're accurate.
+.SP
 .BI "STATS " peer
 Emits a number of
 .B INFO
@@ -647,6 +656,7 @@ was not recognised.
 .BR ADDR ,
 .BR IFNAME ,
 .BR KILL ,
+.BR SETIFNAME ,
 and
 .BR STATS .)
 There is no peer called
@@ -696,6 +706,17 @@ Key exchange with
 has begun or restarted.  If key exchange keeps failing, this message
 will be repeated periodically.
 .SP
+.BI "NEWIFNAME " peer " " old-name " " new-name
+The given
+.IR peer 's
+tunnel interface name has been changed from
+.I old-name
+to
+.IR new-name ,
+as a result of a
+.B SETIFNAME
+command.
+.SP
 .BI "USER " tokens\fR...
 An administration client issued a notification using the
 .B NOTIFY