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