diff options
Diffstat (limited to 'vendor/voclient/doc/votpos.man')
| -rw-r--r-- | vendor/voclient/doc/votpos.man | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/vendor/voclient/doc/votpos.man b/vendor/voclient/doc/votpos.man new file mode 100644 index 00000000..36b57b49 --- /dev/null +++ b/vendor/voclient/doc/votpos.man @@ -0,0 +1,66 @@ +.\" @(#)votpos.1 1.0 Feb-2013 MJF +.TH VOTPOS 1 "Feb 2013" "VOClient Package" +.SH NAME +votpos \- Extract the main positional columns from a VOTable + +.SH SYNOPSIS +\fBvotpos\fP [\fI-opts\fP] votable.xml + +.SH OPTIONS +The \fIvotpos\fP task accepts the following options: +.TP 6 +.B \-h, --help +Print a help summary to the terminal and exit. No processing is done +following this flag. + +.B \-n, --number +Print the row number before the position. +.TP 6 +.B \-o \fINAME\fP, --output \fINAME\fP +Write the result to the file \fINAME\fP. + +.SH DESCRIPTION +The \fIvotpos\fP task is used to extract the positional information from a +VOTable. The columns identified by the UCD \fIPOS_EQ_RA_MAIN\fP and +\fIPOS_EQ_DEC_MAIN\fP (or UCD+ values \fIpos.eq.ra;meta.main\fP and +\fIpos.eq.dec;meta.main\fP) are located automatically and will be written +as a two-column ascii table to the stdout, or to the file named by +the \fI-o\fP flag. An error will be printed if no columns with these +specific UCDs are found. + +If no input file is specified the VOTable will be read from the stdin, +results will be written to stdout unless the \fI\-o\fP (or \fI\--output\fP) +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. + +.SH RETURN STATUS +On exit the \fBvotpos\fP task will return a zero indicating success, or a +one indicating an error. + +.SH EXAMPLES +.TP 4 +1) Print the primary (RA,Dec) columns from a table: + +.nf + % votpos test.xml # un-numbered + % votpos -n test.xml # numbered + % cat test.xml | votpos # un-numbered +.fi +.TP 4 +2) Print the primary (RA,Dec) columns to a file: + +.nf + % votpos -o pos.txt test.xml +.fi +.SH BUGS +- No known bugs with this release. + +- The task should have options to specify columns to extract when no UCDs are +available. +.SH Revision History +Feb 2013 - First public release +.SH Author +Michael Fitzpatrick (fitz@noao.edu), Feb 2013 +.SH "SEE ALSO" +votget, votinfo, votcnv, votsort, votstat |