.help caldbinfo 95Dec ftools.caltools 
.ih
NAME
CALDBINFO -- Checks whether a local CALDB is correctly installed for a user
.ih
USAGE
   caldbinfo infomode
.ih
DESCRIPTION
This task will check and report back on whether a local or remote Calibration
Database (Caldb) appears to be correctly set-up and accessible to a user. The
level of checking and detail of the reporting depend upon the user-defined
parameters infomode and chatter as described below.

Any error messages returned by this task indicate that the local Caldb is not
correctly set-up or accessible to the user. This is likely to prevent a number
of ftools from using the Caldb. In such cases users should: 
.ls first
re-run
caldbinfo, but with the chatter flag set high (eg chatter=30) to get additional
helpful diagnostic message
.le 
.ls second
If you are accessing a local or remote installation of the HEASARC Caldb
for one or more missions, contact the Caldb Manager by sending an e-mail to the
Calibration Database Mailing list at the HEASARC Feedback page
(https://heasarc.gsfc.nasa.gov/cgi-bin/Feedback) 
.le
.ls

At chatter=3 level, machine-readable strings appear for various
CALDB paths and file names.

.ih
PARAMETERS
.ls infomode [string] 
This parameter controls the level of Caldb configuration testing. 
If infomode=BASIC, the task simply checks that the required Caldb environment variables are defined.
If infomode=INST, in addition to performing the checks for infomode=BASIC,
the routine checks that a user-defined mission/instrument combination exists
in the Caldb Configuration file. At chatter = 30, the location of the relevant 
files and directories are reported. 
.le
.ls mission [string]
The name of the mission for which the Caldb Configuration file is to be 
searched. This parameter is only required when infomode=INST.
.le
.ls instrument [string]
The name of the instrument for which the Caldb Configuration file is to be
searched. This parameter is only required when infomode=INST.
.le
.ls (chatter = 9) [integer]
Flag to indicate how chatty the task is at execution. A value of 9 is the 
default, with lower/higher values producing quieter/verbose output respectively.
A value of chatter=0 gives totally silent running, with the exception of 
error messages. For all values of chatter, a message will be written to STDERR
if any errors are encountered.
.le

.ih
EXAMPLES
1.  Do a basic (but silent) check that the Caldb is set-up

    ca> caldbinfo infomode=BASIC chatter=0

2. Do a basic check that the Caldb is set-up, but reporting detailed 
information to STDOUT

    ca> caldbinfo infomode=BASIC chatter=20

3. Silently check that the Caldb is set-up & accessible for a given 
mission/instrument combination

    ca> caldbinfo infomode=INST chatter=0 mission=XTE instrument=PCA
.ih
BUGS
none known
.ih
SEE ALSO
crcif, quzcif
.ih
LOG OF SIGNIFICANT CHANGES
PRIMARY AUTHOR
.nf
Ian M George
HEASARC
NASA/GFSC
.fi
.endhelp

