Debian Codegraph @

cextern/xpa/man/mann/xpa.n

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 "xpa n"
127 .TH xpa 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 \&\fB\s-1XPA:\s0 Public Access to Data and Algorithms\fR
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 This document is the Table of Contents for \s-1XPA\s0.
137 .SH "DESCRIPTION"
138 .IX Header "DESCRIPTION"
139 The \s-1XPA\s0 messaging system provides seamless communication between many
140 kinds of Unix programs, including X programs and Tcl/Tk programs. It
141 also provides an easy way for users to communicate with XPA-enabled
142 programs by executing \s-1XPA\s0 client commands in the shell or by utilizing
143 such commands in scripts. Because \s-1XPA\s0 works both at the programming
144 level and the shell level, it is a powerful tool for unifying any
145 analysis environment: users and programmers have great flexibility in
146 choosing the best level or levels at which to access \s-1XPA\s0 services, and
147 client access can be extended or modified easily at any time.
148 .PP
149 A program becomes an XPA-enabled server by defining named points of
150 public access through which data and commands can be exchanged with
151 other client programs (and users). Using standard \s-1TCP\s0 sockets as a
152 transport mechanism, \s-1XPA\s0 supports both single-point and broadcast
153 messaging to and from these servers. It supports direct communication
154 between clients and servers, or indirect communication via an
155 intermediate message bus emulation program. Host-based access control
156 is implemented, as is as the ability to communicate with \s-1XPA\s0 servers
157 across a network.
158 .PP
159 \&\s-1XPA\s0 implements a layered interface that is designed to be useful both
160 to software developers and to users. The interface consists of a
161 library of \s-1XPA\s0 client and server routines for use in C/\*(C+ programs and
162 a suite of high-level user programs built on top of these libraries.
163 Using the \s-1XPA\s0 library, access points can be added to Tcl/Tk programs,
164 Xt programs, or to Unix programs that use the \s-1XPA\s0 event loop or any
165 event loop based on \fIselect()\fR. Client access subroutines can be added
166 to any Tcl/Tk, Xt, or Unix program. Client access also is supported at
167 the command line via a suite of high-level programs.
168 .PP
169 Choose from the following topics:
170 .IP "\(bu" 4
171 Introduction to \s-1XPA\s0
172 [xpaintro(n)]
173 .IP "\(bu" 4
174 Access Point Names and Templates
175 [xpatemplate(n)]
176 .IP "\(bu" 4
177 Getting Common Information About Access Points
178 [xpacommon(n)]
179 .IP "\(bu" 4
180 Communication Methods
181 [xpamethod(n)]
182 .IP "\(bu" 4
183 Communication Between Hosts
184 [xpainet(n)]
185 .IP "\(bu" 4
186 Distinguishing Users
187 [xpausers(n)]
188 .IP "\(bu" 4
189 \&\s-1XPA\s0 User Programs
190 .RS 4
191 .IP "\(bu" 4
192 xpaget: get data and info
193 [\fIxpaget\fR\|(1)]
194 .IP "\(bu" 4
195 xpaset: send data and info
196 [\fIxpaset\fR\|(1)]
197 .IP "\(bu" 4
198 xpainfo: send info alert
199 [\fIxpainfo\fR\|(1)]
200 .IP "\(bu" 4
201 xpaaccess: get access point info
202 [\fIxpaaccess\fR\|(1)]
203 .IP "\(bu" 4
204 xpamb: message bus emulation
205 [\fIxpamb\fR\|(1)]
206 .IP "\(bu" 4
207 xpans: the \s-1XPA\s0 name server
208 [\fIxpans\fR\|(1)]
209 .RE
210 .RS 4
211 .RE
212 .IP "\(bu" 4
213 \&\s-1XPA\s0 Server Routines
214 .RS 4
215 .IP "\(bu" 4
216 XPANew: define a new access point
217 [\fIxpanew\fR\|(3)]
218 .IP "\(bu" 4
219 XPACmdNew: define a new command access point
220 [\fIxpacmdnew\fR\|(3)]
221 .IP "\(bu" 4
222 XPACmdAdd: add a command
223 [\fIxpacmdadd\fR\|(3)]
224 .IP "\(bu" 4
225 XPACmdDel: delete a command
226 [\fIxpacmddel\fR\|(3)]
227 .IP "\(bu" 4
228 XPAInfoNew: define an info access point
229 [\fIxpainfonew\fR\|(3)]
230 .IP "\(bu" 4
231 XPAFree: free an access point
232 [\fIxpafree\fR\|(3)]
233 .IP "\(bu" 4
234 XPAMainLoop: event loop for select server
235 [\fIxpamainloop\fR\|(3)]
236 .IP "\(bu" 4
237 XPAPoll: poll for \s-1XPA\s0 events
238 [\fIxpapoll\fR\|(3)]
239 .IP "\(bu" 4
240 XPACleanup: release reserved \s-1XPA\s0 memory
241 [\fIxpacleanup\fR\|(3)]
242 .IP "\(bu" 4
243 \&\s-1XPA\s0 Server Macros: accessing structure internals
244 [\fIxpamacros\fR\|(3)]
245 .IP "\(bu" 4
246 \&\s-1XPA\s0 Race Conditions: how to avoid them
247 [\fIxparace\fR\|(3)]
248 .IP "\(bu" 4
249 \&\s-1XPA\s0 Out of Memory (\s-1OOM\s0) errors
250 [\fIxpaoom\fR\|(3)]
251 .RE
252 .RS 4
253 .RE
254 .IP "\(bu" 4
255 \&\s-1XPA\s0 Client Routines
256 .RS 4
257 .IP "\(bu" 4
258 XPAOpen: open a persistent client connection
259 [\fIxpaopen\fR\|(3)]
260 .IP "\(bu" 4
261 XPAClose: close persistent client connection
262 [\fIxpaclose\fR\|(3)]
263 .IP "\(bu" 4
264 XPAGet: get data
265 [\fIxpaget\fR\|(3)]
266 .IP "\(bu" 4
267 XPASet: send data or commands
268 [\fIxpaset\fR\|(3)]
269 .IP "\(bu" 4
270 XPAInfo: send an info alert
271 [\fIxpainfo\fR\|(3)]
272 .IP "\(bu" 4
273 XPAGetFd: get data and write to an fd
274 [\fIxpagetfd\fR\|(3)]
275 .IP "\(bu" 4
276 XPASetFd: read data from and fd and send
277 [\fIxpasetfd\fR\|(3)]
278 .IP "\(bu" 4
279 XPANSLookup: look up an access point
280 [\fIxpanslookup\fR\|(3)]
281 .IP "\(bu" 4
282 XPAAccess: get access info
283 [\fIxpaaccess\fR\|(3)]
284 .IP "\(bu" 4
285 The XPA/Xt Interface: Xt interface to \s-1XPA\s0
286 [xpaxt(n)]
287 .IP "\(bu" 4
288 The XPA/Tcl Interface: Tcl interface to \s-1XPA\s0
289 [xpatcl(n)]
290 .RE
291 .RS 4
292 .RE
293 .IP "\(bu" 4
294 Tailoring the \s-1XPA\s0 Environment
295 .RS 4
296 .IP "\(bu" 4
297 Environment Variables
298 [xpaenv(n)]
299 .IP "\(bu" 4
300 Access Control
301 [xpaacl(n)]
302 .RE
303 .RS 4
304 .RE
305 .IP "\(bu" 4
306 Miscellaneous
307 .RS 4
308 .IP "\(bu" 4
309 Where to Find Example/Test Code
310 .IP "\(bu" 4
311 User Changes Between \s-1XPA\s0 1.0 and 2.0
312 .IP "\(bu" 4
313 \&\s-1API\s0 Changes Between \s-1XPA\s0 1.0 and 2.0
314 .IP "\(bu" 4
315 What Does \s-1XPA\s0 Stand For, Anyway?
316 .RE
317 .RS 4
318 .RE