Use the new official IANA-allocated port number 4070.

[tripe] / doc / tripe-admin.5.in

diff --git a/doc/tripe-admin.5.in b/doc/tripe-admin.5.in
index 1f52a6d..968400e 100644 (file)
--- 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
 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 ,
 .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
 .BR OK ,
 .BR FAIL ,
 and


@@ -215,12 +215,13 @@ are always in upper-case.
 .PP
 At present, only one address family is understood.
 .TP
 .PP
 At present, only one address family is understood.
 .TP

-.BI "INET " address " " port
+.BI "INET " address " \fR[" port \fR]

 An Internet socket, naming an IPv4 address and UDP port.  On output, the
 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
 An Internet socket, naming an IPv4 address and UDP port.  On output, the
 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, unless the command is run in the background.
+permitted; if omitted, the default port 4070 is used.  Name resolution
+does not block the main server, but will 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
 .PP
 If, on input, no recognised address family token is found, the following
 words are assumed to represent an


@@ -257,7 +258,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
 .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.
 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 +361,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.
 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
 .BI "IFNAME " peer
 Emits an
 .B INFO


@@ -389,7 +390,7 @@ line is written containing the peer's name, as given to
 .BR ADD .
 .SP
 .BI "NOTIFY " tokens\fR...
 .BR ADD .
 .SP
 .BI "NOTIFY " tokens\fR...

-Issues a 
+Issues a

 .B USER
 notification to all interested administration clients.
 .SP
 .B USER
 notification to all interested administration clients.
 .SP


@@ -420,7 +421,7 @@ line is printed describing the outcome:
 .RS
 .TP
 .BI "ping-ok " millis
 .RS
 .TP
 .BI "ping-ok " millis

-A response was received 
+A response was received

 .I millis
 after the ping was sent.
 .TP
 .I millis
 after the ping was sent.
 .TP


@@ -516,7 +517,7 @@ is provided; otherwise the command fails with the error
 .BR "service-exists" .
 .SP
 .BI "SVCENSURE " service " \fR[" version \fR]
 .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 .
 .I service
 is provided, and (if specified) to at least the given
 .IR version .


@@ -530,7 +531,7 @@ Send a
 .BR BGFAIL )
 response to the service job with the given
 .IR jobid ,
 .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
 .I tokens
 as the reason for failure.  The job is closed.
 .SP


@@ -615,7 +616,7 @@ The statistics-gathering is experimental and subject to change.
 .SP
 .BR "TRACE " [\fIoptions\fP]
 Selects trace outputs: see
 .SP
 .BR "TRACE " [\fIoptions\fP]
 Selects trace outputs: see

-.B "Trace lists" 
+.B "Trace lists"

 above.  Message types provided are:
 .RS
 .PP
 above.  Message types provided are:
 .RS
 .PP


@@ -699,7 +700,7 @@ is reserved to the Straylight/Edgeware implementation.
 Enables or disables asynchronous broadcasts
 .IR "for the current connection only" .
 See
 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
 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 +727,7 @@ All of the above.
 .RE
 .SP
 .BI "WARN " tokens\fR...
 .RE
 .SP
 .BI "WARN " tokens\fR...

-Issues a 
+Issues a

 .B USER
 warning to all interested administration clients.
 .SH "ERROR MESSAGES"
 .B USER
 warning to all interested administration clients.
 .SH "ERROR MESSAGES"


@@ -757,7 +758,7 @@ of arguments was wrong.
 The
 .I word
 is not a valid time interval specification.  Acceptable time
 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 ,
 .BR d ,
 .BR h ,
 .BR m ,


@@ -787,7 +788,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
 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 SVCRELEASE .)
 The invoking client is not the current provider of the named
 .IR service ,


@@ -870,7 +871,7 @@ There is no peer called
 .BR ADD .)
 The port name
 .I port
 .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
 .BR /etc/services .
 .TP
 .BI "unknown-service " service


@@ -1028,7 +1029,7 @@ there was a problem with the file, usually there will have been
 warnings before this.
 .SP
 .BI "KEYMGMT bad-public-keyring " message
 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
 .B key-file-error
 warnings before this.
 .SP


@@ -1125,7 +1126,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
 .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
 .BR pre-challenge ,
 it may simply mean that the peer has recently restarted.
 .SP


@@ -1141,7 +1142,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
 .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
 .RB ` \- '
 if none is relevant.
 .SP


@@ -1259,11 +1260,11 @@ if none.
 .SP
 .BI "TUN \- bsd no-tunnel-devices"
 The driver couldn't find an available tunnel device.  Maybe if you
 .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 /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.
 An attempt to open the tunnel device file
 .I device
 failed.


@@ -1314,10 +1315,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.
 .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
 .SS "USER warnings"
 These are issued by administration clients using the
 .B WARN