More support scripts and other cool stuff.

[tripe] / doc / tripemon.1

diff --git a/doc/tripemon.1 b/doc/tripemon.1
new file mode 100644 (file)
index 0000000..5518493
--- /dev/null
+++ b/doc/tripemon.1
@@ -0,0 +1,88 @@
+.\" -*-nroff-*-
+.\".
+.de hP
+.IP
+\h'-\w'\fB\\$1\ \fP'u'\fB\\$1\ \fP\c
+..
+.de VS
+.sp 1
+.RS
+.nf
+.ft B
+..
+.de VE
+.ft R
+.fi
+.RE
+.sp 1
+..
+.ie t \{\
+.  ds o \(bu
+.  ds ss \s8\u
+.  ds se \d\s0
+.  if \n(.g \{\
+.    fam P
+.  \}
+.\}
+.el \{\
+.  ds o o
+.  ds ss ^
+.  ds se
+.\}
+.TH tripemon 1 "4 October 2005" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
+.SH "NAME"
+tripemon \- graphical monitor for tripe
+.SH "SYNOPSIS"
+.B tripemon
+.RB [ \-d
+.IR dir ]
+.RB [ \-a
+.IR socket ]
+.SH "DESCRIPTION"
+The
+.B tripemon
+program is a fairly simple graphical monitor program for TrIPE.  It's
+not ever-so user-friendly in some ways, but it works fairly well.  A
+perusal of 
+.BR tripe-admin (5)
+would help you understand it better.  That said, describing the program
+in detail is probably less interesting than letting you explore it for
+yourself.
+.PP
+The command-line options available are:
+.TP
+.B "\-h, \-\-help"
+Writes a brief description of the command-line options available to
+standard output and exits with status 0.
+.TP
+.B "\-v, \-\-version"
+Writes tripe's version number to standard output and exits with status
+0.
+.TP
+.B "\-u, \-\-usage"
+Writes a brief usage summary to standard output and exits with status 0.
+.TP
+.BI "\-d, \-\-directory=" dir
+Make
+.I dir
+the current directory, before doing anything else.  Note that all the
+other filenames (e.g., the log output file) are relative to this
+directory.  The default directory, if this option is not specified, is
+taken from the environment variable
+.BR TRIPEDIR ;
+if that's not defined either, a default default of
+.BR /var/lib/tripe
+is used.
+.TP
+.BI "\-a, \-\-admin=" socket
+If connecting to a running server, connect to the socket named
+.IR socket ;
+if running a new server, instruct it to listen for admin
+connections on
+.IR socket .
+.SH "SEE ALSO"
+.BR tripectl (1),
+.BR tripe\-admin (5),
+.BR tripe (8).
+.SH "AUTHOR"
+Mark Wooding, <mdw@distorted.org.uk>