don't clean Version.c

[unix-history] / usr / src / usr.bin / rlogin / rlogin.1

diff --git a/usr/src/usr.bin/rlogin/rlogin.1 b/usr/src/usr.bin/rlogin/rlogin.1
index e73121b..73f61e1 100644 (file)
--- a/usr/src/usr.bin/rlogin/rlogin.1
+++ b/usr/src/usr.bin/rlogin/rlogin.1
@@ -3,105 +3,143 @@
 .\"
 .\" %sccs.include.redist.man%
 .\"
 .\"
 .\" %sccs.include.redist.man%
 .\"

-.\"     @(#)rlogin.1   6.15 (Berkeley) %G%
+.\"     @(#)rlogin.1   6.18 (Berkeley) %G%

 .\"
 .\"

-.TH RLOGIN 1 "%Q"
-.UC 5
-.SH NAME
-rlogin \- remote login
-.SH SYNOPSIS
-.ft B
-rlogin [ \-8KLdx ] [ \-e char ] [ \-k realm ] [ \-l username ] host
-.ft R
-.SH DESCRIPTION
-.I Rlogin
+.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
 starts a terminal session on a remote host

-.IR host .
-.PP
-.I Rlogin
+.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
 first attempts to use the Kerberos authorization mechanism, described below.
 If the remote host does not supporting Kerberos the standard Berkeley

-.I rhosts
+.Pa rhosts

 authorization mechanism is used.
 The options are as follows:
 authorization mechanism is used.
 The options are as follows:

-.TP
-\-8
-The \-8 option allows an eight-bit input data path at all times; otherwise
+.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.
 parity bits are stripped except when the remote side's stop and start
 characters are other than ^S/^Q.

-Eight-bit mode is the default.
-.TP
-\-K
-The \-K option turns off all Kerberos authentication.
-.TP
-\-L
-The \-L option allows the rlogin session to be run in ``litout'' (see
-.IR tty (4))
+.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.
 mode.

-.TP
-\-d
-The \-d option turns on socket debugging (see
-.IR setsockopt (2))
+.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.
 on the TCP sockets used for communication with the remote host.

-.TP
-\-e
-By default, the tilde (``~'') character is the escape character.
-The \-e option allows specification of a different escape character.
-.TP
-\-k
-The \-k option requests rlogin to obtain tickets for 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
 in realm

-.I realm
-instead of the remote host's realm as determined by 
-.IR krb_realmofhost (3).
-.TP
-\-x
-The \-x option turns on DES encryption for all data passed via the
-rlogin session.
-This may impact response time and CPU utilization, but provides
-increased security.
-.PP
-A line of the form ``~.'' disconnects from the remote host, where ``~''
-is the escape character.
-Similarly, the line ``~^Z'' will suspend the
-.I 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.
-.PP
+.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
 All echoing takes place at the remote site, so that (except for delays)
 the

-.I rlogin
+.Nm rlogin

 is transparent.
 Flow control via ^S/^Q and flushing of input and output on interrupts
 are handled properly.
 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 ``.klogin''
+.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
 in their home directory.
 Each line in this file should contain a Kerberos principal name of the

-form 
-.IR principal.instance@realm .
+form
+.Ar principal.instance@realm  .

 If the originating user is authenticated to one of the principals named
 If the originating user is authenticated to one of the principals named

-in ``.klogin'', access is granted to the account.
-The principal \fIaccountname\fP.@\fIlocalrealm\fP is granted access if
-there is no ``.klogin'' file.
+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
 Otherwise a login and password will be prompted for on the remote machine
 as in

-.IR login (1).
-To avoid certain security problems, the ``.klogin'' file must be owned by
+.Xr login  1  .
+To avoid certain security problems, the
+.Pa .klogin
+file must be owned by

 the remote user.
 the remote user.

-.PP
+.Pp

 If Kerberos authentication fails, a warning message is printed and the
 standard Berkeley
 If Kerberos authentication fails, a warning message is printed and the
 standard Berkeley

-.I rlogin
+.Em rlogin

 is used instead.
 is used instead.

-.SH SEE ALSO
-rsh(1), kerberos(3), krb_sendauth(3), krb_realmofhost(3)
-.SH BUGS
-.I Rlogin
+.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
 will be replaced by

-.IR telnet (1)
+.Xr telnet  1

 in the near future.
 in the near future.

-.PP
+.Pp

 More of the environment should be propagated.
 More of the environment should be propagated.