1
.\" $Xorg: xhost.man,v 1.4 2001/02/09 02:05:46 xorgcvs Exp $
4
.\" Copyright 1988, 1998 The Open Group
5
.\" Copyright 2004 Sun Microsystems, Inc.
7
.\" Permission is hereby granted, free of charge, to any person obtaining a
8
.\" copy of this software and associated documentation files (the
9
.\" "Software"), to deal in the Software without restriction, including
10
.\" without limitation the rights to use, copy, modify, merge, publish,
11
.\" distribute, and/or sell copies of the Software, and to permit persons
12
.\" to whom the Software is furnished to do so, provided that the above
13
.\" copyright notice(s) and this permission notice appear in all copies of
14
.\" the Software and that both the above copyright notice(s) and this
15
.\" permission notice appear in supporting documentation.
17
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
20
.\" OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
21
.\" HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
22
.\" INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
23
.\" FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
24
.\" NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
25
.\" WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
27
.\" Except as contained in this notice, the name of a copyright holder
28
.\" shall not be used in advertising or otherwise to promote the sale, use
29
.\" or other dealings in this Software without prior written authorization
30
.\" of the copyright holder.
32
.\" X Window System is a trademark of The Open Group.
34
.\" $XFree86: xc/programs/xhost/xhost.man,v 1.8tsi Exp $
36
.TH XHOST 1 __xorgversion__
38
xhost \- server access control program for X
43
The \fIxhost\fP program
44
is used to add and delete host names or user names to the list allowed
45
to make connections to the X server. In the case of hosts, this provides
46
a rudimentary form of privacy control and security. It is only sufficient
47
for a workstation (single user) environment, although it does limit the
48
worst abuses. Environments which require more sophisticated measures should
49
implement the user-based mechanism or use the hooks in the
50
protocol for passing other authentication data to the server.
52
\fIXhost\fP accepts the following command line options described below. For
53
security, the options that affect access control may only be run from the
54
"controlling host". For workstations, this is the same machine as the
55
server. For X terminals, it is the login host.
58
Prints a usage message.
61
The given \fIname\fP (the plus sign is optional)
62
is added to the list allowed to connect to the X server.
63
The name can be a host name or a user name.
66
The given \fIname\fP is removed from the list of allowed
67
to connect to the server. The name can be a host name or a user name.
68
Existing connections are not broken, but new
69
connection attempts will be denied.
70
Note that the current machine is allowed to be removed; however, further
71
connections (including attempts to add it back) will not be permitted.
72
Resetting the server (thereby breaking all connections)
73
is the only way to allow local connections again.
76
Access is granted to everyone, even if they aren't on the list
77
(i.e., access control is turned off).
80
Access is restricted to only those on the list
81
(i.e., access control is turned on).
84
If no command line arguments are given,
85
a message indicating whether or not access control is currently enabled
86
is printed, followed by the list of those allowed to connect.
87
This is the only option that may be used from machines other than
90
A complete name has the syntax
91
``family:name'' where the families are
96
inet Internet host (IPv4)
97
inet6 Internet host (IPv6)
99
nis Secure RPC network name
100
krb Kerberos V5 principal
101
local contains only one name, the empty string
102
si Server Interpreted
105
The family is case insensitive.
106
The format of the name varies with the family.
108
When Secure RPC is being used, the
109
network independent netname (e.g., "nis:unix.\fIuid\fP@\fIdomainname\fP") can
110
be specified, or a local user can be specified with just the username
111
and a trailing at-sign (e.g., "nis:pat@").
113
For backward compatibility with pre-R6 \fIxhost\fP,
114
names that contain an at-sign (@) are assumed to be in the nis family.
115
Otherwise they are assumed to be Internet addresses. If compiled to support
116
IPv6, then all IPv4 and IPv6 addresses returned by getaddrinfo(3) are added to
117
the access list in the appropriate inet or inet6 family.
119
Server interpreted addresses consist of a case-sensitive type tag and a
120
string representing a given value, separated by a colon. For example,
121
"si:hostname:almas" is a server interpreted address of type \fIhostname\fP,
122
with a value of \fIalmas\fP. For more information on the available forms
123
of server interpreted addresses, see the \fIXsecurity\fP(__miscmansuffix__)
126
For each name added to the access control list,
127
a line of the form "\fIname\fP being added to access control list"
129
For each name removed from the access control list,
130
a line of the form "\fIname\fP being removed from access control list"
135
X(__miscmansuffix__), Xsecurity(__miscmansuffix__), Xserver(1), xdm(1), xauth(1), getaddrinfo(3)
139
to get the default host and display to use.
142
You can't specify a display on the command line because
144
is a valid command line argument (indicating that you want
145
to remove the machine named
147
from the access list).
149
The X server stores network addresses, not host names, unless you use
150
the server-interpreted hostname type address. If somehow you change a
151
host's network address while the server is still running, and you are
152
using a network-address based form of authentication, \fIxhost\fP must
153
be used to add the new address and/or remove the old address.
155
Bob Scheifler, MIT Laboratory for Computer Science,
157
Jim Gettys, MIT Project Athena (DEC).
added
removed
xhost/xhost.man
