aboutsummaryrefslogtreecommitdiff
path: root/vendor/voclient/doc/Notes-CLI
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@gmail.com>2015-07-08 20:46:52 -0400
committerJoseph Hunkeler <jhunkeler@gmail.com>2015-07-08 20:46:52 -0400
commitfa080de7afc95aa1c19a6e6fc0e0708ced2eadc4 (patch)
treebdda434976bc09c864f2e4fa6f16ba1952b1e555 /vendor/voclient/doc/Notes-CLI
downloadiraf-linux-fa080de7afc95aa1c19a6e6fc0e0708ced2eadc4.tar.gz
Initial commit
Diffstat (limited to 'vendor/voclient/doc/Notes-CLI')
-rw-r--r--vendor/voclient/doc/Notes-CLI172
1 files changed, 172 insertions, 0 deletions
diff --git a/vendor/voclient/doc/Notes-CLI b/vendor/voclient/doc/Notes-CLI
new file mode 100644
index 00000000..c57e613c
--- /dev/null
+++ b/vendor/voclient/doc/Notes-CLI
@@ -0,0 +1,172 @@
+
+Common Flags:
+
+ -h Print task help
+ -v Verbose output
+ -q Suppress all output
+ +d Debug output
+
+
+
+-------------------------------------------------------------------------------
+
+Registry:
+ vodirectory VO Resource discovery (keyword search, resolution, info)
+
+
+-------------------------------------------------------------------------------
+
+Data Access:
+ vodata Query and Access VO data (general engine)
+ vocatalog Query VO catalog services (SAMP load to overlay) (1
+ voimage Query VO image services (SAMP load to display) (1
+ vospectrum Query VO spectrum services (SAMP load) (1
+
+ dss Load DSS field in display (SAMP to ds9/aladin) (1
+ obslog Query public observation logs (SAMP table load) (1
+
+
+
+-------------------------------------------------------------------------------
+
+VOTable:
+ Common Flags:
+ -i <fname> Input filename (else STDIN)
+ -n Number rows
+ -o <fname> Output filename (else STDOUT)
+ -r <range> Extract range of rows
+
+
+ votcopy Copy to/from votable format
+
+ votcopy [flags] [<in>] [<out>]
+
+ -f <fmt> Specify format (fits|ascii|asv|bsv|csv|tsv)
+
+
+ votget Download data access references in a VOTable (w/ selection)
+
+ votget [flags] <votable>
+
+ -A <ucd> Specify UCD for access reference
+ -F <ucd> Specify UCD for format description
+ -N <N> N-threads to download
+
+ -b <base> Base filename
+ -c <col> Download reference in column N (1-indexed)
+ -e <extn> Filename extension
+ -f <fmt> Format to download
+ -l List instead of download references
+
+
+ votinfo Print information about a votable
+
+ votinfo [flags] <votable>
+
+ -N <what> Print number of <what> elements
+ -s Print size of table (ncols x nrows x nres)
+ -f name|id|ucd Find column by value
+ -p name|id|ucd Print column name/id/ucd
+
+
+ votpos Extract position columns from a VOTable
+
+ votpos [flags] <votable>
+
+ -r <range> Extract from row range
+
+
+ votsplit Split a multi-resource votable (opt. output conversion) (2a
+
+ votsplit [flags] <votable>
+
+ -R <resnum> Extract specified resource number (can be range)
+
+ -b <base> Base filename
+ -e <extn> Filename extension
+ -f <fmt> Output format
+
+
+ votjoin Join multiple votables into a multi-resource table (2a
+
+ votjoin [flags] <votable> .....
+
+ -N <name> Base name for <RESOURCE>
+
+
+
+-------------------------------------------------------------------------------
+
+SAMP:
+ Common Flags:
+ -r <recip> Send to specific app, otherwise broadcast
+ -p <sync|async> Send as specified pattern
+
+
+ samp SAMP utility command (list clients, start hub, etc)
+
+ samp [flags] <cmd>
+
+ -f <file> Process commands in <file>
+
+ <cmd> is one of:
+ access <app> Is <app> available? (status=0 or 1)
+ list List available clients
+ ping Ping a specified client
+ sub <mtype> Print which clients are subscribed
+ meta <key> Print client metadata
+ getenv <key> Get client environment value
+ setenv <key> <val> Set client environment value
+ getpar <key> Get client parameter value
+ setpar <key> <val> Set client parameter value
+ exec <cmd_str> Execute command string
+ load <file> Load the named file (as appropriate)
+
+ send <mtype> [k=v] Send message (low level)
+ listen <mtype> Wait for specified mtype
+
+ snoop Print all messages seen
+ help Print help summary
+
+ proxy <server> <key> Run as proxy to forward messages
+
+
+ proxy
+ (inet:6543:server)
+ / \
+ App / | \ App
+ \ / | \ /
+ App - Hub -- samp | samp -- Hub - App
+ / | \
+ App | App
+
+
+
+-------------------------------------------------------------------------------
+
+Cross-Compare
+ voxmatch Cross-compare local table an VO data (3
+
+
+-------------------------------------------------------------------------------
+
+VOSpace:
+
+ vosput Put files to a VOSpace (4
+ vosget Get files from a VOSpace (4
+ vosmove Move files/nodes between VOSpaces (4
+ voslist List files/nodes in a VOSpace (4
+ vosdelete Delete files/nodes in a VOSpace (4
+
+
+-------------------------------------------------------------------------------
+
+Name Resolver:
+ sesame Resolve object names to positions
+
+
+-------------------------------------------------------------------------------
+
+Moving Targets:
+ skybot List known moving objects in an image (2b
+