catremote
is invoked by simply typing:
Arguments may be supplied on the command line or prompted for. Obviously, if catremote
is being
invoked from a script the arguments will usually be supplied on the command line.
The first command-line argument is the mode of operation. The permitted values are listed in Table 2.
The mode can only be specified on the command line. If it is omitted then ‘help
’ mode is
assumed.
The subsequent arguments required depend on the mode chosen and are summarised in Table 3.
Command line arguments are identified by position. They may optionally be omitted, starting at the
right. Omitted arguments will usually be prompted for. Exceptions are the server-type in list
mode,
any additional-condition in query
mode and the mode itself (see below). For each mode the input
required and output produced is described below.
catremote list | server-type |
catremote details | db-name |
catremote query | db-name radius additional-condition |
catremote name | db-name object-name |
catremote help | |
catremote
list
modelist
mode has a single optional argument, the server-type. The values permitted
are listed in Table 4 (and SSN/75[3] gives more details of the individual types).
catremote
lists all the databases in the current configuration file which match the given
server-type. If the argument is omitted then ‘all
’ is assumed (that is, all the databases in
the configuration file are listed).
For each database, the first item is its name, the second its server type and the rest of the line gives a short description.
details
modedetails
mode has a single input argument, db-name; the name of the database for which
the details are to be shown (see Section 2). This database must be included in the current
configuration file.
short_name: | name of the database |
serv_type: | server type of the database (see Table 4) |
long_name: | a short description of the database |
url: | URL of the database server |
search_cols: | columns on which range searches are supported |
help: | URL of help page for the database |
query
modequery
mode has the arguments described below. Any arguments which are omitted will
be prompted for, with the exception of additional-condition. Thus, if an additional-condition
is specified then all the arguments must be included on the command line.
:
’) as the separator.
:
’) as the separator. Southern Declinations are
negative.
column-name=minimum-value,maximum-value
and objects will only be selected if their value for column column-name lies between minimum-value and maximum-value. The second is:
minimum-magnitude,maximum-magnitude
here the range is assumed to be a magnitude and no column name is specified (remember that magnitudes increase the ‘wrong way round’ so that minimum-magnitude corresponds to the brightest object). The third is:
maximum-magnitude
which is again assumed to be a magnitude and only objects brighter than maximum-magnitude are selected. For completeness, the relationship between the forms of additional-condition and the ‘query tokens’ for the database specified in the configuration file (as described in SSN/75[3]) is that additional-condition replaces the tokens as follows:
Form | replaces token | |
first: | column-name=minimum-value,maximum-value | %cond |
second: | minimum-magnitude,maximum-magnitude | %m1 , %m2 |
third: | maximum-magnitude | %m |
catremote
displays a line showing the name of the file created, for
example:
If the catalogue contained no objects which satisfied the query catremote
will report:
name
modename
mode has the following two arguments. If they are omitted then they will be
prompted for.
simbad_ns@eso
, the SIMBAD name resolver provided by ESO
using the SIMBAD2
integrated database maintained by the Centre de Données astronomiques de Strasbourg
(CDS).
simbad_ns@eso
and probably will not
be significant for other name resolvers.
The Right Ascension is in sexagesimal hours, the Declination in sexagesimal degrees and both
are for equinox J2000. If the name could not be resolved then catremote
reports:
help
mode2http://simbad.u-strasbg.fr/Simbad