diff options
Diffstat (limited to 'vendor/voclient/doc/votinfo.html')
| -rw-r--r-- | vendor/voclient/doc/votinfo.html | 188 |
1 files changed, 188 insertions, 0 deletions
diff --git a/vendor/voclient/doc/votinfo.html b/vendor/voclient/doc/votinfo.html new file mode 100644 index 00000000..3566c0d1 --- /dev/null +++ b/vendor/voclient/doc/votinfo.html @@ -0,0 +1,188 @@ +Content-type: text/html + +<HTML><HEAD><TITLE>Manpage of VOTINFO</TITLE> +</HEAD><BODY> +<H1>VOTINFO</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> + +votinfo - Get information about a VOTable +<P> +<A NAME="lbAC"> </A> +<H2>SYNOPSIS</H2> + +<B>votinfo</B> [<opts>] votable.xml +<P> +<A NAME="lbAD"> </A> +<H2>OPTIONS</H2> + +The <I>votinfo</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> +<DT><B>-b,--brief</B> + +<DD> +Print only brief output about the table. +<DT><B>-d,--description</B> + +<DD> +Print the toplevel <DESCRIPTION> element of the VOTable. +<DT><B>-i,--info</B> + +<DD> +Print all <INFO> elements in the VOTable. Parameters are printed as +<I>name=value</I> pairs,, if there is no output it is +implied there are no <INFO> elements in the document. +<DT><B>-n </B><I>WHAT</I>,--numberOf <I>WHAT</I> + +<DD> +Get number of elements specified by <I>WHAT</I>. The <I>WHAT</I> must be a +valid VOTable element name. +<DT><B>-p,--param</B> + +<DD> +Print all <PARAM> elements in the VOTable. Parameters are printed as +<I>name=value</I> pairs, if there is no output it is implied there are no +<PARAM> elements in the document. +<DT><B>-q,--query_status</B> + +<DD> +Get the 'QUERY_STATUS' <INFO> value, a value of zero is returned of the +value is OK, or one if it is an ERROR. +<DT><B>-s,--size</B> + +<DD> +Print the table size as <nrows> and <ncols> values. In a multi-RESOURCE +VOTable only results for the first table are returned. +<DT><B>-v,--verbose</B> + +<DD> +Print verbose otuput. +<DT><B>-w,--warn</B> + +<DD> +Print VOTable parser warning messages. +<P> +<P> +</DL> +<A NAME="lbAE"> </A> +<H2>DESCRIPTION</H2> + +The <I>votinfo</I> task is used to either print a summary of a VOTable's +structure, or to get specific attributes of a VOTable (e.g. the size of +a table, number of parameters, etc). The <I>-n WHAT</I> flag is used to query +for the number of <I>WHAT</I> elements in the document, allow values of WHAT +include: +<P> + +<I>param<TT> </TT></I> + +number of <PARAM> elements<BR> + +<I>info<TT> </TT><TT> </TT></I> + +number of <INFO> elements<BR> + +<I>rows<TT> </TT><TT> </TT></I> + +number of table rows<BR> + +<I>cols<TT> </TT><TT> </TT></I> + +number of table cols<BR> + +<I>resources<TT> </TT></I> + +number of <RESOURCE> elements<BR> +<P> +<P> + +The VOTable <PARAM> elements may be printed using the <I>-p</I> flag, +similarly <INFO> elements can be printed using <I>-i</I>. +<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>votinfo</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 verbose summary information about a VOTable<DD> +<P> +<PRE> + % votinfo -v test.xml +</PRE> + +<DT>2) Print the <PARAM> elements in a table, then get a count<DD> +<P> +<PRE> + % votinfo -p test.xml + % votinfo --numberOf=param test.xml +</PRE> + +<DT>3) Determine whether a VOTable contains a successful result<DD> +<P> +<PRE> + % votinfo -q test.xml +</PRE> + +<P> +A zero indicates 'OK', a one is an 'ERR', and -1 means that an <INFO> with a 'QUERY_STATUS' was not found +<P> +</DL> +<A NAME="lbAH"> </A> +<H2>BUGS</H2> + +The task doesn't always work intuitively with multi-resource VOTables. +<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, votget, votpos, votsort, votstat +<P> +<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> |