usr.bin/rsh/rsh.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 .\"     @(#)rsh.1       8.1 (Berkeley) 6/6/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd July 3, 2017
  32 .Dt RSH 1
  33 .Os
  34 .Sh NAME
  35 .Nm rsh
  36 .Nd remote shell
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl 46dnN
  40 .Op Fl l Ar username
  41 .Op Fl t Ar timeout
  42 .Ar host
  43 .Op command
  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 executes
  57 .Ar command
  58 on
  59 .Ar host .
  60 .Pp
  61 The
  62 .Nm
  63 utility copies its standard input to the remote command, the standard
  64 output of the remote command to its standard output, and the
  65 standard error of the remote command to its standard error.
  66 Interrupt, quit and terminate signals are propagated to the remote
  67 command;
  68 .Nm
  69 normally terminates when the remote command does.
  70 The options are as follows:
  71 .Bl -tag -width flag
  72 .It Fl 4
  73 Use IPv4 addresses only.
  74 .It Fl 6
  75 Use IPv6 addresses only.
  76 .It Fl d
  77 Turn on socket debugging (using
  78 .Xr setsockopt 2 )
  79 on the
  80 .Tn TCP
  81 sockets used for communication with the remote host.
  82 .It Fl l Ar username
  83 Allow the remote
  84 .Ar username
  85 to be specified.
  86 By default, the remote username is the same as the local username.
  87 Authorization is determined
  88 as in
  89 .Xr rlogin 1 .
  90 .It Fl N
  91 Opposite to
  92 .Fl n
  93 option: do not send the "end of file" (EOF) indication for input stream
  94 to the remote host. This option makes the
  95 .Nm
  96 utility compatible with protocol implementations confused by receiving
  97 EOF, like some Cisco IOS versions. Disables
  98 .Fl n .
  99 .It Fl n
 100 Redirect input from the special device
 101 .Pa /dev/null
 102 (see the
 103 .Sx BUGS
 104 section of this manual page). Disables
 105 .Fl N .
 106 .It Fl t Ar timeout
 107 Allow a
 108 .Ar timeout
 109 to be specified (in seconds).
 110 If no
 111 data is sent or received in this time,
 112 .Nm
 113 will exit.
 114 .El
 115 .Pp
 116 If no
 117 .Ar command
 118 is specified, you will be logged in on the remote host using
 119 .Xr rlogin 1 .
 120 .Pp
 121 Shell metacharacters which are not quoted are interpreted on local machine,
 122 while quoted metacharacters are interpreted on the remote machine.
 123 For example, the command
 124 .Pp
 125 .Dl rsh otherhost cat remotefile >> localfile
 126 .Pp
 127 appends the remote file
 128 .Ar remotefile
 129 to the local file
 130 .Ar localfile ,
 131 while
 132 .Pp
 133 .Dl rsh otherhost cat remotefile \&">>\&" other_remotefile
 134 .Pp
 135 appends
 136 .Ar remotefile
 137 to
 138 .Ar other_remotefile .
 139 .\" .Pp
 140 .\" Many sites specify a large number of host names as commands in the
 141 .\" directory /usr/hosts.
 142 .\" If this directory is included in your search path, you can use the
 143 .\" shorthand ``host command'' for the longer form ``rsh host command''.
 144 .Sh FILES
 145 .Bl -tag -width /etc/hosts -compact
 146 .It Pa /etc/hosts
 147 .El
 148 .Sh SEE ALSO
 149 .Xr rlogin 1 ,
 150 .Xr setsockopt 2 ,
 151 .Xr rcmd 3 ,
 152 .Xr ruserok 3 ,
 153 .Xr hosts 5 ,
 154 .Xr hosts.equiv 5 ,
 155 .Xr rlogind 8 ,
 156 .Xr rshd 8
 157 .Sh HISTORY
 158 The
 159 .Nm
 160 command appeared in
 161 .Bx 4.2 .
 162 .Sh BUGS
 163 If you are using
 164 .Xr csh 1
 165 and put a
 166 .Nm
 167 in the background without redirecting its input away from the terminal,
 168 it will block even if no reads are posted by the remote command.
 169 If no input is desired you should redirect the input of
 170 .Nm
 171 to
 172 .Pa /dev/null
 173 using the
 174 .Fl n
 175 option.
 176 .Pp
 177 You cannot run an interactive command
 178 (like
 179 .Xr ee 1
 180 or
 181 .Xr vi 1 )
 182 using
 183 .Nm ;
 184 use
 185 .Xr rlogin 1
 186 instead.
 187 .Pp
 188 Stop signals stop the local
 189 .Nm
 190 process only; this is arguably wrong, but currently hard to fix for reasons
 191 too complicated to explain here.