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 .\" 4. 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$
  30 .\"
  31 .Dd July 3, 2017
  32 .Dt RLOGIN 1
  33 .Os
  34 .Sh NAME
  35 .Nm rlogin
  36 .Nd remote login
  37 .Sh SYNOPSIS
  38 .Ar rlogin
  39 .Op Fl 468DEd
  40 .Op Fl e Ar char
  41 .Op Fl i Ar localname
  42 .Op Fl l Ar username
  43 .Ar host
  44 .Sh DEPRECATION NOTICE
  45 .Nm
  46 is deprecated and will be removed from future versions of the
  47 .Fx
  48 base system.
  49 If
  50 .Nm
  51 is still required, it can be installed from ports or packages
  52 (net/bsdrcmds).
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 utility starts a terminal session on a remote host
  57 .Ar host .
  58 .Pp
  59 The standard Berkeley
  60 .Pa rhosts
  61 authorization mechanism is used.
  62 .Pp
  63 The following options are available:
  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 Allow an eight-bit input data path at all times; otherwise
  71 parity bits are stripped except when the remote side's stop and start
  72 characters are other than
  73 ^S/^Q.
  74 .It Fl D
  75 Set the TCP_NODELAY socket option which can improve interactive response
  76 at the expense of increased network load.
  77 .It Fl E
  78 Stop any character from being recognized as an escape character.
  79 When used with the
  80 .Fl 8
  81 option, this provides a completely transparent connection.
  82 .It Fl d
  83 Turn on socket debugging (see
  84 .Xr setsockopt 2 )
  85 on the TCP sockets used for communication with the remote host.
  86 .It Fl e
  87 Allow user specification of the escape character, which is
  88 .Dq ~
  89 by default.
  90 This specification may be as a literal character, or as an octal
  91 value in the form \ennn.
  92 .It Fl i
  93 Allow the caller to specify a different local name to be used
  94 for authentication.
  95 This option is restricted to processes with uid 0.
  96 .It Fl l
  97 Specify a different
  98 .Ar username
  99 for the remote login.
 100 If this option is not specified, your local username will be used.
 101 .El
 102 .Pp
 103 A line of the form
 104 .Dq Ao escape char Ac Ns \&.
 105 disconnects from the remote host.
 106 Similarly, the line
 107 .Dq Ao escape char Ac Ns ^Z
 108 will suspend the
 109 .Nm
 110 session, and
 111 .Dq Ao escape\ char Ac Ns Ao delayed-suspend\ char Ac
 112 suspends the
 113 send portion of the
 114 .Nm
 115 session, but allows output from the remote system.
 116 By default, the tilde
 117 .Pq Dq ~
 118 character is the escape character, and
 119 normally control-Y
 120 .Pq Dq ^Y
 121 is the delayed-suspend character.
 122 .Pp
 123 All echoing takes place at the remote site, so that (except for delays)
 124 the
 125 .Nm
 126 is transparent.
 127 Flow control via ^S/^Q and flushing of input and output on interrupts
 128 are handled properly.
 129 .Sh ENVIRONMENT
 130 The following environment variable is utilized by
 131 .Nm :
 132 .Bl -tag -width TERM
 133 .It Ev TERM
 134 Determines the user's terminal type.
 135 .El
 136 .Sh FILES
 137 .Bl -tag -width /etc/hosts -compact
 138 .It Pa /etc/hosts
 139 .It Pa /etc/hosts.equiv
 140 .It Ev $HOME Ns Pa /.rhosts
 141 .El
 142 .Sh SEE ALSO
 143 .Xr login 1 ,
 144 .Xr rsh 1 ,
 145 .Xr telnet 1 ,
 146 .Xr setsockopt 2 ,
 147 .Xr ruserok 3 ,
 148 .Xr tty 4 ,
 149 .Xr hosts 5 ,
 150 .Xr hosts.equiv 5 ,
 151 .Xr rlogind 8 ,
 152 .Xr rshd 8
 153 .Sh HISTORY
 154 The
 155 .Nm
 156 command appeared in
 157 .Bx 4.2 .
 158 .Pp
 159 IPv6 support was added by WIDE/KAME project.
 160 .Sh BUGS
 161 The
 162 .Nm
 163 utility will be replaced by
 164 .Xr telnet 1
 165 in the near future.
 166 .Pp
 167 More of the environment should be propagated.