]> git.saurik.com Git - apple/network_cmds.git/blob - rlogin.tproj/rlogin.1
979658a8321af4befe5f3ea0e2997a2d1d59431f
[apple/network_cmds.git] / rlogin.tproj / rlogin.1
1 .\" Copyright (c) 1983, 1990, 1993
2 .\" The Regents of the University of California. All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by the University of
15 .\" California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\" @(#)rlogin.1 8.2 (Berkeley) 4/29/95
33 .\"
34 .Dd April 29, 1995
35 .Dt RLOGIN 1
36 .Os BSD 4.2
37 .Sh NAME
38 .Nm rlogin
39 .Nd remote login
40 .Sh SYNOPSIS
41 .Nm rlogin
42 .Op Fl 8EKLdx
43 .Op Fl e Ar char
44 .Op Fl k Ar realm
45 .Op Fl l Ar username
46 .Ar host
47 .Nm rlogin
48 .Op Fl 8EKLdx
49 .Op Fl e Ar char
50 .Op Fl k Ar realm
51 .Ar username@host
52 .Sh DESCRIPTION
53 .Nm Rlogin
54 starts a terminal session on a remote host
55 .Ar host .
56 .Pp
57 .Nm Rlogin
58 first attempts to use the Kerberos authorization mechanism, described below.
59 If the remote host does not supporting Kerberos the standard Berkeley
60 .Pa rhosts
61 authorization mechanism is used.
62 The options are as follows:
63 .Bl -tag -width flag
64 .It Fl 8
65 The
66 .Fl 8
67 option allows an eight-bit input data path at all times; otherwise
68 parity bits are stripped except when the remote side's stop and start
69 characters are other than
70 ^S/^Q .
71 .It Fl E
72 The
73 .Fl E
74 option stops any character from being recognized as an escape character.
75 When used with the
76 .Fl 8
77 option, this provides a completely transparent connection.
78 .It Fl K
79 The
80 .Fl K
81 option turns off all Kerberos authentication.
82 .It Fl L
83 The
84 .Fl L
85 option allows the rlogin session to be run in ``litout'' (see
86 .Xr tty 4 )
87 mode.
88 .It Fl d
89 The
90 .Fl d
91 option turns on socket debugging (see
92 .Xr setsockopt 2 )
93 on the TCP sockets used for communication with the remote host.
94 .It Fl e
95 The
96 .Fl e
97 option allows user specification of the escape character, which is
98 ``~'' by default.
99 This specification may be as a literal character, or as an octal
100 value in the form \ennn.
101 .It Fl k
102 The
103 .FL k
104 option requests rlogin to obtain tickets for the remote host
105 in realm
106 .Ar realm
107 instead of the remote host's realm as determined by
108 .Xr krb_realmofhost 3 .
109 .It Fl x
110 The
111 .Fl x
112 option turns on
113 .Tn DES
114 encryption for all data passed via the
115 rlogin session.
116 This may impact response time and
117 .Tn CPU
118 utilization, but provides
119 increased security.
120 .El
121 .Pp
122 A line of the form ``<escape char>.'' disconnects from the remote host.
123 Similarly, the line ``<escape char>^Z'' will suspend the
124 .Nm rlogin
125 session, and ``<escape char><delayed-suspend char>'' suspends the
126 send portion of the rlogin, but allows output from the remote system.
127 By default, the tilde (``~'') character is the escape character, and
128 normally control-Y (``^Y'') is the delayed-suspend character.
129 .Pp
130 All echoing takes place at the remote site, so that (except for delays)
131 the
132 .Nm rlogin
133 is transparent.
134 Flow control via ^S/^Q and flushing of input and output on interrupts
135 are handled properly.
136 .Sh KERBEROS AUTHENTICATION
137 Each user may have a private authorization list in the file
138 .Pa .klogin
139 in their home directory.
140 Each line in this file should contain a Kerberos principal name of the
141 form
142 .Ar principal.instance@realm .
143 If the originating user is authenticated to one of the principals named
144 in
145 .Pa .klogin ,
146 access is granted to the account.
147 The principal
148 .Ar accountname.@localrealm
149 is granted access if
150 there is no
151 .Pa .klogin
152 file.
153 Otherwise a login and password will be prompted for on the remote machine
154 as in
155 .Xr login 1 .
156 To avoid certain security problems, the
157 .Pa .klogin
158 file must be owned by
159 the remote user.
160 .Pp
161 If Kerberos authentication fails, a warning message is printed and the
162 standard Berkeley
163 .Nm rlogin
164 is used instead.
165 .Sh ENVIRONMENT
166 The following environment variable is utilized by
167 .Nm rlogin :
168 .Bl -tag -width TERM
169 .It Ev TERM
170 Determines the user's terminal type.
171 .El
172 .Sh SEE ALSO
173 .Xr rsh 1 ,
174 .Xr kerberos 3 ,
175 .Xr krb_sendauth 3 ,
176 .Xr krb_realmofhost 3
177 .Sh HISTORY
178 The
179 .Nm rlogin
180 command appeared in
181 .Bx 4.2 .
182 .Sh BUGS
183 .Nm Rlogin
184 will be replaced by
185 .Xr telnet 1
186 in the near future.
187 .Pp
188 More of the environment should be propagated.