Initial import from FreeBSD RELENG_4:
[dragonfly.git] / crypto / kerberosIV / man / rlogin.1
1 .\"     $NetBSD: rlogin.1,v 1.3 1995/03/21 07:58:37 cgd 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 .Op Fl p Ar portnumber
49 .Ar host
50 .Sh DESCRIPTION
51 .Nm Rlogin
52 starts a terminal session on a remote host
53 .Ar host  .
54 .Pp
55 .Nm Rlogin
56 first attempts to use the Kerberos authorization mechanism, described below.
57 If the remote host does not supporting Kerberos the standard Berkeley
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.
92 .It Fl e
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.
99 .It Fl k
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.
118 .It Fl D
119 Use the TCP nodelay option (see setsockopt(2)).
120 .It Fl p portnumber
121 Specifies the port number to connect to on the remote host.
122 .El
123 .Pp
124 A line of the form ``<escape char>.'' disconnects from the remote host.
125 Similarly, the line ``<escape char>^Z'' will suspend the
126 .Nm rlogin
127 session, and ``<escape char><delayed-suspend char>'' suspends the
128 send portion of the rlogin, but allows output from the remote system.
129 By default, the tilde (``~'') character is the escape character, and
130 normally control-Y (``^Y'') is the delayed-suspend character.
131 .Pp
132 All echoing takes place at the remote site, so that (except for delays)
133 the
134 .Nm rlogin
135 is transparent.
136 Flow control via ^S/^Q and flushing of input and output on interrupts
137 are handled properly.
138 .Sh KERBEROS AUTHENTICATION
139 Each user may have a private authorization list in the file
140 .Pa .klogin
141 in their home directory.
142 Each line in this file should contain a Kerberos principal name of the
143 form
144 .Ar principal.instance@realm  .
145 If the originating user is authenticated to one of the principals named
146 in
147 .Pa .klogin ,
148 access is granted to the account.
149 The principal
150 .Ar accountname.@localrealm
151 is granted access if
152 there is no
153 .Pa .klogin
154 file.
155 Otherwise a login and password will be prompted for on the remote machine
156 as in
157 .Xr login  1  .
158 To avoid certain security problems, the
159 .Pa .klogin
160 file must be owned by
161 the remote user.
162 .Pp
163 If Kerberos authentication fails, a warning message is printed and the
164 standard Berkeley
165 .Nm rlogin
166 is used instead.
167 .Sh ENVIRONMENT
168 The following environment variable is utilized by
169 .Nm rlogin :
170 .Bl -tag -width TERM
171 .It Ev TERM
172 Determines the user's terminal type.
173 .El
174 .Sh SEE ALSO
175 .Xr rsh 1 ,
176 .Xr kerberos 3 ,
177 .Xr krb_sendauth 3 ,
178 .Xr krb_realmofhost 3
179 .Sh HISTORY
180 The
181 .Nm rlogin
182 command appeared in
183 .Bx 4.2 .
184 .Sh BUGS
185 .Nm Rlogin
186 will be replaced by
187 .Xr telnet  1
188 in the near future.
189 .Pp
190 More of the environment should be propagated.