.\" Process this file with
.\" groff -man -Tascii foo.1
.\"
.TH SMMON 1 "JUNE 2014" "pvss_mockup" "User Commands"
.SH NAME
smmon \- monitor TRD super modules and infrastructure 
.SH SYNOPSIS
.B smmon 
.I module 
.B ...

.B smmon
.SH DESCRIPTION
.B smmon
displays the status of TRD super modules and related infrastructure like 
trigger, gas or LV systems.  The display is higly configurable by the means
of modules that display one system and are themselves configurable to some 
degree. The modules receive their information via DIM.

The modules to be displayed can either be specified on the command
line or in a configuration file. 

Each module occupies a rectangular area on the screen. When more than
one module is to be displayed, the modules are by default arranged
vertically.  The special module \fBCOL\fR starts a new column where
subsequent modules will be placed.

If a configuration file is specified on the command line, it is tried
first, then
.B smmon 
tries to open ~/.smmonrc and last /etc/trd/smmon. If no
configuration file is found and no modules are specified on the
command line, an error message is printed and 
.B smmon 
exits.


.SH OPTIONS
.TP
\fB\-f\fR, \fB\-\-file\fR=\fIFILENAME\fR
read list of modules from \fIFILENAME\fR
.TP
\fB\-b\fR, \fB\-\-border\fR=\fIBORDER\fR
leave space of size \fIBORDER\fR around each module


.SH MODULES
.TP
\fBCOL\fR
start a new column
.TP
\fBHLINE\fR
draw a horizontal line
.TP
\fBHLINE:\fItitle\fR
draw a horizontal line with the text \fItitle\fR
.TP
\fBroc\fIXY\fB:\fIoption\fR,...  

display the ROC status of super module \fIXY\fR, as specified in
options:

.B label:
name of the ROC 

.B state:
current FSM state of the ROC

.B temp:
temperature as measured by the NTC

.B oripwr:
optical power (reuires DIM server on GTU)

.B anode:
anode voltages (requires DIM server with special naming of data
points, see also the iseg module)

.B drift:
drift voltages (requires DIM server with special naming of data
points, see also the iseg module)

.B empty:
an empty line

.TP
\fBlvsense\fIXY\fR
display LV sensing for super module \fIXY\fR. By default, the values 
for side A are taken from the DCS board in stack 0 and for side B from
stack 1.

.B reverse
use this switch for super-modules that are powered from RB-24. Side A is 
taken from stack 4 and side B from stack 3.
.TP
\fBwiener\fIXY\fR
display status of Wiener PSUs for super module \fIXY\fR 
(requires wiener2dim)
.TP
\fBiseg:anode|drift,modlow=\fIL\fB,modhigh=\fIH\fR display currents
and voltages for one supermodule. The two parameters modlow, modhigh
specify basenames of the DIM service names for the Iseg HV
modules. The module assumes that modlow supplies stacks 0,1 and the
bottom half of stack 2, and modhigh the top half of stack two and
stacks 3 and 4. This module is suitable if the output of iseg2dim is
used without aliasing to SM/S/L coordinates, e.g. at Point-2.
.TP
\fBiseg_bus:title=\fIT\fB,dimname=\fID\fR
display (TX/RX rate) information about a CAN bus. \fIT\fR is the title that 
will be used as a label in smmon, and \fID\fR is the DIM base name for the 
services.
.TP
\fBttcvi\fR
display information about status of a TTCvi, as published by the ttcvid 
.TP
\fBmsgas\fR
display information from the gas system in Muenster
.TP
\fBdimsrv\fR:\fIDISP\fR=\fIdim_server\fR,...
monitor status of selected DIM servers. For each DIM server, an argument 
\fIDISP\fR=\fIdim_server\fR must be given. If \fIdim_server\fR is running, 
\fIDISP\fR will be displayed in green letters, otherwise in red inverse.


.SH FILES
.TP
.I ~/.smmonrc /etc/trd/smmon
The system wide and user specific configuration file containing the
list of modules to be displayed.
.SH BUGS
None ;-)
.SH AUTHORS
Tom Dietel