Initial commit

1 files changed, 117 insertions, 0 deletions

diff --git a/vo/votools/doc/regdb.hlp b/vo/votools/doc/regdb.hlp
new file mode 100644
index 00000000..52c7a74d
--- /dev/null
+++ b/vo/votools/doc/regdb.hlp
@@ -0,0 +1,117 @@
+.help regdb Mar12 votools
+.ih
+NAME
+regdb -- Manage/Query a local VO Registry database
+.ih
+USAGE
+regdb arg1 <arg2> <arg3>
+.ih
+PARAMETERS
+.ls arg1, arg2, arg3
+Command argument strings.  The \fIarg1\fR parameter is in general the name
+of an operation to be performed (see below), depending on its value the
+additional \fIarg\fR parameters may or may not be required.
+.le
+.ls type = ""
+Service type constraint term.
+.le
+.ls bandpass = ""
+Bandpass constraint term.
+.le
+.ls verbose = no
+Verbose output?
+.le
+.ls status = 0
+Status value, a non-zero value indicates an error or no results found..
+.le
+
+.ls OUTPUT PARAMETERS
+If a matching record is found, one or more of the following task parameters
+may be updated with the record values:
+.nf
+       (alias = "")       	Resource alias
+       (ivorn = "")             Ivorn string
+       (sname = "")       	Short Name
+     (svctype = "")             Resource type
+       (bpass = "")             Bandpass
+         (url = "")             Service URL
+        (desc = "")             Description (Title string)
+.fi
+
+
+.ih
+DESCRIPTION
+
+The \fIREGDB\fR task is used to query or manage the local registry database
+file defined by the VO package \fIresdb\fR parameter.  A local registry
+database allows tasks to use preferred resources without generating a 
+query to the VO Registry each time information about the resource is 
+needed (e.g. the service URL), or to refer to a resource by a user-defined
+alias.  The \fIarg1\fR parameter may be either a command to manage the
+database, or a search term for the database, in all cases the results are
+written to the standard output.
+
+Searches may be constrained by setting the \fItype\fR or \fIbandpass\fR
+parameter to match only those records meeting the constraints.  This can
+be used for example to select the image service in a registry database
+containing multiple services with the same name alias.
+
+.ih
+COMMANDS
+
+If the first argument to the task is not in the following list of allowed
+commands, it is assumed to be a search term.  Record searches are done 
+as case-insensitive substring matches against all the saved fields of 
+the record.
+
+The following commands are supported:
+
+.nf
+    list	List the registry database records
+    resolve	Resolve (search) for the \fIarg2\fR string
+    search	Search for (resolve) the \fIarg2\fR string
+
+    type	Print the service type for records matching \fIarg2\fR
+    alias	Print the DB alias for records matching \fIarg2\fR
+    bpass	Print the bandpass value for records matching \fIarg2\fR
+    ivorn	Print the VO identifier for records matching \fIarg2\fR
+    sname	Print the VO ShortName for records matching \fIarg2\fR
+    url		Print the ServiceURL for records matching \fIarg2\fR
+    desc	Print the Description for records matching \fIarg2\fR
+
+    add		Add a record for the service
+    del		Delete the record that matches the \fIarg2\fR string
+    update	Do a new Registry query and update the local DB
+    rename	Rename the local record alias
+.fi
+
+.ih
+EXAMPLES
+
+1) List the local resource database.  Repeat but list only the image
+services.  Repeat again looking for radio catalog services.
+.nf
+  votools> regdb list
+  votools> regdb list type="image"
+  votools> regdb list type="catalog" bandpass="radio"
+.fi
+
+2) Print the URL for the DSS service in the registry database. 
+.nf
+  votools> regdb url alias="dss"
+.fi
+
+3) Find the one X-Ray service in the registry database:
+.nf
+  votools> regdb resolve bandpass="x-ray"
+.fi
+
+
+.ih
+REVISIONS
+
+.ih
+SEE ALSO
+mkregdb, registry
+
+.endhelp