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