chiark - git - mdw - tripe/blob - mon/tripemon.1.in

   1 .\" -*-nroff-*-
   2 .\".
   3 .\" Manual for the graphical monitor
   4 .\"
   5 .\" (c) 2008 Straylight/Edgeware
   6 .\"
   7 .
   8 .\"----- Licensing notice ---------------------------------------------------
   9 .\"
  10 .\" This file is part of Trivial IP Encryption (TrIPE).
  11 .\"
  12 .\" TrIPE is free software; you can redistribute it and/or modify
  13 .\" it under the terms of the GNU General Public License as published by
  14 .\" the Free Software Foundation; either version 2 of the License, or
  15 .\" (at your option) any later version.
  16 .\"
  17 .\" TrIPE is distributed in the hope that it will be useful,
  18 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 .\" GNU General Public License for more details.
  21 .\"
  22 .\" You should have received a copy of the GNU General Public License
  23 .\" along with TrIPE; if not, write to the Free Software Foundation,
  24 .\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  25 .
  26 .\"--------------------------------------------------------------------------
  27 .so ../defs.man.in \" @@@PRE@@@
  28 .
  29 .\"--------------------------------------------------------------------------
  30 .TH tripemon 1 "4 October 2005" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
  31 .
  32 .\"--------------------------------------------------------------------------
  33 .SH "NAME"
  34 .
  35 tripemon \- graphical monitor for tripe
  36 .
  37 .\"--------------------------------------------------------------------------
  38 .SH "SYNOPSIS"
  39 .
  40 .B tripemon
  41 .RB [ \-d
  42 .IR dir ]
  43 .RB [ \-a
  44 .IR socket ]
  45 .
  46 .\"--------------------------------------------------------------------------
  47 .SH "DESCRIPTION"
  48 .
  49 The
  50 .B tripemon
  51 program is a fairly simple graphical monitor program for TrIPE.  It's
  52 not ever-so user-friendly in some ways, but it works fairly well.  A
  53 perusal of
  54 .BR tripe-admin (5)
  55 would help you understand it better.  That said, describing the program
  56 in detail is probably less interesting than letting you explore it for
  57 yourself.
  58 .PP
  59 The command-line options available are:
  60 .TP
  61 .B "\-h, \-\-help"
  62 Writes a brief description of the command-line options available to
  63 standard output and exits with status 0.
  64 .TP
  65 .B "\-v, \-\-version"
  66 Writes tripe's version number to standard output and exits with status
  67 0.
  68 .TP
  69 .B "\-u, \-\-usage"
  70 Writes a brief usage summary to standard output and exits with status 0.
  71 .TP
  72 .BI "\-d, \-\-directory=" dir
  73 Make
  74 .I dir
  75 the current directory, before doing anything else.  Note that all the
  76 other filenames (e.g., the log output file) are relative to this
  77 directory.  The default directory, if this option is not specified, is
  78 taken from the environment variable
  79 .BR TRIPEDIR ;
  80 if that's not defined either, a default default of
  81 .B \*(/c
  82 is used.
  83 .TP
  84 .BI "\-a, \-\-admin-socket=" socket
  85 Connect to the named administration
  86 .IR socket .
  87 The default socket is given by the environment variable
  88 .BR TRIPESOCK ;
  89 if that's not defined either, a default default of
  90 .B \*(/s/tripesock
  91 is used.
  92
  93 .
  94 .\"--------------------------------------------------------------------------
  95 .SH "SEE ALSO"
  96 .
  97 .BR tripectl (1),
  98 .BR tripe\-admin (5),
  99 .BR tripe (8).
 100 .
 101 .\"--------------------------------------------------------------------------
 102 .SH "AUTHOR"
 103 .
 104 Mark Wooding, <mdw@distorted.org.uk>
 105 .
 106 .\"----- That's all, folks --------------------------------------------------