server: Make a_vformat public.

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

diff --git a/server/tripe-admin.5.in b/server/tripe-admin.5.in
index caaf2557833cc5c3c9f58b2fc4fb1792ddfaa078..3442b02310bf9f29c8f6cef1e032def0a1c1613f 100644 (file)
--- a/server/tripe-admin.5.in
+++ b/server/tripe-admin.5.in
@@ -1,18 +1,42 @@
 .\" -*-nroff-*-
+.\".
+.\" Manual for the administration protocol
+.\"
+.\" (c) 2008 Straylight/Edgeware
 .\"
-.ie t \{\
-.  if \n(.g \{\
-.    fam P
-.  \}
-.\}
 .
-.de SP
-.TP
-..
+.\"----- Licensing notice ---------------------------------------------------
+.\"
+.\" This file is part of Trivial IP Encryption (TrIPE).
+.\"
+.\" TrIPE is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 2 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" TrIPE is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with TrIPE; if not, write to the Free Software Foundation,
+.\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+.
+.\"--------------------------------------------------------------------------
+.so ../defs.man.in \" @@@PRE@@@
+.
+.\"--------------------------------------------------------------------------
 .TH tripe-admin 5 "18 February 2001" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
-.SH NAME
+.
+.\"--------------------------------------------------------------------------
+.SH "NAME"
+.
 tripe-admin \- administrator commands for TrIPE
-.SH DESCRIPTION
+.
+.\"--------------------------------------------------------------------------
+.SH "DESCRIPTION"
+.
 This manual page describes the administration interface provided by the
 .BR tripe (8)
 daemon.
@@ -265,7 +289,10 @@ to the end of the line.
 .PP
 Lowercase key letters control individual message types.  Uppercase key
 letters control collections of message types.
+.
+.\"--------------------------------------------------------------------------
 .SH "COMMAND REFERENCE"
+.
 .\"* 10 Commands
 The commands provided are:
 .SP
@@ -734,7 +761,10 @@ All of the above.
 Issues a
 .B USER
 warning to all interested administration clients.
+.
+.\"--------------------------------------------------------------------------
 .SH "ERROR MESSAGES"
+.
 .\"* 20 Error messages (FAIL codes)
 The following
 .B FAIL
@@ -806,6 +836,12 @@ Adding
 failed for some reason.  A warning should have been emitted explaining
 why.
 .SP
+.BI "peer-addr-exists " address\fR...
+(For
+.BR ADD .)
+There is already a peer with the given
+.IR address .
+.SP
 .BI "peer-exists " peer
 (For
 .BR ADD .)
@@ -896,7 +932,10 @@ The given
 .I tag
 is not the tag for any outstanding background job.  It may have just
 finished.
+.
+.\"--------------------------------------------------------------------------
 .SH "NOTIFICATIONS"
+.
 .\"* 30 Notification broadcasts (NOTE codes)
 The following notifications are sent to clients who request them.
 .SP
@@ -959,7 +998,10 @@ is no longer available.
 An administration client issued a notification using the
 .B NOTIFY
 command.
+.
+.\"--------------------------------------------------------------------------
 .SH "WARNINGS"
+.
 .\"* 40 Warning broadcasts (WARN codes)
 .\"+sep
 There are many possible warnings.  They are categorized according to
@@ -1240,6 +1282,11 @@ A client of the administration interface issued a
 .B QUIT
 command.
 .SP
+.BI "SERVER quit foreground-eof"
+The server is running in foreground mode (the
+.B \-F
+option), and encountered end-of-file on standard input.
+.SP
 .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.
@@ -1327,7 +1374,10 @@ command.
 .BI "USER " tokens\fR...
 An administration client issued a warning.
 .\"-sep
+.
+.\"--------------------------------------------------------------------------
 .SH "SUMMARY"
+.
 .SS "Command responses"
 .nf
 .BI "BGDETACH " tag
@@ -1339,10 +1389,18 @@ An administration client issued a warning.
 .B OK
 .fi
 .\"= summary
+.
+.\"--------------------------------------------------------------------------
 .SH "SEE ALSO"
+.
 .BR tripectl (1),
 .BR tripe (8).
 .PP
 .IR "The Trivial IP Encryption Protocol" .
+.
+.\"--------------------------------------------------------------------------
 .SH "AUTHOR"
+.
 Mark Wooding, <mdw@distorted.org.uk>
+.
+.\"----- That's all, folks --------------------------------------------------