Content-type: text/html Manpage of VOTCNV

VOTCNV

Section: User Commands (1)
Updated: Feb 2013
Index Return to Main Contents

NAME

votcnv - Convert from VOTable to another format

SYNOPSIS

votcnv [-opts] votable.xml

OPTIONS

The votcnv task accepts the following options:

-h, --help: Print a help summary to the terminal and exit. No processing is done following this flag.
-f FMT, --fmt FMT: Convert the VOTable to the format specified by FMT. Allowed formats are described below.
-i NUM, --indent NUM: Indent each level of XML output by NUM spaces.
-n, --noheader: Suppress writing any header information. This flag only applies to formats other than FITS and VOTable.
-o NAME, --output NAME: Write the result to the file NAME.

DESCRIPTION

The votcnv task is used to convert a VOTable XML document to a different format, or to rewrite a VOTable using (or removing) indention. Creating a new VOTable document will fix any compliance issues since the task will loosly read a VOTable on input but will always write an XML file that complies with the VOTable specification.

The -f (or --fmt) flag is used to specify the new format using one of the names listed below.

vot             A new VOTable
asv             ASCII-separated (i.e. whitespace) values.
bsv             Bar-separated values.
csv             Comma-separated values
tsv             Tab-separated values
html            Standalone HTML document (entire table)
shtml   Single HTML table
fits            FITS bintable
ascii   ASV alias
xml             VOTable alias
raw             VOTable alias

For formats such as CSV that normally include column headers, the -n (or --noheader) flag may be used to suppress this header. The FITS file produced will be an MEF containing a bintable extension for each VOTable "<TABLE>" element. Column types and names in this case come from the VOTable "<FIELD>" attributes.

If no input file is specified the VOTable will be read from the stdin, results will be written to stdout unless the -o (or --output) names an output file. The task will only process a single VOTable and may not be used to convert multiple files in a single call.

RETURN STATUS

On exit the votcnv task will return a zero indicating success, or a one indicating an error.

EXAMPLES

1) Convert a VOTable to a CSV file:

  % votcnv --fmt=csv test.xml

2) Rewrite a VOTable with readable indention:

  % votcnv -f vot -i 2 test.xml

3) Remove indention from a VOTable:

  % votcnv -f vot -i 0 test.xml

BUGS

No known bugs with this release.

Revision History

Feb 2013 - First public release

Author

Michael Fitzpatrick (fitz@noao.edu), Feb 2013

This document was created by man2html, using the manual pages.
Time: 05:13:26 GMT, April 14, 2013