Tcl, or more advanced clients such as GUI monitors can be written in C
with little difficulty.
.PP
-By default, the server listens for admin connections on the Unix-domain
-socket
-.BR /var/lib/tripe/tripesock .
Administration commands use a textual protocol. Each client command or
server response consists of a line of ASCII text terminated by a single
linefeed character. No command may be longer than 255 characters.
commands and reply to them.
.PP
Responses to background commands are indicated by a line beginning with
-one of the tokens
+one of the tokens
.BR BGOK ,
.BR BGFAIL ,
or
.BR BGINFO ,
-followed by the command tag. These correspond to the
+followed by the command tag. These correspond to the
.BR OK ,
.BR FAIL ,
and
address is always in numeric dotted-quad form, and the port is given as
a plain number. On input, DNS hostnames and symbolic port names are
permitted. Name resolution does not block the main server, but will
-block the requesting client. This hopefully makes life simpler for
-stupid clients. Complex clients which don't wish to be held up can open
-extra connections or do the resolution themselves.)
+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
words are assumed to represent an
.B INET
-address.
+address. Addresses output by the server always have an address family
+token.
.SS "Key-value output"
Some commands (e.g.,
.B STATS
.B INFO
line, in a fixed-column format. Column zero contains the key letter for
selecting that message type; column one contains either a space or a
-.RB ` + '
+.RB ` + '
sign, if the message type is disabled or enabled respectively; and a
textual description of the message type begins at column 3 and continues
to the end of the line.
.B "DAEMON"
Causes the server to disassociate itself from its terminal and become a
background task. This only works once. A warning is issued.
-.TP
+.SP
.BI "EPING \fR[" options "\fR] " peer
Sends an encrypted ping to the peer, and expects an encrypted response.
This checks that the peer is running (and not being impersonated), and
line for each command it supports. Each line lists the command name,
followed by the names of the arguments. This may be helpful as a memory
aid for interactive use, or for program clients probing for features.
-.SP
+.SP
.BI "IFNAME " peer
Emits an
.B INFO
.BR ADD .
.SP
.BI "NOTIFY " tokens\fR...
-Issues a
+Issues a
.B USER
notification to all interested administration clients.
.SP
.RS
.TP
.BI "ping-ok " millis
-A response was received
+A response was received
.I millis
after the ping was sent.
.TP
.BI "\-timeout " time
Wait for
.I time
-seconds before giving up on a response. The default is 5 seconds. (The
-time format is the same as for the
-.B "ADD \-keepalive"
-option.)
+seconds before giving up on a response. The default is 5 seconds. The
+.I time
+is expressed as a nonnegative integer followed optionally by
+.BR d ,
+.BR h ,
+.BR m ,
+or
+.BR s
+for days, hours, minutes, or seconds respectively; if no suffix is
+given, seconds are assumed.
.\"-opts
.RE
.SP
.BR "service-exists" .
.SP
.BI "SVCENSURE " service " \fR[" version \fR]
-Ensure that
+Ensure that
.I service
is provided, and (if specified) to at least the given
.IR version .
.BR BGFAIL )
response to the service job with the given
.IR jobid ,
-passing the
+passing the
.I tokens
as the reason for failure. The job is closed.
.SP
.SP
.BR "TRACE " [\fIoptions\fP]
Selects trace outputs: see
-.B "Trace lists"
+.B "Trace lists"
above. Message types provided are:
.RS
.PP
Enables or disables asynchronous broadcasts
.IR "for the current connection only" .
See
-.B "Trace lists"
+.B "Trace lists"
above. The default watch state for the connection the server opens
automatically on stdin/stdout is to show warnings and trace messages;
other connections show no asynchronous broadcast messages. (This is
.RE
.SP
.BI "WARN " tokens\fR...
-Issues a
+Issues a
.B USER
warning to all interested administration clients.
.SH "ERROR MESSAGES"
The
.I word
is not a valid time interval specification. Acceptable time
-specifications are nonnegative integers followed optionally by
+specifications are nonnegative integers followed optionally by
.BR d ,
.BR h ,
.BR m ,
The given port number is out of range.
.SP
.BI "not-service-provider " service
-(For
+(For
.BR SVCRELEASE .)
The invoking client is not the current provider of the named
.IR service ,
.BR ADD .)
The port name
.I port
-couldn't be found in
+couldn't be found in
.BR /etc/services .
.TP
.BI "unknown-service " service
warnings before this.
.SP
.BI "KEYMGMT bad-public-keyring " message
-The public keyring couldn't be read. Usually, there will have been
+The public keyring couldn't be read. Usually, there will have been
.B key-file-error
warnings before this.
.SP
.BI "KX " peer " unexpected " msgtoken
The message received wasn't appropriate for this stage of the key
exchange process. This may mean that one of our previous packets got
-lost. For
+lost. For
.BR pre-challenge ,
it may simply mean that the peer has recently restarted.
.SP
.SS "PEER warnings"
These are largely concerned with management of peers and the low-level
details of the network protocol. The second word is usually the name of
-a peer, or
+a peer, or
.RB ` \- '
if none is relevant.
.SP
.SP
.BI "TUN \- bsd no-tunnel-devices"
The driver couldn't find an available tunnel device. Maybe if you
-create some more
+create some more
.BI /dev/tun nn
files, it will work.
.SP
-.BI "TUN - " tun-name " open-error " device " " ecode " " message
+.BI "TUN \- " tun-name " open-error " device " " ecode " " message
An attempt to open the tunnel device file
.I device
failed.
.BI "TUN \- unet getinfo-error " ecode " " message
Reading information about the Unet interface failed. Unet is obsolete
and shouldn't be used any more.
-.SP
-.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"
These are issued by administration clients using the
.B WARN
.SH "SUMMARY"
.SS "Command responses"
.nf
+.BI "BGDETACH " tag
.BI "BGFAIL " tag " " tokens \fR...
.BI "BGINFO " tag " " tokens \fR...
.BI "BGOK " tag
~mdw / tripe / blobdiff