Add 'H' to usage() options. This was missing from the last commit.
[dragonfly.git] / usr.bin / rlogin / rlogin.1
blobd22befe181c992e8a9e941e496dce66913305f3f
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.1 (Berkeley) 6/6/93
33 .\" $FreeBSD: src/usr.bin/rlogin/rlogin.1,v 1.11.2.7 2002/06/21 15:28:48 charnier Exp $
34 .\" $DragonFly: src/usr.bin/rlogin/rlogin.1,v 1.3 2006/02/17 19:39:10 swildner Exp $
35 .\"
36 .Dd June 6, 1993
37 .Dt RLOGIN 1
38 .Os
39 .Sh NAME
40 .Nm rlogin
41 .Nd remote login
42 .Sh SYNOPSIS
43 .Ar rlogin
44 .Op Fl 468DEKLdx
45 .Op Fl e Ar char
46 .Op Fl i Ar localname
47 .Op Fl k Ar realm
48 .Op Fl l Ar username
49 .Ar host
50 .Sh DESCRIPTION
51 The
52 .Nm
53 utility starts a terminal session on a remote host
54 .Ar host  .
55 .Pp
56 The
57 .Nm
58 utility
59 first attempts to use the Kerberos authorization mechanism, described below.
60 If the remote host does not support Kerberos the standard Berkeley
61 .Pa rhosts
62 authorization mechanism is used.
63 The options are as follows:
64 .Bl -tag -width flag
65 .It Fl 4
66 Use IPv4 addresses only.
67 .It Fl 6
68 Use IPv6 addresses only.
69 .It Fl 8
70 The
71 .Fl 8
72 option allows an eight-bit input data path at all times; otherwise
73 parity bits are stripped except when the remote side's stop and start
74 characters are other than
75 ^S/^Q.
76 .It Fl D
77 The
78 .Fl D
79 option sets the TCP_NODELAY socket option which can improve interactive response
80 at the expense of increased network load.
81 .It Fl E
82 The
83 .Fl E
84 option stops any character from being recognized as an escape character.
85 When used with the
86 .Fl 8
87 option, this provides a completely transparent connection.
88 .It Fl K
89 The
90 .Fl K
91 option turns off all Kerberos authentication.
92 .It Fl L
93 The
94 .Fl L
95 option allows the rlogin session to be run in
96 .Dq litout
97 (see
98 .Xr tty 4 )
99 mode.
100 .It Fl d
102 .Fl d
103 option turns on socket debugging (see
104 .Xr setsockopt 2 )
105 on the TCP sockets used for communication with the remote host.
106 .It Fl e
108 .Fl e
109 option allows user specification of the escape character, which is
110 .Dq ~
111 by default.
112 This specification may be as a literal character, or as an octal
113 value in the form \ennn.
114 .It Fl i
116 .Fl i
117 option allows the caller to specify a different local name to be used
118 for authentication.  This option is restricted to processes with uid 0.
119 .It Fl k
121 .Fl k
122 option requests rlogin to obtain tickets for the remote host
123 in realm
124 .Ar realm
125 instead of the remote host's realm as determined by
126 .Xr krb_realmofhost  3  .
127 .It Fl l
129 .Fl l
130 option specifies a different
131 .Ar username
132 for the remote login.
133 If this option is not specified, your local username will be used.
134 .It Fl x
136 .Fl x
137 option turns on
138 .Tn DES
139 encryption for all data passed via the
140 rlogin session.
141 This may impact response time and
142 .Tn CPU
143 utilization, but provides
144 increased security.
147 A line of the form
148 .Dq Aq escape char .
149 disconnects from the remote host.
150 Similarly, the line
151 .Dq Ao escape char Ac Ns ^Z
152 will suspend the
154 session, and
155 .Dq Ao escape\ char Ac Ns Ao delayed-suspend\ char Ac
156 suspends the
157 send portion of the rlogin, but allows output from the remote system.
158 By default, the tilde
159 .Pq Dq ~
160 character is the escape character, and
161 normally control-Y
162 .Pq Dq ^Y
163 is the delayed-suspend character.
165 All echoing takes place at the remote site, so that (except for delays)
168 is transparent.
169 Flow control via ^S/^Q and flushing of input and output on interrupts
170 are handled properly.
171 .Sh KERBEROS AUTHENTICATION
172 Each user may have a private authorization list in the file
173 .Pa .klogin
174 in their home directory.
175 Each line in this file should contain a Kerberos principal name of the
176 form
177 .Ar principal.instance@realm  .
178 If the originating user is authenticated to one of the principals named
180 .Pa .klogin ,
181 access is granted to the account.
182 The principal
183 .Ar accountname.@localrealm
184 is granted access if
185 there is no
186 .Pa .klogin
187 file.
188 Otherwise a login and password will be prompted for on the remote machine
189 as in
190 .Xr login  1  .
191 To avoid certain security problems, the
192 .Pa .klogin
193 file must be owned by
194 the remote user.
196 If Kerberos authentication fails, a warning message is printed and the
197 standard Berkeley
199 is used instead.
200 .Sh ENVIRONMENT
201 The following environment variable is utilized by
202 .Nm :
203 .Bl -tag -width TERM
204 .It Ev TERM
205 Determines the user's terminal type.
207 .Sh FILES
208 .Bl -tag -width /etc/hosts -compact
209 .It Pa /etc/hosts
210 .It Pa /etc/hosts.equiv
211 .It Pa /etc/auth.conf
212 .It Ev $HOME Ns Pa /.rhosts
213 .It Ev $HOME Ns Pa /.klogin
215 .Sh SEE ALSO
216 .Xr login 1 ,
217 .Xr rsh 1 ,
218 .Xr telnet 1 ,
219 .Xr setsockopt 2 ,
220 .Xr kerberos 3 ,
221 .Xr krb_realmofhost 3 ,
222 .Xr krb_sendauth 3 ,
223 .Xr ruserok 3 ,
224 .Xr tty 4 ,
225 .Xr auth.conf 5 ,
226 .Xr hosts 5 ,
227 .Xr hosts.equiv 5 ,
228 .Xr rlogind 8 ,
229 .Xr rshd 8
230 .Sh HISTORY
233 command appeared in
234 .Bx 4.2 .
236 IPv6 support was added by WIDE/KAME project.
237 .Sh BUGS
240 utility will be replaced by
241 .Xr telnet  1
242 in the near future.
244 More of the environment should be propagated.