/usr/share/doc/stilts/sun256/regquery-usage.html is in stilts-doc 3.1.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 | <html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="sun-style.css">
<title>Usage</title>
</head>
<body>
<hr>
<a href="secB.15.2.html">Next</a> <a href="regquery.html">Previous</a> <a href="regquery.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="secB.15.2.html">Examples</a><br>
<b>Up: </b><a href="regquery.html">regquery: Queries the VO registry</a><br>
<b>Previous: </b><a href="regquery.html">regquery: Queries the VO registry</a><br>
<hr>
<h3><a name="regquery-usage">B.15.1 Usage</a></h3>
<p>The usage of <code>regquery</code> is
<pre>
stilts <stilts-flags> regquery query=<value> regurl=<url-value>
soapout=<out-file> ocmd=<cmds>
omode=out|meta|stats|count|cgi|discard|topcat|samp|tosql|gui
out=<out-table> ofmt=<out-format>
</pre>
If you don't have the <code>stilts</code> script installed,
write "<code>java -jar stilts.jar</code>" instead of
"<code>stilts</code>" - see <a href="invoke.html">Section 3</a>.
The available <code><stilts-flags></code> are listed
in <a href="stilts-flags.html">Section 2.1</a>.
For programmatic invocation, the Task class for this
command is <code>uk.ac.starlink.ttools.task.RegQuery</code>.
</p>
<p>Parameter values are assigned on the command line
as explained in <a href="task-args.html">Section 2.3</a>.
They are as follows:
</p>
<p>
<dl>
<dt><strong><code>ocmd = <cmds></code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/filter/ProcessingStep.html">ProcessingStep[]</a>)</em></strong></dt>
<dd>Specifies processing to be performed on
the output table,
after all other processing has taken place.
The value of this parameter is one or more of the filter
commands described in <a href="filterSteps.html">Section 6.1</a>.
If more than one is given, they must be separated by
semicolon characters (";").
This parameter can be repeated multiple times on the same
command line to build up a list of processing steps.
The sequence of commands given in this way
defines the processing pipeline which is performed on the table.
<p>Commands may alteratively be supplied in an external file,
by using the indirection character '@'.
Thus a value of "<code>@filename</code>"
causes the file <code>filename</code> to be read for a list
of filter commands to execute. The commands in the file
may be separated by newline characters and/or semicolons.
</p>
</dd>
<dt><strong><code>ofmt = <out-format></code> <em>(String)</em></strong></dt>
<dd>Specifies the format in which the output table will be written
(one of the ones in <a href="outFormats.html">Section 5.2.2</a> - matching is
case-insensitive and you can use just the first few letters).
If it has the special value
"<code>(auto)</code>"
(the default),
then the output filename will be
examined to try to guess what sort of file is required
usually by looking at the extension.
If it's not obvious from the filename what output format is
intended, an error will result.
<p>This parameter must only be given if
<code>omode</code>
has its default value of "<code>out</code>".
</p>
<p>[Default: <code>(auto)</code>]
</p>
</dd>
<dt><strong><code>omode = out|meta|stats|count|cgi|discard|topcat|samp|tosql|gui</code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/mode/ProcessingMode.html">ProcessingMode</a>)</em></strong></dt>
<dd>The mode in which the result table will be output.
The default mode is <code>out</code>, which means that
the result will be written as a new table to disk or elsewhere,
as determined by the <code>out</code> and <code>ofmt</code>
parameters.
However, there are other possibilities, which correspond
to uses to which a table can be put other than outputting it,
such as displaying metadata, calculating statistics,
or populating a table in an SQL database.
For some values of this parameter, additional parameters
(<code><mode-args></code>)
are required to determine the exact behaviour.
<p>Possible values are
<ul>
<li><code>out</code></li>
<li><code>meta</code></li>
<li><code>stats</code></li>
<li><code>count</code></li>
<li><code>cgi</code></li>
<li><code>discard</code></li>
<li><code>topcat</code></li>
<li><code>samp</code></li>
<li><code>tosql</code></li>
<li><code>gui</code></li>
</ul>
Use the <code>help=omode</code> flag
or see <a href="outModes.html">Section 6.4</a> for more information.
</p>
<p>[Default: <code>out</code>]
</p>
</dd>
<dt><strong><code>out = <out-table></code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/TableConsumer.html">TableConsumer</a>)</em></strong></dt>
<dd>The location of the output table. This is usually a filename
to write to.
If it is equal to the special value "-" (the default)
the output table will be written to standard output.
<p>This parameter must only be given if
<code>omode</code>
has its default value of "<code>out</code>".
</p>
<p>[Default: <code>-</code>]
</p>
</dd>
<dt><strong><code>query = <value></code> <em>(String)</em></strong></dt>
<dd>Text of an ADQL WHERE clause targeted at the
<a href="http://www.ivoa.net/Documents/cover/VOResource-20080222.html">VOResource 1.0</a>
schema defining which resource records
you wish to retrieve from the registry.
Some examples are:
<ul>
<li><code>@xsi:type like '%Organisation%'</code></li>
<li><code>capability/@standardID = 'ivo://ivoa.net/std/ConeSearch' and title like '%SDSS%'</code></li>
<li><code>curation/publisher like 'CDS%' and title like '%galax%'</code></li>
</ul>
<p>A full description of ADQL syntax and of the VOResource schema
is well beyond the scope of this
documentation, but in general you want to use
<code><field-name> like '<value>'</code>
where '<code>%</code>' is a wildcard character.
Logical operators <code>and</code> and <code>or</code> and
parentheses can be used to group and combine expressions.
To work out the various <code><field-name></code>s
you need to look at the VOResource 1.0 schema;
you can find some more discussion in the documentation of the
NVO <a href="http://trac.us-vo.org/project/nvo/wiki/IVOARegistry">IVOARegistry</a> package.
</p>
</dd>
<dt><strong><code>regurl = <url-value></code> <em>(<a href="http://docs.oracle.com/javase/6/docs/api/java/net/URL.html">URL</a>)</em></strong></dt>
<dd>The URL of a SOAP endpoint which provides
a VOResource1.0 IVOA registry service.
Some known suitable registry endpoints at time of writing are
<ul>
<li><code>http://registry.astrogrid.org/astrogrid-registry/services/RegistryQueryv1_0</code></li>
<li><code>http://registry.euro-vo.org/services/RegistrySearch</code></li>
<li><code>http://vao.stsci.edu/directory/ristandardservice.asmx</code></li>
</ul>
<p>[Default: <code>http://registry.astrogrid.org/astrogrid-registry/services/RegistryQueryv1_0</code>]
</p>
</dd>
<dt><strong><code>soapout = <out-file></code> <em>(uk.ac.starlink.util.Destination)</em></strong></dt>
<dd>If set to a non-null value, this gives the destination
for the text of the request and response SOAP messages.
The special value "-" indicates standard output.
</dd>
</dl>
</p>
<hr><a href="secB.15.2.html">Next</a> <a href="regquery.html">Previous</a> <a href="regquery.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="secB.15.2.html">Examples</a><br>
<b>Up: </b><a href="regquery.html">regquery: Queries the VO registry</a><br>
<b>Previous: </b><a href="regquery.html">regquery: Queries the VO registry</a><br>
<hr><i>STILTS - Starlink Tables Infrastructure Library Tool Set<br>Starlink User Note256<br>STILTS web page:
<a href="http://www.starlink.ac.uk/stilts/">http://www.starlink.ac.uk/stilts/</a><br>Author email:
<a href="mailto:m.b.taylor@bristol.ac.uk">m.b.taylor@bristol.ac.uk</a><br>Mailing list:
<a href="mailto:topcat-user@jiscmail.ac.uk">topcat-user@jiscmail.ac.uk</a><br></i></body>
</html>
|