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