Debian Codegraph @

cextern/xpa/man/man1/xpaset.1

raw
1 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 . ds -- \(*W-
28 . ds PI pi
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31 . ds L" ""
32 . ds R" ""
33 . ds C` ""
34 . ds C' ""
35 'br\}
36 .el\{\
37 . ds -- \|\(em\|
38 . ds PI \(*p
39 . ds L" ``
40 . ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD. Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 . de IX
53 . tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 . nr % 0
56 . rr F
57 .\}
58 .el \{\
59 . de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear. Run. Save yourself. No user-serviceable parts.
65 . \" fudge factors for nroff and troff
66 .if n \{\
67 . ds #H 0
68 . ds #V .8m
69 . ds #F .3m
70 . ds #[ \f1
71 . ds #] \fP
72 .\}
73 .if t \{\
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 . ds #V .6m
76 . ds #F 0
77 . ds #[ \&
78 . ds #] \&
79 .\}
80 . \" simple accents for nroff and troff
81 .if n \{\
82 . ds ' \&
83 . ds ` \&
84 . ds ^ \&
85 . ds , \&
86 . ds ~ ~
87 . ds /
88 .\}
89 .if t \{\
90 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 . \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 . \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 . \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 . ds : e
114 . ds 8 ss
115 . ds o a
116 . ds d- d\h'-1'\(ga
117 . ds D- D\h'-1'\(hy
118 . ds th \o'bp'
119 . ds Th \o'LP'
120 . ds ae ae
121 . ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "xpaset 1"
127 .TH xpaset 1 "July 23, 2013" "version 2.1.15" "SAORD Documentation"
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 \&\fBxpaset: send data to one or more \s-1XPA\s0 servers\fR
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 <data> | xpaset [\-h] [\-i nsinet] [\-m method] [\-n] [\-p] [\-s] [\-t sval,lval] [\-u users] [\-v] <template|host:port> [paramlist]
137 .SH "OPTIONS"
138 .IX Header "OPTIONS"
139 .Vb 10
140 \& \-h print help message
141 \& \-i access XPA point on different machine (override XPA_NSINET)
142 \& \-m override XPA_METHOD environment variable
143 \& \-n don\*(Aqt wait for the status message after server completes
144 \& \-p don\*(Aqt read (or send) buf data from stdin
145 \& \-s enter server mode
146 \& \-t [s,l] set short and long timeouts (override XPA_[SHORT,LONG]_TIMEOUT)
147 \& \-u [users] XPA points can be from specified users (override XPA_NSUSERS)
148 \& \-v verify message to stdout
149 \& \-\-version display version and exit
150 .Ve
151 .SH "DESCRIPTION"
152 .IX Header "DESCRIPTION"
153 Data read from stdin will be sent to access points matching the
154 template
155 or host:port.
156 A set of qualifying parameters can be appended.
157 .PP
158 Normally, xpaset reads data input from stdin until \s-1EOF\s0 and sends those
159 data to the \s-1XPA\s0 target, along with parameters entered on the command
160 line. For example to send a \s-1FITS\s0 file to the ds9 image display:
161 .PP
162 .Vb 1
163 \& cat foo.fits | xpaset ds9 fits
164 .Ve
165 .PP
166 Sometimes, however, it is desirable to send only parameters to an \s-1XPA\s0
167 access point, without sending data. For such cases, use the \-p switch to
168 indicate that there is no data being send to stdin. For example, to
169 change the colormap used by the ds9 image display program, use:
170 .PP
171 .Vb 1
172 \& csh> xpaset \-p ds9 cmap Heat
173 .Ve
174 .PP
175 Of course, this also can be accomplished by sending \s-1EOF\s0 to stdin in
176 any of the usual ways:
177 .PP
178 .Vb 4
179 \& csh> echo "" | xpaset ds9 cmap Heat
180 \& csh> xpaget ds9 cmap Heat < /dev/null
181 \& csh> xpaset ds9 cmap Heat
182 \& ^D # Ctl\-D signals EOF
183 .Ve
184 .PP
185 The \-s switch puts xpaset into server mode, in which commands and data
186 can be sent to access points without having to run xpaset multiple times.
187 (Its not clear if this buys you much!) The syntax for sending commands
188 in server mode is:
189 .PP
190 .Vb 8
191 \& csh> xpaset \-s
192 \& xpaset ds9 colormap I8
193 \& ^D
194 \& xpaset ds9 regions
195 \& circle 200 300 40
196 \& circle 300 400 50
197 \& ^D
198 \&etc.
199 .Ve
200 .PP
201 After the required \*(L"xpaset\*(R" command is specified, optional \s-1ASCII\s0 data
202 can be appended (as in the region example). A single data/command set is
203 delimited by ^D. Note that typing ^D when a command is expected terminates
204 the program.
205 .PP
206 \&\s-1NB:\s0 server mode only works from the terminal and only \s-1ASCII\s0 data can be
207 sent in this way.
208 .PP
209 \&\fBExamples:\fR
210 .PP
211 .Vb 2
212 \& csh> xpaset ds9 file < foo.fits
213 \& csh> echo "stop" | xpaset myhost:12345
214 .Ve
215 .SH "SEE ALSO"
216 .IX Header "SEE ALSO"
217 See xpa(n) for a list of \s-1XPA\s0 help pages