NAME
rt user - real time system user setup
DESCRIPTION
The real time system is typically run from the special rt user
account.
Typically, there is one subdirectory of ~rt for each real time network
run. One computer may be running multiple networks.
Within a particular network subdirectory, there is a particular
configuration of directories and environment variables which works
well together. Changing this setup
should be approached cautiously even by a sophisticated user,
as there may be unexpected interactions among the
various configuration files.
DIRECTORY STRUCTURE
-
bin/
This directory may contain special executables for the real time system.
-
dbmaster/
This contains the more static part of the database which describes
the stations and instruments which make up the network:
tables like site, sitechan, sensor and instrument.
Use dbe(1) to inspect this database.
-
db/
This contains the database collected from the real time system:
waveforms, arrivals, and locations.
Typically, the database descriptor file is used to link these
tables with more static tables kept in dbmaster/.
This database accumulates many days of
data, and is regularly backed up using rtbackup(1), and
pruned to a reasonable size with rtdbclean(1).
Use dbe(1) to inspect this database.
-
db/year/day-of-year
These directories contain the (currently available) waveforms,
organized by year/day-of-year.
Use dbpick(1) or trdisp(1) to inspect the waveforms.
-
logs/
This contains the logs from the various programs run by rtexec.
Each program has a private log; in addition there is a central
log file, logs/errors, which contains intermixed messages.
This may sometimes make it easier to see the sequence of events;
the private logs may be more detailed. In the event a program
actually dies for some reason, a core file may be saved in this
directory also.
-
rtsys/
This contains databases related to system operation. The rtsys
database contains information about startups and restarts for
realtime system programs. If present, the tcp database contains
information about the bandwidth and reliability of certain tcp connections.
-
orb/
This subdirectory holds the orbserver buffers: the actual packet
data and a couple of indexes. These files are static in size once
created, and their size should be commensurate with the machine memory.
-
pf/
Except for rtexec.pf, parameter files are kept in this directory.
Many of the programs are configured with parameter files, which have
a format described in pf(3).
-
state/
When programs are stopped and restarted, they must often save some information,
typically a position in the ring buffer, to avoid loss of data.
Some examples are orb2orb(1) and orb2db(1).
This directory contains the resurrection files for such programs;
many of these files are actually parameter files -- see bury(3) and pf(3).
Dot files
The various files in ~rt which begin with '.' configure some of the standard
unix programs.
-
.tcshrc
This file is read by the shell program tcsh on startup; it sets up the
environment, including the path, the prompt and a variety of other parameters.
See tcsh(1) for more information.
-
.less
This configures the pager program less(1); less is a replacement for more(1)
with some additional features, including better moving commands, with a vi
syntax.
-
.vilerc
This configures the program vile(1), a replacement for vi. Some of
vile's features are "infinite" undo's, and use of a mouse in an xterm window.
ENVIRONMENT
This is controlled by the dot files described above; rtexec completely
sets the environment when it is run.
PARAMETER FILE
Many programs are partially controlled by parameter files. Most of these
parameter files are found in the pf subdirectory.
The default versions are kept in $ANTELOPE/data/pf.
Parameter files are a method for feeding programs with a variety of
configurable parameters. See pf(3) for more information about the format,
and refer to the particular program's man page for detailed information
about a particular parameter.
The primary parameter file is rtexec.pf, which resides in the
network subdirectory, rather than in the (next lower) pf subdirectory.
This parameter file specifies what tasks (programs) are run, the
environment in which they run, and cron jobs which should be run
as part of the system.
rtexec(1)
monitors the running tasks (programs) of the real time system,
and controls how the environment is setup for these tasks, and
runs crontab jobs (like rtbackup(1) and rtdbclean(1)).
If any task fails for any reason,
rtexec attempts to restart it.
rtm(1) is the GUI (graphical user interface) program
which is often used to monitor the real time system, as
well as start, stop or restart the system.
rtm modifies rtexec.pf to cause individual tasks to be stopped or restarted,
and itself runs rtexec(1) to start, stop or restart the real time system.
SEE ALSO
rt(5)
rtinit(1)
rtsetup(8)
rtexec(1)
orb2db(1)
dbe(1)
dbpick(1)
orbserver(1)
pf(3)
pfecho(1)
AUTHOR
Daniel Quinlan