date and time created 91/01/17 18:24:03 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.\"
3c003a08 4.\" %sccs.include.redist.man%
3f1cd9e6 5.\"
83a41c77 6.\" @(#)rlogin.1 6.17.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:
5325ced3
CL
32.Tw Fl
33.Tp Fl 8
34The
35.Fl 8
36option allows an eight-bit input data path at all times; otherwise
afe1e594
KB
37parity bits are stripped except when the remote side's stop and start
38characters are other than ^S/^Q.
999d0d08
KB
39.Tp Fl E
40The
41.Fl E
42option stops any character from being recognized as an escape character.
43When used with the
44.Fl 8
45option, this provides a completely transparent connection.
5325ced3
CL
46.Tp Fl K
47The
48.Fl K
49option turns off all Kerberos authentication.
50.Tp Fl L
51The
52.Fl L
53option allows the rlogin session to be run in ``litout'' (see
54.Xr tty 4 )
afe1e594 55mode.
5325ced3
CL
56.Tp Fl d
57The
58.Fl d
59option turns on socket debugging (see
60.Xr setsockopt 2 )
afe1e594 61on the TCP sockets used for communication with the remote host.
5325ced3 62.Tp Fl e
5325ced3
CL
63The
64.Fl e
999d0d08
KB
65option allows user specification of the escape character, which is
66``~'' by default.
67This specification may be as a literal character, or as an octal
68value in the form \ennn.
5325ced3
CL
69.Tp Fl k
70The
71.FL k
72option requests rlogin to obtain tickets for the remote host
afe1e594 73in realm
5325ced3
CL
74.Ar realm
75instead of the remote host's realm as determined by
76.Xr krb_realmofhost 3 .
5325ced3
CL
77.Tp
78.Pp
999d0d08
KB
79A line of the form ``<escape char>.'' disconnects from the remote host.
80Similarly, the line ``<escape char>^Z'' will suspend the
5325ced3 81.Nm rlogin
999d0d08
KB
82session, and ``<escape char><delayed-suspend char>'' suspends the
83send portion of the rlogin, but allows output from the remote system.
84By default, the tilde (``~'') character is the escape character, and
85normally control-Y (``^Y'') is the delayed-suspend character.
5325ced3 86.Pp
afe1e594
KB
87All echoing takes place at the remote site, so that (except for delays)
88the
5325ced3 89.Nm rlogin
afe1e594
KB
90is transparent.
91Flow control via ^S/^Q and flushing of input and output on interrupts
92are handled properly.
5325ced3
CL
93.Sh KERBEROS AUTHENTICATION
94Each user may have a private authorization list in the file
95.Pa .klogin
afe1e594
KB
96in their home directory.
97Each line in this file should contain a Kerberos principal name of the
5325ced3
CL
98form
99.Ar principal.instance@realm .
bd97c21a 100If the originating user is authenticated to one of the principals named
5325ced3
CL
101in
102.Pa .klogin ,
103access is granted to the account.
104The principal
105.Ar accountname.@localrealm
106is granted access if
107there is no
108.Pa .klogin
109file.
afe1e594
KB
110Otherwise a login and password will be prompted for on the remote machine
111as in
5325ced3
CL
112.Xr login 1 .
113To avoid certain security problems, the
114.Pa .klogin
115file must be owned by
bd97c21a 116the remote user.
5325ced3 117.Pp
afe1e594
KB
118If Kerberos authentication fails, a warning message is printed and the
119standard Berkeley
5325ced3 120.Em rlogin
afe1e594 121is used instead.
5325ced3
CL
122.Sh ENVIRONMENT
123The following environment variable is utilized by
124.Nm rlogin :
125.Tw Fl
126.Tp Ev TERM
127to find user's terminal type.
128.Tp
129.Sh SEE ALSO
130.Xr rsh 1 ,
131.Xr kerberos 3 ,
132.Xr krb_sendauth 3 ,
133.Xr krb_realmofhost 3
134.Sh HISTORY
135.Nm Rlogin
136appeared in 4.2 BSD.
137.Sh BUGS
138.Nm Rlogin
afe1e594 139will be replaced by
5325ced3 140.Xr telnet 1
afe1e594 141in the near future.
5325ced3 142.Pp
db8b94d6 143More of the environment should be propagated.