379 lines
11 KiB
Groff
379 lines
11 KiB
Groff
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
|
|
.\"
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" 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, 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.
|
|
.\"
|
|
.\" 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
|
|
.\" 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.
|
|
.\"
|
|
.\" 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.
|
|
.\"
|
|
.\" X Window System is a trademark of The Open Group.
|
|
.\"
|
|
.\" Copyright 2004 Oracle and/or its affiliates. All rights reserved.
|
|
.\"
|
|
.\" 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.
|
|
.\"
|
|
.\" 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.
|
|
.\" It is provided ``as is'' without express or implied warranty.
|
|
.\"
|
|
.\"
|
|
.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
|
|
.na
|
|
.de Ds
|
|
.nf
|
|
.\\$1D \\$2 \\$1
|
|
.ft 1
|
|
.\".ps \\n(PS
|
|
.\".if \\n(VS>=40 .vs \\n(VSu
|
|
.\".if \\n(VS<=39 .vs \\n(VSp
|
|
..
|
|
.de De
|
|
.ce 0
|
|
.if \\n(BD .DF
|
|
.nr BD 0
|
|
.in \\n(OIu
|
|
.if \\n(TM .ls 2
|
|
.sp \\n(DDu
|
|
.fi
|
|
..
|
|
.de FD
|
|
.LP
|
|
.KS
|
|
.TA .5i 3i
|
|
.ta .5i 3i
|
|
.nf
|
|
..
|
|
.de FN
|
|
.fi
|
|
.KE
|
|
.LP
|
|
..
|
|
.de IN \" send an index entry to the stderr
|
|
..
|
|
.de C{
|
|
.KS
|
|
.nf
|
|
.D
|
|
.\"
|
|
.\" choose appropriate monospace font
|
|
.\" the imagen conditional, 480,
|
|
.\" may be changed to L if LB is too
|
|
.\" heavy for your eyes...
|
|
.\"
|
|
.ie "\\*(.T"480" .ft L
|
|
.el .ie "\\*(.T"300" .ft L
|
|
.el .ie "\\*(.T"202" .ft PO
|
|
.el .ie "\\*(.T"aps" .ft CW
|
|
.el .ft R
|
|
.ps \\n(PS
|
|
.ie \\n(VS>40 .vs \\n(VSu
|
|
.el .vs \\n(VSp
|
|
..
|
|
.de C}
|
|
.DE
|
|
.R
|
|
..
|
|
.de Pn
|
|
.ie t \\$1\fB\^\\$2\^\fR\\$3
|
|
.el \\$1\fI\^\\$2\^\fP\\$3
|
|
..
|
|
.de ZN
|
|
.ie t \fB\^\\$1\^\fR\\$2
|
|
.el \fI\^\\$1\^\fP\\$2
|
|
..
|
|
.de hN
|
|
.ie t <\fB\\$1\fR>\\$2
|
|
.el <\fI\\$1\fP>\\$2
|
|
..
|
|
.de NT
|
|
.ne 7
|
|
.ds NO Note
|
|
.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
|
|
.if \\n(.$ .if !'\\$1'C' .ds NO \\$1
|
|
.ie n .sp
|
|
.el .sp 10p
|
|
.TB
|
|
.ce
|
|
\\*(NO
|
|
.ie n .sp
|
|
.el .sp 5p
|
|
.if '\\$1'C' .ce 99
|
|
.if '\\$2'C' .ce 99
|
|
.in +5n
|
|
.ll -5n
|
|
.R
|
|
..
|
|
. \" Note End -- doug kraft 3/85
|
|
.de NE
|
|
.ce 0
|
|
.in -5n
|
|
.ll +5n
|
|
.ie n .sp
|
|
.el .sp 10p
|
|
..
|
|
.ny0
|
|
.TH XAddHost __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
|
|
.SH NAME
|
|
XAddHost, XAddHosts, XListHosts, XRemoveHost, XRemoveHosts, XSetAccessControl, XEnableAccessControl, XDisableAccessControl, XHostAddress, XServerInterpretedAddress \- control host access and host control structure
|
|
.SH SYNTAX
|
|
.HP
|
|
int XAddHost\^(\^Display *\fIdisplay\fP, XHostAddress *\fIhost\fP\^);
|
|
.HP
|
|
int XAddHosts\^(\^Display *\fIdisplay\fP, XHostAddress *\fIhosts\fP,
|
|
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\^);
|
|
.SH ARGUMENTS
|
|
.IP \fIdisplay\fP 1i
|
|
Specifies the connection to the X server.
|
|
.ds Ho added or removed
|
|
.IP \fIhost\fP 1i
|
|
Specifies the host that is to be \*(Ho.
|
|
.ds Ho added or removed
|
|
.IP \fIhosts\fP 1i
|
|
Specifies each host that is to be \*(Ho.
|
|
.IP \fImode\fP 1i
|
|
Specifies the mode.
|
|
You can pass
|
|
.ZN EnableAccess
|
|
or
|
|
.ZN DisableAccess .
|
|
.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
|
|
.ZN XAddHost
|
|
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
|
|
.ZN BadAccess
|
|
error results.
|
|
.LP
|
|
.ZN XAddHost
|
|
can generate
|
|
.ZN BadAccess
|
|
and
|
|
.ZN BadValue
|
|
errors.
|
|
.LP
|
|
The
|
|
.ZN XAddHosts
|
|
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
|
|
.ZN BadAccess
|
|
error results.
|
|
.LP
|
|
.ZN XAddHosts
|
|
can generate
|
|
.ZN BadAccess
|
|
and
|
|
.ZN BadValue
|
|
errors.
|
|
.LP
|
|
The
|
|
.ZN XListHosts
|
|
function returns the current access control list as well as whether the use
|
|
of the list at connection setup was enabled or disabled.
|
|
.ZN XListHosts
|
|
allows a program to find out what machines can make connections.
|
|
It also returns a pointer to a list of host structures that
|
|
were allocated by the function.
|
|
When no longer needed,
|
|
this memory should be freed by calling
|
|
.ZN XFree .
|
|
.LP
|
|
The
|
|
.ZN XRemoveHost
|
|
function removes the specified host from the access control list
|
|
for that display.
|
|
The server must be on the same host as the client process, or a
|
|
.ZN BadAccess
|
|
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
|
|
.ZN XRemoveHost
|
|
can generate
|
|
.ZN BadAccess
|
|
and
|
|
.ZN BadValue
|
|
errors.
|
|
.LP
|
|
The
|
|
.ZN XRemoveHosts
|
|
function removes each specified host from the access control list for that
|
|
display.
|
|
The X server must be on the same host as the client process, or a
|
|
.ZN BadAccess
|
|
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
|
|
.ZN XRemoveHosts
|
|
can generate
|
|
.ZN BadAccess
|
|
and
|
|
.ZN BadValue
|
|
errors.
|
|
.LP
|
|
The
|
|
.ZN XSetAccessControl
|
|
function either enables or disables the use of the access control list
|
|
at each connection setup.
|
|
.LP
|
|
.ZN XSetAccessControl
|
|
can generate
|
|
.ZN BadAccess
|
|
and
|
|
.ZN BadValue
|
|
errors.
|
|
.LP
|
|
The
|
|
.ZN XEnableAccessControl
|
|
function enables the use of the access control list at each connection setup.
|
|
.LP
|
|
.ZN XEnableAccessControl
|
|
can generate a
|
|
.ZN BadAccess
|
|
error.
|
|
.LP
|
|
The
|
|
.ZN XDisableAccessControl
|
|
function disables the use of the access control list at each connection setup.
|
|
.LP
|
|
.ZN XDisableAccessControl
|
|
can generate a
|
|
.ZN BadAccess
|
|
error.
|
|
.SH STRUCTURES
|
|
The
|
|
.ZN XHostAddress
|
|
structure contains:
|
|
.LP
|
|
.Ds 0
|
|
.TA .5i 3i
|
|
.ta .5i 3i
|
|
typedef struct {
|
|
int family; /\&* for example FamilyInternet */
|
|
int length; /\&* length of address, in bytes */
|
|
char *address; /\&* pointer to where to find the address */
|
|
} XHostAddress;
|
|
.De
|
|
.LP
|
|
The family member specifies which protocol address family to use
|
|
(for example, TCP/IP or DECnet) and can be
|
|
.ZN FamilyInternet ,
|
|
.ZN FamilyInternet6 ,
|
|
.ZN FamilyServerInterpreted ,
|
|
.ZN FamilyDECnet ,
|
|
or
|
|
.ZN FamilyChaos .
|
|
The length member specifies the length of the address in bytes.
|
|
The address member specifies a pointer to the address.
|
|
.LP
|
|
For the ServerInterpreted family, the length is ignored and the address
|
|
member is a pointer to a
|
|
.ZN XServerInterpretedAddress
|
|
structure which contains:
|
|
.LP
|
|
.Ds 0
|
|
.TA .5i 3i
|
|
.ta .5i 3i
|
|
typedef struct {
|
|
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 */
|
|
} XServerInterpretedAddress;
|
|
.De
|
|
.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.
|
|
.SH DIAGNOSTICS
|
|
.TP 1i
|
|
.ZN BadAccess
|
|
A client attempted
|
|
to modify the access control list from other than the local
|
|
(or otherwise authorized) host.
|
|
.TP 1i
|
|
.ZN BadValue
|
|
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"
|
|
XFree(__libmansuffix__)
|
|
.br
|
|
\fI\*(xL\fP
|