diff options
Diffstat (limited to 'vendor/voclient/doc/votpos.html')
| -rw-r--r-- | vendor/voclient/doc/votpos.html | 122 |
1 files changed, 122 insertions, 0 deletions
diff --git a/vendor/voclient/doc/votpos.html b/vendor/voclient/doc/votpos.html new file mode 100644 index 00000000..c8623034 --- /dev/null +++ b/vendor/voclient/doc/votpos.html @@ -0,0 +1,122 @@ +Content-type: text/html + +<HTML><HEAD><TITLE>Manpage of VOTPOS</TITLE> +</HEAD><BODY> +<H1>VOTPOS</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> + +votpos - Extract the main positional columns from a VOTable +<P> +<A NAME="lbAC"> </A> +<H2>SYNOPSIS</H2> + +<B>votpos</B> [<I>-opts</I>] votable.xml +<P> +<A NAME="lbAD"> </A> +<H2>OPTIONS</H2> + +The <I>votpos</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. +<P> +<B>-n, --number</B> + +Print the row number before the position. +<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>votpos</I> task is used to extract the positional information from a +VOTable. The columns identified by the UCD <I>POS_EQ_RA_MAIN</I> and +<I>POS_EQ_DEC_MAIN</I> (or UCD+ values <I>pos.eq.ra;meta.main</I> and +<I>pos.eq.dec;meta.main</I>) are located automatically and will be written +as a two-column ascii table to the stdout, or to the file named by +the <I>-o</I> flag. An error will be printed if no columns with these +specific UCDs are found. +<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. In a multi-resource +VOTABLE only the first <RESOURCE> table will be processed. +<P> +<A NAME="lbAF"> </A> +<H2>RETURN STATUS</H2> + +On exit the <B>votpos</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) Print the primary (RA,Dec) columns from a table:<DD> +<P> +<PRE> + % votpos test.xml # un-numbered + % votpos -n test.xml # numbered + % cat test.xml | votpos # un-numbered +</PRE> + +<DT>2) Print the primary (RA,Dec) columns to a file:<DD> +<P> +<PRE> + % votpos -o pos.txt test.xml +</PRE> + +</DL> +<A NAME="lbAH"> </A> +<H2>BUGS</H2> + +- No known bugs with this release. +<P> +- The task should have options to specify columns to extract when no UCDs are +available. +<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, votcnv, 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:27 GMT, April 14, 2013 +</BODY> +</HTML> |