.SH "COMMAND REFERENCE"
The commands provided are:
.TP
-.BI "ADD " peer " " address\fR...
+.BI "ADD " peer " \fR[" options "\fR] " address "\fR..."
Adds a new peer. The peer is given the name
.IR peer ;
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.
+be contacted. The following options are recognised.
+.RS
+.TP
+.BI "-tunnel " tunnel
+Use the named tunnel driver, rather than the default.
+.RE
.TP
.BI "ADDR " peer
Emits an
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
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 "NOTIFICATIONS"
The following notifications are sent to clients who request them.
.TP
-.BI "ADD " peer " " address \fR...
+.BI "ADD " peer " " ifname " " address \fR...
A new peer has been added. The peer's name is
-.I peer
+.IR peer ,
+its tunnel is network interface
+.IR ifname ,
and its network address is
.IR address .
.TP
.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.
.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 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.
.I device
failed.
.TP
+.BI "TUN \- linux config-error \-\- " message
+Configuring the Linux TUN/TAP interface failed.
+.TP
.BI "TUN " ifname " read-error \-\- " message
Reading from the tunnel device failed.
.TP
-.BI "TUN \- linux config-error \-\- " message
-Configuring the Linux TUN/TAP interface failed.
+.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.
+.TP
+.BI "TUN " ifname " slip eof"
+The SLIP driver encountered end-of-file on its input descriptor.
+Pending data is discarded, and no attempt is made to read any more data
+from that interface ever.
+.TP
+.BI "TUN " ifname " slip escape-end"
+The SLIP driver encountered an escaped `end' marker. This probably
+means that someone's been sending it junk. The erroneous packet is
+discarded, and we hope that we've rediscovered synchronization.
+.TP
+.BI "TUN \- slip fork-error \-\- " message
+The SLIP driver encountered an error forking a child process while
+allocating a new dynamic interface.
+.TP
+.BI "TUN \- slip no-slip-interfaces"
+The driver ran out of static SLIP interfaces. Either preallocate more,
+or use dynamic SLIP interface allocation.
+.TP
+.BI "TUN " ifname " slip overflow"
+The SLIP driver gave up reading a packet because it got too large.
+.TP
+.BI "TUN \- slip pipe-error \-\- " message
+The SLIP driver encountered an error creating pipes while allocating a
+new dynamic interface.
+.TP
+.BI "TUN \- slip read-ifname-failed \-\- " message
+The SLIP driver encountered an error reading the name of a dynamically
+allocated interface. Maybe the allocation script is broken.
.TP
.BI "TUN \- unet config-error \-\- " message
Configuring the Linux Unet interface failed. Unet is obsolete and
.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).
.PP
.IR "The Trivial IP Encryption Protocol" .
.SH "AUTHOR"
-Mark Wooding, <mdw@nsict.org>
+Mark Wooding, <mdw@distorted.org.uk>
~mdw / tripe / blobdiff