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