aboutsummaryrefslogtreecommitdiff
path: root/vendor/voclient/doc/vocatalog.man
blob: 400892df4bf55baec73ad45818ccaccb6351e108 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
." @(#)vocatalog.1 1.0 Feb-2013 MJF
.TH VOCATALOG 1 "Feb 2013" "VOClient Package"
.SH NAME
vocatalog \- Query VO catalog services for data

.SH SYNOPSIS
\fBvocatalog\fP [<opts>] <service> [ <object> | <ra> <dec> ] [ <size> ]

.SH OPTIONS
The \fIvocatalog\fP application accepts the following options:
.TP 6
.B \-h, --help
Print a help summary to the terminal and exit.  No processing is done 
following this flag.

.TP 6
.B All VODATA task options

.SH DESCRIPTION
The \fIvocatalog\fP task is a convenience application built on top of the
\fIvodata\fP application, logically it will only query for catalog data and
will set the appropriate flags when calling \fIvodata\fP.
.PP
For a complete list of options and a description of the task behavior, see
the \fIVODATA\fP man page.

.SH RETURN STATUS
On exit the \fBvocatalog\fP task will return a zero indicating success, or a
one indicating an error.

.SH EXAMPLES
.TP 4
1) Query the GSC 2.3 catalog for stars a) within the 0.1 degree default search size around NGC 1234:  b) around all positions contained in file 'pos.txt':  c) for the list of objects given on the command line:  d) query a list of services for a list of positions: e) print a count of results that would be returned from 3 services for each position in a file:

.nf
  % vocatalog gsc2.3 ngc1234                 (a)
  % vocatalog gsc2.3 pos.txt                 (b)
  % vocatalog gsc2.3 m31,m51,m93             (c)
  % vocatalog svcs.txt pos.txt               (d)
  % vocatalog hst,chandra,gsc2.3 pos.txt     (e)
.fi
.TP 4
2) Print a count of X-ray catalog data around Abell2712:

.nf
  % vocatalog -c -b x-ray any abell2712
  % vocatalog --count -b x-ray any abell2712
.fi

.SH BUGS
No known bugs with this release.
.SH Revision History
Feb 2013 - First public release
.SH Author
Michael Fitzpatrick (fitz@noao.edu), Feb 2013
.SH "SEE ALSO"
vodata, voimage, vospectrum