This file is indexed.

/usr/share/doc/stilts/sun256/taplint-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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
<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.20.2.html">Next</a> <a href="taplint.html">Previous</a> <a href="taplint.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="secB.20.2.html">Examples</a><br>
       <b>Up: </b><a href="taplint.html">taplint: Tests TAP services</a><br>
       <b>Previous: </b><a href="taplint.html">taplint: Tests TAP services</a><br>
      
      <hr>
      <h3><a name="taplint-usage">B.20.1 Usage</a></h3>
      <p>The usage of <code>taplint</code> is
         <pre>
   stilts &lt;stilts-flags&gt; taplint
                                 stages=TMV|TME|TMS|TMC|CPV|CAP|AVV|QGE|QPO|QAS|UWS|MDQ|OBS|UPL|EXA[ ...]
                                 maxtable=&lt;int-value&gt; format=text|json
                                 report=[EWISF]+ maxrepeat=&lt;int-value&gt;
                                 truncate=&lt;int-value&gt; debug=true|false
                                 syncurl=&lt;url-value&gt; asyncurl=&lt;url-value&gt;
                                 tablesurl=&lt;url-value&gt;
                                 capabilitiesurl=&lt;url-value&gt;
                                 availabilityurl=&lt;url-value&gt;
                                 examplesurl=&lt;url-value&gt;
                                 [tapurl=]&lt;url-value&gt;
