usr.bin/rlogin/rlogin.1

   1 .\"     $NetBSD: rlogin.1,v 1.24 2005/03/11 13:14:34 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1983, 1990, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)rlogin.1    8.2 (Berkeley) 4/29/95
  31 .\"
  32 .Dd July 16, 2005
  33 .Dt RLOGIN 1
  34 .Os
  35 .Sh NAME
  36 .Nm rlogin
  37 .Nd remote login
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Op Fl 468Ed
  41 .Op Fl e Ar char
  42 .Op Fl l Ar username
  43 .Op Fl p Ar port
  44 .Ar host
  45 .Nm
  46 .Op Fl 468Ed
  47 .Op Fl e Ar char
  48 .Op Fl p Ar port
  49 .Ar username@host
  50 .Sh DESCRIPTION
  51 .Nm
  52 starts a terminal session on a remote host
  53 .Ar host  .
  54 .Pp
  55 .Nm
  56 first attempts to use the standard Berkeley
  57 .Em rhosts
  58 authorization mechanism.
  59 The options are as follows:
  60 .Bl -tag -width XlXusernameX
  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 .Sq \&^S/^Q .
  72 .It Fl E
  73 The
  74 .Fl E
  75 option stops any character from being recognized as an escape character.
  76 When used with the
  77 .Fl 8
  78 option, this provides a completely transparent connection.
  79 .It Fl d
  80 The
  81 .Fl d
  82 option turns on socket debugging (see
  83 .Xr setsockopt 2 )
  84 on the TCP sockets used for communication with the remote host.
  85 .It Fl e Ar char
  86 The
  87 .Fl e
  88 option allows user specification of the escape character, which is
  89 .Dq \&~
  90 by default.
  91 This specification may be as a literal character, or as an octal
  92 value in the form \ennn.
  93 .It Fl l Ar username
  94 the
  95 .Fl l
  96 option specifies an alternate
  97 .Ar username
  98 for the remote login.
  99 If this option is not specified, your local username will be used.
 100 .It Fl p Ar port
 101 Uses the given
 102 .Ar port
 103 instead of the one assigned to the service
 104 .Dq login .
 105 May be given either as symbolic name or as number.
 106 .El
 107 .Pp
 108 A line of the form
 109 .Dq Ao escape char Ac Ns \&.
 110 disconnects from the remote host.
 111 Similarly, the line
 112 .Dq Ao escape char Ac Ns ^Z
 113 will suspend the
 114 .Nm
 115 session, and
 116 .Dq Ao escape char Ac Ns Aq delayed-suspend char
 117 suspends the
 118 send portion of the rlogin, but allows output from the remote system.
 119 By default, the tilde
 120 .Pq Dq \&~
 121 character is the escape character, and normally control-Y
 122 .Pq Dq \&^Y
 123 is the delayed-suspend character.
 124 .Pp
 125 All echoing takes place at the remote site, so that (except for delays) the
 126 .Nm
 127 is transparent.
 128 Flow control via ^S/^Q and flushing of input and output on interrupts
 129 are handled properly.
 130 .Sh ENVIRONMENT
 131 The following environment variable is used by
 132 .Nm :
 133 .Bl -tag -width TERM
 134 .It Ev TERM
 135 Determines the user's terminal type.
 136 .El
 137 .Sh SEE ALSO
 138 .Xr rcmd 1 ,
 139 .Xr rsh 1 ,
 140 .Xr rcmd 3 ,
 141 .Xr hosts.equiv 5 ,
 142 .Xr rhosts 5 ,
 143 .Xr environ 7
 144 .Sh HISTORY
 145 The
 146 .Nm
 147 command appeared in
 148 .Bx 4.2 .
 149 .Sh BUGS
 150 More of the environment should be propagated.