This file is indexed.

/usr/share/doc/stilts/sun256/tjoin-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
<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.29.2.html">Next</a> <a href="tjoin.html">Previous</a> <a href="tjoin.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="secB.29.2.html">Examples</a><br>
       <b>Up: </b><a href="tjoin.html">tjoin: Joins multiple tables side-to-side</a><br>
       <b>Previous: </b><a href="tjoin.html">tjoin: Joins multiple tables side-to-side</a><br>
      
      <hr>
      <h3><a name="tjoin-usage">B.29.1 Usage</a></h3>
      <p>The usage of <code>tjoin</code> is
         <pre>
   stilts &lt;stilts-flags&gt; tjoin nin=&lt;count&gt; ifmtN=&lt;in-format&gt; inN=&lt;tableN&gt;
                               icmdN=&lt;cmds&gt; ocmd=&lt;cmds&gt;
                               omode=out|meta|stats|count|cgi|discard|topcat|samp|tosql|gui
                               out=&lt;out-table&gt; ofmt=&lt;out-format&gt;
                               fixcols=none|dups|all suffixN=&lt;label&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.TableJoinN</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>fixcols = none|dups|all</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/task/JoinFixActionParameter.Fixer.html">Fixer</a>)</em></strong></dt>
            <dd>Determines how input columns are renamed before
               use in the output table.  The choices are:
               
               <ul>
                  <li><code>none</code>: columns are not renamed
                  </li>
                  <li><code>dups</code>: columns which would otherwise have duplicate names in the output will be renamed
                     to indicate which table they came from
                  </li>
                  <li><code>all</code>: all columns will be renamed to indicate which table they came from
                  </li>
               </ul>
               If columns are renamed, the new ones are determined
               by <code>suffix*</code> parameters.
               
               <p>[Default: <code>dups</code>]
               </p>
            </dd>
            <dt><strong><code>icmdN = &lt;cmds&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<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
               input table #N as specified by parameter <code>inN</code>,
               before any 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>ifmtN = &lt;in-format&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(String)</em></strong></dt>
            <dd>Specifies the format of input table #N as specified by parameter <code>inN</code>.
               The known formats are listed in <a href="inFormats.html">Section 5.2.1</a>.
               This flag can be used if you know what format your
               table is in.
               If it has the special value
               <code>(auto)</code> (the default),
               then an attempt will be
               made to detect the format of the table automatically.
               This cannot always be done correctly however, in which case
               the program will exit with an error explaining which
               formats were attempted.
               
               <p>[Default: <code>(auto)</code>]
               </p>
            </dd>
            <dt><strong><code>inN = &lt;tableN&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(<a href="http://www.starlink.ac.uk/stil/javadocs/uk/ac/starlink/table/StarTable.html">StarTable</a>)</em></strong></dt>
            <dd>The location of input table #N.
               This may take one of the following forms:
               
               <ul>
                  <li>A filename.</li>
                  <li>A URL.</li>
                  <li>The special value "<code>-</code>",
                     meaning standard input.
                     In this case the input format must be given explicitly
                     using the <code>ifmtN</code>
                     parameter.
                     Note that not all formats can be streamed in this way.
                  </li>
                  <li>A system command line with
                     either a "<code>&lt;</code>" character at the start,
                     or a "<code>|</code>" character at the end
                     ("<code>&lt;syscmd</code>" or
                     "<code>syscmd|</code>").
                     This executes the given pipeline and reads from its
                     standard output.
                     This will probably only work on unix-like systems.
                  </li>
               </ul>
               
               In any case, compressed data in one of the supported compression
               formats (gzip, Unix compress or bzip2) will be decompressed
               transparently.
               
            </dd>
            <dt><strong><code>nin = &lt;count&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(Integer)</em></strong></dt>
            <dd>The number of input tables for this task.
               For each of the input tables N
               there will be associated parameters
               <code>ifmtN</code>, <code>inN</code> and <code>icmdN</code>.
               
            </dd>
            <dt><strong><code>ocmd = &lt;cmds&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<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 = &lt;out-format&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<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> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<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>&lt;mode-args&gt;</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 = &lt;out-table&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<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>suffixN = &lt;label&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(String)</em></strong></dt>
            <dd>If the <code>fixcols</code> parameter
               is set so that input columns are renamed for insertion into
               the output table, this parameter determines how the
               renaming is done.
               It gives a suffix which is appended to all renamed columns
               from table N.
               
               <p>[Default: <code>_N</code>]
               </p>
            </dd>
         </dl>
         
      </p>
      <hr><a href="secB.29.2.html">Next</a> <a href="tjoin.html">Previous</a> <a href="tjoin.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="secB.29.2.html">Examples</a><br>
       <b>Up: </b><a href="tjoin.html">tjoin: Joins multiple tables side-to-side</a><br>
       <b>Previous: </b><a href="tjoin.html">tjoin: Joins multiple tables side-to-side</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>