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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)rlogin.1    8.1 (Berkeley) 6/6/93
  29 .\" $FreeBSD: src/usr.bin/rlogin/rlogin.1,v 1.11.2.7 2002/06/21 15:28:48 charnier Exp $
  30 .\" $DragonFly: src/usr.bin/rlogin/rlogin.1,v 1.3 2006/02/17 19:39:10 swildner Exp $
  31 .\"
  32 .Dd June 6, 1993
  33 .Dt RLOGIN 1
  34 .Os
  35 .Sh NAME
  36 .Nm rlogin
  37 .Nd remote login
  38 .Sh SYNOPSIS
  39 .Ar rlogin
  40 .Op Fl 468DEKLdx
  41 .Op Fl e Ar char
  42 .Op Fl i Ar localname
  43 .Op Fl k Ar realm
  44 .Op Fl l Ar username
  45 .Ar host
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 utility starts a terminal session on a remote host
  50 .Ar host  .
  51 .Pp
  52 The
  53 .Nm
  54 utility
  55 first attempts to use the Kerberos authorization mechanism, described below.
  56 If the remote host does not support Kerberos the standard Berkeley
  57 .Pa rhosts
  58 authorization mechanism is used.
  59 The options are as follows:
  60 .Bl -tag -width flag
  61 .It Fl 4
  62 Use IPv4 addresses only.
  63 .It Fl 6
  64 Use IPv6 addresses only.
  65 .It Fl 8
  66 The
  67 .Fl 8
  68 option allows an eight-bit input data path at all times; otherwise
  69 parity bits are stripped except when the remote side's stop and start
  70 characters are other than
  71 ^S/^Q.
  72 .It Fl D
  73 The
  74 .Fl D
  75 option sets the TCP_NODELAY socket option which can improve interactive response
  76 at the expense of increased network load.
  77 .It Fl E
  78 The
  79 .Fl E
  80 option stops any character from being recognized as an escape character.
  81 When used with the
  82 .Fl 8
  83 option, this provides a completely transparent connection.
  84 .It Fl K
  85 The
  86 .Fl K
  87 option turns off all Kerberos authentication.
  88 .It Fl L
  89 The
  90 .Fl L
  91 option allows the rlogin session to be run in
  92 .Dq litout
  93 (see
  94 .Xr tty 4 )
  95 mode.
  96 .It Fl d
  97 The
  98 .Fl d
  99 option turns on socket debugging (see
 100 .Xr setsockopt 2 )
 101 on the TCP sockets used for communication with the remote host.
 102 .It Fl e
 103 The
 104 .Fl e
 105 option allows user specification of the escape character, which is
 106 .Dq ~
 107 by default.
 108 This specification may be as a literal character, or as an octal
 109 value in the form \ennn.
 110 .It Fl i
 111 The
 112 .Fl i
 113 option allows the caller to specify a different local name to be used
 114 for authentication.  This option is restricted to processes with uid 0.
 115 .It Fl k
 116 The
 117 .Fl k
 118 option requests rlogin to obtain tickets for the remote host
 119 in realm
 120 .Ar realm
 121 instead of the remote host's realm as determined by
 122 .Xr krb_realmofhost  3  .
 123 .It Fl l
 124 The
 125 .Fl l
 126 option specifies a different
 127 .Ar username
 128 for the remote login.
 129 If this option is not specified, your local username will be used.
 130 .It Fl x
 131 The
 132 .Fl x
 133 option turns on
 134 .Tn DES
 135 encryption for all data passed via the
 136 rlogin session.
 137 This may impact response time and
 138 .Tn CPU
 139 utilization, but provides
 140 increased security.
 141 .El
 142 .Pp
 143 A line of the form
 144 .Dq Aq escape char .
 145 disconnects from the remote host.
 146 Similarly, the line
 147 .Dq Ao escape char Ac Ns ^Z
 148 will suspend the
 149 .Nm
 150 session, and
 151 .Dq Ao escape\ char Ac Ns Ao delayed-suspend\ char Ac
 152 suspends the
 153 send portion of the rlogin, but allows output from the remote system.
 154 By default, the tilde
 155 .Pq Dq ~
 156 character is the escape character, and
 157 normally control-Y
 158 .Pq Dq ^Y
 159 is the delayed-suspend character.
 160 .Pp
 161 All echoing takes place at the remote site, so that (except for delays)
 162 the
 163 .Nm
 164 is transparent.
 165 Flow control via ^S/^Q and flushing of input and output on interrupts
 166 are handled properly.
 167 .Sh KERBEROS AUTHENTICATION
 168 Each user may have a private authorization list in the file
 169 .Pa .klogin
 170 in their home directory.
 171 Each line in this file should contain a Kerberos principal name of the
 172 form
 173 .Ar principal.instance@realm  .
 174 If the originating user is authenticated to one of the principals named
 175 in
 176 .Pa .klogin ,
 177 access is granted to the account.
 178 The principal
 179 .Ar accountname.@localrealm
 180 is granted access if
 181 there is no
 182 .Pa .klogin
 183 file.
 184 Otherwise a login and password will be prompted for on the remote machine
 185 as in
 186 .Xr login  1  .
 187 To avoid certain security problems, the
 188 .Pa .klogin
 189 file must be owned by
 190 the remote user.
 191 .Pp
 192 If Kerberos authentication fails, a warning message is printed and the
 193 standard Berkeley
 194 .Nm
 195 is used instead.
 196 .Sh ENVIRONMENT
 197 The following environment variable is utilized by
 198 .Nm :
 199 .Bl -tag -width TERM
 200 .It Ev TERM
 201 Determines the user's terminal type.
 202 .El
 203 .Sh FILES
 204 .Bl -tag -width /etc/hosts -compact
 205 .It Pa /etc/hosts
 206 .It Pa /etc/hosts.equiv
 207 .It Pa /etc/auth.conf
 208 .It Ev $HOME Ns Pa /.rhosts
 209 .It Ev $HOME Ns Pa /.klogin
 210 .El
 211 .Sh SEE ALSO
 212 .Xr login 1 ,
 213 .Xr rsh 1 ,
 214 .Xr telnet 1 ,
 215 .Xr setsockopt 2 ,
 216 .Xr kerberos 3 ,
 217 .Xr krb_realmofhost 3 ,
 218 .Xr krb_sendauth 3 ,
 219 .Xr ruserok 3 ,
 220 .Xr tty 4 ,
 221 .Xr auth.conf 5 ,
 222 .Xr hosts 5 ,
 223 .Xr hosts.equiv 5 ,
 224 .Xr rlogind 8 ,
 225 .Xr rshd 8
 226 .Sh HISTORY
 227 The
 228 .Nm
 229 command appeared in
 230 .Bx 4.2 .
 231 .Pp
 232 IPv6 support was added by WIDE/KAME project.
 233 .Sh BUGS
 234 The
 235 .Nm
 236 utility will be replaced by
 237 .Xr telnet  1
 238 in the near future.
 239 .Pp
 240 More of the environment should be propagated.