Annotation of src/usr.bin/rlogin/rlogin.1, Revision 1.9
1.9 ! hin 1: .\" $OpenBSD: rlogin.1,v 1.8 2001/05/01 17:58:04 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
1.9 ! hin 45: .Op Fl 8EKLd
1.1 deraadt 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.6 aaron 51: .Nm
1.1 deraadt 52: starts a terminal session on a remote host
1.6 aaron 53: .Ar host .
1.1 deraadt 54: .Pp
1.6 aaron 55: .Nm
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.
1.6 aaron 60: .Pp
1.1 deraadt 61: The options are as follows:
1.7 aaron 62: .Bl -tag -width Ds
1.1 deraadt 63: .It Fl 8
64: The
65: .Fl 8
66: option allows an eight-bit input data path at all times; otherwise
67: parity bits are stripped except when the remote side's stop and start
68: characters are other than
69: ^S/^Q .
70: .It Fl E
71: The
72: .Fl E
73: option stops any character from being recognized as an escape character.
74: When used with the
75: .Fl 8
76: option, this provides a completely transparent connection.
77: .It Fl K
78: The
79: .Fl K
80: option turns off all Kerberos authentication.
81: .It Fl L
82: The
83: .Fl L
1.6 aaron 84: option allows the rlogin session to be run in
85: .Dq litout
86: (see
1.1 deraadt 87: .Xr tty 4 )
88: mode.
89: .It Fl d
90: The
91: .Fl d
92: option turns on socket debugging (see
93: .Xr setsockopt 2 )
94: on the TCP sockets used for communication with the remote host.
1.4 aaron 95: .It Fl e Ar char
1.1 deraadt 96: The
97: .Fl e
98: option allows user specification of the escape character, which is
1.6 aaron 99: .Ql ~
100: by default.
1.1 deraadt 101: This specification may be as a literal character, or as an octal
102: value in the form \ennn.
1.4 aaron 103: .It Fl k Ar realm
1.1 deraadt 104: The
105: .Fl k
106: option requests rlogin to obtain tickets for the remote host
107: in realm
108: .Ar realm
109: instead of the remote host's realm as determined by
1.6 aaron 110: .Xr krb_realmofhost 3 .
1.4 aaron 111: .It Fl l Ar username
1.3 deraadt 112: The
113: .Fl l
114: option specifies a different
115: .Ar username
116: for the remote login.
117: If this option is not specified, your local username will be used.
1.1 deraadt 118: .El
119: .Pp
1.6 aaron 120: A line of the form
121: .Dq <escape char>.
122: disconnects from the remote host.
123: Similarly, the line
124: .Dq <escape char>^Z
125: will suspend the
126: .Nm
127: session, and
128: .Dq <escape char><delayed-suspend char>
129: suspends the
1.1 deraadt 130: send portion of the rlogin, but allows output from the remote system.
1.6 aaron 131: By default, the tilde
132: .Pq Ql ~
133: character is the escape character, and
134: normally control-Y
135: .Pq Ql ^Y
136: is the delayed-suspend character.
1.1 deraadt 137: .Pp
138: All echoing takes place at the remote site, so that (except for delays)
139: the
1.6 aaron 140: .Nm
1.1 deraadt 141: is transparent.
142: Flow control via ^S/^Q and flushing of input and output on interrupts
143: are handled properly.
144: .Sh KERBEROS AUTHENTICATION
145: Each user may have a private authorization list in the file
146: .Pa .klogin
147: in their home directory.
148: Each line in this file should contain a Kerberos principal name of the
149: form
1.6 aaron 150: .Ar principal.instance@realm .
1.1 deraadt 151: If the originating user is authenticated to one of the principals named
152: in
153: .Pa .klogin ,
154: access is granted to the account.
155: The principal
156: .Ar accountname.@localrealm
157: is granted access if
158: there is no
159: .Pa .klogin
160: file.
161: Otherwise a login and password will be prompted for on the remote machine
162: as in
1.6 aaron 163: .Xr login 1 .
1.1 deraadt 164: To avoid certain security problems, the
165: .Pa .klogin
166: file must be owned by
167: the remote user.
168: .Pp
169: If Kerberos authentication fails, a warning message is printed and the
170: standard Berkeley
1.6 aaron 171: .Nm
1.1 deraadt 172: is used instead.
173: .Sh ENVIRONMENT
174: .Bl -tag -width TERM
175: .It Ev TERM
176: Determines the user's terminal type.
177: .El
178: .Sh SEE ALSO
179: .Xr rsh 1 ,
180: .Xr kerberos 3 ,
1.4 aaron 181: .Xr krb_realmofhost 3 ,
182: .Xr krb_sendauth 3
1.1 deraadt 183: .Sh HISTORY
184: The
185: .Nm rlogin
186: command appeared in
187: .Bx 4.2 .
188: .Sh BUGS
1.4 aaron 189: .Nm rlogin
1.1 deraadt 190: will be replaced by
1.6 aaron 191: .Xr telnet 1
1.1 deraadt 192: in the near future.
193: .Pp
194: More of the environment should be propagated.
1.9 ! hin 195: .Pp
! 196: .Nm
! 197: does currently not support encryption of the datastream when Kerberos
! 198: authentication is used.
! 199: