]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - usr.bin/rlogin/rlogin.1
This commit was generated by cvs2svn to compensate for changes in r140216,
[FreeBSD/FreeBSD.git] / usr.bin / rlogin / 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.1 (Berkeley) 6/6/93
33 .\" $FreeBSD$
34 .\"
35 .Dd September 26, 2003
36 .Dt RLOGIN 1
37 .Os
38 .Sh NAME
39 .Nm rlogin
40 .Nd remote login
41 .Sh SYNOPSIS
42 .Ar rlogin
43 .Op Fl 468DEd
44 .Op Fl e Ar char
45 .Op Fl i Ar localname
46 .Op Fl l Ar username
47 .Ar host
48 .Sh DESCRIPTION
49 The
50 .Nm
51 utility starts a terminal session on a remote host
52 .Ar host .
53 .Pp
54 The
55 .Nm
56 utility
57 first attempts to use the Kerberos authorization mechanism, described below.
58 If the remote host does not support Kerberos the standard Berkeley
59 .Pa rhosts
60 authorization mechanism is used.
61 .Pp
62 The following options are available:
63 .Bl -tag -width flag
64 .It Fl 4
65 Use IPv4 addresses only.
66 .It Fl 6
67 Use IPv6 addresses only.
68 .It Fl 8
69 Allow an eight-bit input data path at all times; otherwise
70 parity bits are stripped except when the remote side's stop and start
71 characters are other than
72 ^S/^Q.
73 .It Fl D
74 Set the TCP_NODELAY socket option which can improve interactive response
75 at the expense of increased network load.
76 .It Fl E
77 Stop any character from being recognized as an escape character.
78 When used with the
79 .Fl 8
80 option, this provides a completely transparent connection.
81 .It Fl d
82 Turn on socket debugging (see
83 .Xr setsockopt 2 )
84 on the TCP sockets used for communication with the remote host.
85 .It Fl e
86 Allow user specification of the escape character, which is
87 .Dq ~
88 by default.
89 This specification may be as a literal character, or as an octal
90 value in the form \ennn.
91 .It Fl i
92 Allow the caller to specify a different local name to be used
93 for authentication.
94 This option is restricted to processes with uid 0.
95 .It Fl l
96 Specify a different
97 .Ar username
98 for the remote login.
99 If this option is not specified, your local username will be used.
100 .El
101 .Pp
102 A line of the form
103 .Dq Ao escape char Ac Ns \&.
104 disconnects from the remote host.
105 Similarly, the line
106 .Dq Ao escape char Ac Ns ^Z
107 will suspend the
108 .Nm
109 session, and
110 .Dq Ao escape\ char Ac Ns Ao delayed-suspend\ char Ac
111 suspends the
112 send portion of the
113 .Nm
114 session, but allows output from the remote system.
115 By default, the tilde
116 .Pq Dq ~
117 character is the escape character, and
118 normally control-Y
119 .Pq Dq ^Y
120 is the delayed-suspend character.
121 .Pp
122 All echoing takes place at the remote site, so that (except for delays)
123 the
124 .Nm
125 is transparent.
126 Flow control via ^S/^Q and flushing of input and output on interrupts
127 are handled properly.
128 .Sh KERBEROS AUTHENTICATION
129 Each user may have a private authorization list in the file
130 .Pa .klogin
131 in their home directory.
132 Each line in this file should contain a Kerberos principal name of the
133 form
134 .Ar principal.instance@realm .
135 If the originating user is authenticated to one of the principals named
136 in
137 .Pa .klogin ,
138 access is granted to the account.
139 The principal
140 .Ar accountname.@localrealm
141 is granted access if
142 there is no
143 .Pa .klogin
144 file.
145 Otherwise a login and password will be prompted for on the remote machine
146 as in
147 .Xr login 1 .
148 To avoid certain security problems, the
149 .Pa .klogin
150 file must be owned by
151 the remote user.
152 .Pp
153 If Kerberos authentication fails, a warning message is printed and the
154 standard Berkeley
155 .Nm
156 is used instead.
157 .Sh ENVIRONMENT
158 The following environment variable is utilized by
159 .Nm :
160 .Bl -tag -width TERM
161 .It Ev TERM
162 Determines the user's terminal type.
163 .El
164 .Sh SEE ALSO
165 .Xr login 1 ,
166 .Xr rsh 1 ,
167 .Xr telnet 1 ,
168 .Xr setsockopt 2 ,
169 .Xr kerberos 3 ,
170 .Xr krb_realmofhost 3 ,
171 .Xr krb_sendauth 3 ,
172 .Xr ruserok 3 ,
173 .Xr tty 4 ,
174 .Xr auth.conf 5 ,
175 .Xr hosts 5 ,
176 .Xr hosts.equiv 5 ,
177 .Xr rlogind 8 ,
178 .Xr rshd 8
179 .Sh FILES
180 .Bl -tag -width /etc/hosts -compact
181 .It Pa /etc/hosts
182 .It Pa /etc/hosts.equiv
183 .It Pa /etc/auth.conf
184 .It Ev $HOME Ns Pa /.rhosts
185 .It Ev $HOME Ns Pa /.klogin
186 .El
187 .Sh HISTORY
188 The
189 .Nm
190 command appeared in
191 .Bx 4.2 .
192 .Pp
193 IPv6 support was added by WIDE/KAME project.
194 .Sh BUGS
195 The
196 .Nm
197 utility will be replaced by
198 .Xr telnet 1
199 in the near future.
200 .Pp
201 More of the environment should be propagated.