Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.bin / rlogin / rlogin.1
1 .\" Copyright (c) 1983, 1990, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)rlogin.1    8.1 (Berkeley) 6/6/93
33 .\" $FreeBSD: src/usr.bin/rlogin/rlogin.1,v 1.11.2.7 2002/06/21 15:28:48 charnier Exp $
34 .\"
35 .Dd June 6, 1993
36 .Dt RLOGIN 1
37 .Os
38 .Sh NAME
39 .Nm rlogin
40 .Nd remote login
41 .Sh SYNOPSIS
42 .Ar rlogin
43 .Op Fl 468DEKLdx
44 .Op Fl e Ar char
45 .Op Fl i Ar localname
46 .Op Fl k Ar realm
47 .Op Fl l Ar username
48 .Ar host
49 .Sh DESCRIPTION
50 The
51 .Nm
52 utility starts a terminal session on a remote host
53 .Ar host  .
54 .Pp
55 The
56 .Nm
57 utility
58 first attempts to use the Kerberos authorization mechanism, described below.
59 If the remote host does not support Kerberos the standard Berkeley
60 .Pa rhosts
61 authorization mechanism is used.
62 The options are as follows:
63 .Bl -tag -width flag
64 .It Fl 4
65 Use IPv4 addresses only.
66 .It Fl 6
67 Use IPv6 addresses only.
68 .It Fl 8
69 The
70 .Fl 8
71 option allows an eight-bit input data path at all times; otherwise
72 parity bits are stripped except when the remote side's stop and start
73 characters are other than
74 ^S/^Q.
75 .It Fl D
76 The
77 .Fl D
78 option sets the TCP_NODELAY socket option which can improve interactive response
79 at the expense of increased network load.
80 .It Fl E
81 The
82 .Fl E
83 option stops any character from being recognized as an escape character.
84 When used with the
85 .Fl 8
86 option, this provides a completely transparent connection.
87 .It Fl K
88 The
89 .Fl K
90 option turns off all Kerberos authentication.
91 .It Fl L
92 The
93 .Fl L
94 option allows the rlogin session to be run in
95 .Dq litout
96 (see
97 .Xr tty 4 )
98 mode.
99 .It Fl d
100 The
101 .Fl d
102 option turns on socket debugging (see
103 .Xr setsockopt 2 )
104 on the TCP sockets used for communication with the remote host.
105 .It Fl e
106 The
107 .Fl e
108 option allows user specification of the escape character, which is
109 .Dq ~
110 by default.
111 This specification may be as a literal character, or as an octal
112 value in the form \ennn.
113 .It Fl i
114 The
115 .Fl i
116 option allows the caller to specify a different local name to be used
117 for authentication.  This option is restricted to processes with uid 0.
118 .It Fl k
119 The
120 .Fl k
121 option requests rlogin to obtain tickets for the remote host
122 in realm
123 .Ar realm
124 instead of the remote host's realm as determined by
125 .Xr krb_realmofhost  3  .
126 .It Fl l
127 The
128 .Fl l
129 option specifies a different
130 .Ar username
131 for the remote login.
132 If this option is not specified, your local username will be used.
133 .It Fl x
134 The
135 .Fl x
136 option turns on
137 .Tn DES
138 encryption for all data passed via the
139 rlogin session.
140 This may impact response time and
141 .Tn CPU
142 utilization, but provides
143 increased security.
144 .El
145 .Pp
146 A line of the form
147 .Dq Aq escape char .
148 disconnects from the remote host.
149 Similarly, the line
150 .Dq Ao escape char Ac Ns ^Z
151 will suspend the
152 .Nm
153 session, and
154 .Dq Ao escape\ char Ac Ns Ao delayed-suspend\ char Ac
155 suspends the
156 send portion of the rlogin, but allows output from the remote system.
157 By default, the tilde
158 .Pq Dq ~
159 character is the escape character, and
160 normally control-Y
161 .Pq Dq ^Y
162 is the delayed-suspend character.
163 .Pp
164 All echoing takes place at the remote site, so that (except for delays)
165 the
166 .Nm
167 is transparent.
168 Flow control via ^S/^Q and flushing of input and output on interrupts
169 are handled properly.
170 .Sh KERBEROS AUTHENTICATION
171 Each user may have a private authorization list in the file
172 .Pa .klogin
173 in their home directory.
174 Each line in this file should contain a Kerberos principal name of the
175 form
176 .Ar principal.instance@realm  .
177 If the originating user is authenticated to one of the principals named
178 in
179 .Pa .klogin ,
180 access is granted to the account.
181 The principal
182 .Ar accountname.@localrealm
183 is granted access if
184 there is no
185 .Pa .klogin
186 file.
187 Otherwise a login and password will be prompted for on the remote machine
188 as in
189 .Xr login  1  .
190 To avoid certain security problems, the
191 .Pa .klogin
192 file must be owned by
193 the remote user.
194 .Pp
195 If Kerberos authentication fails, a warning message is printed and the
196 standard Berkeley
197 .Nm
198 is used instead.
199 .Sh ENVIRONMENT
200 The following environment variable is utilized by
201 .Nm :
202 .Bl -tag -width TERM
203 .It Ev TERM
204 Determines the user's terminal type.
205 .El
206 .Sh SEE ALSO
207 .Xr login 1 ,
208 .Xr rsh 1 ,
209 .Xr telnet 1 ,
210 .Xr setsockopt 2 ,
211 .Xr kerberos 3 ,
212 .Xr krb_realmofhost 3 ,
213 .Xr krb_sendauth 3 ,
214 .Xr ruserok 3 ,
215 .Xr tty 4 ,
216 .Xr auth.conf 5 ,
217 .Xr hosts 5 ,
218 .Xr hosts.equiv 5 ,
219 .Xr rlogind 8 ,
220 .Xr rshd 8
221 .Sh FILES
222 .Bl -tag -width /etc/hosts -compact
223 .It Pa /etc/hosts
224 .It Pa /etc/hosts.equiv
225 .It Pa /etc/auth.conf
226 .It Ev $HOME Ns Pa /.rhosts
227 .It Ev $HOME Ns Pa /.klogin
228 .El
229 .Sh HISTORY
230 The
231 .Nm
232 command appeared in
233 .Bx 4.2 .
234 .Pp
235 IPv6 support was added by WIDE/KAME project.
236 .Sh BUGS
237 The
238 .Nm
239 utility will be replaced by
240 .Xr telnet  1
241 in the near future.
242 .Pp
243 More of the environment should be propagated.