diff options
Diffstat (limited to 'vendor/voclient/doc/votcnv.html')
| -rw-r--r-- | vendor/voclient/doc/votcnv.html | 185 |
1 files changed, 185 insertions, 0 deletions
diff --git a/vendor/voclient/doc/votcnv.html b/vendor/voclient/doc/votcnv.html new file mode 100644 index 00000000..00e858d2 --- /dev/null +++ b/vendor/voclient/doc/votcnv.html @@ -0,0 +1,185 @@ +Content-type: text/html + +<HTML><HEAD><TITLE>Manpage of VOTCNV</TITLE> +</HEAD><BODY> +<H1>VOTCNV</H1> +Section: User Commands (1)<BR>Updated: Feb 2013<BR><A HREF="#index">Index</A> +<A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR> + +<A NAME="lbAB"> </A> +<H2>NAME</H2> + +votcnv - Convert from VOTable to another format +<P> +<A NAME="lbAC"> </A> +<H2>SYNOPSIS</H2> + +<B>votcnv</B> [<I>-opts</I>] votable.xml +<P> +<A NAME="lbAD"> </A> +<H2>OPTIONS</H2> + +The <I>votcnv</I> task accepts the following options: +<DL COMPACT> +<DT><B>-h, --help</B> + +<DD> +Print a help summary to the terminal and exit. No processing is done +following this flag. +<DT><B>-f </B><I>FMT</I>, --fmt <I>FMT</I> + +<DD> +Convert the VOTable to the format specified by <I>FMT</I>. Allowed +formats are described below. +<DT><B>-i </B><I>NUM</I>, --indent <I>NUM</I> + +<DD> +Indent each level of XML output by <I>NUM</I> spaces. +<DT><B>-n, --noheader</B> + +<DD> +Suppress writing any header information. This flag only applies to formats +other than FITS and VOTable. +<DT><B>-o </B><I>NAME</I>, --output <I>NAME</I> + +<DD> +Write the result to the file <I>NAME</I>. +<P> +</DL> +<A NAME="lbAE"> </A> +<H2>DESCRIPTION</H2> + +The <I>votcnv</I> 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. +<P> +The <I>-f</I> (or <I>--fmt</I>) flag is used to specify the new format using +one of the names listed below. +<P> + +<I>vot<TT> </TT><TT> </TT></I> + +A new VOTable<BR> + +<I>asv<TT> </TT><TT> </TT></I> + +ASCII-separated (i.e. whitespace) values.<BR> + +<I>bsv<TT> </TT><TT> </TT></I> + +Bar-separated values.<BR> + +<I>csv<TT> </TT><TT> </TT></I> + +Comma-separated values<BR> + +<I>tsv<TT> </TT><TT> </TT></I> + +Tab-separated values<BR> + +<I>html<TT> </TT><TT> </TT></I> + +Standalone HTML document (entire table)<BR> + +<I>shtml<TT> </TT></I> + +Single HTML table<BR> + +<I>fits<TT> </TT><TT> </TT></I> + +FITS bintable<BR> + +<I>ascii<TT> </TT></I> + +ASV alias<BR> + +<I>xml<TT> </TT><TT> </TT></I> + +VOTable alias<BR> + +<I>raw<TT> </TT><TT> </TT></I> + +VOTable alias<BR> +<P> + +For formats such as CSV that normally +include column headers, the <I>-n</I> (or <I>--noheader</I>) 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. +<P> +If no input file is specified the VOTable will be read from the stdin, +results will be written to stdout unless the <I>-o</I> (or <I>--output</I>) +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. +<P> +<A NAME="lbAF"> </A> +<H2>RETURN STATUS</H2> + +On exit the <B>votcnv</B> task will return a zero indicating success, or a +one indicating an error. +<P> +<A NAME="lbAG"> </A> +<H2>EXAMPLES</H2> + +<DL COMPACT> +<DT>1) Convert a VOTable to a CSV file:<DD> +<P> +<PRE> + % votcnv --fmt=csv test.xml +</PRE> + +<DT>2) Rewrite a VOTable with readable indention:<DD> +<P> +<PRE> + % votcnv -f vot -i 2 test.xml +</PRE> + +<DT>3) Remove indention from a VOTable:<DD> +<P> +<PRE> + % votcnv -f vot -i 0 test.xml +</PRE> + +</DL> +<A NAME="lbAH"> </A> +<H2>BUGS</H2> + +No known bugs with this release. +<A NAME="lbAI"> </A> +<H2>Revision History</H2> + +Feb 2013 - First public release +<A NAME="lbAJ"> </A> +<H2>Author</H2> + +Michael Fitzpatrick (<A HREF="mailto:fitz@noao.edu">fitz@noao.edu</A>), Feb 2013 +<A NAME="lbAK"> </A> +<H2>SEE ALSO</H2> + +votget, votinfo, votpos, votsort, votstat +<P> + +<HR> +<A NAME="index"> </A><H2>Index</H2> +<DL> +<DT><A HREF="#lbAB">NAME</A><DD> +<DT><A HREF="#lbAC">SYNOPSIS</A><DD> +<DT><A HREF="#lbAD">OPTIONS</A><DD> +<DT><A HREF="#lbAE">DESCRIPTION</A><DD> +<DT><A HREF="#lbAF">RETURN STATUS</A><DD> +<DT><A HREF="#lbAG">EXAMPLES</A><DD> +<DT><A HREF="#lbAH">BUGS</A><DD> +<DT><A HREF="#lbAI">Revision History</A><DD> +<DT><A HREF="#lbAJ">Author</A><DD> +<DT><A HREF="#lbAK">SEE ALSO</A><DD> +</DL> +<HR> +This document was created by +<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>, +using the manual pages.<BR> +Time: 05:13:26 GMT, April 14, 2013 +</BODY> +</HTML> |