</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>&lt;stilts-flags&gt;</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.TapLint</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>asyncurl = &lt;url-value&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(<a href="http://docs.oracle.com/javase/6/docs/api/java/net/URL.html">URL</a>)</em></strong></dt>
            <dd>Sets the URL to use for the async endpoint
               of the TAP service.
               By default, this would be
               <code>&lt;tapurl&gt;/async</code>
               but you can set this parameter to some other location
               if required.
               If left blank, the default value is used.
               
            </dd>
            <dt><strong><code>availabilityurl = &lt;url-value&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(<a href="http://docs.oracle.com/javase/6/docs/api/java/net/URL.html">URL</a>)</em></strong></dt>
            <dd>Sets the URL to use for the availability endpoint
               of the TAP service.
               By default, this would be
               <code>&lt;tapurl&gt;/availability</code>
               but you can set this parameter to some other location
               if required.
               If left blank, the default value is used.
               
            </dd>
            <dt><strong><code>capabilitiesurl = &lt;url-value&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(<a href="http://docs.oracle.com/javase/6/docs/api/java/net/URL.html">URL</a>)</em></strong></dt>
            <dd>Sets the URL to use for the capabilities endpoint
               of the TAP service.
               By default, this would be
               <code>&lt;tapurl&gt;/capabilities</code>
               but you can set this parameter to some other location
               if required.
               If left blank, the default value is used.
               
            </dd>
            <dt><strong><code>debug = true|false</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(Boolean)</em></strong></dt>
            <dd>If true, debugging output including stack traces will be
               output along with the normal validation messages.
               
               <p>[Default: <code>false</code>]
               </p>
            </dd>
            <dt><strong><code>examplesurl = &lt;url-value&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(<a href="http://docs.oracle.com/javase/6/docs/api/java/net/URL.html">URL</a>)</em></strong></dt>
            <dd>Sets the URL to use for the examples endpoint
               of the TAP service.
               By default, this would be
               <code>&lt;tapurl&gt;/examples</code>
               but you can set this parameter to some other location
               if required.
               If left blank, the default value is used.
               
            </dd>
            <dt><strong><code>format = text|json</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/taplint/OutputReporter.html">OutputReporter</a>)</em></strong></dt>
            <dd>Determines the format of the output.
               Possible values are
               <code>text</code>, <code>json</code>.
               
               <p>Note not all of the other parameters may be applicable
                  to all output formats.
                  
               </p>
               <p>[Default: <code>text</code>]
               </p>
            </dd>
            <dt><strong><code>maxrepeat = &lt;int-value&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(Integer)</em></strong></dt>
            <dd>Puts a limit on the number of times that a single message
               will be repeated.
               By setting this to some reasonably small number, you can ensure
               that the output does not get cluttered up by millions of
               repetitions of essentially the same error.
               
               <p>[Default: <code>9</code>]
               </p>
            </dd>
            <dt><strong><code>maxtable = &lt;int-value&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(Integer)</em></strong></dt>
            <dd>Limits the number of tables from the service
               that will be tested.
               Currently, this only affects
               stage <code>MDQ</code>.
               If the value is left blank (the default),
               or if it is larger than the number of tables actually
               present in the service, it will have no effect.
               
            </dd>
            <dt><strong><code>report = [EWISF]+</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(String)</em></strong></dt>
            <dd>Letters indicating which message types should be listed.
               Each character of the string is one of the letters , , , ,  with the following meanings:
               
               <ul>
                  <li><code>E</code>: Error in operation or standard compliance of the service.
                  </li>
                  <li><code>W</code>: Warning that service behaviour is questionable, or contravenes a standard recommendation,
                     but is not in actual violation of the standard.
                  </li>
                  <li><code>I</code>: Information about progress, for instance details of queries made.
                  </li>
                  <li><code>S</code>: Summary of previous successful/unsuccessful reports.
                  </li>
                  <li><code>F</code>: Failure of the validator to perform some testing. The cause is either some error
                     internal to the validator, or some error or missing functionality in the service which
                     has already been reported.
                  </li>
               </ul>
               
               <p>[Default: <code>EWISF</code>]
               </p>
            </dd>
            <dt><strong><code>stages = TMV|TME|TMS|TMC|CPV|CAP|AVV|QGE|QPO|QAS|UWS|MDQ|OBS|UPL|EXA[ ...]</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(String[])</em></strong></dt>
            <dd>Lists the validation stages which the validator will perform.
               Each stage is represented by a short code, as follows:
               
               <ul>
                  <li><code>TMV</code>: Validate table metadata against XML schema (on)
                  </li>
                  <li><code>TME</code>: Check content of tables metadata from /tables (on)
                  </li>
                  <li><code>TMS</code>: Check content of tables metadata from TAP_SCHEMA (on)
                  </li>
                  <li><code>TMC</code>: Compare table metadata from /tables and TAP_SCHEMA (on)
                  </li>
                  <li><code>CPV</code>: Validate capabilities against XML schema (on)
                  </li>
                  <li><code>CAP</code>: Check content of TAPRegExt capabilities record (on)
                  </li>
                  <li><code>AVV</code>: Validate availability against XML schema (on)
                  </li>
                  <li><code>QGE</code>: Make ADQL queries in sync GET mode (on)
                  </li>
                  <li><code>QPO</code>: Make ADQL queries in sync POST mode (on)
                  </li>
                  <li><code>QAS</code>: Make ADQL queries in async mode (on)
                  </li>
                  <li><code>UWS</code>: Test asynchronous UWS/TAP behaviour (on)
                  </li>
                  <li><code>MDQ</code>: Check table query result columns against declared metadata (on)
                  </li>
                  <li><code>OBS</code>: Test implementation of ObsCore Data Model (on)
                  </li>
                  <li><code>UPL</code>: Make queries with table uploads (on)
                  </li>
                  <li><code>EXA</code>: Check content of examples document (on)
                  </li>
               </ul>
               You can specify a list of stage codes, separated by spaces.
               Order is not significant.
               
               <p>Note that removing some stages may affect the operation
                  of others;
                  for instance table metadata is acquired from the metadata stages,
                  and avoiding those will mean that later stages that use
                  the table metadata to pose queries will not be able to do so
                  with knowledge of the database schema.
                  
               </p>
               <p>[Default: <code>TMV TME TMS TMC CPV CAP AVV QGE QPO QAS UWS MDQ OBS UPL EXA</code>]
               </p>
            </dd>
            <dt><strong><code>syncurl = &lt;url-value&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(<a href="http://docs.oracle.com/javase/6/docs/api/java/net/URL.html">URL</a>)</em></strong></dt>
            <dd>Sets the URL to use for the sync endpoint
               of the TAP service.
               By default, this would be
               <code>&lt;tapurl&gt;/sync</code>
               but you can set this parameter to some other location
               if required.
               If left blank, the default value is used.
               
            </dd>
            <dt><strong><code>tablesurl = &lt;url-value&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(<a href="http://docs.oracle.com/javase/6/docs/api/java/net/URL.html">URL</a>)</em></strong></dt>
            <dd>Sets the URL to use for the tables endpoint
               of the TAP service.
               By default, this would be
               <code>&lt;tapurl&gt;/tables</code>
               but you can set this parameter to some other location
               if required.
               If left blank, the default value is used.
               
            </dd>
            <dt><strong><code>tapurl = &lt;url-value&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(<a href="http://docs.oracle.com/javase/6/docs/api/java/net/URL.html">URL</a>)</em></strong></dt>
            <dd>The base URL of a Table Access Protocol service.
               This is the bare URL without a trailing "/[a]sync".
               
               <p>The default values of the various endpoints
                  (sync and async query submission, tables metadata,
                  service-provided examples etc)
                  use this URL as a parent
                  and append standard sub-paths.
                  However, other parameters (<code>syncurl</code>, <code>asyncurl</code>, ...)
                  are provided so that the different endpoints
                  can be set individually if required.
                  
               </p>
            </dd>
            <dt><strong><code>truncate = &lt;int-value&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(Integer)</em></strong></dt>
            <dd>Limits the line length written to the output.
               
               <p>[Default: <code>640</code>]
               </p>
            </dd>
         </dl>
         
      </p>
      <hr><a href="secB.20.2.html">Next</a> <a href="taplint.html">Previous</a> <a href="taplint.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="secB.20.2.html">Examples</a><br>
       <b>Up: </b><a href="taplint.html">taplint: Tests TAP services</a><br>
       <b>Previous: </b><a href="taplint.html">taplint: Tests TAP services</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>