diff options
Diffstat (limited to 'vendor/voclient/doc/voimage.man')
-rw-r--r-- | vendor/voclient/doc/voimage.man | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/vendor/voclient/doc/voimage.man b/vendor/voclient/doc/voimage.man new file mode 100644 index 00000000..0e9b2d2e --- /dev/null +++ b/vendor/voclient/doc/voimage.man @@ -0,0 +1,53 @@ +.\" @(#)voimage.1 1.0 Feb-2013 MJF +.TH VOIMAGE 1 "Feb 2013" "VOClient Package" +.SH NAME +voimage \- Query VO image services for data + +.SH SYNOPSIS +\fBvoimage\fP [<opts>] <service> [ <object> | <ra> <dec> ] [ <size> ] + +.SH OPTIONS +The \fIvoimage\fP application 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. + +.TP 6 +.B All VODATA task options + +.SH DESCRIPTION +The \fIvoimage\fP task is a convenience application built on top of the +\fIvodata\fP application, logically it will only query for image data and will +set the appropriate flags when calling \fIvodata\fP. +.PP +For a complete list of options and a description of the task behavior, see +the \fIVODATA\fP man page. + +.SH RETURN STATUS +On exit the \fBvoimage\fP task will return a zero indicating success, or a +one indicating an error. + +.SH EXAMPLES +.TP 4 +1) Query for all X-ray image data of M51: + +.nf + % voimage -b x-ray any m51 +.fi +.TP 4 +2) Query an HST service having data of the subdwarf galaxy IC 10, print a +count of the results only: + +.nf + % voimage -c CADC/HST IC10 +.fi + +.SH BUGS +No known bugs with this release. +.SH Revision History +Feb 2013 - First public release +.SH Author +Michael Fitzpatrick (fitz@noao.edu), Feb 2013 +.SH "SEE ALSO" +vodata, vocatalog, vospectrum |