RUL Helium Monitor
Reference Manual
RUL Helium Monitor
Reference Manual
Huygens Laboratorium
Rijksuniversiteit Leiden
Niels Bohrweg 2
2333 CA Leiden
Tel.: 071-275800
RUL Helium Monitor
Reference Manual
Copyright (C) 1990, 1991 by Rijksuniversiteit Leiden
Author: Martin Moene
This edition corresponds to version 1.10 of the RUL Helium Monitor program.
This manual was set in Times Roman and Courier by Rijksuniversiteit Leiden, using an
Apple Laserwriter IIntx laser printer. The text was prepared under MS-DOS with WP 5.1
of Wordperfect Corporation.
Introduction
1. How to Read This Manual
This Reference Manual is divided into 5 major sections. The first section, Section 1,
makes up the vast bulk of this manual. It contains documentation in alphabetical order
for each command included in the RUL Helium Monitor program. Each command starts
on a new page.
The next two sections, Sections 2 and 3, describe programmer interfaces to the system;
these sections exist for compatibility with UNIX manuals, but since these interfaces are
not provided, these sections are present but empty.
Section 4 describes the format of various files used by the utilities described in section
1. Section 5 describes various additional information which doesn't really fit into other
categories, but currently it is empty.
This manual layout will be familiar to many as it is the standard layout for UNIX
manuals. If you don't know UNIX, don't worry - this is actually a very simple method
to locate specific information quickly. A permuted index of the topics covered in the
various commands and sections is provided following the table of contents.
When we refer to documentation in the manual, we usually give the topic followed by
the section that contains the topic. For example, if we say `See ls(1)', we mean that
you should look up ls in section 1 of the Reference Manual. Since every section is in
alphabetical order, it is quite easy to find anything in this way.
A description of an individual topic (e.g. a command) is loosely called `the manual
page' for that topic, even if it is actually several pages long. This is often abbreviated
to `the man page', as in `Read the man page for ls.'
In the sections that follow, we will describe the parts of a man page. Any of these parts
may be omitted if they are irrelevant to the software being described. This section looks
at examples taken from real RUL Helium Monitor man pages.
1.1. The Synopsis Section
In the man page for a command, the SYNOPSIS section provides a quick summary of
the command's format. For example, here is the synopsis of the retrieve command.
retrieve [-h] [-i] [-bdate] [-edate] channel ...
The synopsis takes the form of a command line as you might type it in to the system;
it shows what you can type in and the order in which you should do it. The parts that
are enclosed in square brackets are optional; you may omit them if you choose. Parts
that are not enclosed in square brackets must be present for the command to be correct.
The synopsis begins with the name of the command itself. These names are always
written in bold typewriter font.
After a command name comes a list of options, if there are any. A typical command
option consists of a - (dash) followed by a single character, usually an upper or lower
case letter. For example you might have -h or -i. Each option must be preceded by it's
own dash. The synopsis section shows options in bold typewriter font. Note that
the case of the letters is important.
Another common option form is
-xvalue
where -x is a dash followed by a character, and value provides extra information for
using that option. For example, the retrieve command converts the helium pollution
data from an internal format to a LOTUS-123 readable file format; here's the
command's synopsis:
retrieve [-h] [-i] [-bdate] [-edate] channel ...
In this example we have the option
-bdate
This option tells the retrieve command at which date to start. The form of the option
is -b, followed by date. In a command synopsis anything written in italics is a
`placeholder' for information that you are expected to supply. Sometime after the
synopsis, the man page will explain what kind of information is expected in place of the
placeholder.
The end of the retrieve synopsis is
channel ...
This means a list of one or more channel numbers; the ellipsis `...' stands for
repetition of what immediately precedes it.
The order of items on the command line is important. When you type in a command
line, you should specify the parts of the command line in the order they appear in the
command synopsis. The exception to this is options marked with a -; they do not have
to be given in the exact order shown in the synopsis.. However, all the - options must
appear in the correct area of the command line.
1.2. The Description Section
The DESCRIPTION section describes what the command does and how each of the
options work. For particularly complex software, this section may be divided into a large
number of subsections, each dealing with a particular aspect of the command.
Inside the description section, the names of files and directories are written in plain
typewriter font.
1.3. The Examples Section
The EXAMPLES section is present in many man pages, giving examples of how the
software can be used.
1.4. The Files Section
The FILES section lists the supplementary files that the commands refer to, if any. By
supplementary files, we mean files that are not specified on the command line. Such
files usually provide information that the command needs; the command `quietly'
accesses these files during its operation. If the files cannot be found, the command will
print a message to this effect.
Files documented in this section may be temporary files, output files, datafiles,
configuration files, etc..
1.5. The See Also Section
The SEE ALSO section refers to other manual pages that may contain information
relevant to the man page you just have read. For example, consider the mkdir
command; this command creates a new directory. Its SEE ALSO section refers you to
rmdir(1), the command that removes an empty directory.
1.6. The Bugs Section
The BUGS section informs you of known failure of the command.
1.7. The Permuted Index
The permuted index is not really part of the manual pages, but rather a guide to the
manual pages. The index follows the table of contents at the beginning of the Reference
Manual. The permuted index can help you explore the RUL Helium Monitor program
and what its commands can do for you; however it takes some practice to figure out how
to read it.
Each line in the permuted index is taken from the title of a manual page. The words of
the title are shifted to get entries for the index. For example, the title of the ls manual
page is
ls - list file and directory names
This produces the following permuted index entries:
ls - list file and directory names
ls - list file and directory names
ls - list file and directory names
ls - list file and directory names
Notice that there is a gap in the middle of each line. The permuted index is sorted by
the word that comes after this gap.
The permuted index lets you look up commands according to key words in their title
lines. For example, suppose you want to list file and directory names, and want to know
which command(s) do this. Looking up the word `list' in the permuted index, we find
the entry:
ls - list file and directory names
Each of the index entries is associated with a manual page (found via the command
name in the table of contents). By looking at the title lines, you should be able to
determine which command does what you want and go directly to the appropriate
manual page.
The permuted index is not easy to read casually, but it is really a good way to zero in
on commands that do a particular job. We think that familiarizing yourself with how the
index works is a good investment of time.
Table of Contents
Introduction
1. How to Read This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.1. The Synopsis Section. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.2. The Description Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.3. The Examples Section. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.4. The Files Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.5. The See Also Section. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.6. The Bugs Section. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.7. The Permuted Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Section 1. Commands
intro - introduction to file shell commands. . . . . . . . . . . . . . . . . . . . 17
alarm - control alarm process. . . . . . . . . . . . . . . . . . . . . . . . . . . 18
at - execute commands at a later time. . . . . . . . . . . . . . . . . . . . . . . 19
cat - concatenate and display text files . . . . . . . . . . . . . . . . . . . . . 21
catdat - display helium data . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
catlog - display messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
chdir - change working directory . . . . . . . . . . . . . . . . . . . . . . . . . 24
chprio - change process priority . . . . . . . . . . . . . . . . . . . . . . . . . 25
close - close file(s). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
cls - clear screen of current window . . . . . . . . . . . . . . . . . . . . . . . 27
config - configure monitor parameters. . . . . . . . . . . . . . . . . . . . . . . 28
cp - copy files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
date - display date and time or set date . . . . . . . . . . . . . . . . . . . . . 30
dev - display device information . . . . . . . . . . . . . . . . . . . . . . . . . 31
echo - echo command arguments to standard output device. . . . . . . . . . . . . . 32
exit - exit from the shell . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
fg - bring process back into the foreground. . . . . . . . . . . . . . . . . . . . 34
hello - print 'hello' message. . . . . . . . . . . . . . . . . . . . . . . . . . . 35
help - print available commands. . . . . . . . . . . . . . . . . . . . . . . . . . 36
kill - destroy a process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
lexprint - monitor communication between PC and Helium-meters. . . . . . . . . . . 38
login - authenticate computer user . . . . . . . . . . . . . . . . . . . . . . . . 39
logout - exit from the shell . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
loop - endless loop. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
ls - list file and directory names . . . . . . . . . . . . . . . . . . . . . . . . 42
mail - send and receive mail . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
mem - print memory usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
mkdir - create a new directory . . . . . . . . . . . . . . . . . . . . . . . . . . 45
mkusr - create a new user entry. . . . . . . . . . . . . . . . . . . . . . . . . . 46
monitor - RUL Helium Monitor DOS-command . . . . . . . . . . . . . . . . . . . . . 47
mount - install a logical device name. . . . . . . . . . . . . . . . . . . . . . . 50
mv - rename and move files and directories . . . . . . . . . . . . . . . . . . . . 51
passwd - change user login password. . . . . . . . . . . . . . . . . . . . . . . . 52
ps - display process and memory blocks . . . . . . . . . . . . . . . . . . . . . . 53
pwd - print working directory. . . . . . . . . . . . . . . . . . . . . . . . . . . 54
quantum - display or set preemption value (clock ticks). . . . . . . . . . . . . . 55
resume - resume a suspended process. . . . . . . . . . . . . . . . . . . . . . . . 56
retrieve - export monitor data to LOTUS-123. . . . . . . . . . . . . . . . . . . . 57
rm - remove files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
rmdir - remove directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
rmusr - remove an user entry . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
run - run a shell script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
shell - RUL Helium Monitor command shell . . . . . . . . . . . . . . . . . . . . . 63
shutdown - leave the RUL Helium Monitor program. . . . . . . . . . . . . . . . . . 67
sleep - suspend execution for a specified time (s) . . . . . . . . . . . . . . . . 68
suspend - suspend a ready process. . . . . . . . . . . . . . . . . . . . . . . . . 69
time - display date and time or set time . . . . . . . . . . . . . . . . . . . . . 70
unmount - uninstall logical device . . . . . . . . . . . . . . . . . . . . . . . . 71
uptime - display system up time. . . . . . . . . . . . . . . . . . . . . . . . . . 72
version - display monitor version and date . . . . . . . . . . . . . . . . . . . . 73
wdog - control watchdog process. . . . . . . . . . . . . . . . . . . . . . . . . . 74
which - print full pathname for file . . . . . . . . . . . . . . . . . . . . . . . 75
who - print login accounting information . . . . . . . . . . . . . . . . . . . . . 76
xversion - display Xinu version and date . . . . . . . . . . . . . . . . . . . . . 77
Section 2 (System Calls)
intro - introduction to system calls . . . . . . . . . . . . . . . . . . . . . . . 81
Section 3 (C Runtime Library)
intro - introduction to the C runtime library. . . . . . . . . . . . . . . . . . . 85
Section 4 (File formats)
intro - introduction to file formats . . . . . . . . . . . . . . . . . . . . . . . 89
a.$$$ - format of etc\a.$$$ file . . . . . . . . . . . . . . . . . . . . . . . . . 90
issue - format of etc\issue file . . . . . . . . . . . . . . . . . . . . . . . . . 91
login - format of etc\login file . . . . . . . . . . . . . . . . . . . . . . . . . 92
logout - format of etc\logout file . . . . . . . . . . . . . . . . . . . . . . . . 93
monitor.cfg - format of cfg\monitor.cfg file . . . . . . . . . . . . . . . . . . . 94
monitor.dat - format of dat\monitor.dat file . . . . . . . . . . . . . . . . . . . 95
monitor.log - format of log\monitor.log file . . . . . . . . . . . . . . . . . . . 96
monitor.rc - format of etc\monitor.rc file . . . . . . . . . . . . . . . . . . . . 97
passwd - format of etc\passwd file . . . . . . . . . . . . . . . . . . . . . . . . 98
retrieve - format of LOTUS-123 readable output file. . . . . . . . . . . . . . . . 99
Section 5 (Miscellaneous Information)
intro - introduction to miscellaneous information. . . . . . . . . . . . . . . . . 103
Permuted Index
fg - bring process back into the foreground
lexprint - monitor communication between PC and Helium-meters
ps - display process and memory blocks
fg - bring process back into the foreground
intro - introduction to the C runtime library
intro - introduction to system calls
chprio - change process priority
passwd - change user login password
chdir - change working directory
cls - clear screen of current window
close - close file(s)
echo - echo command arguments to standard output device
shell - RUL Helium Monitor command shell
help - print available commands
at - execute commands at a later time
lexprint - monitor communication between PC and Helium-meters
login - authenticate computer user
cat - concatenate and display text files
config - configure monitor parameters
alarm - control alarm process
wdog - control watchdog process
cp - copy files
mkdir - create a new directory
mkusr - create a new user entry
cls - clear screen of current window
catdat - display helium data
date - display date and time or set date
version - display monitor version and date
xversion - display Xinu version and date
date - display date and time or set date
time - display date and time or set time
kill - destroy a process
echo - echo command arguments to standard output device
unmount - uninstall logical device
dev - display device information
mount - install a logical device name
mv - rename and move files and directories
chdir - change working directory
mkdir - create a new directory
pwd - print working directory
rmdir - remove directory
ls - list file and directory names
date - display date and time or set date
time - display date and time or set time
dev - display device information
catdat - display helium data
catlog - display messages
version - display monitor version and date
quantum - display or set preemption value (clock ticks)
ps - display process and memory blocks
uptime - display system up time
cat - concatenate and display text files
xversion - display Xinu version and date
monitor - RUL Helium Monitor DOS-command
echo - echo command arguments to standard output device
loop - endless loop
mkusr - create a new user entry
rmusr - remove an user entry
issue - format of etc\issue file
login - format of etc\login file
logout - format of etc\logout file
passwd - format of etc\passwd file
at - execute commands at a later time
sleep - suspend execution for a specified time (s)
exit - exit from the shell
logout - exit from the shell
issue - format of etc\issue file
login - format of etc\login file
logout - format of etc\logout file
passwd - format of etc\passwd file
retrieve - format of LOTUS-123 output file
which - print full pathname for file
ls - list file and directory names
intro - introduction to file formats
close - close file(s)
cp - copy files
rm - remove files
cat - concatenate and display text files
mv - rename and move files and directories
which - print full pathname for file
catdat - display helium data
shell - RUL Helium Monitor command shell
monitor - RUL Helium Monitor DOS-command
shutdown - leave the RUL Helium Monitor program.
lexprint - monitor communication between PC and Helium-meters
at - execute commands at a later time
shutdown - leave the RUL Helium Monitor program.
intro - introduction to the C runtime library
ls - list file and directory names
unmount - uninstall logical device
mount - install a logical device name
who - print login accounting information
passwd - change user login password
loop - endless loop
retrieve - format of LOTUS-123 output file
mail - send and receive mail
ps - display process and memory blocks
mem - print memory usage
hello - print 'hello' message
catlog - display messages
intro - introduction to miscellaneous information
shell - RUL Helium Monitor command shell
lexprint - monitor communication between PC and Helium-meters
monitor - RUL Helium Monitor DOS-command
config - configure monitor parameters
shutdown - leave the RUL Helium Monitor program.
version - display monitor version and date
mv - rename and move files and directories
mount - install a logical device name
ls - list file and directory names
mkdir - create a new directory
mkusr - create a new user entry
echo - echo command arguments to standard output device
retrieve - format of LOTUS-123 output file
config - configure monitor parameters
passwd - change user login password
which - print full pathname for file
lexprint - monitor communication between PC and Helium-meters
quantum - display or set preemption value (clock ticks)
hello - print 'hello' message
help - print available commands
which - print full pathname for file
who - print login accounting information
mem - print memory usage
pwd - print working directory
chprio - change process priority
alarm - control alarm process
kill - destroy a process
resume - resume a suspended process
suspend - suspend a ready process
wdog - control watchdog process
ps - display process and memory blocks
fg - bring process back into the foreground
chprio - change process priority
shutdown - leave the RUL Helium Monitor program.
suspend - suspend a ready process
mail - send and receive mail
rmusr - remove an user entry
rmdir - remove directory
rm - remove files
mv - rename and move files and directories
resume - resume a suspended process
shell - RUL Helium Monitor command shell
monitor - RUL Helium Monitor DOS-command
shutdown - leave the RUL Helium Monitor program.
run - run a shell script
intro - introduction to the C runtime library
cls - clear screen of current window
run - run a shell script
mail - send and receive mail
date - display date and time or set date
quantum - display or set preemption value (clock ticks)
time - display date and time or set time
exit - exit from the shell
logout - exit from the shell
shell - RUL Helium Monitor command shell
run - run a shell script
sleep - suspend execution for a specified time (s)
echo - echo command arguments to standard output device
suspend - suspend a ready process
sleep - suspend execution for a specified time (s)
resume - resume a suspended process
intro - introduction to system calls
uptime - display system up time
cat - concatenate and display text files
quantum - display or set preemption value (clock ticks)
at - execute commands at a later time
time - display date and time or set time
uptime - display system up time
sleep - suspend execution for a specified time (s)
date - display date and time or set date
time - display date and time or set time
unmount - uninstall logical device
uptime - display system up time
mem - print memory usage
login - authenticate computer user
mkusr - create a new user entry
rmusr - remove an user entry
passwd - change user login password
quantum - display or set preemption value (clock ticks)
version - display monitor version and date
xversion - display Xinu version and date
wdog - control watchdog process
cls - clear screen of current window
chdir - change working directory
pwd - print working directory
xversion - display Xinu version and date
Section 1. Commands
intro(1) RUL Helium Monitor intro(1)
NAME
intro - introduction to file shell commands
DESCRIPTION
Section 1 describes the shell commands of the RUL Helium Monitor program.
alarm(1) RUL Helium Monitor alarm(1)
NAME
alarm - control alarm process
SYNOPSIS
alarm [-h] [-i] [-r] [-a] [-u]
[-pcount] [-vtime] [-dtime] [-flfreq] [-fhfreq]
-h : this help
-i : install
-r : remove
-a : activate
-u : unactivate
-pcount: set repeat count
-vtime : set interval time [s]
-dtime : set tone duration [s/18]
-flfreq: set alarm low frequency [Hz]
-fhfreq: set alarm high frequency [Hz]
DESCRIPTION
The alarm command controls the behaviour of the alarm process. It installs,
removes, activates or unactivates the process. Further it can set the frequency,
duration, interval time and repeat count of the two-tone alarm sound.
EXAMPLE
alarm -i -v60
PRIVILEGE LEVEL
super user, operator
SEE ALSO
wdog(1)
at(1) RUL Helium Monitor at(1)
NAME
at - execute commands at a later time
SYNOPSIS
at [-h] [-l] [-rjob] time [date] [+ num increment]
-h : this help
-i : install at process
-l : list jobs
-rjob: remove job by number
time : hh:mm, now, noon, midnight
date : dd-mm-yy, sun..sat, today, tomorrow, next
incr : minutes, hours, days, weeks, months, years
DESCRIPTION
at reads commands from standard input to be executed at a later time. at lets you
specify when the commands should be executed. at may be executed with the
following options:
-h: prints help
-i: install at-process
-r: removes jobs previously scheduled with at
-l: reports all jobs scheduled for all users
Standard output and standard error output are mailed to the user unless the user
is logged in at time of execution.
All jobs are placed on the queue 'a.$$$'.
The time may be specified as 1 or 2 digits taken to be hours. The time may
alternately be specified as two numbers separated by a colon, meaning
hour:minute. A 24-hour clock time is used. The special names noon,
midnight, now and next are also recognized.
An optional date may be specified as either a (partly) specified numeric date
or a day of the week abbreviated to three characters. Two special 'days', today
and tomorrow are recognized. If no date is given, today is assumed if the
given hour is greater than the current hour and tomorrow is assumed if it is less.
The optional increment part is simply a number suffixed by one of the
following: minutes, hours, days, weeks, months or years. (The shortest
unambiguous abbreviation can also be used.)
Thus legitimate commands include:
at 8:15 24-1
at now + 1 day
at 17 friday
at -rjob removes a job previously scheduled by at. You can get the job numbers
by typing at -l.
at -i installs the process that handles the at-requests.
EXAMPLE
at 3 21-9-91
time 2
echo "Set time from 3am to 2am (end summertime)"
^Z
PRIVILEGE LEVEL
super user, operator
FILES
etc\a.$$$
file with time, user id and command information
tmp\atcmd.$$$
file where commands are placed when time has come to execute
commands
tmp\attmp.$$$
temporary file used to manipulate the at-queue a.$$$
SEE ALSO
a.$$$(4), kill(1), mail(1), ps(1)
BUGS
You don't have to be superuser to remove a job of another user.
cat(1) RUL Helium Monitor cat(1)
NAME
cat - concatenate and display text files
SYNOPSIS
cat [-h] inputfile ...
-h: this help
DESCRIPTION
cat is most often used to display or concatenate files. It copies each file to the
standard output. If no files are given, it reads the standard input.
EXAMPLE
cat part1 part2 >prn
PRIVILEGE LEVEL
super user, operator, user
SEE ALSO
catdat(1), catlog(1), cp(1), mv(1)
catdat(1) RUL Helium Monitor catdat(1)
NAME
catdat - display helium data
SYNOPSIS
catdat [-h] [-i] [-x] [-r] [-p] [-g] channel ...
-h: this help
-i: display range of available data
-x: display excitation voltage
-r: display reference voltage
-p: display pollution
-g: graphic output
DESCRIPTION
catdat displays the contents of the monitor database on disk. You can display the
hour-mean helium pollution (-p), the measurement bridge excitation voltage (-x)
and the reference-NTC voltage (-r). If -g is specified, the helium pollution is
presented graphically.
When the -i option is specified, catdat prints the number of entries available and
the date and time of the first and the last entry.
EXAMPLE
catdat -p -g -a 1 2 3
PRIVILEGE LEVEL
operator
FILES
dat\monitor.dat
monitor cyclic data file
SEE ALSO
catlog(1), config(1), monitor.dat(4), retrieve(1)
catlog(1) RUL Helium Monitor catlog(1)
NAME
catlog - display messages
SYNOPSIS
catlog [-h] [-a]
-h: this help
-a: type all messages in logfile
DESCRIPTION
catlog displays the system messages not yet read, or all messages available if the
-a option is specified.
EXAMPLE
catlog -a
PRIVILEGE LEVEL
super user, operator, user
FILES
log\monitor.log
cyclic datafile with last couple of messages
SEE ALSO
catdat(1), config(1), monitor.log(4), retrieve(1)
chdir(1) RUL Helium Monitor chdir(1)
NAME
chdir - change working directory
SYNOPSIS
chdir [-h] directory
-h: this help
DESCRIPTION
chdir directory changes the working directory to directory. If directory
is an absolute pathname, beginning with '\', this is the target directory. If
directory is a relative pathname, there are two possibilities.
If the prefix of directory is defined by the logical file-system, this prefix is
substituted with the replacement string for that prefix. The replacement string can
specify an absolute or relative directory. If the prefix of directory isn't
defined, chdir takes directory to be relative to the current directory.
EXAMPLE
chdir a:\mydir
PRIVILEGE LEVEL
super user, operator
SEE ALSO
mkdir(1), mount(1), rmdir(1), unmount(1)
chprio(1) RUL Helium Monitor chprio(1)
NAME
chprio - change process priority
SYNOPSIS
chprio [-h] pid newprio
-h: this help
DESCRIPTION
chprio sets the priority of a process given it's pid to the specified priority.
EXAMPLE
chprio 1 10
PRIVILEGE LEVEL
super user
SEE ALSO
ps(1)
close(1) RUL Helium Monitor close(1)
NAME
close - close file(s)
SYNOPSIS
close [-h] device-number ...
-h: this help
DESCRIPTION
The command close closes a file given it's file descriptor. It is used to close files
that are left open when a command is interrupted and the command was not able
to close the files it opened.
EXAMPLE
close 14 15
PRIVILEGE LEVEL
super user
SEE ALSO
dev(1)
cls(1) RUL Helium Monitor cls(1)
NAME
cls - clear screen of current window
SYNOPSIS
cls [-h]
-h: this help
DESCRIPTION
cls clears the screen of the current window and places the cursor at the leftmost
upper corner.
EXAMPLE
cls
PRIVILEGE LEVEL
super user, operator, user
SEE ALSO
config(1) RUL Helium Monitor config(1)
NAME
config - configure monitor parameters
SYNOPSIS
config [-h] [-c] [channel ...]
-h: this help
-c: change info
DESCRIPTION
If no option is specified, config displays the configuration of the specified
channels, or if no channels are specified of all twelve channels.
When the -c option is specified, you can change the configuration of the
specified channels. Along with the configuration parameters, the current settings
are displayed:
- description [kanaal 1]:
- datafile [kanaal1.prn]:
- pollution factor [0.039 %]:
- pollution alarm [2.5 %]:
- flow factor [1.000 l]:
- no alarm below flow of [0.0 l/min]:
- reference offset [0.0 %]:
- reference offset alarm [2.5 %]:
EXAMPLE
config -c 1 2 3
PRIVILEGE LEVEL
operator
FILES
cfg\monitor.cfg
contains monitor configuration data
SEE ALSO
catlog(1), catdat(1), monitor.cfg(4)
cp(1) RUL Helium Monitor cp(1)
NAME
cp - copy files
SYNOPSIS
cp [-h] file tofile
-h: this help
DESCRIPTION
cp copies a file to another. If the tofile is an existing file, it is overwritten;
if it does not exist, it is created. Both file and tofile must be specified
completely.
EXAMPLE
cp data.dat a:\subdir\data.dat
PRIVILEGE LEVEL
super user, operator, user
SEE ALSO
cat(1), mv(1), rm(1)
date(1) RUL Helium Monitor date(1)
NAME
date - display date and time or set date
SYNOPSIS
date [-h] [date]
-h: this help
date: dd[-mm[-yy]]
DESCRIPTION
if no argument is specified the command date displays the current date and time;
when an argument is given it is taken to be a new date to be set to the real time
clock.
EXAMPLE
date 1-2-90
PRIVILEGE LEVEL
super user, operator, user
SEE ALSO
time(1)
dev(1) RUL Helium Monitor dev(1)
NAME
dev - display device information
SYNOPSIS
dev [-h]
-h: this help
DESCRIPTION
dev shows all the devices in the system, their names, minor device numbers,
interrupt vectors and control block addresses.
EXAMPLE
dev
PRIVILEGE LEVEL
super user, operator, user
SEE ALSO
mem(1), ps(1)
echo(1) RUL Helium Monitor echo(1)
NAME
echo - echo command arguments to standard output device
SYNOPSIS
echo [-h] [-n]
-h: this help
-n: continue on same line
DESCRIPTION
echo writes it's arguments to the standard output. Unless the -n option is
specified, the line is terminated with a newline.
EXAMPLE
echo "Hello world" >file
PRIVILEGE LEVEL
super user, operator, user
SEE ALSO
hello(1)
exit(1) RUL Helium Monitor exit(1)
NAME
exit - exit from the shell
SYNOPSIS
exit [-h]
-h: this help
DESCRIPTION
exit terminates the shell.
EXAMPLE
exit
PRIVILEGE LEVEL
super user, operator, user
SEE ALSO
logout(1)
fg(1) RUL Helium Monitor fg(1)
NAME
fg - bring process back into the foreground
SYNOPSIS
fg [-h] pid
-h: this help
DESCRIPTION
fg is used to regain control over a process that is running in the background.
EXAMPLE
fg 1
PRIVILEGE LEVEL
super user, operator, user
SEE ALSO
ps(1), shell(1)
hello(1) RUL Helium Monitor hello(1)
NAME
hello - print 'hello' message
SYNOPSIS
hello [-h] [-n]
-h: this help
-g: skip printing of 'Good'
-n: continue on same line
DESCRIPTION
hello prints a warm welcome to the user. The standard form is: 'Good
morning/afternoon/evening', depending on the time of day. When the -g option
is specified, the word 'Good' is omitted. Specifying -n lets the output continue
on the same line.
EXAMPLE
Hello -n "folkes."
PRIVILEGE LEVEL
super user, operator, user
SEE ALSO
echo(1)
help(1) RUL Helium Monitor help(1)
NAME
help - print available commands
SYNOPSIS
help [-h]
-h: this help
DESCRIPTION
help displays the available commands in four columns. Which commands are
available depends on the privilege level of the current user.
EXAMPLE
help
PRIVILEGE LEVEL
super user, operator, user
SEE ALSO
mkusr(1), shell(1)
kill(1) RUL Helium Monitor kill(1)
NAME
kill - destroy a process
SYNOPSIS
kill [-h] process-id | process-name ...
-h: this help
DESCRIPTION
kill removes a ready process from the process table. You can specify the process
either by process id number (pid) or by its name.
EXAMPLE
kill loop
PRIVILEGE LEVEL
super user
SEE ALSO
ps(1)
lexprint(1) RUL Helium Monitor lexprint(1)
NAME
lexprint - monitor communication between PC and Helium-meters
SYNOPSIS
lexprint [-h] [on | off]
-h: this help
DESCRIPTION
lexprint enables you to monitor the incoming character stream from the
Helium-meters in the RUL Helium Monitor shell window. With the lexprint
command you can turn the monitoring on and off.
EXAMPLE
lexprint on
PRIVILEGE LEVEL
super user
SEE ALSO
Hebug - Monitor for the MC68705 Computer (Helium-meter)
login(1) RUL Helium Monitor login(1)
NAME
login - authenticate computer user
SYNOPSIS
login: username
DESCRIPTION
The login procedure validates the identity of a user who is requesting access to
the computer system, and establishes the initial environment for the shell. The
username is authenticated in the etc\passwd file (see passwd(4)). You are
prompted to enter a password only if username has a password in etc\passwd
or if username doesn't exist. You may establish a password with the
passwd(1) command.
After user authentication, login changes to the user's default directory and starts
the shell.
NOTE
Login is not available as a separate command.
PRIVILEGE LEVEL
super user, operator
FILES
etc\issue
login herald message.
etc\passwd
database of permissable users, passwords, home directories, etc.
SEE ALSO
exit(1), logout(1), passwd(1), shell(1), who(1),
issue(4), passwd(4)
logout(1) RUL Helium Monitor logout(1)
NAME
logout - exit from the shell
SYNOPSIS
logout [-h]
DESCRIPTION
logout terminates the shell.
EXAMPLE
logout
PRIVILEGE LEVEL
super user, operator, user
SEE ALSO
exit(1), login(1), shell(1)
loop(1) RUL Helium Monitor loop(1)
NAME
loop - endless loop
SYNOPSIS
loop
DESCRIPTION
loop is an endless for() loop. It can be used for system tests.
EXAMPLE
loop
PRIVILEGE LEVEL
super user
SEE ALSO
ps(1)
ls(1) RUL Helium Monitor ls(1)
NAME
ls - list file and directory names
SYNOPSIS
ls [-h] [pathname ...]
DESCRIPTION
ls lists files and directories.
If pathname is a file, all files according to that specification are listed. The
pathname may contain the wildcard characters `?' and `*' using the MS-DOS
wildcard specification rules.
If pathname specifies a directory, ls lists the contents of that directory. The
directoryname must end with a `\'.
EXAMPLE
ls usr\operator\*.prn
PRIVILEGE LEVEL
super user, operator, user
mail(1) RUL Helium Monitor mail(1)
NAME
mail - send and receive mail
SYNOPSIS
mail [-c] [-uuser] [username ...]
-h : this help
-c : check for mail
-uuser: pretend to be user
DESCRIPTION
mail is intended to read and write electronic mail messages on your system.
When no options and/or arguments are specified mail reads the messages sent to
you, if any. When the username argument is specified, mail lets you enter a
message on the command line. End the message with ^Z on a new line.
When the -uuser option is used, mail pretends that the user is user.
The -c options checks if there is mail and prints `You have mail.' if there is
mail, otherwise it prints `No mail for user.'.
EXAMPLE
mail operator
mem(1) RUL Helium Monitor mem(1)
NAME
mem - print memory usage
SYNOPSIS
mem [-h]
DESCRIPTION
mem displays the memory occupied by stack and heap and the free memory list.
EXAMPLE
mem
PRIVILEGE LEVEL
super user
SEE ALSO
dev(1), ps(1)
mkdir(1) RUL Helium Monitor mkdir(1)
NAME
mkdir - create a new directory
SYNOPSIS
mkdir [-h] directory ...
-h: this help
DESCRIPTION
The mkdir command will create a new directory for each named directory
argument.
EXAMPLE
mkdir a:\tmp
PRIVILEGE LEVEL
super user, operator, user
SEE ALSO
rm(1), rmdir(1)
mkusr(1) RUL Helium Monitor mkusr(1)
NAME
mkusr - create a new user entry
SYNOPSIS
mkusr [-h]
-h: this help
DESCRIPTION
mkusr creates a new user entry in the etc\passwd file. It asks for an unique
username, a description, the home directory and an initial command to execute.
Last command has no effect presently. The password for the new user entry
created, is the same as the username.
EXAMPLE
mkusr
user name: myid
group id: 0 (super user)
1 (operator)
2 (user)
..
15
description: My Description
home directory: usr\mydir
command: (none)
PRIVILEGE LEVEL
super user
FILES
etc\passwd
file where passwords are stored.
SEE ALSO
rmusr(1), shell(1), passwd(1), passwd(4)
monitor(1) RUL Helium Monitor monitor(1)
NAME
monitor - RUL Helium Monitor DOS-command
SYNOPSIS
monitor
DESCRIPTION
monitor is the DOS-command that establishes the RUL Helium Monitor
environment. The description of the RUL Helium Monitor is divided in the
following subsections: Introduction, Options and Invocation, The Screen,
Function Keys, File System and Configuration.
Introduction
The RUL Helium Monitor program provides the following features. It controls
the helium pollution meters via a multiplexer to obtain a measurement (sample)
each minute for each channel, and records this information in a databuffer. It
displays the pollution data on the screen for the last three minutes and the mean
pollution values for the last nine hours. Further it provides a command shell as
an user-interface to control the program, e.g. for setting the helium meter
configuration parameters and to retrieve the pollution data from the internal
database for further processing.
The RUL Helium Monitor program is intended to run continuously for a long
period of time. To be flexible enough, it provides it's own multitasking
environment, so pollution measurement can continue while you use the command
shell e.g. to retrieve some pollution data from the internal database. The software
used to implement these multitasking capabilities is PC-Xinu (see [1] and [2]).
Options and Invocation
When the RUL Helium Monitor program is started, it begins with executing the
shell command script file etc\monitor.rc (see Configuration below). There
are no command line options.
The screen
When started the screen shows three windows and a help line.
- the top window shows the program name and a time-of-day clock,
- the middle window represents the helium pollution data of 12 channels,
- the bottom window is a command shell;
for more information see shell(1),
- at the far bottom of the screen a function-key help line is displayed.
Function keys
The RUL Helium Monitor program can be controlled by means of the following
function keys.
- F1: with this key you can switch the size of the command shell window
between small and (almost) full screen,
- F3: when F3 is pressed, the presentation of pollution data is in numerical
form,
- F4: when F4 is pressed, the presentation of pollution data is in graphical form,
- F5: pressing F5 saves the pollution data immediately to the diskfile; saving is
normally done automatically at the end of the day,
- F10: with this key you can stop the alarm that is activated when the pollution
of a channel exceeds its alarm floor.
File system
The RUL Helium Monitor program uses a logical file system, the namespace, to
determine the real name of files and devices. When started, the file system is
set-up as follows.
prefix replace device
"[#]:" Ä> "" win (window device)
"(O):" Ä> "" cdos (cyclic file)
"aux:" Ä> "" aux (RS232c port)
"con:" Ä> "" con (console)
"nul:" Ä> "" nul (trash)
"prn:" Ä> "" lst (printer port)
"tty:" Ä> "" tty (terminal)
"root" Ä> "." namespace
"root\" Ä> ".\" namespace
"bin\" Ä> "root\bin\" namespace
"cfg\" Ä> "root\dat\" namespace
"dat\" Ä> "root\dat\" namespace
"etc\" Ä> "root\etc\" namespace
"log\ Ä> "root\dat\" namespace
"tmp\ Ä> "root\tmp\" namespace
"usr\ Ä> "root\usr\" namespace
"" Ä> "" dos (DOS-file)
To be able to find the system files, it is necessary to replace the definitions for
root and root\ with the actual absolute directory path including the drive
specification. This can be done with the mount command (see mount(1)) in
the monitor start-up file monitor.rc (see Configuration below and
monitor.rc(4)).
Configuration
When the RUL Helium Monitor program starts, it executes the shell command
file etc\monitor.rc. You can use this file to configure the program at
start-up (see shell(1)).
EXAMPLE
monitor
FILES
etc\monitor.rc
file with monitor start-up commands
SEE ALSO
shell(1)
REFERENCE
[1] Operating System Design - Volume I
The Xinu Approach / P.C. Edition
Douglas Comer
Timothy V. Fossum
Prentice Hall International, 1988
ISBN 0-13-638313-0
[2] Operating System Design - Volume II
Internetworking with Xinu
Douglas Comer
Prentice Hall International, 1987
ISBN 0-13-637646-0
mount(1) RUL Helium Monitor mount(1)
NAME
mount - install a logical device name
SYNOPSIS
mount [-h] [prefix device new_prefix]
-h: this help
DESCRIPTION
mount installs a logical device into the device map or namespace. This map is
used to resolve a logical name to a physical device or file.
device can be one of the following:
device description
aux RS232c serial port (COM1:)
cdos circular DOS file
con console (shell-window)
dos plain DOS file
lst parallel printer port (PRN:)
namespace logical namespace
nul NUL device
tty console (full screen)
win window device
EXAMPLE
mount root namespace c:\monitor
PRIVILEGE LEVEL
super user
SEE ALSO
unmount(1), which(1)
mv(1) RUL Helium Monitor mv(1)
NAME
mv - rename and move files and directories
SYNOPSIS
mv [-h] file tofile
-h: this help
DESCRIPTION
mv is used to rename files or move them to a different directory. Both file and
tofile must be specified completely.
EXAMPLE
mv tempfile tmp\tempfile
PRIVILEGE LEVEL
super user, operator, user
SEE ALSO
cp(1), rm(1)
passwd(1) RUL Helium Monitor passwd(1)
NAME
passwd - change user login password
SYNOPSIS
passwd [-h]
-h: this help
DESCRIPTION
The passwd command will change your login password. If you want to remove
an existing password, fill in `-' for the new password.
EXAMPLE
passwd
Old passwd: myoldpwd
New passwd: mynewpwd
Re-enter new passwd: mynewpwd
PRIVILEGE LEVEL
super user, operator, user
FILES
etc\passwd
file where passwords are stored
SEE ALSO
mkusr(1), passwd(4), rmusr(1)
ps(1) RUL Helium Monitor ps(1)
NAME
ps - display process and memory blocks
SYNOPSIS
ps [-h] [-c[time]] [pid ...]
-h : this help
-c : continuous status display (interval 60s)
-ctime: idem; pause time sec between update (time min 1s)
DESCRIPTION
ps shows the process status on Xinu. For each process ps displays the pid, the
process name, the status (ready, suspended, current, waiting, receiving), the
scheduling priority, the stack usage and stack space available and if waiting, the
semaphore identifier, or if receiving the message identifier.
If the -c option is specified, ps continuously displays the process status until
interrupted (^C). The update interval can be specified with the -c option.
If one or more pids are specified, ps displays these processes, otherwise all
processes are displayed.
EXAMPLE
ps -c5
PRIVILEGE LEVEL
super user
SEE ALSO
kill(1)
pwd(1) RUL Helium Monitor pwd(1)
NAME
pwd - print working directory
SYNOPSIS
pwd [-h]
-h: this help
DESCRIPTION
pwd prints the pathname of the current working directory on the standard output.
EXAMPLE
pwd
PRIVILEGE LEVEL
super user, operator, user
SEE ALSO
chdir(1)
quantum(1) RUL Helium Monitor quantum(1)
NAME
quantum - display or set preemption value (clock ticks)
SYNOPSIS
quantum [-h] [value]
-h : this help
value: preemption value (1..100)
DESCRIPTION
quantum displays the current preemption value or if a numeric argument is
specified, it sets it to this new value. Value is specified in clock ticks
(approximately 55 ms).
EXAMPLE
quantum 10
PRIVILEGE LEVEL
super user
SEE ALSO
resume(1) RUL Helium Monitor resume(1)
NAME
resume - resume a suspended process
SYNOPSIS
resume [-h] pid ...
-h: this help
DESCRIPTION
resume continues the running of a previously suspended process.
EXAMPLE
resume 2
PRIVILEGE LEVEL
super user
SEE ALSO
suspend(1)
retrieve(1) RUL Helium Monitor retrieve(1)
NAME
retrieve - export monitor data to LOTUS-123
SYNOPSIS
retrieve [-h] [-i] [-bdate] [-edate] channel ...
-h: this help
-i: print range of available data
-bdate: begin date (dd[-mm[-yy]])
-edate: end date (dd[-mm[-yy]])
DESCRIPTION
retrieve can be used to extract data from the RUL Helium Monitor internal
database and represent it in a LOTUS-123 readable file format. With this file you
can create graphs from LOTUS-123 to present the helium pollution data.
The retrieve command writes a different file for each channel specified. The
name for this file is entered in the configuration file with the config(1)
command. Valid channelnumbers are 1..12.
If the -i option is specified, retrieve prints the number of entries available in the
database, and the dates of the first and last entry.
You can specify the begin and end dates either interactively or with the -b and
-e options on the command line.
When a date is specified, the month (or/and year) part is optional: if no month
(or/and year) is specified the current month/year is assumed.
EXAMPLE
retrieve -b1-1-90 -e31-12-90 1 2 3
PRIVILEGE LEVEL
operator
FILES
cfg\monitor.cfg
monitor configuration file;
contains filename for LOTUS-123 readable file.
dat\monitor.dat
monitor data file;
contains the helium-meter data.
SEE ALSO
catdat(1), catlog(1), config(1), monitor.cfg(4),
monitor.dat(4), retrieve(4)
rm(1) RUL Helium Monitor rm(1)
NAME
rm - remove files
SYNOPSIS
rm [-h] file ...
-h: this help
DESCRIPTION
Each file argument to rm is removed (provided that it is a valid pathname).
EXAMPLE
rm myfile yourfile
PRIVILEGE LEVEL
super user, operator, user
SEE ALSO
cp(1), mv(1), rmdir(1)
rmdir(1) RUL Helium Monitor rmdir(1)
NAME
rmdir - remove directory
SYNOPSIS
rmdir [-h] directory ...
-h: this help
DESCRIPTION
The rmdir command removes each requested directory. Each directory
must be empty for rmdir to be successful.
EXAMPLE
rmdir mydir\mysub mydir
PRIVILEGE LEVEL
super user, operator, user
SEE ALSO
mkdir(1), rm(1)
rmusr(1) RUL Helium Monitor rmusr(1)
NAME
rmusr - remove an user entry
SYNOPSIS
rmusr [-h] [username ...]
-h: this help
DESCRIPTION
rmusr removes an user entry from the etc\passwd file. The only
non-removable entry is the root entry (super user).
EXAMPLE
rmusr a_user
PRIVILEGE LEVEL
super user
FILES
etc\passwd
file where passwords are stored
SEE ALSO
mkusr(1), passwd(1), passwd(4)
run(1) RUL Helium Monitor run(1)
NAME
run - run a shell script
SYNOPSIS
run [-h] script ...
-h: this help
DESCRIPTION
run executes the commands from the shell scripts specified.
EXAMPLE
run apr.sh
PRIVILEGE LEVEL
super user, operator, user
SEE ALSO
shell(1)
shell(1) RUL Helium Monitor shell(1)
NAME
shell - RUL Helium Monitor command shell
SYNOPSIS
not available as a separate command
DESCRIPTION
The description of the RUL Helium Monitor shell is divided in the following
subsections: Login, Privilege Level, Command Syntax, Command Execution,
Quoting, Parameter Substitution, Filename Generation, Redirection, Variables and
Internal Commands. The order of subsections dealing with substitution or
interpretation of input reflects the order in which the shell performs those
substitutions and interpretations. Because much of the functionality of the shell
is found in built-in commands, some features of the shell are documented only
in the specific pages for that built-in command.
Login
To get access to the RUL Helium Monitor shell, the user has to supply his
username to the login prompt. The shell validates the identity of a user who is
requesting access to the computer system, and establishes the initial environment
for the shell. The username is authenticated in the etc\passwd file (see
passwd(4)). You are prompted to enter a password only if username has a
password in etc\passwd. You may establish a password with the passwd(1)
command. After user authentication, the current working directory is changed to
the user's default home directory and the shell command file etc\login is
executed (see login(4)), followed by the execution of home\login. You can
leave the shell with exit(1), logout(1) or by pressing ^Z.
Privilege Level
The RUL Helium Monitor shell recognizes three different privilege levels. Each
username has a privilege level associated with it. For each privilege level there
is an entry in the etc\passwd file already.
level username usage
0 root system management, or super user level
1 operator helium monitor management
2 user user level
The system management level is intended for operations like adding or removing
user entries. The helium monitor management level is for setting helium-meter
configuration parameters and retrieving pollution data and the like. The user level
at last gives access to the helium pollution data, but no changes to any
configuration can be made.
Command Syntax
The shell implements a simple command syntax that allows to control the
execution of individual commands. When the shell scans its input, the following
characters are always treated specially:
& < > space tab new-line
Because these characters normally delimit arguments, they must be quoted to be
included in an argument (see Quoting below). A simple command is a list of
arguments separated by whitespace (blanks or tabs). The first word specifies the
name of the command to be executed. Except as stated below, the remaining
words are passed as arguments to the invoked command. The command name is
passed as argument 0.
A & terminating the command, causes asynchronous execution of the preceding
command (i.e., the shell does not wait for that command to finish). An argument
with an unquoted `#' introduces a comment, and input up to the next new-line is
discarded.
Command Execution
While a command is executing in the foreground, you can interrupt it by pressing
^C, or put it into the background by pressing ^B. With the fg(1) command you
can bring a command running in the background back into the foreground.
All commands are internal to the shell. No external DOS-commands can be
executed due to limitations of the PC-Xinu multitasking environment.
Quoting
In order to override the special meaning of certain special characters, a quoting
mechanism is provided in the shell. The most stringent quoting mechanism is to
surround the entire command argument with apostrophe (single quote) characters.
You can also surround arguments with quotation (double quote) characters. This
shell makes no distinction between both types of quotation. Everything between
quotation marks is within one command argument.
Parameter Substitution
There is no parameter substitution in this shell.
Filename Generation
Filenames in this shell are subject to the filename translation of the syntactic
namespace (logical file system, see mount(1)).
Redirection
Typically, commands running under the RUL Helium Monitor shell make use of
three standard input/output streams:
- standard input (0)
- standard output (1)
- standard error (2)
The number shown after the name of each stream above, is the file descriptor
number associated with that stream. Normally all three of these file descriptors
will represent the user's terminal. However it is possible to redirect two of these
file descriptors to or from another file (so that I/O on the associated streams
takes place on the file instead of the terminal). In fact, you can redirect the I/O
streams associated with the file descriptors `0' and `1', using the following
command line constructs:
name
Tells the shell to use the file name as standard output (file descriptor 1).
The file will be created if it does not already exist. Output written to the
file will overwrite the current contents of the file (if any).
Variables
This shell does not support variables.
Internal Commands
The following commands are built into the shell:
alarm(1), cat(1), catdat(1), catlog(1), chdir(1), chprio(1), close(1), cls(1),
config(1), cp(1), date(1), dev(1), display(1), echo(1), exit(1), fg(1), hello(1),
help(1), kill(1), login(1), logout(1), loop(1), ls(1), mem(1), mkdir(1), mkusr(1),
mount(1), mv(1), passwd(1), ps(1), pwd(1), quantum(1), resume(1), retrieve(1),
rm(1), rmdir(1), rmusr(1), run(1), shutdown(1), sleep(1), suspend(1), time(1),
unmount(1), uptime(1), version(1), wdog(1), which(1), who(1), xversion(1),
issue(1), passwd(1).
See the specific manual pages for details on these commands.
EXAMPLE
ps >tmp\tmpfile &
FILES
etc\issue
file with login herald message
etc\login
shell script executed at user login before HOME\login
etc\logout
shell script executed at user logout after HOME\logout
etc\passwd
file where the passwords are stored
SEE ALSO
passwd(1), who(1), issue(4), passwd(4)
shutdown(1) RUL Helium Monitor shutdown(1)
NAME
shutdown - leave the RUL Helium Monitor program.
SYNOPSIS
shutdown [-h]
-h: this help
DESCRIPTION
The shutdown command stops the execution of all processes, leaves the PC-Xinu
environment and returns to MS-DOS.
EXAMPLE
shutdown
PRIVILEGE LEVEL
super user
SEE ALSO
sleep(1) RUL Helium Monitor sleep(1)
NAME
sleep - suspend execution for a specified time (s)
SYNOPSIS
sleep [-h] delay
-h: this help
DESCRIPTION
The sleep command will continue running until the specified number of seconds
has elapsed. sleep can delay execution of a program. The delay argument must
be specified in seconds.
EXAMPLE
sleep 10
PRIVILEGE LEVEL
super user, operator, user
SEE ALSO
date(1), time(1)
suspend(1) RUL Helium Monitor suspend(1)
NAME
suspend - suspend a ready process
SYNOPSIS
suspend [-h] pid ...
-h: this help
DESCRIPTION
suspend stops the execution of a process specified by it's pid. To continue
execution use the resume command.
EXAMPLE
suspend 3
PRIVILEGE LEVEL
super user
SEE ALSO
resume(1)
time(1) RUL Helium Monitor time(1)
NAME
time - display date and time or set time
SYNOPSIS
time [-h] [time]
-h : this help
time: hh[:mm[:ss]]
DESCRIPTION
if no argument is specified the command time displays the current date and time;
when an argument is given it is taken to be a new time to be set to the real time
clock.
EXAMPLE
time 12:34
PRIVILEGE LEVEL
super user, operator
SEE ALSO
date(1)
unmount(1) RUL Helium Monitor unmount(1)
NAME
unmount - uninstall logical device
SYNOPSIS
unmount [-h] prefix ...
-h: this help
DESCRIPTION
unmount uninstalls the specified prefix(es).
EXAMPLE
unmount mydev
PRIVILEGE LEVEL
super user
SEE ALSO
mount(1), which(1)
uptime(1) RUL Helium Monitor time(1)
NAME
uptime - display system up time
SYNOPSIS
uptime [-h] [-s]
-h: this help
-s: up since date
DESCRIPTION
uptime display the number of days, hours and minutes since startup of the
system. If the -s option (since) is specified the date and time of startup is
appended.
EXAMPLE
uptime -s
PRIVILEGE LEVEL
super user, operator, user
SEE ALSO
date(1), time(1)
version(1) RUL Helium Monitor version(1)
NAME
version - display monitor version and date
SYNOPSIS
version [-h]
-h: this help
DESCRIPTION
version displays the version number and date of creation of the
RUL Helium Monitor program.
EXAMPLE
version
PRIVILEGE LEVEL
super user, operator, user
SEE ALSO
xversion(1)
wdog(1) RUL Helium Monitor wdog(1)
NAME
wdog - control watchdog process
SYNOPSIS
wdog [-h] [-i] [-r] [-a] [-u] [-ttime] [-vtime]
-h : this help
-i : install
-r : remove
-a : activate
-u : unactivate
-ttime: set terminal idle time
-vtime: set message interval time
DESCRIPTION
The wdog command controls the watchdog process. The watchdog process is
currently used only to check the terminal idle time. The wdog command installs,
removes, activates or unactivates the watchdog process. Further it can set the
check terminal idle time and message interval time of the watchdog process.
EXAMPLE
wdog -r
PRIVILEGE LEVEL
super user
SEE ALSO
alarm(1)
which(1) RUL Helium Monitor which(1)
NAME
which - print full pathname for file
SYNOPSIS
which [-h] file ...
-h: this help
DESCRIPTION
which prints the full pathname for the specified files. This is useful to determine
the full pathname of files on a logical device.
EXAMPLE
which etc\issue
PRIVILEGE LEVEL
super user, operator, user
SEE ALSO
mount(1), unmount(1)
who(1) RUL Helium Monitor who(1)
NAME
who - print login accounting information
SYNOPSIS
who [-h]
-h: this help
DESCRIPTION
who prints the user name, tty number the user is working on and the login time
of the user currently logged in.
EXAMPLE
who
PRIVILEGE LEVEL
super user, operator, user
FILES
etc\passwd
file where passwords are stored
SEE ALSO
shell(1), login(1)
xversion(1) RUL Helium Monitor xversion(1)
NAME
xversion - display Xinu version and date
SYNOPSIS
xversion [-h]
-h: this help
DESCRIPTION
version displays the version number and date of creation of the Xinu library.
EXAMPLE
xversion
PRIVILEGE LEVEL
super user, operator, user
SEE ALSO
version(1)
BUGS
The date shown is the date of creation of the monitor(1) program; the version
number is right.
Section 2 (System Calls)
NAME
intro - introduction to system calls
DESCRIPTION
Because the RUL Helium Monitor does not provide a system call interface,
Section 2 is provided solely as a placeholder.
Section 3 (C Runtime Library)
NAME
intro - introduction to the C runtime library
DESCRIPTION
Because the RUL Helium Monitor does not provide a C library interface, Section
3 is provided solely as a placeholder.
Section 4 (File formats)
intro(4) RUL Helium Monitor intro(4)
NAME
intro - introduction to file formats
DESCRIPTION
Section 4 of the RUL Helium Monitor Reference Manual gives more detailed
information on the formats of files used by the various commands described in
Section 1.
a.$$$(4) RUL Helium Monitor a.$$$(4)
NAME
a.$$$ - format of etc\a.$$$ file
DESCRIPTION
Command at(1) saves the timed commands in file etc\a.$$$. This file
contains entries with the following format.
long-time username
command
...
command
The entries are ordered by their time value such that the next command to be
executed is the first entry in the file.
SEE ALSO
at(1)
issue(4) RUL Helium Monitor issue(4)
NAME
issue - format of etc\issue file
DESCRIPTION
The file etc\issue customizes the message printed by login(1) when it first
asks for a user name. If no etc\issue file is found, login will prompt with the
string `login: '.
If the file exists, login will start by printing the etc\issue file minus the last
line. Each time login requests that a user name be entered, it will prompt with the
last line of the file.
SEE ALSO
login(1), shell(1)
login(4) RUL Helium Monitor login(4)
NAME
login - format of etc\login file
DESCRIPTION
login(1) executes the commands from the file etc\login at user login
before the commands from the user home\login file are executed. This can be
used to registrate the logins that are made.
SEE ALSO
login(1), shell(1)
logout(4) RUL Helium Monitor logout(4)
NAME
logout - format of etc\logout file
DESCRIPTION
login(1) executes the shell command script etc\logout at user logout after
the user shell script home\logout is executed.
SEE ALSO
login(1), shell(1)
monitor.cfg(4) RUL Helium Monitor monitor.cfg(4)
NAME
monitor.cfg - format of cfg\monitor.cfg file
DESCRIPTION
The cfg\monitor.cfg monitor configuration file contains names for monitor
channel description and datafiles, and parameter values for alarm settings and
helium-meter calibration.
The format of this file is an array of 12 items with the following structure.
typedef struct
{
char channel; /* number for this channel */
char chdes[CFGDESLEN]; /* description for this channel */
char chfil[CFGFILLEN]; /* data-filename for this channel */
float flowfactor; /* flowmeter factor [m3/pulse] */
float flowalarm; /* flow alarm floor [m3/pulse] */
float polfactor; /* pollution factor [%/bit] */
float polalarmlocal; /* pollution alarm local [%] */
float polalarmpublic; /* pollution alarm public [%] */
float refoffset; /* He-reference offset [%] */
float refalarm; /* He-reference alarm [%] */
};
t_cfg;
SEE ALSO
monitor.dat(4), monitor.log(4)
monitor.dat(4) RUL Helium Monitor monitor.dat(4)
NAME
monitor.dat - format of dat\monitor.dat file
DESCRIPTION
dat\monitor.dat is a circular buffer file (device cdos). It contains the data
of the helium-meters. If this file does not exist when monitor(1) starts
execution, then it will be created with 43800 entries of the structure described
below. This is enough to hold data for 5 years.
The size of the datafile is approximately 6 Mbyte. Creation of this file will take
some time: approx. 45 min on a 8 MHz PC-XT!
The format of the entries in the monitor.dat file is as follows.
typedef struct
{
t_mmm mmm[CHASIZ]; /* for all channels */
struct date date; /* Unix date */
struct time time; /* and time information */
}
t_hrs;
where t_mmm is:
typedef struct
{
unsigned char cha; /* channel number */
unsigned char num; /* number of sample this hour */
unsigned char excmean; /* bridge excitation voltage code */
unsigned char refmean; /* reference voltage code */
signed char difmean; /* pollution mean voltage code */
signed char difmin; /* pollution min. voltage code */
signed char difmax; /* pollution max. voltage code */
unsigned long cnttot; /* volume meter total pulse count */
}
t_mmm;
SEE ALSO
monitor.cfg(4), monitor.log(4)
monitor.log(4) RUL Helium Monitor monitor.log(4)
NAME
monitor.log - format of log\monitor.log file
DESCRIPTION
log\monitor.log is a circular buffer file (device cdos). It contains messages
from the system (start-up time), and can be printed to from the shell:
echo "text" >(O):log\monitor.log
New messages are appended to the end of the buffer and if the buffer gets full,
the oldest information is overwritten. The buffer can contain 10 kbyte text.
SEE ALSO
monitor.cfg(4), monitor.dat(4)
monitor.rc(4) RUL Helium Monitor monitor.rc(4)
NAME
monitor.rc - format of etc\monitor.rc file
DESCRIPTION
etc\monitor.rc is a shell script that is executed by monitor(1) at start-
up.
This is the location to configure the RUL Helium Monitor program: mounting the
root directory, specifying process priorities, install processes (at(1),
alarm(1), wdog(1)) etc..
EXAMPLE
# mount root directory
mount root namespace c:\helium
mount root\ namespace c:\helium\
at -i # (re-)install at process
wdog -i # install watch-dog process
SEE ALSO
monitor(1)
passwd(4) RUL Helium Monitor passwd(4)
NAME
passwd - format of etc\passwd file
DESCRIPTION
login(1) uses etc\passwd to hold the names, passwords, and other
information on all authorized users of the computer.
Each line of the file is a record representing one user. Each record contains
fields, separated by semicolons. The fields are as follows:
user name
user password
numerical user ID
numerical group ID
comments field
home directory
default command (not used)
The user name is the name that should be typed to login to identify someone as
an authorized user.
The user password is either omitted (represented by a `-' in the password field),
or else is the password which login compares to the password entered by the
user. The password is not (yet) encrypted.
Each user has a unique numerical user ID within his group.
The numerical group ID is used to divide the users into different groups with
different capabilities:
0 - superuser
1 - operator
2 - user
3..15 - other
The comments field may contain anything you want, but often it contains the
user's full name.
The home directory is the initial working directory when you begin a session.
The default command entry is currently unused.
SEE ALSO
shell(1)
retrieve(4) RUL Helium Monitor retrieve(4)
NAME
retrieve - format of LOTUS-123 readable output file
DESCRIPTION
retrieve(1) converts the helium pollution data from the internal database
format into the format described below and writes it into a file. There is one file
per channel. It's name, along with other information, is defined in monitor(4)
(see also config(1)).
The LOTUS-123 readable file consists of two parts: a header part that contains
eight records (lines) followed by a data part that can contain a variable number
of data records.
The header part contains the following records: a channelnumber, description,
filename, helium-meter pollution sensitivity, current reference-helium pollution,
flow-meter sensitivity, an empty line and a header for the data part.
A data record contains the following fields: date, time, number of samples
collected, mean pollution, minimum pollution, maximum pollution, helium flow,
helium-meter NTC-bridge excitation voltage and the helium-meter reference-NTC
voltage.
An example of this file format is shown below.
"channel" 2
"description" "Kanaal 2"
"filename" "a:\kanaal2.prn"
"polfactor [%]" 0.039400
"refoffset [%]" 0.000000
"flowfactor [l]" 1.000000
"date" "time" "#" "pol [%]" "min [%]" "max[%]" "volume [l]" "brdg_exc [V]"
"brdg_ref [V]"
"27/11/90" "14:30" 0 0.00 5.00 -5.04 0.00 0.00 0.00
"27/11/90" "15:30" 12 2.29 0.24 0.28 626.00 12.53 5.71
"28/11/90" "10:30" 31 1.26 0.83 5.00 1741.00 12.24 5.41
"28/11/90" "11:30" 60 0.83 0.35 4.73 3261.00 12.18 5.00
"28/11/90" "12:30" 60 0.35 0.20 0.87 3260.00 12.18 4.71
"28/11/90" "13:30" 11 2.13 2.01 2.76 610.00 12.18 4.65
"28/11/90" "14:30" 60 1.30 0.59 2.32 3329.00 12.18 4.65
"28/11/90" "15:30" 60 0.95 0.47 2.80 3314.00 12.18 4.59
"28/11/90" "16:30" 59 0.51 0.43 0.63 3297.00 12.18 4.59
"28/11/90" "17:30" 60 0.47 0.35 0.59 3295.00 12.18 4.59
SEE ALSO
config(1), retrieve(1)
Section 5 (Miscellaneous Information)
intro(5) RUL Helium Monitor intro(5)
NAME
intro - introduction to miscellaneous information
DESCRIPTION
Section 5 of the RUL Helium Monitor Reference Manual gives details on
miscellaneous topics not covered in other sections. General overviews, tables,
packages, and so on are included in this section.
Currently, Section 5 is empty.