aboutsummaryrefslogtreecommitdiff
path: root/vendor/voclient/doc/Notes-CLI
blob: c57e613c396f8621f591c203888a5180be3b869f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
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