fix build: update SOURCE0 consists of name and version macro
[pkgs/xorg/util/xorg-x11-xauth.git] / packaging / mkxauth.man
1 .de TQ
2 .br
3 .ns
4 .TP \\$1
5 ..
6 .TH mkxauth 1x "12-Dec-1996" "Red Hat Software" "Linux User's Manual"
7 .SH NAME
8 mkxauth \- create and merge .Xauthority files
9 .SH SYNOPSIS
10 (1)
11 .B mkxauth
12 [ \-q ] [ \-u
13 .I login
14 ] \-c [
15 .I host
16 [
17 .I host
18 \|.\|.\|. ] ]
19 .PP
20 (2)
21 .B mkxauth
22 [ \-q ] [ \-u
23 .I login
24 ] \-m
25 .I login
26 .PP
27 (3)
28 .B mkxauth
29 [ \-q ] [ \-u
30 .I login
31 ] \-f
32 .I host
33 .PP
34 (4)
35 .B mkxauth
36 [ \-q ] [ \-u
37 .I login
38 ] \-r
39 .I host
40 [ \-l
41 .I login
42 ]
43 .PP
44 (5)
45 .B mkxauth
46 [ \-q ] [ \-u
47 .I login
48 ] \-z
49 .I host
50 [ \-l
51 .I login
52 ]
53 .SH DESCRIPTION
54 .B mkxauth 
55 aids in the creation and maintenance of X authentication databases
56 (.Xauthority files).  Use it to create a ~/.Xauthority file or merge
57 keys from another local or remote .Xauthority file.  Remote .Xauthority
58 files can be retrieved via FTP (using 
59 .BR ncftp (1)) 
60 or via 
61 .BR rsh (1).
62 For a slight measure of security,
63 .B mkxauth 
64 does not create any temporary files containing authentication keys
65 (although anyone spying on network packets can see the authentication
66 key data as they pass through the network; for secure network
67 communications, use 
68 .BR ssh (1)).
69 .SS Creating and Adding to a .Xauthority File
70 To create a .Xauthority file, use
71 .B mkxauth \-c 
72 (see (1) above).
73 .B mkxauth 
74 creates a .Xauthority file in the user's home directory (~/),
75 containing a `key' or `magic cookie' for the host it was run on (the
76 one returned by
77 .BR hostname (1)).  
78 If a .Xauthority file already exists, the keys are added to it.  If
79 keys for that host already exist, they are replaced.
80 .PP
81 To create or add to a .Xauthority file for another user, use
82 .B mkxauth \-u
83 .I login
84 .BR \-c .
85 .B mkxauth
86 adds keys to
87 .RI ~ login /.Xauthority
88 (only the root user is allowed to do this).
89 .PP
90 To add a key for more than one host, specify all hosts on the command
91 line:
92 .B mkxauth \-c daffy porky 
93 .BR bugs .
94 All hosts specified on the same command line receive the same key.  To
95 create different keys for multiple hosts, run
96 .B mkxauth
97 for each host in succession:
98 .PP
99 .RS
100 .TQ
101 mkxauth \-c daffy
102 .TQ
103 mkxauth \-c porky
104 .TQ
105 mkxauth \-c bugs
106 .RE
107 .SS Merging Keys from Local .Xauthority Files
108 To merge keys from another local user's .Xauthority file, use
109 .B mkxauth \-m
110 .I login 
111 (see (2) above).
112 .B mkxauth
113 adds the keys in 
114 .RI ~ login /.Xauthority
115 to ~/.Xauthority, replacing any keys which already exist.
116 .RI ~ login /.Xauthority
117 must be readable by the user running
118 .B mkxauth
119 (normally only the root user can read other people's .Xauthority files).
120 .SS Merging Keys via FTP
121 To merge keys from a remote .Xauthority file via FTP, use
122 .B mkxauth \-f
123 .I host
124 (see (3) above).
125 .B mkxauth 
126 retrieves the remote .Xauthority from
127 .I host
128 using
129 .BR ncftp (1)
130 and adds those keys to ~/.Xauthority, replacing any keys which already
131 exist.
132 .RI [ NOTE :
133 you must have a ~/.netrc file set up to automatically log you into
134 .IR host ,
135 otherwise the FTP login attempt will fail.]
136 .SS Merging Keys via rsh(1)
137 To merge keys from remote .Xauthority file via
138 .BR rsh (1),
139 use
140 .B mkxauth \-r
141 .I host
142 (see (4) above).
143 .B mkxauth
144 retrieves the remote .Xauthority from
145 .I host
146 using
147 .BR rsh (1)
148 and adds those keys to ~/.Xauthority, replacing any keys which already
149 exist.  To login as a different user, use
150 .B \-l
151 .IR login .
152 .RI [ NOTE :
153 you must have a .rhosts file set up properly for this to work,
154 otherwise the remote login attempt will fail].
155 .SS Merging Keys via rsh(1) and gzip(1)
156 If your remote .Xauthority file is large, or to make it slightly less
157 obvious that you're transferring authentication keys over the network,
158 .B mkxauth
159 can
160 .BR gzip (1)
161 your .Xauthority file before retrieving it via 
162 .BR rsh (1).
163 To do this, use
164 .B mkxauth \-z
165 .I host
166 (see (5) above).
167 .B mkxauth
168 retrieves the remote .Xauthority from
169 .I host
170 using
171 .BR rsh (1)
172 and adds those keys to ~/.Xauthority, replacing any keys which already
173 exist.  To login as a different user, use
174 .B \-l
175 .IR login .
176 .RI [ NOTE :
177 you must have a .rhosts file set up properly for this to work,
178 otherwise the remote login attempt will fail].
179 .SS Options
180 To make 
181 .B mkxauth
182 operate quietly, use the
183 .B \-q
184 option.
185 .PP
186 To add to 
187 .RI ~ login /.Xauthority,
188 use the
189 .B \-u
190 .I login
191 option.
192 .PP
193 To use 
194 .I login
195 for the remote login in 
196 .B mkxauth 
197 .BR \-f ,
198 .B mkxauth
199 .BR \-r ,
200 and
201 .B mkxauth
202 .BR \-z ,
203 use the
204 .B \-l
205 .I login 
206 option.
207 .SS Getting Help
208 To get quick help about
209 .BR mkxauth ,
210 use 
211 .B mkxauth 
212 .BR \-\-help .
213 .SH FILES
214 .TQ
215 ~/.Xauthority
216 .TQ
217 ~/.netrc
218 .TQ
219 ~/.rhosts
220 .SH COMMENTS
221 .B mkxauth
222 is mostly useful for maintaining .Xauthority files in an environment
223 which uses
224 .BR startx (1x).
225 .BR xdm (1x)
226 uses its own method of generating .Xauthority files.  However, 
227 .B mkxauth
228 is still useful for transferring .Xauthority information to remote
229 login sessions so that the user can display remote X clients on the
230 local host without too much trouble.
231 .PP
232 Note, however, that using 
233 .BR rsh (1)
234 is inherently insecure, and sites concerned about security should use
235 .BR ssh (1)
236 instead (see http://www.cs.hut.fi/ssh/ for more information).
237 .SH SEE ALSO
238 .BR X (1x),
239 .BR Xsecurity (1x),
240 .BR gzip (1),
241 .BR mcookie (1),
242 .BR md5sum (1),
243 .BR ncftp (1),
244 .BR rsh (1),
245 .BR startx (1x),
246 .BR xauth (1x),
247 .BR xdm (1x)
248 .SH BUGS
249 Does not respect the XAUTHORITY environment variable.
250 .SH AUTHOR
251 Conceived and written by Jim Knoble <jmknoble@redhat.com>.  Copyright
252 1996 by Jim Knoble and Red Hat Software.  Distributed under the GNU GPL
253 (General Public License); see ftp://prep.ai.mit.edu/pub/gnu/COPYING for
254 more information.