Final docs tweaks.

[tripe] / doc / tripe-admin.5

diff --git a/doc/tripe-admin.5 b/doc/tripe-admin.5
index d39866e0a0de65093013f48351ee506f9cb131cf..9f434bdc9f3e7b6cf3be42248c0906635cb1cd2e 100644 (file)
--- a/doc/tripe-admin.5
+++ b/doc/tripe-admin.5
@@ -147,6 +147,11 @@ For each currently-known peer, an
 line is written containing the peer's name, as given to
 .BR ADD .
 .TP
 line is written containing the peer's name, as given to
 .BR ADD .
 .TP

+.BI "NOTIFY " tokens\fR...
+Issues a 
+.B USER
+notification to all interested administration clients.
+.TP

 .B "PORT"
 Emits an
 .B INFO
 .B "PORT"
 Emits an
 .B INFO


@@ -284,6 +289,11 @@ line stating its software version, as two words: the server name, and
 its version string.  The server name
 .B tripe
 is reserved to the Straylight/Edgeware implementation.
 its version string.  The server name
 .B tripe
 is reserved to the Straylight/Edgeware implementation.

+.TP
+.BI "WARN " tokens\fR...
+Issues a 
+.B USER
+warning to all interested administration clients.

 .SH "ERROR MESSAGES"
 The following
 .B FAIL
 .SH "ERROR MESSAGES"
 The following
 .B FAIL


@@ -399,6 +409,11 @@ Key exchange with
 .I peer
 has begun or restarted.  If key exchange keeps failing, this message
 will be repeated periodically.
 .I peer
 has begun or restarted.  If key exchange keeps failing, this message
 will be repeated periodically.

+.TP
+.BI "USER " tokens\fR...
+An administration client issued a notification using the
+.B NOTIFY
+command.

 .SH "WARNINGS"
 There are many possible warnings.  They are categorized according to
 their first tokens.
 .SH "WARNINGS"
 There are many possible warnings.  They are categorized according to
 their first tokens.


@@ -504,7 +519,7 @@ persuade your
 .B tripe
 server to leak private key information.  No chance!
 .TP
 .B tripe
 server to leak private key information.  No chance!
 .TP

-.BI "KX " peer " decrypt-failed \fR[\fBreply\fR|\fBswitch-ok\fR]"
+.BI "KX " peer " decrypt-failed reply\fR|\fBswitch-ok"

 A symmetrically-encrypted portion of a key-exchange message failed to
 decrypt.
 .TP
 A symmetrically-encrypted portion of a key-exchange message failed to
 decrypt.
 .TP


@@ -512,7 +527,7 @@ decrypt.
 A key-exchange message was malformed.  This almost certainly indicates a
 bug somewhere.
 .TP
 A key-exchange message was malformed.  This almost certainly indicates a
 bug somewhere.
 .TP

-.BI "KX " peer " incorrect \fR[\fBcookie\fR|\fBswitch-rq\fR|\fBswitch-ok\fR]"
+.BI "KX " peer " incorrect cookie\fR|\fBswitch-rq\fR|\fBswitch-ok"

 A message didn't contain the right magic data.  This may be a replay of
 some old exchange, or random packets being sent in an attempt to waste
 CPU.
 A message didn't contain the right magic data.  This may be a replay of
 some old exchange, or random packets being sent in an attempt to waste
 CPU.


@@ -661,6 +676,13 @@ and shouldn't be used any more.
 .BI "TUN \- unet ifname-too-long \-\- " message
 The Unet interface's name overflowed, so we couldn't read it properly.
 Unet is obsolete and shouldn't be used any more.
 .BI "TUN \- unet ifname-too-long \-\- " message
 The Unet interface's name overflowed, so we couldn't read it properly.
 Unet is obsolete and shouldn't be used any more.

+.SS "USER warnings"
+These are issued by administration clients using the
+.B WARN
+command.
+.TP
+.BI "USER " tokens\fR...
+An administration client issued a warning.

 .SH "SEE ALSO"
 .BR tripectl (1),
 .BR tripe (8).
 .SH "SEE ALSO"
 .BR tripectl (1),
 .BR tripe (8).