Initial import from FreeBSD RELENG_4:
[dragonfly.git] / 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: src/usr.bin/rsh/rsh.1,v 1.11.2.5 2002/06/21 15:28:58 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 46Kdnx
44 .Op Fl t Ar timeout
45 .Op Fl k Ar realm
46 .Op Fl l Ar username
47 .Ar host
48 .Op command
49 .Sh DESCRIPTION
50 The
51 .Nm
52 utility executes
53 .Ar command
54 on
55 .Ar host .
56 .Pp
57 The
58 .Nm
59 utility copies its standard input to the remote command, the standard
60 output of the remote command to its standard output, and the
61 standard error of the remote command to its standard error.
62 Interrupt, quit and terminate signals are propagated to the remote
63 command;
64 .Nm
65 normally terminates when the remote command does.
66 The options are as follows:
67 .Bl -tag -width flag
68 .It Fl 4
69 Use IPv4 addresses only.
70 .It Fl 6
71 Use IPv6 addresses only.
72 .It Fl K
73 Turn off all Kerberos authentication.
74 .It Fl d
75 Turn on socket debugging (using
76 .Xr setsockopt 2 )
77 on the
78 .Tn TCP
79 sockets used for communication with the remote host.
80 .It Fl k Ar realm
81 Cause
82 .Nm
83 to obtain tickets for the remote host in
84 .Ar realm
85 instead of the remote host's realm as determined by
86 .Xr krb_realmofhost 3 .
87 .It Fl l Ar username
88 Allow the remote
89 .Ar username
90 to be specified.
91 By default, the remote username is the same as the local username.
92 Kerberos authentication is used, and authorization is determined
93 as in
94 .Xr rlogin 1 .
95 .It Fl n
96 Redirect input from the special device
97 .Pa /dev/null
98 (see the
99 .Sx BUGS
100 section of this manual page).
101 .It Fl x
102 Turn on
103 .Tn DES
104 encryption for all data exchange.
105 This may introduce a significant delay in response time.
106 .It Fl t Ar timeout
107 Allow a
108 .Ar timeout
109 to be specified (in seconds).  If no
110 data is sent or received in this time,
111 .Nm
112 will exit.
113 .El
114 .Pp
115 If no
116 .Ar command
117 is specified, you will be logged in on the remote host using
118 .Xr rlogin 1 .
119 .Pp
120 Shell metacharacters which are not quoted are interpreted on local machine,
121 while quoted metacharacters are interpreted on the remote machine.
122 For example, the command
123 .Pp
124 .Dl rsh otherhost cat remotefile >> localfile
125 .Pp
126 appends the remote file
127 .Ar remotefile
128 to the local file
129 .Ar localfile ,
130 while
131 .Pp
132 .Dl rsh otherhost cat remotefile \&">>\&" other_remotefile
133 .Pp
134 appends
135 .Ar remotefile
136 to
137 .Ar other_remotefile .
138 .\" .Pp
139 .\" Many sites specify a large number of host names as commands in the
140 .\" directory /usr/hosts.
141 .\" If this directory is included in your search path, you can use the
142 .\" shorthand ``host command'' for the longer form ``rsh host command''.
143 .Sh FILES
144 .Bl -tag -width /etc/hosts -compact
145 .It Pa /etc/hosts
146 .It Pa /etc/auth.conf
147 .El
148 .Sh SEE ALSO
149 .Xr rlogin 1 ,
150 .Xr setsockopt 2 ,
151 .Xr kerberos 3 ,
152 .Xr krb_realmofhost 3 ,
153 .Xr krb_sendauth 3 ,
154 .Xr rcmd 3 ,
155 .Xr ruserok 3 ,
156 .Xr auth.conf 5 ,
157 .Xr hosts 5 ,
158 .Xr hosts.equiv 5 ,
159 .Xr rlogind 8 ,
160 .Xr rshd 8
161 .Sh HISTORY
162 The
163 .Nm
164 command appeared in
165 .Bx 4.2 .
166 .Sh BUGS
167 If you are using
168 .Xr csh  1
169 and put a
170 .Nm
171 in the background without redirecting its input away from the terminal,
172 it will block even if no reads are posted by the remote command.
173 If no input is desired you should redirect the input of
174 .Nm
175 to
176 .Pa /dev/null
177 using the
178 .Fl n
179 option.
180 .Pp
181 You cannot run an interactive command
182 (like
183 .Xr rogue 6
184 or
185 .Xr vi 1 )
186 using
187 .Nm ;
188 use
189 .Xr rlogin 1
190 instead.
191 .Pp
192 Stop signals stop the local
193 .Nm
194 process only; this is arguably wrong, but currently hard to fix for reasons
195 too complicated to explain here.