Remove unnecessary whitespace in macro arguments in some manual pages.
[dragonfly.git] / bin / rcp / rcp.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 .\"     @(#)rcp.1       8.1 (Berkeley) 5/31/93
29 .\" $FreeBSD: src/bin/rcp/rcp.1,v 1.9.2.6 2002/08/16 20:06:34 ume Exp $
30 .\"
31 .Dd May 31, 1993
32 .Dt RCP 1
33 .Os
34 .Sh NAME
35 .Nm rcp
36 .Nd remote file copy
37 .Sh SYNOPSIS
38 .Nm
39 .Op Fl 46Kpx
40 .Op Fl k Ar realm
41 .Ar file1 file2
42 .Nm
43 .Op Fl 46Kprx
44 .Op Fl k Ar realm
45 .Ar
46 .Ar directory
47 .Sh DESCRIPTION
48 The
49 .Nm
50 utility copies files between machines.  Each
51 .Ar file
52 or
53 .Ar directory
54 argument is either a remote file name of the
55 form
56 .Dq rname@rhost:path ,
57 or a local file name (containing no `:' characters,
58 or a `/' before any `:'s).
59 .Pp
60 The following options are available:
61 .Bl -tag -width indent
62 .It Fl 4
63 Use IPv4 addresses only.
64 .It Fl 6
65 Use IPv6 addresses only.
66 .It Fl K
67 Turn off all Kerberos authentication.
68 .It Fl k
69 Request
70 .Nm
71 to obtain tickets
72 for the remote host in realm
73 .Ar realm
74 instead of the remote host's realm as determined by
75 .Xr krb_realmofhost 3 .
76 .It Fl p
77 Cause
78 .Nm
79 to attempt to preserve (duplicate) in its copies the modification
80 times and modes of the source files, ignoring the
81 .Ar umask .
82 By default, the mode and owner of
83 .Ar file2
84 are preserved if it already existed; otherwise the mode of the source file
85 modified by the
86 .Xr umask 2
87 on the destination host is used.
88 .It Fl r
89 If any of the source files are directories,
90 .Nm
91 copies each subtree rooted at that name; in this case
92 the destination must be a directory.
93 .It Fl x
94 Turn on
95 .Tn DES
96 encryption for all data passed by
97 .Nm .
98 This may impact response time and
99 .Tn CPU
100 utilization, but provides
101 increased security.
102 .El
103 .Pp
104 If
105 .Ar path
106 is not a full path name, it is interpreted relative to
107 the login directory of the specified user
108 .Ar ruser
109 on
110 .Ar rhost ,
111 or your current user name if no other remote user name is specified.
112 A
113 .Ar path
114 on a remote host may be quoted (using \e, ", or \(aa)
115 so that the metacharacters are interpreted remotely.
116 .Pp
117 The
118 .Nm
119 utility does not prompt for passwords; it performs remote execution
120 via
121 .Xr rsh 1 ,
122 and requires the same authorization.
123 .Pp
124 The
125 .Nm
126 utility handles third party copies, where neither source nor target files
127 are on the current machine.
128 .Sh FILES
129 .Bl -tag -width /etc/auth.conf -compact
130 .It Pa /etc/auth.conf
131 configure authentication services
132 .El
133 .Sh SEE ALSO
134 .Xr cp 1 ,
135 .Xr ftp 1 ,
136 .Xr rlogin 1 ,
137 .Xr rsh 1 ,
138 .Xr auth.conf 5 ,
139 .Xr hosts.equiv 5
140 .Sh HISTORY
141 The
142 .Nm
143 command appeared in
144 .Bx 4.2 .
145 The version of
146 .Nm
147 described here
148 has been reimplemented with Kerberos in
149 .Bx 4.3 Reno .
150 .Sh BUGS
151 Doesn't detect all cases where the target of a copy might
152 be a file in cases where only a directory should be legal.
153 .Pp
154 Is confused by any output generated by commands in a
155 .Pa \&.login ,
156 .Pa \&.profile ,
157 or
158 .Pa \&.cshrc
159 file on the remote host.
160 .Pp
161 The destination user and hostname may have to be specified as
162 .Dq rhost.rname
163 when the destination machine is running the
164 .Bx 4.2
165 version of
166 .Nm .