Debian Codegraph @

cextern/xpa/man/mann/xpatemplate.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 "xpatemplate n"
127 .TH xpatemplate 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 \&\fBXPATemplate: Access Point Names and Templates\fR
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 \&\s-1XPA\s0 access points are composed of two parts: a general class and a
137 specific name. Both parts accept template characters so that you
138 can send/retrieve data to/from multiple servers at one time.
139 .SH "DESCRIPTION"
140 .IX Header "DESCRIPTION"
141 When \s-1XPA\s0 servers call
142 \&\fIXPANew()\fR,
143 or
144 \&\fIXPACmdNew()\fR
145 to define \s-1XPA\s0 access points, they specify a string identifier composed of a
146 class and a name. When clients communicate with \s-1XPA\s0 access points,
147 they specify which access points to communicate with using
148 an identifier of the form:
149 .PP
150 .Vb 1
151 \& class:name
152 .Ve
153 .PP
154 All registered \s-1XPA\s0 access points that match the specified identifier
155 will be available for communication (subject to access control rules,
156 etc.)
157 .PP
158 As of \s-1XPA\s0 2.1.5, the length of both the class and name designations are
159 limited to 1024 characters.
160 .PP
161 The \s-1XPA\s0 class:name identifier actually is a template: it accepts wild
162 cards in its syntax, so a single specifier can match more than one \s-1XPA\s0
163 access point. (Note that the class is optional and defaults to \*(L"*\*(R".)
164 The allowed syntax for clients to specify the class:name template is
165 of the form shown below. (Note that \*(L"*\*(R" is used to denote a generic
166 wild card, but other wild cards characters are supported, as described
167 below).
168 .PP
169 .Vb 7
170 \& template explanation
171 \& \-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-
172 \& class:name exact match of class and name
173 \& name match any class with this name
174 \& *:name match any class with this name
175 \& class:* match any name of this class
176 \& *:* match any access point
177 .Ve
178 .PP
179 In general, the following wild-cards can be applied to class and name:
180 .PP
181 .Vb 5
182 \& wildcard explanation
183 \& \-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-
184 \& ? match any character, but there must be one
185 \& * match anything, or nothing
186 \& [...] match an inclusive set
187 .Ve
188 .PP
189 Although the class:name template normally is used to refer to \s-1XPA\s0
190 access points, these also can be specified using their individual
191 socket identifiers. For inet sockets, the socket identifier is
192 \&\fBip:port\fR, where ip can be the DNS-registered name,
193 the \s-1ASCII\s0 \s-1IP\s0 number (e.g. 123.45.67.890) or the hex \s-1IP\s0 number
194 (e.g. 838f3a60). For unix sockets, the identifier is the socket file
195 name. These socket identifiers are displayed as the fourth argument
196 in the xpans display of registered access points. For example,
197 consider the ds9 program started using inet sockets. The xpans name
198 server will register something like this:
199 .PP
200 .Vb 2
201 \& csh> xpaget xpans
202 \& DS9 ds9 gs saord.harvard.edu:3236 eric
203 .Ve
204 .PP
205 You can access ds9 using ip:3236 in any of the three forms:
206 .PP
207 .Vb 2
208 \& csh> xpaget saord:3236 file
209 \& /home/eric/data/snr.ev
210 \&
211 \& csh> xpaget 123.45.67.890:3236 file
212 \& /home/eric/data/snr.ev
213 \&
214 \& csh> xpaget 838f3a60:3236 file
215 \& /home/eric/data/snr.ev
216 .Ve
217 .PP
218 In the case of unix sockets, the socket identifier is a file:
219 .PP
220 .Vb 2
221 \& csh> xpaget xpans
222 \& DS9 ds9 gs /tmp/.xpa/DS9_ds9.2631 eric
223 \&
224 \& csh> xpaget /tmp/.xpa/DS9_ds9.2631 file
225 \& /home/eric/data/snr.ev
226 .Ve
227 .PP
228 This feature can be useful in distinguishing between multiple
229 instances of a program that all have the same class:name designation.
230 .SH "SEE ALSO"
231 .IX Header "SEE ALSO"
232 See xpa(n) for a list of \s-1XPA\s0 help pages