/usr/share/doc/stilts/sun256/tapresume-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 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 | <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.22.2.html">Next</a> <a href="tapresume.html">Previous</a> <a href="tapresume.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="secB.22.2.html">Examples</a><br>
<b>Up: </b><a href="tapresume.html">tapresume: Resumes a previous query to a Table Access Protocol server</a><br>
<b>Previous: </b><a href="tapresume.html">tapresume: Resumes a previous query to a Table Access Protocol server</a><br>
<hr>
<h3><a name="tapresume-usage">B.22.1 Usage</a></h3>
<p>The usage of <code>tapresume</code> is
<pre>
stilts <stilts-flags> tapresume joburl=<url-value> compress=true|false
poll=<millisec> progress=true|false
delete=finished|never|always 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.TapResume</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>compress = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>If true, the service is requested to provide HTTP-level
compression for the response stream
(Accept-Encoding header is set to "<code>gzip</code>",
see RFC 2616).
This does not guarantee that compression will happen
but if the service honours this request it may result in
a smaller amount of network traffic
at the expense of more processing on the server and client.
<p>[Default: <code>true</code>]
</p>
</dd>
<dt><strong><code>delete = finished|never|always</code> <em>(DeleteMode)</em></strong></dt>
<dd>Determines under what circumstances the UWS job is to be
deleted from the server when its data is no longer required.
If it is not deleted, then the job is left on the TAP server
and it can be accessed via the normal UWS REST endpoints
until it is destroyed by the server.
<p>Possible values:
<ul>
<li><code>finished</code>: delete only if the job finished, successfully or not
</li>
<li><code>never</code>: do not delete
</li>
<li><code>always</code>: delete in any case
</li>
</ul>
</p>
<p>[Default: <code>finished</code>]
</p>
</dd>
<dt><strong><code>joburl = <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 job created by submission of a TAP query
which was created earlier and has not yet been
deleted (by the client) or destroyed (by the server).
This will usually be of the form
<code><tap-url>/async/<job-id></code>.
You can also find out, and possibly retrieve results from
the job by pointing a web browser at this URL.
</dd>
<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>poll = <millisec></code> <em>(Integer)</em></strong></dt>
<dd>Interval to wait between polling attempts, in milliseconds.
Asynchronous TAP queries can only find out when they are
complete by repeatedly polling the server to find out the
job's status. This parameter allows you to set how often
that happens.
Attempts to set it too low (<50)
will be rejected on the assumption that you're thinking in
seconds.
<p>[Default: <code>5000</code>]
</p>
</dd>
<dt><strong><code>progress = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>If this parameter is set true, progress of the job is
reported to standard output as it happens.
<p>[Default: <code>true</code>]
</p>
</dd>
</dl>
</p>
<hr><a href="secB.22.2.html">Next</a> <a href="tapresume.html">Previous</a> <a href="tapresume.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="secB.22.2.html">Examples</a><br>
<b>Up: </b><a href="tapresume.html">tapresume: Resumes a previous query to a Table Access Protocol server</a><br>
<b>Previous: </b><a href="tapresume.html">tapresume: Resumes a previous query to a Table Access Protocol server</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>
|