aboutsummaryrefslogtreecommitdiff
path: root/vo/doc/vizier.hlp
diff options
context:
space:
mode:
authorJoe Hunkeler <jhunkeler@gmail.com>2015-08-11 16:51:37 -0400
committerJoe Hunkeler <jhunkeler@gmail.com>2015-08-11 16:51:37 -0400
commit40e5a5811c6ffce9b0974e93cdd927cbcf60c157 (patch)
tree4464880c571602d54f6ae114729bf62a89518057 /vo/doc/vizier.hlp
downloadiraf-osx-40e5a5811c6ffce9b0974e93cdd927cbcf60c157.tar.gz
Repatch (from linux) of OSX IRAF
Diffstat (limited to 'vo/doc/vizier.hlp')
-rw-r--r--vo/doc/vizier.hlp87
1 files changed, 87 insertions, 0 deletions
diff --git a/vo/doc/vizier.hlp b/vo/doc/vizier.hlp
new file mode 100644
index 00000000..4cfe5146
--- /dev/null
+++ b/vo/doc/vizier.hlp
@@ -0,0 +1,87 @@
+.help vizier Aug06 nvo
+.ih
+NAME
+vizier -- Download one or more VizieR tables
+.ih
+USAGE
+vizier tab_id
+.ih
+PARAMETERS
+.ls tab_id
+A registry ShortName or Identifier string used to resolve to a specific
+ServiceUrl for the table.
+.le
+.ls output = "STDOUT"
+Output filename or STDOUT to print the table to the screen.
+.le
+.ls otype = "ascii"
+Type of output table. The default return from a Cone service is a standard
+VOTable (xml format). This table may be automatically converted to some
+other format for use by other tasks by resetting this parameter. Allowed
+output table types include:
+.ls ascii
+Simple space-separated ASCII file format. Note that string values in the
+original VOTable will be quoted.
+.le
+.ls csv
+Comma-Separated Value format. The first line is a header which contains
+the column names.
+.le
+.ls fits
+Convert VOTable to FITS binary table. Primary HDU is data-less, first
+extension contains a FITS binary table.
+.le
+.ls votable
+Do not process returned VOTable and output it directly.
+.le
+
+For a full description of the supported STILTS output formats see
+.nf
+
+ http://www.star.bris.ac.uk/~mbt/stilts/sun256/outFormats.html
+.fi
+.le
+.le
+.ls all = yes
+Download all matching tables? If enabled then each table matching the
+given \fBtab_id\fR will be download and the \fBoutput\fR filename will
+be the root filename and each table will be appended with a running number.
+
+A Registry ShortName typically refer to a single publication, while the
+identifier refer to a specific table within that paper. To download all
+tables in a given paper, run this task with the \fBtab_id\fR as the
+Registry ShortName entry and the \fBall\fR parameter enabled. If you will
+to download a specific table, call the task with the \fBIdentifier\fR field.
+.le
+.ls verbose = no
+Verbose output flag.
+.le
+.ls status = ""
+Status return code of task (output).
+.le
+
+.ih
+DESCRIPTION
+
+The \fBVIZIER\fR task ......
+
+.ih
+EXAMPLES
+1.
+
+.nf
+.fi
+
+
+2.
+
+.nf
+.fi
+
+.ih
+REVISIONS
+.le
+.ih
+SEE ALSO
+voclient
+.endhelp