.help mkregdb Mar12 votools
.ih
NAME
mkregdb -- Create a local registry database
.ih
USAGE
mkregdb query
.ih
PARAMETERS
.ls query
Registry query term(s).
.le
.ls output = ""
Output filename.
.le
.ls type = ""
Constraint on the resource type (e.g. 'catalog' or 'image')
.le
.ls bandpass = ""
Constraint on the resource spectral coverage.
.le
.ls content = ""
Constraint on the resource content level.
.le
.ls sql = ""
Arbitrary SQL predicate string.
.le
.ls header = yes
Print header?
.le
.ls nresults = 0
Updated with the number of resources found.
.le
.ls status = 0
Status value, a non-zero value indicates an error.
.le

.ih
DESCRIPTION

The \fIMKREGDB\fR task is used to create a local resource database that
matches a given query term and service constraints.  The \fIquery\fR 
parameter is a search term or phrase for the Registry, results may be
constrained by specifying the \fItype\fR, \fIbandpass\fR, \fIcontent\fR
or \fIsql\fR parameters.  Output is written to the \fIoutput\fR filename
(or "STDOUT" if a null string).

The \fItype\fR parameter is currently limited to supported data services,
namely 'image', 'catalog' or 'spectra'.  The \fIcontent\fR parameter can be
used to select only research-grade service, EPO data, etc.  Allowed content
values are described in the IVOA Resource Metadata document
(http://www.ivoa.net/Documents/latest/RM.html).  

The \fIbandpass\fR constraint may be one of the following values:
.nf
    radio
    millimeter
    infrared, IR
    optical
    ultraviolet, ultra-violet, EUV, UV
    xray, x-ray
    gamma, gammaray, gamma-ray
.fi

When done, the \fInresults\fR parameter is updated with the number of
matching records found.  Note that non-data services (e.g. institutional
names) are not included in the result table.  If an error is encountered,
or no results are found, the \fIstatus\fR parameter will contain a 
non-zero value.

.ih
EXAMPLES

1) Create a local database of VO Resources containing image data on quasars:

.nf
  votools> mkregdb quasar type="image"
.fi

2) Create a local database of all IR catalog services.

.nf
  votools> mkregdb "" bandpass="infrared" type="catalog"
.fi

.ih
REVISIONS

.ih
SEE ALSO
regdb, registry

.endhelp