Content-type: text/html Manpage of VOTINFO

VOTINFO

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

NAME

votinfo - Get information about a VOTable

SYNOPSIS

votinfo [<opts>] votable.xml

OPTIONS

The votinfo task accepts the following options:

-h, --help

Print a help summary to the terminal and exit. No processing is done following this flag.

-b,--brief

Print only brief output about the table.

-d,--description

Print the toplevel <DESCRIPTION> element of the VOTable.

-i,--info

Print all <INFO> elements in the VOTable. Parameters are printed as name=value pairs,, if there is no output it is implied there are no <INFO> elements in the document.

-n WHAT,--numberOf WHAT

Get number of elements specified by WHAT. The WHAT must be a valid VOTable element name.

-p,--param

Print all <PARAM> elements in the VOTable. Parameters are printed as name=value pairs, if there is no output it is implied there are no <PARAM> elements in the document.

-q,--query_status

Get the 'QUERY_STATUS' <INFO> value, a value of zero is returned of the value is OK, or one if it is an ERROR.

-s,--size

Print the table size as <nrows> and <ncols> values. In a multi-RESOURCE VOTable only results for the first table are returned.

-v,--verbose

Print verbose otuput.

-w,--warn

Print VOTable parser warning messages.

DESCRIPTION

The votinfo 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 -n WHAT flag is used to query for the number of WHAT elements in the document, allow values of WHAT include:

param   number of <PARAM> elements
info            number of <INFO> elements
rows            number of table rows
cols            number of table cols
resources       number of <RESOURCE> elements

The VOTable <PARAM> elements may be printed using the -p flag, similarly <INFO> elements can be printed using -i.

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 votinfo task will return a zero indicating success, or a one indicating an error.

EXAMPLES

1) Print verbose summary information about a VOTable

    % votinfo -v test.xml

2) Print the <PARAM> elements in a table, then get a count

    % votinfo -p test.xml
    % votinfo --numberOf=param test.xml

3) Determine whether a VOTable contains a successful result

    % votinfo -q test.xml

A zero indicates 'OK', a one is an 'ERR', and -1 means that an <INFO> with a 'QUERY_STATUS' was not found

BUGS

The task doesn't always work intuitively with multi-resource VOTables.

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