date and time created 93/03/04 18:31:32 by bostic
[unix-history] / usr / src / usr.bin / rlogin / rlogin.1
CommitLineData
afe1e594 1.\" Copyright (c) 1983, 1990 The Regents of the University of California.
9e682bbf 2.\" All rights reserved.
3f1cd9e6 3.\"
263cc8fc 4.\" %sccs.include.redist.roff%
3f1cd9e6 5.\"
0bf4a03b 6.\" @(#)rlogin.1 6.19.1.1 (Berkeley) %G%
9e682bbf 7.\"
5325ced3
CL
8.Dd
9.Dt RLOGIN 1
10.Os BSD 4.2
11.Sh NAME
12.Nm rlogin
13.Nd remote login
14.Sh SYNOPSIS
15.Ar rlogin
83a41c77 16.Op Fl 8EKLd
5325ced3
CL
17.Op Fl e Ar char
18.Op Fl k Ar realm
19.Op Fl l Ar username
20.Ar host
21.Sh DESCRIPTION
22.Nm Rlogin
afe1e594 23starts a terminal session on a remote host
5325ced3
CL
24.Ar host .
25.Pp
26.Nm Rlogin
afe1e594
KB
27first attempts to use the Kerberos authorization mechanism, described below.
28If the remote host does not supporting Kerberos the standard Berkeley
5325ced3 29.Pa rhosts
afe1e594
KB
30authorization mechanism is used.
31The options are as follows:
263cc8fc
CL
32.Bl -tag -width flag
33.It Fl 8
5325ced3
CL
34The
35.Fl 8
36option allows an eight-bit input data path at all times; otherwise
afe1e594 37parity bits are stripped except when the remote side's stop and start
263cc8fc
CL
38characters are other than
39^S/^Q .
40.It Fl E
999d0d08
KB
41The
42.Fl E
43option stops any character from being recognized as an escape character.
44When used with the
45.Fl 8
46option, this provides a completely transparent connection.
263cc8fc 47.It Fl K
5325ced3
CL
48The
49.Fl K
50option turns off all Kerberos authentication.
263cc8fc 51.It Fl L
5325ced3
CL
52The
53.Fl L
54option allows the rlogin session to be run in ``litout'' (see
263cc8fc 55.Xr tty 4 )
afe1e594 56mode.
263cc8fc 57.It Fl d
5325ced3
CL
58The
59.Fl d
60option turns on socket debugging (see
263cc8fc 61.Xr setsockopt 2 )
afe1e594 62on the TCP sockets used for communication with the remote host.
263cc8fc 63.It Fl e
5325ced3
CL
64The
65.Fl e
999d0d08
KB
66option allows user specification of the escape character, which is
67``~'' by default.
68This specification may be as a literal character, or as an octal
69value in the form \ennn.
263cc8fc 70.It Fl k
5325ced3
CL
71The
72.FL k
73option requests rlogin to obtain tickets for the remote host
afe1e594 74in realm
5325ced3
CL
75.Ar realm
76instead of the remote host's realm as determined by
77.Xr krb_realmofhost 3 .
263cc8fc 78.El
5325ced3 79.Pp
999d0d08
KB
80A line of the form ``<escape char>.'' disconnects from the remote host.
81Similarly, the line ``<escape char>^Z'' will suspend the
5325ced3 82.Nm rlogin
999d0d08
KB
83session, and ``<escape char><delayed-suspend char>'' suspends the
84send portion of the rlogin, but allows output from the remote system.
85By default, the tilde (``~'') character is the escape character, and
86normally control-Y (``^Y'') is the delayed-suspend character.
5325ced3 87.Pp
afe1e594
KB
88All echoing takes place at the remote site, so that (except for delays)
89the
5325ced3 90.Nm rlogin
afe1e594
KB
91is transparent.
92Flow control via ^S/^Q and flushing of input and output on interrupts
93are handled properly.
5325ced3
CL
94.Sh KERBEROS AUTHENTICATION
95Each user may have a private authorization list in the file
96.Pa .klogin
afe1e594
KB
97in their home directory.
98Each line in this file should contain a Kerberos principal name of the
5325ced3
CL
99form
100.Ar principal.instance@realm .
bd97c21a 101If the originating user is authenticated to one of the principals named
5325ced3
CL
102in
103.Pa .klogin ,
104access is granted to the account.
105The principal
106.Ar accountname.@localrealm
107is granted access if
108there is no
109.Pa .klogin
110file.
afe1e594
KB
111Otherwise a login and password will be prompted for on the remote machine
112as in
5325ced3
CL
113.Xr login 1 .
114To avoid certain security problems, the
115.Pa .klogin
116file must be owned by
bd97c21a 117the remote user.
5325ced3 118.Pp
afe1e594
KB
119If Kerberos authentication fails, a warning message is printed and the
120standard Berkeley
263cc8fc 121.Nm rlogin
afe1e594 122is used instead.
5325ced3
CL
123.Sh ENVIRONMENT
124The following environment variable is utilized by
125.Nm rlogin :
263cc8fc
CL
126.Bl -tag -width TERM
127.It Ev TERM
128Determines the user's terminal type.
129.El
5325ced3
CL
130.Sh SEE ALSO
131.Xr rsh 1 ,
132.Xr kerberos 3 ,
133.Xr krb_sendauth 3 ,
134.Xr krb_realmofhost 3
135.Sh HISTORY
263cc8fc
CL
136The
137.Nm rlogin
138command appeared in
139.Bx 4.2 .
5325ced3
CL
140.Sh BUGS
141.Nm Rlogin
afe1e594 142will be replaced by
5325ced3 143.Xr telnet 1
afe1e594 144in the near future.
5325ced3 145.Pp
db8b94d6 146More of the environment should be propagated.