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