Annotation of src/usr.bin/rlogin/rlogin.1, Revision 1.1
1.1 ! deraadt 1: .\" $NetBSD: rlogin.1,v 1.4 1995/08/18 15:07:35 pk 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.1 (Berkeley) 6/6/93
! 35: .\"
! 36: .Dd June 6, 1993
! 37: .Dt RLOGIN 1
! 38: .Os BSD 4.2
! 39: .Sh NAME
! 40: .Nm rlogin
! 41: .Nd remote login
! 42: .Sh SYNOPSIS
! 43: .Ar rlogin
! 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: .Sh DESCRIPTION
! 50: .Nm Rlogin
! 51: starts a terminal session on a remote host
! 52: .Ar host .
! 53: .Pp
! 54: .Nm Rlogin
! 55: first attempts to use the Kerberos authorization mechanism, described below.
! 56: If the remote host does not supporting Kerberos the standard Berkeley
! 57: .Pa rhosts
! 58: authorization mechanism is used.
! 59: The options are as follows:
! 60: .Bl -tag -width flag
! 61: .It Fl 8
! 62: The
! 63: .Fl 8
! 64: option allows an eight-bit input data path at all times; otherwise
! 65: parity bits are stripped except when the remote side's stop and start
! 66: characters are other than
! 67: ^S/^Q .
! 68: .It Fl E
! 69: The
! 70: .Fl E
! 71: option stops any character from being recognized as an escape character.
! 72: When used with the
! 73: .Fl 8
! 74: option, this provides a completely transparent connection.
! 75: .It Fl K
! 76: The
! 77: .Fl K
! 78: option turns off all Kerberos authentication.
! 79: .It Fl L
! 80: The
! 81: .Fl L
! 82: option allows the rlogin session to be run in ``litout'' (see
! 83: .Xr tty 4 )
! 84: mode.
! 85: .It Fl d
! 86: The
! 87: .Fl d
! 88: option turns on socket debugging (see
! 89: .Xr setsockopt 2 )
! 90: on the TCP sockets used for communication with the remote host.
! 91: .It Fl e
! 92: The
! 93: .Fl e
! 94: option allows user specification of the escape character, which is
! 95: ``~'' by default.
! 96: This specification may be as a literal character, or as an octal
! 97: value in the form \ennn.
! 98: .It Fl k
! 99: The
! 100: .Fl k
! 101: option requests rlogin to obtain tickets for the remote host
! 102: in realm
! 103: .Ar realm
! 104: instead of the remote host's realm as determined by
! 105: .Xr krb_realmofhost 3 .
! 106: .It Fl x
! 107: The
! 108: .Fl x
! 109: option turns on
! 110: .Tn DES
! 111: encryption for all data passed via the
! 112: rlogin session.
! 113: This may impact response time and
! 114: .Tn CPU
! 115: utilization, but provides
! 116: increased security.
! 117: .El
! 118: .Pp
! 119: A line of the form ``<escape char>.'' disconnects from the remote host.
! 120: Similarly, the line ``<escape char>^Z'' will suspend the
! 121: .Nm rlogin
! 122: session, and ``<escape char><delayed-suspend char>'' suspends the
! 123: send portion of the rlogin, but allows output from the remote system.
! 124: By default, the tilde (``~'') character is the escape character, and
! 125: normally control-Y (``^Y'') is the delayed-suspend character.
! 126: .Pp
! 127: All echoing takes place at the remote site, so that (except for delays)
! 128: the
! 129: .Nm rlogin
! 130: is transparent.
! 131: Flow control via ^S/^Q and flushing of input and output on interrupts
! 132: are handled properly.
! 133: .Sh KERBEROS AUTHENTICATION
! 134: Each user may have a private authorization list in the file
! 135: .Pa .klogin
! 136: in their home directory.
! 137: Each line in this file should contain a Kerberos principal name of the
! 138: form
! 139: .Ar principal.instance@realm .
! 140: If the originating user is authenticated to one of the principals named
! 141: in
! 142: .Pa .klogin ,
! 143: access is granted to the account.
! 144: The principal
! 145: .Ar accountname.@localrealm
! 146: is granted access if
! 147: there is no
! 148: .Pa .klogin
! 149: file.
! 150: Otherwise a login and password will be prompted for on the remote machine
! 151: as in
! 152: .Xr login 1 .
! 153: To avoid certain security problems, the
! 154: .Pa .klogin
! 155: file must be owned by
! 156: the remote user.
! 157: .Pp
! 158: If Kerberos authentication fails, a warning message is printed and the
! 159: standard Berkeley
! 160: .Nm rlogin
! 161: is used instead.
! 162: .Sh ENVIRONMENT
! 163: The following environment variable is utilized by
! 164: .Nm rlogin :
! 165: .Bl -tag -width TERM
! 166: .It Ev TERM
! 167: Determines the user's terminal type.
! 168: .El
! 169: .Sh SEE ALSO
! 170: .Xr rsh 1 ,
! 171: .Xr kerberos 3 ,
! 172: .Xr krb_sendauth 3 ,
! 173: .Xr krb_realmofhost 3
! 174: .Sh HISTORY
! 175: The
! 176: .Nm rlogin
! 177: command appeared in
! 178: .Bx 4.2 .
! 179: .Sh BUGS
! 180: .Nm Rlogin
! 181: will be replaced by
! 182: .Xr telnet 1
! 183: in the near future.
! 184: .Pp
! 185: More of the environment should be propagated.