Next Previous Up Contents
Next: Examples
Up: votcopy: VOTable Encoding Translator
Previous: votcopy: VOTable Encoding Translator
The usage of votcopy
is
stilts <stilts-flags> votcopy charset=<xml-encoding> cache=true|false
href=true|false base=<location>
[in=]<location> [out=]<location>
[format=]tabledata|binary|fits|empty
If you don't have the stilts
script installed,
write "java -jar stilts.jar
" instead of
"stilts
" - see Section 3.
The available <stilts-flags>
are listed
in Section 2.1.
Parameter values are assigned on the command line
as explained in Section 2.3.
They are as follows:
-
base = <location>
- Determines the name of external output files written when the
-href
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
<location>
string.
This flag is compulsory if
href
is true
and no out=-
(output is to standard out),
since in this case there is no default base name to use.
-
cache = true|false
- 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.
[Default:
false
]
-
charset = <xml-encoding>
- Selects the Unicode encoding used for the output XML.
The available options and default are dependent on your JVM,
but the default probably corresponds to UTF-8.
Use
help=charset
for a full listing.
-
format = tabledata|binary|fits|empty
- Determines the encoding format of the table data in the
output document.
If
empty
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.
[Default: tabledata
]
-
href = true|false
- In the case of BINARY or FITS encoding, this determines
whether the STREAM elements output will contain their data
inline or externally.
If set true, the output document will be self-contained,
with STREAM data inline as base64-encoded characters.
If false, 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
base
flag.
[Default: false
]
-
in = <location>
- 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).
[Default:
-
]
-
out = <location>
- Location of the output VOTable.
May be a filename or "-" to indicate standard output.
[Default:
-
]
Next Previous Up Contents
Next: Examples
Up: votcopy: VOTable Encoding Translator
Previous: votcopy: VOTable Encoding Translator
STILTS - Starlink Tables Infrastructure Library Tool Set
Starlink User Note
256
STILTS web page:
http://www.starlink.ac.uk/stilts/
Author email:
m.b.taylor@bristol.ac.uk