X-Git-Url: https://git.distorted.org.uk/~mdw/tripe/blobdiff_plain/797cf76bc51a342ab680c9426a480bd544edf334..dfc1ab4f3326bf8295ac8dca5c4821d57ef417e8:/doc/tripe-admin.5.in diff --git a/doc/tripe-admin.5.in b/doc/tripe-admin.5.in index 1f52a6db..7fb59c3e 100644 --- a/doc/tripe-admin.5.in +++ b/doc/tripe-admin.5.in @@ -120,12 +120,12 @@ option. From this point on, the server is ready to process more 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 @@ -257,7 +257,7 @@ one to an .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. @@ -360,7 +360,7 @@ Causes the server to emit an 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 @@ -389,7 +389,7 @@ line is written containing the peer's name, as given to .BR ADD . .SP .BI "NOTIFY " tokens\fR... -Issues a +Issues a .B USER notification to all interested administration clients. .SP @@ -420,7 +420,7 @@ line is printed describing the outcome: .RS .TP .BI "ping-ok " millis -A response was received +A response was received .I millis after the ping was sent. .TP @@ -516,7 +516,7 @@ is provided; otherwise the command fails with the error .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 . @@ -530,7 +530,7 @@ Send a .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 @@ -615,7 +615,7 @@ The statistics-gathering is experimental and subject to change. .SP .BR "TRACE " [\fIoptions\fP] Selects trace outputs: see -.B "Trace lists" +.B "Trace lists" above. Message types provided are: .RS .PP @@ -699,7 +699,7 @@ is reserved to the Straylight/Edgeware implementation. 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 @@ -726,7 +726,7 @@ All of the above. .RE .SP .BI "WARN " tokens\fR... -Issues a +Issues a .B USER warning to all interested administration clients. .SH "ERROR MESSAGES" @@ -757,7 +757,7 @@ of arguments was wrong. 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 , @@ -787,7 +787,7 @@ An error occurred during the attempt to become a daemon, as reported by 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 , @@ -870,7 +870,7 @@ There is no peer called .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 @@ -1028,7 +1028,7 @@ there was a problem with the file, usually there will have been 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 @@ -1125,7 +1125,7 @@ hard asymmetric crypto sums. .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 @@ -1141,7 +1141,7 @@ An unknown key-exchange message arrived. .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 @@ -1259,11 +1259,11 @@ if none. .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. @@ -1314,10 +1314,6 @@ shouldn't be used any more. .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