don't clean Version.c
[unix-history] / usr / src / usr.bin / rlogin / rlogin.1
index b2f947c..73f61e1 100644 (file)
-.\" Copyright (c) 1983 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1983, 1990 The Regents of the University of California.
+.\" All rights reserved.
 .\"
 .\"
-.\"    @(#)rlogin.1    6.6 (Berkeley) %G%
+.\" %sccs.include.redist.man%
 .\"
 .\"
-.TH RLOGIN 1C ""
-.UC 5
-.SH NAME
-rlogin \- remote login
-.SH SYNOPSIS
-.B rlogin
-rhost [
-\fB\-e\fR\fI\|c\fR
-] [
-.B \-8
-] [
-.B \-L
-] [
-.B \-l
-username ]
-.br
-rhost [
-\fB\-e\fR\fIc\fR
-] [
-.B \-8
-] [
-.B \-L
-] [
-.B \-l
-username ]
-.SH DESCRIPTION
-.I Rlogin
-connects your terminal on the current local host system
-.I lhost
-to the remote host system
-.I rhost.
-.PP
-Each host has a file
-.I /etc/hosts.equiv
-which contains a list of \fIrhost\fR's with which it shares account names.
-(The host names must be the standard names as described in
-.IR rsh (1C).)
-When you
-.I rlogin
-as the same user on an equivalent host, you don't need
-to give a password.
-Each user may also have a private equivalence list in a file \&.rhosts
-in his login directory.  Each line in this file should contain a \fIrhost\fP
-and a \fIusername\fP separated by a space, giving additional cases
-where logins without passwords are to be permitted.
-If the originating user is not equivalent to the remote user, then
-a login and password will be prompted for on the remote machine as in
-.IR login (1).
-To avoid some security problems, the \&.rhosts file must be owned by
-either the remote user or root.
-.PP
-Your remote terminal type is the same as your local
-terminal type (as given in your environment TERM variable).
-All echoing takes place at the remote site, so that (except for
-delays) the rlogin is transparent.  Flow control via ^S and ^Q and
-flushing of input and output on interrupts are handled properly.
-The optional argument
-.B \-8
-allows an eight-bit data path at all times;
-otherwise parity bits are stripped except when the remote side's
-stop and start characters are other than ^S/^Q.
-The argument
-.B \-L
-allows the rlogin session to be run in litout mode.
-A line of the form ``~.'' disconnects from the remote host, where
-``~'' is the escape character.
-Similarly, the line ``~^Z'' (where ^Z, control-Z, is the suspend character)
-will suspend the rlogin session.
-Substitution of the delayed-suspend character (normally ^Y)
-for the suspend character suspends the send portion of the rlogin,
-but allows output from the remote system.
-A different escape character may
-be specified by the
-.B \-e
-option.
-There is no space separating this option flag and the argument
-character.
-.SH SEE ALSO
-rsh(1C)
-.SH FILES
-/usr/hosts/*           for \fIrhost\fP version of the command
-.SH BUGS
+.\"     @(#)rlogin.1   6.18 (Berkeley) %G%
+.\"
+.Vx
+.Vx
+.Dd 
+.Dt RLOGIN 1
+.Os BSD 4.2
+.Sh NAME
+.Nm rlogin
+.Nd remote login
+.Sh SYNOPSIS
+.Ar rlogin
+.Op Fl 8EKLd
+.Op Fl e Ar char
+.Op Fl k Ar realm
+.Op Fl l Ar username
+.Ar host
+.Sh DESCRIPTION
+.Nm Rlogin
+starts a terminal session on a remote host
+.Ar host  .
+.Pp
+.Nm Rlogin
+first attempts to use the Kerberos authorization mechanism, described below.
+If the remote host does not supporting Kerberos the standard Berkeley
+.Pa rhosts
+authorization mechanism is used.
+The options are as follows:
+.Tw Fl
+.Tp Fl 8
+The
+.Fl 8
+option allows an eight-bit input data path at all times; otherwise
+parity bits are stripped except when the remote side's stop and start
+characters are other than ^S/^Q.
+.Tp Fl E
+The
+.Fl E
+option stops any character from being recognized as an escape character.
+When used with the
+.Fl 8
+option, this provides a completely transparent connection.
+.Tp Fl K
+The
+.Fl K
+option turns off all Kerberos authentication.
+.Tp Fl L
+The
+.Fl L
+option allows the rlogin session to be run in ``litout'' (see
+.Xr tty  4  )
+mode.
+.Tp Fl d
+The
+.Fl d
+option turns on socket debugging (see
+.Xr setsockopt  2  )
+on the TCP sockets used for communication with the remote host.
+.Tp Fl e
+The
+.Fl e
+option allows user specification of the escape character, which is
+``~'' by default.
+This specification may be as a literal character, or as an octal
+value in the form \ennn.
+.Tp Fl k
+The
+.FL k
+option requests rlogin to obtain tickets for the remote host
+in realm
+.Ar realm
+instead of the remote host's realm as determined by
+.Xr krb_realmofhost  3  .
+.Tp
+.Pp
+A line of the form ``<escape char>.'' disconnects from the remote host.
+Similarly, the line ``<escape char>^Z'' will suspend the
+.Nm rlogin
+session, and ``<escape char><delayed-suspend char>'' suspends the
+send portion of the rlogin, but allows output from the remote system.
+By default, the tilde (``~'') character is the escape character, and
+normally control-Y (``^Y'') is the delayed-suspend character.
+.Pp
+All echoing takes place at the remote site, so that (except for delays)
+the
+.Nm rlogin
+is transparent.
+Flow control via ^S/^Q and flushing of input and output on interrupts
+are handled properly.
+.Sh KERBEROS AUTHENTICATION
+Each user may have a private authorization list in the file
+.Pa .klogin
+in their home directory.
+Each line in this file should contain a Kerberos principal name of the
+form
+.Ar principal.instance@realm  .
+If the originating user is authenticated to one of the principals named
+in
+.Pa .klogin ,
+access is granted to the account.
+The principal
+.Ar accountname.@localrealm
+is granted access if
+there is no
+.Pa .klogin
+file.
+Otherwise a login and password will be prompted for on the remote machine
+as in
+.Xr login  1  .
+To avoid certain security problems, the
+.Pa .klogin
+file must be owned by
+the remote user.
+.Pp
+If Kerberos authentication fails, a warning message is printed and the
+standard Berkeley
+.Em rlogin
+is used instead.
+.Sh ENVIRONMENT
+The following environment variable is utilized by
+.Nm rlogin :
+.Tw Fl
+.Tp Ev TERM
+to find user's terminal type.
+.Tp
+.Sh SEE ALSO
+.Xr rsh 1 ,
+.Xr kerberos 3 ,
+.Xr krb_sendauth 3 ,
+.Xr krb_realmofhost 3
+.Sh HISTORY
+.Nm Rlogin
+appeared in 4.2 BSD.
+.Sh BUGS
+.Nm Rlogin
+will be replaced by
+.Xr telnet  1
+in the near future.
+.Pp
 More of the environment should be propagated.
 More of the environment should be propagated.