| 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 "xpaenv n" |
| 127 |
.TH xpaenv n "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 |
\&\fBXPAEnv: Environment Variables for \s-1XPA\s0 Messaging\fR |
| 134 |
.SH "SYNOPSIS" |
| 135 |
.IX Header "SYNOPSIS" |
| 136 |
Describes the environment variables which can be used to tailor the overall |
| 137 |
\&\s-1XPA\s0 environment. |
| 138 |
.SH "DESCRIPTION" |
| 139 |
.IX Header "DESCRIPTION" |
| 140 |
The following environment variables are supported by \s-1XPA:\s0 |
| 141 |
.IP "\(bu" 4 |
| 142 |
\&\fB\s-1XPA_ACL\s0\fR |
| 143 |
.Sp |
| 144 |
If \fI\s-1XPA_ACL\s0\fR is \fItrue\fR, then |
| 145 |
host-based \s-1XPA\s0 Access Control |
| 146 |
is turned on and only specified machines can access specified access |
| 147 |
points. If \fIfalse\fR, then access control is turned off and any |
| 148 |
machine can access point. The default is turn turn access control on. |
| 149 |
.IP "\(bu" 4 |
| 150 |
\&\fB\s-1XPA_ACLFILE\s0\fR |
| 151 |
.Sp |
| 152 |
If |
| 153 |
\&\s-1XPA\s0 Access Control |
| 154 |
is turned on, this variable specifies the name of the file containing |
| 155 |
access control information for all access points started by this user. |
| 156 |
The default file name is: \fI\f(CI$HOME\fI/acls.xpa\fR. |
| 157 |
.IP "\(bu" 4 |
| 158 |
\&\fB\s-1XPA_CONNECT_TIMEOUT\s0\fR |
| 159 |
.Sp |
| 160 |
When an \s-1XPA\s0 server first starts up, it immediately tries to |
| 161 |
connect to the \s-1XPA\s0 name server program (xpans) on the host specified by |
| 162 |
the \fI\s-1XPA_NSINET\s0\fR variable. (If this connection fails on the |
| 163 |
local host, and if xpans can be found in the path, then the name |
| 164 |
server is started automatically.) Unfortunately, a mis-configured |
| 165 |
network can cause this connect attempt to hang for many seconds while |
| 166 |
the \fIconnect()\fR system call times out. Therefore, an alarm is started |
| 167 |
to interrupt the \fIconnect()\fR call and prevent a long hang. The initial |
| 168 |
value of the alarm timeout is 10 seconds, but can be changed by setting |
| 169 |
this environment variable. If you want to disable the alarm and allow |
| 170 |
the initial \fIconnect()\fR to time out, set the value of this variable to |
| 171 |
0. Normally, users would not change this variable at all. |
| 172 |
.IP "\(bu" 4 |
| 173 |
\&\fB\s-1XPA_CLIENT_DOXPA\s0\fR |
| 174 |
.Sp |
| 175 |
Normally, an \s-1XPA\s0 client (xpaget, xpaset, etc.) will process incoming |
| 176 |
\&\s-1XPA\s0 server requests while awaiting the completion of the client request. |
| 177 |
Setting this variable to \*(L"false\*(R" will prevent \s-1XPA\s0 server requests from |
| 178 |
being processed by the client. |
| 179 |
.IP "\(bu" 4 |
| 180 |
\&\fB\s-1XPA_DEFACL\s0\fR |
| 181 |
.Sp |
| 182 |
If |
| 183 |
\&\s-1XPA\s0 Access Control |
| 184 |
is turned on, this variable specifies the default access control |
| 185 |
condition for all access points, if the \fI\s-1XPA_ACLFILE\s0\fR file does |
| 186 |
not exist. The default acl is: \fI\f(CI$host:\fI* \f(CI$host\fI +\fR, meaning that |
| 187 |
all processes on the host machine have full access to all access points. |
| 188 |
.IP "\(bu" 4 |
| 189 |
\&\fB\s-1XPA_HOST\s0\fR |
| 190 |
.Sp |
| 191 |
For the \s-1INET\s0 socket method, \s-1XPA\s0 utilizes the canonical hostname (as |
| 192 |
returned by the \fIgethostname()\fR routine) to construct the \s-1IP\s0 part of the |
| 193 |
method id. Under some circumstances, this might not be a correct choice |
| 194 |
of name and \s-1IP\s0. For example, if an \s-1XPA\s0 server is started on a machine |
| 195 |
running \s-1VPN\s0, you might want to use the \s-1VPN\s0 name and \s-1IP\s0 instead of the |
| 196 |
canonical host name, so that other machines in the \s-1VPN\s0 network can |
| 197 |
access the server. In this case, you can set the \s-1XPA_HOST\s0 to be |
| 198 |
the \s-1VPN\s0 name (if resolvable) or, more easily, the \s-1VPN\s0 \s-1IP\s0. |
| 199 |
.IP "\(bu" 4 |
| 200 |
\&\fB\s-1XPA_IOCALLSXPA\s0\fR |
| 201 |
.Sp |
| 202 |
Setting this variable causes all \s-1XPA\s0 socket \s-1IO\s0 calls to process |
| 203 |
outstanding \s-1XPA\s0 requests whenever the primary socket is not ready for |
| 204 |
\&\s-1IO\s0. This means that a server making a client call will (recursively) |
| 205 |
process incoming server requests while waiting for client completion. |
| 206 |
This inter-IO \s-1XPA\s0 processing avoids a rare |
| 207 |
\&\s-1XPA\s0 Race Condition: two or more |
| 208 |
\&\s-1XPA\s0 servers sending messages to one another using an \s-1XPA\s0 client |
| 209 |
routine such as \fIXPASet()\fR can deadlock while each waits for the other |
| 210 |
server to respond. This can happen, for example, if the servers call |
| 211 |
\&\fIXPAPoll()\fR with a time limit, and send messages in between the polling call. |
| 212 |
.Sp |
| 213 |
By default, this option is turned off, because we judge that the added |
| 214 |
code complication and overhead involved will not be justified by the |
| 215 |
amount of its use. Moreover, processing \s-1XPA\s0 requests within socket \s-1IO\s0 |
| 216 |
can lead to non-intuitive results, since incoming server requests will |
| 217 |
not necessarily be processed to completion in the order in which they |
| 218 |
are received. |
| 219 |
.IP "\(bu" 4 |
| 220 |
\&\fB\s-1XPA_LOGNAME\s0\fR |
| 221 |
.Sp |
| 222 |
\&\s-1XPA\s0 preferentially uses the de facto standard environment variable |
| 223 |
\&\s-1LOGNAME\s0 to determine the username when registering an access point in |
| 224 |
the name server. If this environment variable has been used for |
| 225 |
something other than the actual user name (such as a log file name), |
| 226 |
unexpected results can ensue. In such cases, use the \s-1XPA_LOGNAME\s0 |
| 227 |
variable to set the user name. (If neither exists, then getpwuid(\fIgeteuid()\fR) |
| 228 |
is used as a last resort). |
| 229 |
.IP "\(bu" 4 |
| 230 |
\&\fB\s-1XPA_LONG_TIMEOUT\s0\fR |
| 231 |
.Sp |
| 232 |
\&\s-1XPA\s0 is designed to allow data to be sent from one process to |
| 233 |
another over a long period of time (i.e., a program that generates |
| 234 |
image data sends that data to an image display, but slowly) but it |
| 235 |
also seeks to prevent hangs. This is done by supporting 2 timeout |
| 236 |
periods: a \fIshort\fR timeout for protocol communication |
| 237 |
and a \fIlong\fR for data communication. |
| 238 |
.Sp |
| 239 |
The \fI\s-1XPA_LONG_TIMEOUT\s0\fR variable controls the \fIlong\fR |
| 240 |
timeout and is used to prevent hangs in cases where communication |
| 241 |
between the client and server that is \fInot\fR controlled by the |
| 242 |
\&\s-1XPA\s0 interface itself. Transfer of data between client and server, or a |
| 243 |
client's wait for a status message after completion of the server |
| 244 |
callback, are two examples of this sort of communication. By default, |
| 245 |
the \fIlong\fR timeout is set to 180 seconds. |
| 246 |
Setting the value to \-1 will disable \fIlong\fR timeouts and allow |
| 247 |
an infinite amount of time. |
| 248 |
.IP "\(bu" 4 |
| 249 |
\&\fB\s-1XPA_MAXHOSTS\s0\fR |
| 250 |
.Sp |
| 251 |
The maximum number of access points that the programs |
| 252 |
\&\fIxpaset\fR, \fIxpaget\fR, and \fIxpainfo\fR will |
| 253 |
communicate with at one time. The default is 64, meaning, for |
| 254 |
example, that the \fIxpaset\fR program will not send a message |
| 255 |
to more than 100 access points at one time and \fIxpaget\fR will |
| 256 |
not retrieve from more than 100 access points at one time. |
| 257 |
.IP "\(bu" 4 |
| 258 |
\&\fB\s-1XPA_METHOD\s0\fR |
| 259 |
.Sp |
| 260 |
Determines the socket connection method used by this session of \s-1XPA\s0. |
| 261 |
The choices are: \fIinet\fR (to use \s-1INET\s0 or Internet-based |
| 262 |
sockets), \fIlocalhost\fR (to use the machines localhost inet |
| 263 |
socket), or \fIlocal (unix)\fR (to use \s-1UNIX\s0 sockets). The default |
| 264 |
is \fI\s-1INET\s0\fR. Using the \fIinet\fR method will allow access |
| 265 |
from other machines (subject to access controls) but using |
| 266 |
\&\fIlocalhost\fR or \fIlocal\fR will not. Localhost is most useful |
| 267 |
for private access and when the machine in question is not connected |
| 268 |
to the Internet. The unix method also can be used for private access |
| 269 |
and non-Internet connections (Unix platforms only). |
| 270 |
.Sp |
| 271 |
Once defined, the first registration of an \s-1XPA\s0 access point will |
| 272 |
ensure that an instance of the |
| 273 |
\&\s-1XPA\s0 Name Server (xpans) |
| 274 |
is running that handles that connection method. All new access points |
| 275 |
will use the new connection method but existing access points will use |
| 276 |
the original method. |
| 277 |
.IP "\(bu" 4 |
| 278 |
\&\fB\s-1XPA_NSINET\s0\fR |
| 279 |
.Sp |
| 280 |
For the \fIinet\fR method of socket connection, this variable |
| 281 |
specifies the host and port on which the |
| 282 |
\&\s-1XPA\s0 Name Server (xpans) |
| 283 |
is listens for new access points. The default is \fI\f(CI$host:\fI$port\fR, |
| 284 |
meaning that the default \s-1XPA\s0 port (14285) on the current machine |
| 285 |
(as returned by \fIgethostname()\fR) is used. If several machines were all |
| 286 |
accessing the same \s-1XPA\s0 access points, you would use this variable to |
| 287 |
specify that they all use the same name server to find out about these |
| 288 |
access points. For example, a value of \fImyhost:$port\fR would |
| 289 |
mean that the xpans name server is running on myhost and uses the |
| 290 |
default port 12345. All machines would then get the \s-1XPA\s0 access points |
| 291 |
registered with that name server, subject to access controls. |
| 292 |
.Sp |
| 293 |
The port used by xpans to register its \s-1XPA\s0 access point normally is |
| 294 |
taken to be one greater than the port on which it receives new access |
| 295 |
points from \s-1XPA\s0 servers. You can specify a specific access point port |
| 296 |
using the syntax machine:port1,port2, i.e., the access point port is |
| 297 |
specified after the comma. For example, \f(CW$host:12345\fR,23456 will listen |
| 298 |
for new access ports on 12345 and will accept \s-1XPA\s0 commands on 23456. |
| 299 |
.IP "\(bu" 4 |
| 300 |
\&\fB\s-1XPA_NSREGISTER\s0\fR |
| 301 |
.Sp |
| 302 |
This boolean variable specifies whether a server registers its \s-1XPA\s0 |
| 303 |
access point with the specified xpans name server. The default is |
| 304 |
\&\fItrue\fR. If set to \fIfalse\fR, the access point still is |
| 305 |
set up but it is not registered with xpans and therefore cannot be |
| 306 |
accessed by name. (It can be accessed by method, if the latter is |
| 307 |
known.) Note that an access point can be registered later on (using |
| 308 |
\&\-remote or \-proxy, for example). This variable mainly is useful in |
| 309 |
cases where the Internet configuration is broken (so that registration |
| 310 |
causes a \s-1DNS\s0 hang) but you still wish to and can use the server with a |
| 311 |
remote xpans (e.g., ds9's Virtual Observatory capability). |
| 312 |
.IP "\(bu" 4 |
| 313 |
\&\fB\s-1XPA_NSUNIX\s0\fR |
| 314 |
.Sp |
| 315 |
For the \fIlocal\fR method of socket connection, this variable |
| 316 |
specifies the name of the Unix file that will be used to access the |
| 317 |
\&\s-1XPA\s0 Name Server (xpans). The default is |
| 318 |
\&\fIxpans_unix\fR. This variable is not usually needed. Note that |
| 319 |
is the \fIlocal\fR socket method is used, then remote machines will |
| 320 |
not be able to access the xpans name server or the registered \s-1XPA\s0 access |
| 321 |
points. |
| 322 |
.IP "\(bu" 4 |
| 323 |
\&\fB\s-1XPA_NSUSERS\s0\fR |
| 324 |
.Sp |
| 325 |
This variable specifies whether other users' access points will be |
| 326 |
returned by the |
| 327 |
\&\s-1XPA\s0 Name Server (xpans) for use by |
| 328 |
\&\fIxpaget\fR, \fIxpaset\fR, etc. |
| 329 |
Generally speaking, it is sufficient to run one xpans name server per |
| 330 |
machine and register the access points for all users with that xpans. |
| 331 |
This means, for example, that if you request information from |
| 332 |
ds9 by running: |
| 333 |
.Sp |
| 334 |
.Vb 1 |
| 335 |
\& xpaget ds9 colormap |
| 336 |
.Ve |
| 337 |
.Sp |
| 338 |
you might get information from your own ds9 as well as |
| 339 |
from another user running ds9 on the same machine. The |
| 340 |
\&\fI\s-1XPA_NSUSERS\s0\fR variable controls whether you want such access |
| 341 |
to the access points of other users. |
| 342 |
By default, only your own access points are returned, so |
| 343 |
that, in the example above, you would only get the colormap information |
| 344 |
from the ds9 you registered. If, however, you had set the value of the |
| 345 |
\&\fI\s-1XPA_NSUSERS\s0\fR variable to \fIeric,fred\fR, then you would be |
| 346 |
able to communicate with both eric and fred's access points. Note that |
| 347 |
this variable can be overridden using the \fI\-u\fR switch on the |
| 348 |
\&\fIxpaget\fR, \fIxpaset\fR, and \fIxpainfo\fR programs. |
| 349 |
.IP "\(bu" 4 |
| 350 |
\&\fB\s-1XPA_PORT\s0\fR |
| 351 |
.Sp |
| 352 |
A semi-colon delimited list of user specified ports to use for specific |
| 353 |
\&\s-1XPA\s0 access points. The format is each specification is: |
| 354 |
.Sp |
| 355 |
class:template port1[ port2] |
| 356 |
.Sp |
| 357 |
where \fBport1\fR is the main (command) port for the access point and |
| 358 |
\&\fBport2\fR is the (secondary) data port. If port2 is not specified, |
| 359 |
it defaults to a value of 0 (meaning the system assigns the port). |
| 360 |
.Sp |
| 361 |
Specification of specific ports is useful, for example, when a machine |
| 362 |
outside a firewall needs to communicate with a machine inside a |
| 363 |
firewall. In such a case, the firewall should be configured to allow |
| 364 |
socket connections to both the command and data port from the outside |
| 365 |
machine, and the inside \s-1XPA\s0 program should be started up with the |
| 366 |
outside machine in its \s-1ACL\s0 list. Then, when the inside program is |
| 367 |
started with specified ports, outside \s-1XPA\s0 programs can use |
| 368 |
\&\*(L"machine:port\*(R" to contact the inside access points, instead of the |
| 369 |
access point names. That is, the machine outside the firewall does not |
| 370 |
need access to the \s-1XPA\s0 name server: |
| 371 |
.Sp |
| 372 |
export XPA_PORT=\*(L"DS9:ds9 12345 12346\*(R" # on machine \*(L"inside\*(R" |
| 373 |
cat foo.fits | xpaset inside:12345 fits # on machine \*(L"outside\*(R" |
| 374 |
.Sp |
| 375 |
Note that 2 ports are required for full \s-1XPA\s0 communication and |
| 376 |
therefore 2 ports should be specified to go through a firewall. The |
| 377 |
second port assignment is not important if you simply are assigning |
| 378 |
the command port in order to communicate commands with a known |
| 379 |
port (e.g., to bypass the xpans name server). If only one (command) |
| 380 |
port is specified, the system will negotiate a random data port and |
| 381 |
everything will work properly. |
| 382 |
.Sp |
| 383 |
This support is somewhat experimental. If you run into problems, please |
| 384 |
let us know. |
| 385 |
.IP "\(bu" 4 |
| 386 |
\&\fB\s-1XPA_PORTFILE\s0\fR |
| 387 |
.Sp |
| 388 |
A list of user-specified port to use for specific xpa access points. |
| 389 |
The format of the file is: |
| 390 |
.Sp |
| 391 |
class:template port1 [port2] |
| 392 |
.Sp |
| 393 |
where \fBport1\fR is the main port for the access point and |
| 394 |
\&\fBport2\fR is the data port. If port2 is not specified, it defaults |
| 395 |
to a value of 0 (meaning the system assigns the port). See |
| 396 |
\&\fB\s-1XPA_PORT\s0\fR above for an explanation of user-specified ports. |
| 397 |
.IP "\(bu" 4 |
| 398 |
\&\fB\s-1XPA_SHORT_TIMEOUT\s0\fR |
| 399 |
.Sp |
| 400 |
\&\s-1XPA\s0 is designed to allow data to be sent from one process to |
| 401 |
another over a long period of time (i.e., a program that generates |
| 402 |
image data sends that data to an image display, but slowly) but it |
| 403 |
also seeks to prevent hangs. This is done by supporting 2 timeout |
| 404 |
periods: a \fIshort\fR timeout for protocol communication |
| 405 |
and a \fIlong\fR for data communication. |
| 406 |
.Sp |
| 407 |
The \fI\s-1XPA_SHORT_TIMEOUT\s0\fR variable |
| 408 |
controls the \fIshort\fR timeout and is used to prevent hangs |
| 409 |
in cases where the \s-1XPA\s0 protocol requires internal communication between |
| 410 |
the client and server that is controlled by the \s-1XPA\s0 interface |
| 411 |
itself. Authentication is an example of this sort of communication, |
| 412 |
as is the establishment of a data channel between the two processes. |
| 413 |
The default value for the \fIshort\fR is 30 seconds (which is |
| 414 |
a pretty long time, actually). Setting the value to \-1 will disable |
| 415 |
\&\fIshort\fR timeouts and allow an infinite amount of time. |
| 416 |
.IP "\(bu" 4 |
| 417 |
\&\fB\s-1XPA_SIGUSR1\s0\fR |
| 418 |
.Sp |
| 419 |
If the value of this variable is \fItrue\fR, then \s-1XPA\s0 will |
| 420 |
catch \s-1SIGUSR1\s0 signals when performing an I/O operation in order to |
| 421 |
curtail that operation. This facility allows users to send a \s-1SIGUSR1\s0 |
| 422 |
signal to an \s-1XPA\s0 server if a client is hanging up the server by |
| 423 |
sending or receiving data too slowly (timeouts also can be used \*(-- see |
| 424 |
above). When enabled in this way, the \s-1SIGUSR1\s0 signal is ignored at all other |
| 425 |
times, so that its safe to send the signal at any time. If the |
| 426 |
variable is set to \fIfalse\fR, then \s-1SIGUSR1\s0 is not used at |
| 427 |
all. Turning off \s-1SIGUSR1\s0 would be desired in cases there the program |
| 428 |
uses \s-1SIGUSR1\s0 for some other reason and does not want \s-1XPA\s0 interfering. |
| 429 |
The default is to use the signal. |
| 430 |
.IP "\(bu" 4 |
| 431 |
\&\fB\s-1XPA_TIMESTAMP_ERRORS\s0\fR |
| 432 |
.Sp |
| 433 |
If \fI\s-1XPA_TIMESTAMP_ERRORS\s0\fR is \fItrue\fR, then error |
| 434 |
messages will include a date/time string. This can be useful when |
| 435 |
\&\s-1XPA\s0 errors are being saved in an error log (e.g. Web/CGI use). The |
| 436 |
default is false. |
| 437 |
.IP "\(bu" 4 |
| 438 |
\&\fB\s-1XPA_TMPDIR\s0\fR |
| 439 |
.Sp |
| 440 |
This variable specifies the directory into which \s-1XPA\s0 logs, Unix |
| 441 |
socket files (when \fI\s-1XPA_METHOD\s0\fR is \fIlocal\fR), etc. are |
| 442 |
stored. The default is \fI/tmp/.xpa\fR. |
| 443 |
.IP "\(bu" 4 |
| 444 |
\&\fB\s-1XPA_VERBOSITY\s0\fR |
| 445 |
.Sp |
| 446 |
Specify the verbosity level of error messages. If the value is |
| 447 |
set to \fI0\fR, \fIfalse\fR, or \fIoff\fR, then no error |
| 448 |
messages are printed to stderr. If the value is \fI1\fR, then |
| 449 |
important \s-1XPA\s0 error messages will be output. If the value is |
| 450 |
set to \fI2\fR, \s-1XPA\s0 warnings about out-of-sync messages will also |
| 451 |
be output. These latter almost always can be ignored. |
| 452 |
.IP "\(bu" 4 |
| 453 |
\&\fB\s-1XPA_VERSIONCHECK\s0\fR |
| 454 |
.Sp |
| 455 |
Specify whether a new access point should check its major and minor \s-1XPA\s0 |
| 456 |
version number against the version used by the xpans name server at |
| 457 |
registration time. The default is \fItrue\fR. When checking is |
| 458 |
performed, a warning is issued if the server major version is found to |
| 459 |
be greater than the xpans version. Note that the check is performed |
| 460 |
both by the \s-1XPA\s0 server and by the xpans process and warnings will be |
| 461 |
issued by each. Also, instead of the values of \fItrue\fR or |
| 462 |
\&\fIfalse\fR, you can give this variable an integer value n. In this |
| 463 |
case, each version checking process (i.e., the XPA-enabled server or |
| 464 |
xpans) will print out a maximum of n warning messages (after which |
| 465 |
version warnings are silently swallowed). |
| 466 |
.Sp |
| 467 |
In general, it is a bad idea to run an XPA-enabled server program |
| 468 |
using a version of \s-1XPA\s0 newer than the basic xpaset, xpaget, xpaaccess, |
| 469 |
xpans programs. This sort of mismatch usually will not work due to |
| 470 |
protocol changes. |
| 471 |
.SH "SEE ALSO" |
| 472 |
.IX Header "SEE ALSO" |
| 473 |
See xpa(n) for a list of \s-1XPA\s0 help pages |
| 474 |
.SH "POD ERRORS" |
| 475 |
.IX Header "POD ERRORS" |
| 476 |
Hey! \fBThe above document had some coding errors, which are explained below:\fR |
| 477 |
.IP "Around line 458:" 4 |
| 478 |
.IX Item "Around line 458:" |
| 479 |
\&'=item' outside of any '=over' |
| 480 |
.IP "Around line 509:" 4 |
| 481 |
.IX Item "Around line 509:" |
| 482 |
You forgot a '=back' before '=head1' |