Debian Codegraph @

cextern/xpa/man/man1/xpaaccess.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 "xpaaccess 1"
127 .TH xpaaccess 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 \&\fBxpaaccess: see if template matches registered \s-1XPA\s0 access points\fR
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 xpaaccess [\-c] [\-h] [\-i nsinet] [\-m method] [\-n] [\-t sval,lval] [\-u users] \-v <template> [type]
137 .SH "OPTIONS"
138 .IX Header "OPTIONS"
139 .Vb 10
140 \& \-c contact each access point individually
141 \& \-h print help message
142 \& \-i access XPA point on different machine (override XPA_NSINET)
143 \& \-m override XPA_METHOD environment variable
144 \& \-n return number of matches instead of "yes" or "no"
145 \& \-t [s,l] set short and long timeouts (override XPA_[SHORT,LONG]_TIMEOUT)
146 \& \-u [users] XPA points can be from specified users (override XPA_NSUSERS)
147 \& \-v print info about each successful access point
148 \& \-V print info or error about each access point
149 \& \-\-version display version and exit
150 .Ve
151 .SH "DESCRIPTION"
152 .IX Header "DESCRIPTION"
153 xpaaccess returns \*(L"yes\*(R" to stdout (with a return error code if 1) if there are
154 existing \s-1XPA\s0 access points that match the
155 template
156 (and optional access type: g,i,s). Otherwise, it returns \*(L"no\*(R" (with a
157 return error code of 0). If \-n is specified, the number of matches is
158 returned instead (both to stdout and in the returned error code). If
159 \&\-v is specified, each access point is displayed to stdout instead of
160 the number of matches.
161 .PP
162 By default, xpaaccess simply contacts the xpans name server to find
163 the list of registered access points that match the specified
164 template. It also checks to make sure the specified types are
165 supported by that access point. This is the fastest way to determine
166 available access points. However, an access point might registered but
167 not yet available, if, for example, the server program has not entered
168 its event loop to process \s-1XPA\s0 requests. To find access points that are
169 guaranteed to be available for processing, use the \-c (contact)
170 switch. With this switch, xpaaccess contacts each matching \s-1XPA\s0 server
171 (rather than the name server) to make sure the registered access point
172 really is ready for processing. In this mode, if an access point is
173 registered but not available, xpaaccess will pause for a period of
174 time equal to the \s-1XPA_LONG_TIMEOUT\s0, in order to give the server a
175 chance to ready itself. By default, this timeout is 30 seconds. You
176 can shorten the time of delay using the \-t \*(L"short,long\*(R" switch. For
177 example, to shorten the delay time to 2 seconds, use:
178 .PP
179 .Vb 1
180 \& xpaaccess \-c \-t "2,2" ds9
181 .Ve
182 .PP
183 The first argument is the short delay value, and is ignored in this
184 operation. The second is the long delay timeout.
185 .PP
186 Note also that the default xpaaccess method (no \-c switch) does not
187 check access control (acls) but rather only checks whether the access
188 point is both registered with the xpans name server and provides the
189 specified type of access. In other words, the default xpaaccess could
190 return 'yes' when you might not actually have access. This mode also
191 always returns 'yes' for the xpans name server itself, regardless of
192 whether the name server is active. The \-c (contact) switch, which
193 contacts the access point directly, can and does check the access
194 control (only for servers using version 2.1 and above) and also
195 returns the real status of xpans.
196 .SH "SEE ALSO"
197 .IX Header "SEE ALSO"
198 See xpa(n) for a list of \s-1XPA\s0 help pages