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 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)rsh.1       8.1 (Berkeley) 6/6/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd October 16, 2002
  36 .Dt RSH 1
  37 .Os
  38 .Sh NAME
  39 .Nm rsh
  40 .Nd remote shell
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl 46dn
  44 .Op Fl l Ar username
  45 .Op Fl t Ar timeout
  46 .Ar host
  47 .Op command
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 utility executes
  52 .Ar command
  53 on
  54 .Ar host .
  55 .Pp
  56 The
  57 .Nm
  58 utility copies its standard input to the remote command, the standard
  59 output of the remote command to its standard output, and the
  60 standard error of the remote command to its standard error.
  61 Interrupt, quit and terminate signals are propagated to the remote
  62 command;
  63 .Nm
  64 normally terminates when the remote command does.
  65 The options are as follows:
  66 .Bl -tag -width flag
  67 .It Fl 4
  68 Use IPv4 addresses only.
  69 .It Fl 6
  70 Use IPv6 addresses only.
  71 .It Fl d
  72 Turn on socket debugging (using
  73 .Xr setsockopt 2 )
  74 on the
  75 .Tn TCP
  76 sockets used for communication with the remote host.
  77 .It Fl l Ar username
  78 Allow the remote
  79 .Ar username
  80 to be specified.
  81 By default, the remote username is the same as the local username.
  82 Authorization is determined
  83 as in
  84 .Xr rlogin 1 .
  85 .It Fl n
  86 Redirect input from the special device
  87 .Pa /dev/null
  88 (see the
  89 .Sx BUGS
  90 section of this manual page).
  91 .It Fl t Ar timeout
  92 Allow a
  93 .Ar timeout
  94 to be specified (in seconds).
  95 If no
  96 data is sent or received in this time,
  97 .Nm
  98 will exit.
  99 .El
 100 .Pp
 101 If no
 102 .Ar command
 103 is specified, you will be logged in on the remote host using
 104 .Xr rlogin 1 .
 105 .Pp
 106 Shell metacharacters which are not quoted are interpreted on local machine,
 107 while quoted metacharacters are interpreted on the remote machine.
 108 For example, the command
 109 .Pp
 110 .Dl rsh otherhost cat remotefile >> localfile
 111 .Pp
 112 appends the remote file
 113 .Ar remotefile
 114 to the local file
 115 .Ar localfile ,
 116 while
 117 .Pp
 118 .Dl rsh otherhost cat remotefile \&">>\&" other_remotefile
 119 .Pp
 120 appends
 121 .Ar remotefile
 122 to
 123 .Ar other_remotefile .
 124 .\" .Pp
 125 .\" Many sites specify a large number of host names as commands in the
 126 .\" directory /usr/hosts.
 127 .\" If this directory is included in your search path, you can use the
 128 .\" shorthand ``host command'' for the longer form ``rsh host command''.
 129 .Sh FILES
 130 .Bl -tag -width /etc/hosts -compact
 131 .It Pa /etc/hosts
 132 .It Pa /etc/auth.conf
 133 .El
 134 .Sh SEE ALSO
 135 .Xr rlogin 1 ,
 136 .Xr setsockopt 2 ,
 137 .Xr rcmd 3 ,
 138 .Xr ruserok 3 ,
 139 .Xr auth.conf 5 ,
 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 .Sh BUGS
 150 If you are using
 151 .Xr csh 1
 152 and put a
 153 .Nm
 154 in the background without redirecting its input away from the terminal,
 155 it will block even if no reads are posted by the remote command.
 156 If no input is desired you should redirect the input of
 157 .Nm
 158 to
 159 .Pa /dev/null
 160 using the
 161 .Fl n
 162 option.
 163 .Pp
 164 You cannot run an interactive command
 165 (like
 166 .Xr ee 1
 167 or
 168 .Xr vi 1 )
 169 using
 170 .Nm ;
 171 use
 172 .Xr rlogin 1
 173 instead.
 174 .Pp
 175 Stop signals stop the local
 176 .Nm
 177 process only; this is arguably wrong, but currently hard to fix for reasons
 178 too complicated to explain here.