aboutsummaryrefslogtreecommitdiffstats
path: root/utils/vmon.8
diff options
context:
space:
mode:
authorWilliam Harrington <kb0iic@berzerkula.org>2025-01-14 16:06:02 -0600
committerWilliam Harrington <kb0iic@berzerkula.org>2025-01-14 16:06:02 -0600
commit0cc9b20c15460213e488bf5e70963b941482f628 (patch)
treebb0143245583ec846630f39bfa2258dba640ccd7 /utils/vmon.8
parent0e084ade5069756d487b5c948c48b777e37c00c9 (diff)
Add source.
Diffstat (limited to 'utils/vmon.8')
-rw-r--r--utils/vmon.865
1 files changed, 65 insertions, 0 deletions
diff --git a/utils/vmon.8 b/utils/vmon.8
new file mode 100644
index 0000000..84a1308
--- /dev/null
+++ b/utils/vmon.8
@@ -0,0 +1,65 @@
+.TH "vmon" "8" "January 1997" "Speak 0.2" "Text-to-Speech"
+.PP
+.SH NAME
+.PP
+\fBvmon\fP - monitor system status (town crier).
+.PP
+.SH SYNOPSIS
+.PP
+\fBvmon\fP \fIfilesystems\fP
+.br
+\fBvstat\fP \fIfilesystems\fP
+.PP
+.SH DESCRIPTION
+.PP
+The Text-to-speech package introduces a standard TCP/IP port service for
+attaching text-to-speech resources to your network. These resources can
+be used to monitor system status, provide verbal alarms, etc. This network
+service may be accessed by telnetting to a machine running a "speak" server,
+or by using the various application utilities, such as \fBvmon\fP.
+.PP
+
+The \fBvmon\fP program will monitor the specified list of file systems.
+If any of these file systems exceed a maximum "quota" (such as over 90%
+capacity in blocks or i-node use), then the monitor will send verbal
+alerts every 5 minutes. This quota, and other parameters for vmon, may
+be found in the [\fIvmon\fP] section of \fBspeak.conf\fP.
+.PP
+
+The \fBvmon\fP program will also announce current system status once
+every hour. This system status includes the total used capacity of
+all file systems being monitored, how long the system has been up, and
+how many users are currently logged in (excluding root). This hourly
+announcement can be used to determine a given system is still alive.
+.PP
+
+The \fBvmon\fP program will now also monitor specified user mailboxes
+for new mail and announce when new mail arrives. The users to be
+monitored are specified in the [\fIvmon\fP] section of \fBspeak.conf\fP.
+Simply list mailbox= entries for each mailbox you wish to monitor. See
+the example speak.conf included with the distribution.
+.PP
+
+The \fBvmon\fP program can also be ran as \fBvstat\fP. When used as
+\fBvstat\fP, the program performs an immediate system check, announces,
+and then terminates. You can either use \fBvstat\fP from a crontab or
+start \fBvmon\fP from \fBspeak.init\fP. You may also start \fBvmon\fP
+from a \fBrc.local\fP file. Please check the \fBspeak.init\fP file
+to add any file systems you wish to monitor. By default, the root
+filesystem is enabled in \fBspeak.init\fP.
+.PP
+
+A mute option may also be specified in the [\fIvmon\fP] section of
+\fBspeak.conf\fP. This option mutes voice output during certain times of
+the day. This is normally specified by 24 hour clock in hours, hence 18-7
+means to mute output anytime after 18' hours (6pm) and anytime before 7'
+hours (7am).
+.PP
+.SH SEE ALSO
+.PP
+.BR speak.conf (7)
+.PP
+.SH AUTHOR
+.PP
+David Sugar (dyfet@tycho.com)
+.PP