osirisScriptMsg -- a general purpose utility for reporting script

NAME

osirisScriptMsg -- a general purpose utility for reporting script

OSIRIS library of scripts

messages to STDOUT, OGS, or a text log file.

SYNOPSIS

osirisScriptMsg [-t #] [-T] [-f filename] [-S] [-E] [-W] [-m] "message"

DESCRIPTION

This script is designed to provide a uniform way of reporting a
variety of script messages (status, warnings, or errors) to STDOUT,
the OSIRIS global server, and text log files. Originally designed
mostly for use with osirisTakeDataset and ODEC, this script may
be useful in other contexts as well.

OPTIONS

-t #
ID number to attach to all script generated errors, warnings, and
questions that are passed to the OGS. The ID number is separated
from the rest of the message with a ";".

-T
general message - report to STDOUT with an "echo" command

-f filename
log the message to "filename"
-S
status message - report to OGS "setstatus" keyword

-E
error message - report to OGS "scripterror" keyword
keyword set only if ID number is non-zero

-W
warning message - report to OGS "scriptwarn" keyword
keyword set only if ID number is non-zero

-A
ask message - report to OGS "scriptask" keyword
keyword set only if ID number is non-zero

-m
simulate calls to RPC servers. during simulated calls, the
command is echoed (instead of being executed).

"message"
the text message to be reported. the text may not begin with a
dash "-".

EXAMPLES

osirisScriptMsg -t 12345 -T -E "Bad things are happening"
The message "Bad things are happening" will be echoed to STDOUT
and sent to the OGS "scripterror" keyword with the ID number
12345 attached.

ENVIRONMENT VARIABLES

none

FILES

none

SERVERS & KEYWORDS

service = osiris
keywords: setstatus, scripterror, scriptwarn, scriptask

SCRIPTS CALLED

help, syncheck

EXIT STATUS

update this...
0 - normal exit, no error
1 - script aborted by an interrupt
2 - syncheck error
3 - error parsing command line input
other errors...

SEE ALSO

???

See Also

The shell script osirisScriptMsg
OSIRIS script index

---

Go to: OSIRIS Home Page - Instruments Home Page - Keck Home Page

---

Last modified: Fri Feb 18 02:51:29 2022