aboutsummaryrefslogtreecommitdiff
path: root/vendor/voclient/doc/vocatalog.html
blob: 72a1615221a693b32534e304223a6ed87747d821 (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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
Content-type: text/html

<HTML><HEAD><TITLE>Manpage of VOCATALOG</TITLE>
</HEAD><BODY>
<H1>VOCATALOG</H1>
Section: User Commands  (1)<BR>Updated: Feb 2013<BR><A HREF="#index">Index</A>
<A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR>

<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>

vocatalog - Query VO catalog services for data
<P>
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>

<B>vocatalog</B> [&lt;opts&gt;] &lt;service&gt; [ &lt;object&gt; | &lt;ra&gt; &lt;dec&gt; ] [ &lt;size&gt; ]
<P>
<A NAME="lbAD">&nbsp;</A>
<H2>OPTIONS</H2>

The <I>vocatalog</I> application accepts the following options:
<DL COMPACT>
<DT><B>-h, --help</B>

<DD>
Print a help summary to the terminal and exit.  No processing is done 
following this flag.
<P>
<DT><B>All VODATA task options</B>

<DD>
<P>
</DL>
<A NAME="lbAE">&nbsp;</A>
<H2>DESCRIPTION</H2>

The <I>vocatalog</I> task is a convenience application built on top of the
<I>vodata</I> application, logically it will only query for catalog data and
will set the appropriate flags when calling <I>vodata</I>.
<P>

For a complete list of options and a description of the task behavior, see
the <I>VODATA</I> man page.
<P>
<A NAME="lbAF">&nbsp;</A>
<H2>RETURN STATUS</H2>

On exit the <B>vocatalog</B> task will return a zero indicating success, or a
one indicating an error.
<P>
<A NAME="lbAG">&nbsp;</A>
<H2>EXAMPLES</H2>

<DL COMPACT>
<DT>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:<DD>
<P>
<PRE>
  % 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)
</PRE>

<DT>2) Print a count of X-ray catalog data around Abell2712:<DD>
<P>
<PRE>
  % vocatalog -c -b x-ray any abell2712
  % vocatalog --count -b x-ray any abell2712
</PRE>

<P>
</DL>
<A NAME="lbAH">&nbsp;</A>
<H2>BUGS</H2>

No known bugs with this release.
<A NAME="lbAI">&nbsp;</A>
<H2>Revision History</H2>

Feb 2013 - First public release
<A NAME="lbAJ">&nbsp;</A>
<H2>Author</H2>

Michael Fitzpatrick (<A HREF="mailto:fitz@noao.edu">fitz@noao.edu</A>), Feb 2013
<A NAME="lbAK">&nbsp;</A>
<H2>SEE ALSO</H2>

vodata, voimage, vospectrum
<P>

<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT><A HREF="#lbAB">NAME</A><DD>
<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT><A HREF="#lbAD">OPTIONS</A><DD>
<DT><A HREF="#lbAE">DESCRIPTION</A><DD>
<DT><A HREF="#lbAF">RETURN STATUS</A><DD>
<DT><A HREF="#lbAG">EXAMPLES</A><DD>
<DT><A HREF="#lbAH">BUGS</A><DD>
<DT><A HREF="#lbAI">Revision History</A><DD>
<DT><A HREF="#lbAJ">Author</A><DD>
<DT><A HREF="#lbAK">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 05:13:22 GMT, April 14, 2013
</BODY>
</HTML>