Initial import from FreeBSD RELENG_4:
[dragonfly.git] / crypto / kerberosIV / man / rsh.1
1 .\" Copyright (c) 1983, 1990 The Regents of the University of California.
2 .\" 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 .\"     from: @(#)rsh.1 6.10 (Berkeley) 7/24/91
33 .\"     $Id: rsh.1,v 1.1.1.1 1995/10/23 11:20:27 d91-jda Exp $
34 .\"
35 .Dd July 24, 1991
36 .Dt RSH 1
37 .Os BSD 4.2
38 .Sh NAME
39 .Nm rsh
40 .Nd remote shell
41 .Sh SYNOPSIS
42 .Nm rsh
43 .Op Fl Kdnx
44 .Op Fl k Ar realm
45 .Op Fl l Ar username
46 .Ar host
47 .Op command
48 .Sh DESCRIPTION
49 .Nm Rsh
50 executes
51 .Ar command
52 on
53 .Ar host  .
54 .Pp
55 .Nm Rsh
56 copies its standard input to the remote command, the standard
57 output of the remote command to its standard output, and the
58 standard error of the remote command to its standard error.
59 Interrupt, quit and terminate signals are propagated to the remote
60 command;
61 .Nm rsh
62 normally terminates when the remote command does.
63 The options are as follows:
64 .Bl -tag -width flag
65 .It Fl K
66 The
67 .Fl K
68 option turns off all Kerberos authentication.
69 .It Fl d
70 The
71 .Fl d
72 option turns 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 k
78 The
79 .Fl k
80 option causes
81 .Nm rsh
82 to obtain tickets for the remote host in
83 .Ar realm
84 instead of the remote host's realm as determined by
85 .Xr krb_realmofhost  3  .
86 .It Fl l
87 By default, the remote username is the same as the local username.
88 The
89 .Fl l
90 option allows the remote name to be specified.
91 Kerberos authentication is used, and authorization is determined
92 as in
93 .Xr rlogin  1  .
94 .It Fl n
95 The
96 .Fl n
97 option redirects input from the special device
98 .Pa /dev/null
99 (see the
100 .Sx BUGS
101 section of this manual page).
102 .It Fl x
103 The
104 .Fl x
105 option turns on
106 .Tn DES
107 encryption for all data exchange.
108 This may introduce a significant delay in response time.
109 .El
110 .Pp
111 If no
112 .Ar command
113 is specified, you will be logged in on the remote host using
114 .Xr rlogin  1  .
115 .Pp
116 Shell metacharacters which are not quoted are interpreted on local machine,
117 while quoted metacharacters are interpreted on the remote machine.
118 For example, the command
119 .Pp
120 .Dl rsh otherhost cat remotefile >> localfile
121 .Pp
122 appends the remote file
123 .Ar remotefile
124 to the local file
125 .Ar localfile ,
126 while
127 .Pp
128 .Dl rsh otherhost cat remotefile \&">>\&" other_remotefile
129 .Pp
130 appends
131 .Ar remotefile
132 to
133 .Ar other_remotefile .
134 .\" .Pp
135 .\" Many sites specify a large number of host names as commands in the
136 .\" directory /usr/hosts.
137 .\" If this directory is included in your search path, you can use the
138 .\" shorthand ``host command'' for the longer form ``rsh host command''.
139 .Sh FILES
140 .Bl -tag -width /etc/hosts -compact
141 .It Pa /etc/hosts
142 .El
143 .Sh SEE ALSO
144 .Xr rlogin 1 ,
145 .Xr kerberos 3 ,
146 .Xr krb_sendauth 3 ,
147 .Xr krb_realmofhost 3
148 .Sh HISTORY
149 The
150 .Nm rsh
151 command appeared in
152 .Bx 4.2 .
153 .Sh BUGS
154 If you are using
155 .Xr csh  1
156 and put a
157 .Nm rsh
158 in the background without redirecting its input away from the terminal,
159 it will block even if no reads are posted by the remote command.
160 If no input is desired you should redirect the input of
161 .Nm rsh
162 to
163 .Pa /dev/null
164 using the
165 .Fl n
166 option.
167 .Pp
168 You cannot run an interactive command
169 (like
170 .Xr rogue  6
171 or
172 .Xr vi  1  )
173 using
174 .Nm rsh  ;
175 use
176 .Xr rlogin  1
177 instead.
178 .Pp
179 Stop signals stop the local
180 .Nm rsh
181 process only; this is arguably wrong, but currently hard to fix for reasons
182 too complicated to explain here.