chiark / gitweb /
Correctly tokenize output to admin clients.
[tripe] / doc / tripe-admin.5
index 4afa6a9f54a4097f21fb16f42d05648895f6f3bb..5d07d69092b460d6aa77247efb85cc93c6d1c796 100644 (file)
@@ -554,11 +554,11 @@ The
 .B tripe
 server is already running as a daemon.
 .TP
-.BI "bad-addr-syntax \-\- " message
+.BI "bad-addr-syntax " message
 (For commands accepting socket addresses.)  The address couldn't be
 understood.
 .TP
-.BI "bad-syntax \-\- " message
+.BI "bad-syntax " cmd " " message
 (For any command.)  The command couldn't be understood: e.g., the number
 of arguments was wrong.
 .TP
@@ -584,7 +584,7 @@ An unknown trace option was requested.
 .BR WATCH .)
 An unknown watch option was requested.
 .TP
-.BI "daemon-error \-\- " message
+.BI "daemon-error " ecode " " message
 (For
 .BR DAEMON .)
 An error occurred during the attempt to become a daemon, as reported by
@@ -692,6 +692,22 @@ command.
 .SH "WARNINGS"
 There are many possible warnings.  They are categorized according to
 their first tokens.
+.PP
+Many of these warnings report system errors.  These are reported as a
+pair of tokens, described below as
+.I ecode
+and
+.IR message .
+The
+.I ecode
+is a string of the form
+.BI E number
+giving the
+.BR errno (3)
+value of the error; the
+.I message
+is the `human-readable' form of the message, as reported by
+.BR strerror (3).
 .SS "ABORT warnings"
 These all indicate that the
 .B tripe
@@ -704,11 +720,11 @@ it will probably waste all available CPU doing nothing.
 .SS "ADMIN warnings"
 These indicate a problem with the administration socket interface.
 .TP
-.BI "ADMIN accept-error \-\- " message
+.BI "ADMIN accept-error " ecode " " message
 There was an error while attempting to accept a connection from a new
 client.
 .TP
-.BI "ADMIN client-read-error \-\- " message
+.BI "ADMIN client-write-error " ecode " " message
 There was an error sending data to a client.  The connection to the
 client has been closed.
 .SS "CHAL warnings"
@@ -738,18 +754,18 @@ Challenge received was old, but maybe not actually a replay.  Try again.
 These indicate a problem with the keyring files, or the keys stored in
 them.
 .TP
-.BI "KEYMGMT bad-private-key \-\- " message
+.BI "KEYMGMT bad-private-key " message
 The private key could not be read, or failed a consistency check.  If
 there was a problem with the file, usually there will have been
 .B key-file-error
 warnings before this.
 .TP
-.BI "KEYMGMT bad-public-keyring \-\- " message
+.BI "KEYMGMT bad-public-keyring " message
 The public keyring couldn't be read.  Usually, there will have been 
 .B key-file-error
 warnings before this.
 .TP
-.BI "KEYMGMT key-file-error " file ":" line " \-\- " message
+.BI "KEYMGMT key-file-error " file ":" line " " message
 Reports a specific error with the named keyring file.  This probably
 indicates a bug in
 .BR key (1).
@@ -763,7 +779,7 @@ The algorithms specified on the public key don't match the ones for our
 private key.  All the peers in a network have to use the same
 algorithms.
 .TP
-.BI "KEYMGMT public-key " tag " bad \-\- " message
+.BI "KEYMGMT public-key " tag " bad " message
 The public key couldn't be read, or is invalid.
 .TP
 .BI "KEYMGMT public-key " tag " bad-public-group-element"
@@ -905,10 +921,10 @@ Either there's a bug, or the bad guys are playing tricks on you.
 There wasn't enough space in our buffer to put the packet we wanted to
 send.  Shouldn't happen.
 .TP
-.BI "PEER \- socket-read-error \-\- " message
+.BI "PEER \- socket-read-error " ecode " " message
 An error occurred trying to read an incoming packet.
 .TP
-.BI "PEER " peer " socket-write-error \-\- " message
+.BI "PEER " peer " socket-write-error " ecode " " message
 An error occurred attempting to send a network packet.  We lost that
 one.
 .TP
@@ -952,7 +968,7 @@ A client of the administration interface issued a
 .B QUIT
 command.
 .TP
-.BI "SERVER select-error \-\- " message
+.BI "SERVER select-error " ecode " " message
 An error occurred in the server's main event loop.  This is bad: if it
 happens too many times, the server will abort.
 .SS "SYMM warnings"
@@ -980,15 +996,15 @@ create some more
 .BI /dev/tun nn
 files, it will work.
 .TP
-.BI "TUN - open-error " device " \-\- " message
+.BI "TUN - " tun-name " open-error " device " " ecode " " message
 An attempt to open the tunnel device file
 .I device
 failed.
 .TP
-.BI "TUN \- linux config-error \-\- " message
+.BI "TUN \- linux config-error " ecode " " message
 Configuring the Linux TUN/TAP interface failed.
 .TP
-.BI "TUN " ifname " read-error \-\- " message
+.BI "TUN " ifname " " tun-name " read-error " ecode " " message
 Reading from the tunnel device failed.
 .TP
 .BI "TUN " ifname " slip bad-escape"
@@ -1005,7 +1021,7 @@ 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
+.BI "TUN \- slip fork-error " ecode " " message
 The SLIP driver encountered an error forking a child process while
 allocating a new dynamic interface.
 .TP
@@ -1016,23 +1032,23 @@ or use dynamic SLIP interface allocation.
 .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
+.BI "TUN \- slip pipe-error " ecode " " message
 The SLIP driver encountered an error creating pipes while allocating a
 new dynamic interface.
 .TP
-.BI "TUN \- slip read-ifname-failed \-\- " message
+.BI "TUN \- slip read-ifname-failed " ecode " " 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
+.BI "TUN \- unet config-error " ecode " " message
 Configuring the Linux Unet interface failed.  Unet is obsolete and
 shouldn't be used any more.
 .TP
-.BI "TUN \- unet getinfo-error \-\- " message
+.BI "TUN \- unet getinfo-error " ecode " " message
 Reading information about the Unet interface failed.  Unet is obsolete
 and shouldn't be used any more.
 .TP
-.BI "TUN \- unet ifname-too-long \-\- " message
+.BI "TUN \- unet ifname-too-long"
 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"