NetBSD/bin/rcp/rcp.1

.\"	$NetBSD: rcp.1,v 1.20 2005/03/11 02:55:23 ginsbach Exp $
.\"
.\" Copyright (c) 1983, 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)rcp.1	8.1 (Berkeley) 5/31/93
.\"
.Dd March 8, 2005
.Dt RCP 1
.Os
.Sh NAME
.Nm rcp
.Nd remote file copy
.Sh SYNOPSIS
.Nm
.Op Fl 46p
.Ar file1 file2
.Nm
.Op Fl 46pr
.Ar file ...
.Ar directory
.Sh DESCRIPTION
.Nm
copies files between machines.
Each
.Ar file
or
.Ar directory
argument is either a remote file name of the
form ``rname@rhost:path'', or a local file name (containing no `:'
(colon) characters,
or a `/' (slash) before any `:' (colon) characters).
.Pp
The
.Ar rhost
can be an IPv4 or an IPv6 address string.
Since IPv6 addresses already contain `:' (colon) characters,
an IPv6 address string must be enclosed between `[' (left square bracket)
and `]' (right square bracket) characters.
Otherwise, the first occurrence of a `:' (colon) character would be
interpreted as the separator between the
.Ar rhost
and the
.Ar path.
For example,
.Pp
.Dl [2001:DB8::800:200C:417A]:tmp/file
.Pp
Options:
.Bl -tag -width flag
.It Fl 4
Use IPv4 addresses only.
.It Fl 6
Use IPv6 addresses only.
.It Fl p
The
.Fl p
option causes
.Nm
to attempt to preserve (duplicate) in its copies the modification
times and modes of the source files, ignoring the
.Ar umask  .
By default, the mode and owner of
.Ar file2
are preserved if it already existed; otherwise the mode of the source file
modified by the
.Xr umask  2
on the destination host is used.
.It Fl r
If any of the source files are directories,
.Nm
copies each subtree rooted at that name; in this case
the destination must be a directory.
.El
.Pp
If
.Ar path
is not a full path name, it is interpreted relative to
the login directory of the specified user
.Ar ruser
on
.Ar rhost  ,
or your current user name if no other remote user name is specified.
A
.Ar path
on a remote host may be quoted (using \e, ", or \(aa)
so that the metacharacters are interpreted remotely.
.Pp
.Nm
does not prompt for passwords; it performs remote execution
via
.Xr rsh  1  ,
and requires the same authorization.
.Pp
.Nm
handles third party copies, where neither source nor target files
are on the current machine.
.Sh SEE ALSO
.Xr cp 1 ,
.Xr ftp 1 ,
.Xr rcmd 1 ,
.Xr rlogin 1 ,
.Xr rsh 1 ,
.Xr rcmd 3 ,
.Xr hosts.equiv 5 ,
.Xr rhosts 5 ,
.Xr environ 7
.Sh HISTORY
The
.Nm
utility appeared in
.Bx 4.2 .
The version of
.Nm
described here
has been reimplemented with Kerberos in
.Bx 4.3 Reno .
.Sh BUGS
Doesn't detect all cases where the target of a copy might
be a file in cases where only a directory should be legal.
.Pp
Is confused by any output generated by commands in a
.Pa \&.login ,
.Pa \&.profile ,
or
.Pa \&.cshrc
file on the remote host.
.Pp
The destination user and hostname may have to be specified as
``rhost.rname'' when the destination machine is running the
.Bx 4.2
version of
.Nm .
Add mechanism for escaping IPv6 address strings, since they already contain colons. Idea from Solaris rcp(1). 2005-03-11 05:55:23 +03:00			`.\" $NetBSD: rcp.1,v 1.20 2005/03/11 02:55:23 ginsbach Exp $`
actually do the import. rcp appears to have been previously imported but not merged(?!?!?). 1995-03-21 11:18:58 +03:00			`.\"`
			`.\" Copyright (c) 1983, 1990, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
Move UCB-licensed code from 4-clause to 3-clause licence. Patches provided by Joel Baker in PR 22249, verified by myself. 2003-08-07 13:05:01 +04:00			`.\" 3. Neither the name of the University nor the names of its contributors`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
actually do the import. rcp appears to have been previously imported but not merged(?!?!?). 1995-03-21 11:18:58 +03:00			`.\" @(#)rcp.1 8.1 (Berkeley) 5/31/93`
added rcs ids to all files 1993-03-22 11:04:00 +03:00			`.\"`
- Support -4 and -6. Approved by christos. 2005-03-09 06:11:21 +03:00			`.Dd March 8, 2005`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Dt RCP 1`
More and more .Os cleanups. .Os is defined in the tmac.doc-common file, so we shouldn't override it with versions in the manpages. Many more to come. 1999-03-22 21:25:43 +03:00			`.Os`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh NAME`
			`.Nm rcp`
			`.Nd remote file copy`
			`.Sh SYNOPSIS`
- cleanup use of .Nm in man page - getopt returns -1 not EOF 1997-09-14 12:17:11 +04:00			`.Nm`
- Support -4 and -6. Approved by christos. 2005-03-09 06:11:21 +03:00			`.Op Fl 46p`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Ar file1 file2`
.Nm does not need a dummy argument ("") before punctuation or for correct formatting of the SYNOPSIS any longer. 2003-02-25 13:34:36 +03:00			`.Nm`
- Support -4 and -6. Approved by christos. 2005-03-09 06:11:21 +03:00			`.Op Fl 46pr`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Ar file ...`
			`.Ar directory`
			`.Sh DESCRIPTION`
- cleanup use of .Nm in man page - getopt returns -1 not EOF 1997-09-14 12:17:11 +04:00			`.Nm`
New policy: New sentences start on a new line. Patches by Robert Elz <kre at munnari oz au>, with minimal changes by me. 2002-09-25 19:18:36 +04:00			`copies files between machines.`
			`Each`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Ar file`
			`or`
			`.Ar directory`
			`argument is either a remote file name of the`
Add mechanism for escaping IPv6 address strings, since they already contain colons. Idea from Solaris rcp(1). 2005-03-11 05:55:23 +03:00			form ``rname@rhost:path'', or a local file name (containing no `:'
			`(colon) characters,`
			or a `/' (slash) before any `:' (colon) characters).
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Pp`
Add mechanism for escaping IPv6 address strings, since they already contain colons. Idea from Solaris rcp(1). 2005-03-11 05:55:23 +03:00			`The`
			`.Ar rhost`
			`can be an IPv4 or an IPv6 address string.`
			Since IPv6 addresses already contain `:' (colon) characters,
			an IPv6 address string must be enclosed between `[' (left square bracket)
			and `]' (right square bracket) characters.
			Otherwise, the first occurrence of a `:' (colon) character would be
			`interpreted as the separator between the`
			`.Ar rhost`
			`and the`
			`.Ar path.`
			`For example,`
			`.Pp`
			`.Dl [2001:DB8::800:200C:417A]:tmp/file`
			`.Pp`
			`Options:`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Bl -tag -width flag`
- Support -4 and -6. Approved by christos. 2005-03-09 06:11:21 +03:00			`.It Fl 4`
			`Use IPv4 addresses only.`
			`.It Fl 6`
			`Use IPv6 addresses only.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.It Fl p`
			`The`
			`.Fl p`
			`option causes`
- cleanup use of .Nm in man page - getopt returns -1 not EOF 1997-09-14 12:17:11 +04:00			`.Nm`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`to attempt to preserve (duplicate) in its copies the modification`
			`times and modes of the source files, ignoring the`
			`.Ar umask .`
			`By default, the mode and owner of`
			`.Ar file2`
			`are preserved if it already existed; otherwise the mode of the source file`
			`modified by the`
			`.Xr umask 2`
			`on the destination host is used.`
actually do the import. rcp appears to have been previously imported but not merged(?!?!?). 1995-03-21 11:18:58 +03:00			`.It Fl r`
			`If any of the source files are directories,`
- cleanup use of .Nm in man page - getopt returns -1 not EOF 1997-09-14 12:17:11 +04:00			`.Nm`
actually do the import. rcp appears to have been previously imported but not merged(?!?!?). 1995-03-21 11:18:58 +03:00			`copies each subtree rooted at that name; in this case`
			`the destination must be a directory.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.El`
			`.Pp`
			`If`
			`.Ar path`
			`is not a full path name, it is interpreted relative to`
			`the login directory of the specified user`
			`.Ar ruser`
			`on`
			`.Ar rhost ,`
			`or your current user name if no other remote user name is specified.`
			`A`
			`.Ar path`
			`on a remote host may be quoted (using \e, ", or \(aa)`
			`so that the metacharacters are interpreted remotely.`
			`.Pp`
- cleanup use of .Nm in man page - getopt returns -1 not EOF 1997-09-14 12:17:11 +04:00			`.Nm`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`does not prompt for passwords; it performs remote execution`
			`via`
			`.Xr rsh 1 ,`
			`and requires the same authorization.`
			`.Pp`
- cleanup use of .Nm in man page - getopt returns -1 not EOF 1997-09-14 12:17:11 +04:00			`.Nm`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`handles third party copies, where neither source nor target files`
			`are on the current machine.`
			`.Sh SEE ALSO`
			`.Xr cp 1 ,`
			`.Xr ftp 1 ,`
* Document $RCMD_CMD in environ(7). * Cross-reference rcmd(1), rcmd(3), and environ(7) as appropriate. Should fix [bin/21670] from Geoff Wing. 2003-05-26 14:18:39 +04:00			`.Xr rcmd 1 ,`
Add xrefs to new hosts.equiv(5)/rhosts(5) man page. 1997-11-26 21:06:51 +03:00			`.Xr rlogin 1 ,`
Sort SEE ALSO. 2001-12-20 23:03:29 +03:00			`.Xr rsh 1 ,`
* Document $RCMD_CMD in environ(7). * Cross-reference rcmd(1), rcmd(3), and environ(7) as appropriate. Should fix [bin/21670] from Geoff Wing. 2003-05-26 14:18:39 +04:00			`.Xr rcmd 3 ,`
Add xrefs to new hosts.equiv(5)/rhosts(5) man page. 1997-11-26 21:06:51 +03:00			`.Xr hosts.equiv 5 ,`
* Document $RCMD_CMD in environ(7). * Cross-reference rcmd(1), rcmd(3), and environ(7) as appropriate. Should fix [bin/21670] from Geoff Wing. 2003-05-26 14:18:39 +04:00			`.Xr rhosts 5 ,`
Bump date for removal of Kerberos option descriptions. Remove dots at end of SEE ALSO. 2004-09-05 12:48:32 +04:00			`.Xr environ 7`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh HISTORY`
			`The`
- cleanup use of .Nm in man page - getopt returns -1 not EOF 1997-09-14 12:17:11 +04:00			`.Nm`
Use "utility" instead of "command". Modern definitions of these terms are distinct (See POSIX.2 glossary). A utility is a executable, script or shell builtin; while a command can be any of those things plus lists, pipelines, compound commands (if, for, while) and shell function definitions. 1995-07-25 23:36:36 +04:00			`utility appeared in`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Bx 4.2 .`
			`The version of`
- cleanup use of .Nm in man page - getopt returns -1 not EOF 1997-09-14 12:17:11 +04:00			`.Nm`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`described here`
			`has been reimplemented with Kerberos in`
			`.Bx 4.3 Reno .`
			`.Sh BUGS`
			`Doesn't detect all cases where the target of a copy might`
			`be a file in cases where only a directory should be legal.`
			`.Pp`
			`Is confused by any output generated by commands in a`
			`.Pa \&.login ,`
			`.Pa \&.profile ,`
			`or`
			`.Pa \&.cshrc`
			`file on the remote host.`
			`.Pp`
			`The destination user and hostname may have to be specified as`
			``rhost.rname'' when the destination machine is running the
			`.Bx 4.2`
			`version of`
.Nm does not need a dummy argument ("") before punctuation or for correct formatting of the SYNOPSIS any longer. 2003-02-25 13:34:36 +03:00			`.Nm .`