XAddHost.man 9.44 KB
Newer Older
1 2
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
.\"
Egbert Eich's avatar
Egbert Eich committed
3
.\" All rights reserved.
4
.\"
Egbert Eich's avatar
Egbert Eich committed
5 6
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the
7 8
.\" "Software"), to deal in the Software without restriction, including
.\" without limitation the rights to use, copy, modify, merge, publish,
Egbert Eich's avatar
Egbert Eich committed
9 10 11 12 13
.\" distribute, and/or sell copies of the Software, and to permit persons
.\" to whom the Software is furnished to do so, provided that the above
.\" copyright notice(s) and this permission notice appear in all copies of
.\" the Software and that both the above copyright notice(s) and this
.\" permission notice appear in supporting documentation.
14
.\"
15 16
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Egbert Eich's avatar
Egbert Eich committed
17 18 19 20 21 22 23
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
.\" OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
.\" HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
.\" INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
.\" FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
.\" NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
.\" WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
24
.\"
Egbert Eich's avatar
Egbert Eich committed
25 26 27 28
.\" Except as contained in this notice, the name of a copyright holder
.\" shall not be used in advertising or otherwise to promote the sale, use
.\" or other dealings in this Software without prior written authorization
.\" of the copyright holder.
29
.\"
Egbert Eich's avatar
Egbert Eich committed
30
.\" X Window System is a trademark of The Open Group.
31
.\"
32
.\" Copyright 2004 Oracle and/or its affiliates. All rights reserved.
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
.\" to deal in the Software without restriction, including without limitation
.\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
.\" and/or sell copies of the Software, and to permit persons to whom the
.\" Software is furnished to do so, subject to the following conditions:
.\"
.\" The above copyright notice and this permission notice (including the next
.\" paragraph) shall be included in all copies or substantial portions of the
.\" Software.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
.\" DEALINGS IN THE SOFTWARE.
.\"
53 54 55 56 57 58 59 60 61 62 63 64 65 66
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
.\" Digital Equipment Corporation
.\"
.\" Portions Copyright \(co 1990, 1991 by
.\" Tektronix, Inc.
.\"
.\" Permission to use, copy, modify and distribute this documentation for
.\" any purpose and without fee is hereby granted, provided that the above
.\" copyright notice appears in all copies and that both that copyright notice
.\" and this permission notice appear in all copies, and that the names of
.\" Digital and Tektronix not be used in in advertising or publicity pertaining
.\" to this documentation without specific, written prior permission.
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
Walter Harms's avatar
Walter Harms committed
67
.\" It is provided "as is" without express or implied warranty.
68
.\"
Egbert Eich's avatar
Egbert Eich committed
69
.\"
70 71 72 73
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
.ds xL Xlib \- C Language X Interface
.ds xC Inter-Client Communication Conventions Manual
74
.TH XAddHost __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
75
.SH NAME
Egbert Eich's avatar
Egbert Eich committed
76
XAddHost, XAddHosts, XListHosts, XRemoveHost, XRemoveHosts, XSetAccessControl, XEnableAccessControl, XDisableAccessControl, XHostAddress, XServerInterpretedAddress \- control host access and host control structure
77
.SH SYNTAX
Egbert Eich's avatar
Egbert Eich committed
78
.HP
79
int XAddHost\^(\^Display *\fIdisplay\fP, XHostAddress *\fIhost\fP\^);
Egbert Eich's avatar
Egbert Eich committed
80
.HP
81
int XAddHosts\^(\^Display *\fIdisplay\fP, XHostAddress *\fIhosts\fP,
Egbert Eich's avatar
Egbert Eich committed
82 83 84 85 86 87 88 89 90 91 92 93 94 95
int \fInum_hosts\fP\^);
.HP
XHostAddress *XListHosts\^(\^Display *\fIdisplay\fP, int *\fInhosts_return\fP,
Bool \fIstate_return\fP\^);
.HP
int XRemoveHost\^(\^Display *\fIdisplay\fP, XHostAddress *\fIhost\fP\^);
.HP
int XRemoveHosts\^(\^Display *\fIdisplay\fP, XHostAddress *\fIhosts\fP, int \fInum_hosts\fP\^);
.HP
int XSetAccessControl\^(\^Display *\fIdisplay\fP, int \fImode\fP\^);
.HP
int XEnableAccessControl\^(\^Display *\fIdisplay\fP\^);
.HP
int XDisableAccessControl\^(\^Display *\fIdisplay\fP\^);
96 97 98 99
.SH ARGUMENTS
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
.IP \fIhost\fP 1i
Walter Harms's avatar
Walter Harms committed
100
Specifies the host that is to be added or removed.
101
.IP \fIhosts\fP 1i
Walter Harms's avatar
Walter Harms committed
102
Specifies each host that is to be added or removed.
103 104 105
.IP \fImode\fP 1i
Specifies the mode.
You can pass
106
.B EnableAccess
107
or
108
.BR DisableAccess .
109 110 111 112 113 114 115 116
.IP \fInhosts_return\fP 1i
Returns the number of hosts currently in the access control list.
.IP \fInum_hosts\fP 1i
Specifies the number of hosts.
.IP \fIstate_return\fP 1i
Returns the state of the access control.
.SH DESCRIPTION
The
117
.B XAddHost
118 119
function adds the specified host to the access control list for that display.
The server must be on the same host as the client issuing the command, or a
120
.B BadAccess
121 122
error results.
.LP
123
.B XAddHost
124
can generate
125
.B BadAccess
126
and
127
.B BadValue
128 129 130
errors.
.LP
The
131
.B XAddHosts
132 133
function adds each specified host to the access control list for that display.
The server must be on the same host as the client issuing the command, or a
134
.B BadAccess
135 136
error results.
.LP
137
.B XAddHosts
138
can generate
139
.B BadAccess
140
and
141
.B BadValue
142 143 144
errors.
.LP
The
145
.B XListHosts
146
function returns the current access control list as well as whether the use
147
of the list at connection setup was enabled or disabled.
148
.B XListHosts
149 150
allows a program to find out what machines can make connections.
It also returns a pointer to a list of host structures that
151
were allocated by the function.
152 153
When no longer needed,
this memory should be freed by calling
154
.BR XFree .
155 156
.LP
The
157
.B XRemoveHost
158
function removes the specified host from the access control list
159 160
for that display.
The server must be on the same host as the client process, or a
161
.B BadAccess
162 163 164 165 166
error results.
If you remove your machine from the access list,
you can no longer connect to that server,
and this operation cannot be reversed unless you reset the server.
.LP
167
.B XRemoveHost
168
can generate
169
.B BadAccess
170
and
171
.B BadValue
172 173 174
errors.
.LP
The
175
.B XRemoveHosts
176 177
function removes each specified host from the access control list for that
display.
178
The X server must be on the same host as the client process, or a
179
.B BadAccess
180
error results.
181
If you remove your machine from the access list,
182 183 184
you can no longer connect to that server,
and this operation cannot be reversed unless you reset the server.
.LP
185
.B XRemoveHosts
186
can generate
187
.B BadAccess
188
and
189
.B BadValue
190 191 192
errors.
.LP
The
193
.B XSetAccessControl
194
function either enables or disables the use of the access control list
195 196
at each connection setup.
.LP
197
.B XSetAccessControl
198
can generate
199
.B BadAccess
200
and
201
.B BadValue
202 203 204
errors.
.LP
The
205
.B XEnableAccessControl
206 207
function enables the use of the access control list at each connection setup.
.LP
208
.B XEnableAccessControl
209
can generate a
210
.B BadAccess
211 212 213
error.
.LP
The
214
.B XDisableAccessControl
215 216
function disables the use of the access control list at each connection setup.
.LP
217
.B XDisableAccessControl
218
can generate a
219
.B BadAccess
220 221 222
error.
.SH STRUCTURES
The
223
.B XHostAddress
224 225
structure contains:
.LP
226
.EX
227
typedef struct {
228 229 230
        int family;     /\&* for example FamilyInternet */
        int length;     /\&* length of address, in bytes */
        char *address;  /\&* pointer to where to find the address */
231
} XHostAddress;
232
.EE
233
.LP
234
The family member specifies which protocol address family to use
235
(for example, TCP/IP or DECnet) and can be
236 237 238 239
.BR FamilyInternet ,
.BR FamilyInternet6 ,
.BR FamilyServerInterpreted ,
.BR FamilyDECnet ,
240
or
241
.BR FamilyChaos .
242 243
The length member specifies the length of the address in bytes.
The address member specifies a pointer to the address.
Egbert Eich's avatar
Egbert Eich committed
244
.LP
245 246
For the ServerInterpreted family, the length is ignored and the address
member is a pointer to a
247
.B XServerInterpretedAddress
Egbert Eich's avatar
Egbert Eich committed
248 249
structure which contains:
.LP
250
.EX
Egbert Eich's avatar
Egbert Eich committed
251
typedef struct {
252 253 254 255
        int typelength;         /\&* length of type string, in bytes */
        int valuelength;        /\&* length of value string, in bytes */
        char *type;             /\&* pointer to where to find the type string */
        char *value;            /\&* pointer to where to find the address */
Egbert Eich's avatar
Egbert Eich committed
256
} XServerInterpretedAddress;
257
.EE
Egbert Eich's avatar
Egbert Eich committed
258 259 260 261 262
.LP
The type and value members point to strings representing the type and value of
the server interpreted entry.  These strings may not be NULL-terminated so care
should be used when accessing them.  The typelength and valuelength members
specify the length in byte of the type and value strings.
263 264
.SH DIAGNOSTICS
.TP 1i
265
.B BadAccess
266 267 268 269
A client attempted
to modify the access control list from other than the local
(or otherwise authorized) host.
.TP 1i
270
.B BadValue
271 272 273 274 275
Some numeric value falls outside the range of values accepted by the request.
Unless a specific range is specified for an argument, the full range defined
by the argument's type is accepted.  Any argument defined as a set of
alternatives can generate this error.
.SH "SEE ALSO"
276
XFree(__libmansuffix__)
277 278
.br
\fI\*(xL\fP