/usr/share/doc/stilts/sun256/votcopy-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 | <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.38.2.html">Next</a> <a href="votcopy.html">Previous</a> <a href="votcopy.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="secB.38.2.html">Examples</a><br>
<b>Up: </b><a href="votcopy.html">votcopy: Transforms between VOTable encodings</a><br>
<b>Previous: </b><a href="votcopy.html">votcopy: Transforms between VOTable encodings</a><br>
<hr>
<h3><a name="votcopy-usage">B.38.1 Usage</a></h3>
<p>The usage of <code>votcopy</code> is
<pre>
stilts <stilts-flags> votcopy version=1.0|1.1|1.2|1.3
charset=<xml-encoding> cache=true|false
href=true|false nomagic=true|false
base=<location>
[in=]<location> [out=]<location>
[format=]TABLEDATA|BINARY|BINARY2|FITS
</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.VotCopy</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>base = <location></code> <em>(String)</em></strong></dt>
<dd>Determines the name of external output files written when the
<code>href</code> flag is true.
Normally these are given names based on the name of the
output file.
But if this flag is given, the names will be based on the
<code><location></code> string.
This flag is compulsory if
<code>href</code> is true
and <code>out=-</code> (output is to standard out),
since in this case there is no default base name to use.
</dd>
<dt><strong><code>cache = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>Determines whether the input tables are read into a cache
prior to being written out.
The default is selected automatically depending on the input
table; so you should normally leave this flag alone.
</dd>
<dt><strong><code>charset = <xml-encoding></code> <em>(<a href="http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Charset</a>)</em></strong></dt>
<dd>Selects the Unicode encoding used for the output XML.
The available options are dependent on your JVM,
use <code>help=charset</code> for a full listing.
Setting the value null will use the JVM's system default.
<p>[Default: <code>UTF-8</code>]
</p>
</dd>
<dt><strong><code>format = TABLEDATA|BINARY|BINARY2|FITS</code> <em>(uk.ac.starlink.votable.DataFormat)</em></strong></dt>
<dd>Determines the encoding format of the table data in the
output document.
If <code>null</code> is selected, then the tables will be
data-less (will contain no DATA element), leaving only
the document structure.
Data-less tables are legal VOTable elements.
<p>The <code>BINARY2</code> format is only available for
<code>version</code>=<code>1.3</code>
</p>
<p>[Default: <code>TABLEDATA</code>]
</p>
</dd>
<dt><strong><code>href = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>In the case of BINARY or FITS encoding, this determines
whether the STREAM elements output will contain their data
inline or externally.
If set false, the output document will be self-contained,
with STREAM data inline as base64-encoded characters.
If true, then for each TABLE in the document the binary
data will be written to a separate file and referenced
by an href attribute on the corresponding STREAM element.
The name of these files is usually determined by the name
of the main output file; but see also the <code>
base</code> flag.
</dd>
<dt><strong><code>in = <location></code> <em>(String)</em></strong></dt>
<dd>Location of the input VOTable.
May be a URL, filename, or "-" to indicate standard input.
The input table may be compressed using one of the known
compression formats (Unix compress, gzip or bzip2).
<p>[Default: <code>-</code>]
</p>
</dd>
<dt><strong><code>nomagic = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>Eliminate the <code>null</code> attributes of
<code>VALUES</code> elements
where they are no longer required.
In VOTable versions <=1.2, the only way to specify
null values for integer-type scalar columns was to use
the <code>null</code> attribute of the <code>VALUES</code>
element to indicate an in-band magic value representing null.
From VOTable v1.3, null values can be represented using
empty <code><TD></code> elements or flagged
specially in <code>BINARY2</code> streams.
In these cases, it is recommended (though not required)
not to use the <code>VALUES</code>/<code>null</code> mechanism.
<p>If this parameter is set true, then any
<code>VALUES</code>/<code>null</code>
attributes will be removed in VOTable 1.3 BINARY2 or TABLEDATA
output.
If this results in an empty <code>VALUES</code> element,
it too will be removed.
</p>
<p>This parameter is ignored if the output VOTable version
is lower than 1.3 or if
<code>format</code>=BINARY/FITS.
</p>
<p>[Default: <code>true</code>]
</p>
</dd>
<dt><strong><code>out = <location></code> <em>(String)</em></strong></dt>
<dd>Location of the output VOTable.
May be a filename or "-" to indicate standard output.
<p>[Default: <code>-</code>]
</p>
</dd>
<dt><strong><code>version = 1.0|1.1|1.2|1.3</code> <em>(uk.ac.starlink.votable.VOTableVersion)</em></strong></dt>
<dd>Determines the version of the VOTable standard to which
the output will conform.
If null (the default), the output table will have the same
version as the input table.
</dd>
</dl>
</p>
<hr><a href="secB.38.2.html">Next</a> <a href="votcopy.html">Previous</a> <a href="votcopy.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="secB.38.2.html">Examples</a><br>
<b>Up: </b><a href="votcopy.html">votcopy: Transforms between VOTable encodings</a><br>
<b>Previous: </b><a href="votcopy.html">votcopy: Transforms between VOTable encodings</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>
|