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