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