1xpacommon(n) SAORD Documentation xpacommon(n)
2
6 XPACommon: Getting Common Information About Access Points
7
9 There are various kinds of generic information you can retrieve about
10 an XPA access point by using the xpaget command.
11
13 You can find out which XPA access points have been registered with the
14 currently running XPA name server by executing the xpaget command to
15 retrieve info from the XPA name server:
16 xpaget xpans
18 If, for example, the stest test server program is running, the follow‐
20 ing XPA access points will be returned (the specifics of the returned
21 info will vary for different machines and users):
22 XPA xpa gs 838e2f67:1262 eric
24 XPA xpa1 gs 838e2f67:1266 eric
25 XPA c_xpa gs 838e2f67:1267 eric
26 XPA i_xpa i 838e2f67:1268 eric
27 Note that access to this information is subject to the usual XPA Access
29 Control restrictions.
30 Each XPA access point supports a number of reserved sub-commands that
32 provide access to different kinds of information, e.g. the access con‐
33 trol for that access point. These sub-commands can be executed by
34 using xpaset or xpaget at the command line, or XPAGet() or XPASet() in
35 programs, e.g:
36 xpaget ds9 -acl
38 xpaget ds9 -help
39 xpaget ds9 env FOO
40 xpaset -p ds9 env FOO foofoo
42 With the exception of -help and -version, reserved sub-commands are
44 available only on the machine on which the XPA server itself is run‐
45 ning.
46 The following reserved sub-commands are defined for all access points:
48 · -acl get (set) the access control list [options: host type acl, for
50 set]
51 The 'xpaset' option allows you to add a new acl for a given host,
53 or change the acl for an existing host. See XPA Access Control for
54 more information. This access point is available only on the
55 server machine.
56 · -env get (set) an environment variable [options: name (value, for
58 set)]
59 The 'xpaget' option will return the value of the named environment
61 variable. The 'xpaset' option will set the value of the names
62 variable to the specified value. This access point is available
63 only on the server machine. (Please be advised that we have had
64 problems setting environment variables in static Tcl/Tk programs
65 such as ds9 running under Linux.)
66 · -clipboard set(get) information on a named clipboard
68 Clients can store ASCII state information on any number of named
70 clipboards. Clipboards of the same name created by clients on dif‐
71 ferent machines are kept separate. The syntax for creating a clip‐
72 board is:
73 [data] ⎪ xpaset [server] -clipboard add⎪append [clipboard_name]
75 xpaset -p [server] -clipboard delete [clipboard_name]
76 Use "add" to create a new clipboard or replace the contents of an
78 existing one. Use "append" to append to an existing clipboard.
79 Information on a named clipboard is retrieved using:
81 xpaget [server] -clipboard [clipboard_name]
83 · -exec set: execute commands from buffer [options: none]
85 If -exec is specified in the paramlist of an 'xpaset' call, then
87 further sub-commands will be retrieved from the data buffer.
88 · -help get: return help string for this XPA or sub-command [options:
90 name (for sub-commands)]
91 Each XPA access point and each XPA sub-command can have a help
93 string associated with it that is specified when the access point
94 is defined. The -help option will return this help string. For
95 XPA access points that contain user-defined sub-commands, you can
96 get the help string for a particular sub-command by specifying its
97 name, or else get the help strings for all sub-commands if not name
98 is specified.
99 · -ltimeout get (set) the long timeout value [options: seconds⎪reset]
101 The 'xpaget' option will return the value of the long timeout (in
103 seconds). The 'xpaset' option will set the value of the long time‐
104 out. If "reset" is specified, then the timeout value will be reset
105 to the default value.
106 · -nsconnect set: re-establish name server connection to all XPA's
108 [options: none]
109 If the XPA Name Server (xpans) process has terminated unexpectedly
111 and then re-started, this sub-command can be used to re-establish
112 the connection. You use it by sending the command to the
113 [name:port] or [file] of the access point instead of to the XPA
114 name (since the latter requires the xpans connection!):
115 xpaset -p 838e2f67:1268 -nsconnect
117 See xpans for more information.
119 · -nsdisconnect set: break name server connection to all XPA's
121 [options: none]
122 This sub-command will terminate the connection to the XPA Name
124 Server (xpans), thereby making all access points inaccessible
125 except through their underlying [name:port] or [file] identifiers.
126 I forget why we added it, it seems pretty useless.
127 · -stimeout get (set) the short timeout value [options: sec‐
129 onds⎪reset]
130 The 'xpaget' option will return the value of the short timeout (in
132 seconds). The 'xpaset' option will set the value of the short
133 timeout. If "reset" is specified, then the timeout value will be
134 reset to the default value.
135 · -remote set: register xpa with remote server [options: host[:port]
137 [acl]] [-proxy]
138 This sub-command will register the XPA access point with the XPA
140 name server (xpans) on the specified host (which must already be
141 running). The specified host also is given access control to the
142 access point, using the specified acl or the default acl of "+"
143 (meaning the remote host can xpaset, xpaget, xpainfo or xpaaccess).
144 If the acl is specified as "-", then the access point is unregis‐
145 tered. See Communication Between Machines for more information on
146 how this sub-command is used.
147 · -version get: return XPA version string [options: none]
149 The version refers to the version of XPA used to define this access
151 point (currently something like 2.0).
152 You can add your own reserved commands to all XPA access points by
154 using the XPACmdAdd() routine, passing the XPA handle returned by XPA
155 XPAGetReserved(void) as the first argument. Note again that these will
156 only be available on the machine where the XPA service is running.
157
159 See xpa(n) for a list of XPA help pages
160version 2.1.8 November 1, 2007 xpacommon(n)