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 46dn
  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 Redirect input from the special device
  92 .Pa /dev/null
  93 (see the
  94 .Sx BUGS
  95 section of this manual page).
  96 .It Fl t Ar timeout
  97 Allow a
  98 .Ar timeout
  99 to be specified (in seconds).
 100 If no
 101 data is sent or received in this time,
 102 .Nm
 103 will exit.
 104 .El
 105 .Pp
 106 If no
 107 .Ar command
 108 is specified, you will be logged in on the remote host using
 109 .Xr rlogin 1 .
 110 .Pp
 111 Shell metacharacters which are not quoted are interpreted on local machine,
 112 while quoted metacharacters are interpreted on the remote machine.
 113 For example, the command
 114 .Pp
 115 .Dl rsh otherhost cat remotefile >> localfile
 116 .Pp
 117 appends the remote file
 118 .Ar remotefile
 119 to the local file
 120 .Ar localfile ,
 121 while
 122 .Pp
 123 .Dl rsh otherhost cat remotefile \&">>\&" other_remotefile
 124 .Pp
 125 appends
 126 .Ar remotefile
 127 to
 128 .Ar other_remotefile .
 129 .\" .Pp
 130 .\" Many sites specify a large number of host names as commands in the
 131 .\" directory /usr/hosts.
 132 .\" If this directory is included in your search path, you can use the
 133 .\" shorthand ``host command'' for the longer form ``rsh host command''.
 134 .Sh FILES
 135 .Bl -tag -width /etc/hosts -compact
 136 .It Pa /etc/hosts
 137 .El
 138 .Sh SEE ALSO
 139 .Xr rlogin 1 ,
 140 .Xr setsockopt 2 ,
 141 .Xr rcmd 3 ,
 142 .Xr ruserok 3 ,
 143 .Xr hosts 5 ,
 144 .Xr hosts.equiv 5 ,
 145 .Xr rlogind 8 ,
 146 .Xr rshd 8
 147 .Sh HISTORY
 148 The
 149 .Nm
 150 command appeared in
 151 .Bx 4.2 .
 152 .Sh BUGS
 153 If you are using
 154 .Xr csh 1
 155 and put a
 156 .Nm
 157 in the background without redirecting its input away from the terminal,
 158 it will block even if no reads are posted by the remote command.
 159 If no input is desired you should redirect the input of
 160 .Nm
 161 to
 162 .Pa /dev/null
 163 using the
 164 .Fl n
 165 option.
 166 .Pp
 167 You cannot run an interactive command
 168 (like
 169 .Xr ee 1
 170 or
 171 .Xr vi 1 )
 172 using
 173 .Nm ;
 174 use
 175 .Xr rlogin 1
 176 instead.
 177 .Pp
 178 Stop signals stop the local
 179 .Nm
 180 process only; this is arguably wrong, but currently hard to fix for reasons
 181 too complicated to explain here.