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