version 1.15, 2019/03/31 13:17:44 |
version 1.16, 2019/04/01 13:04:51 |
|
|
.Op Fl aDglnoprtv |
.Op Fl aDglnoprtv |
.Op Fl e Ar program |
.Op Fl e Ar program |
.Op Fl -del |
.Op Fl -del |
.Op Fl -port Ns = Ns Ar portnumber |
.Op Fl -numeric-ids |
|
.Op Fl -port Ns = Ns Ar service |
.Op Fl -rsync-path Ns = Ns Ar program |
.Op Fl -rsync-path Ns = Ns Ar program |
.Op Fl -version |
.Op Fl -version |
.Ar source ... |
.Ar source ... |
|
|
The arguments are as follows: |
The arguments are as follows: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Fl a , -archive |
.It Fl a , -archive |
Archive mode. |
|
Shorthand for |
Shorthand for |
.Fl Dgloprt . |
.Fl Dgloprt . |
.It Fl D |
.It Fl D |
Transfer device and special files. |
Also transfer device and special files. |
Shorthand for |
Shorthand for |
.Fl -devices -specials |
.Fl -devices -specials . |
.It Fl -del , -delete |
.It Fl -del , -delete |
Delete files in |
Delete files in |
.Ar directory |
.Ar directory |
|
|
Only applicable with |
Only applicable with |
.Fl r . |
.Fl r . |
.It Fl -devices |
.It Fl -devices |
Transfer device files. |
Also transfer device files. |
.It Fl e Ar program , Fl -rsh Ns = Ns Ar program |
.It Fl e Ar program , Fl -rsh Ns = Ns Ar program |
Specify alternative program, defaults to |
Specify alternative communication program, defaults to |
.Xr ssh 1 . |
.Xr ssh 1 . |
.It Fl g , -group |
.It Fl g , -group |
Set group identifier to match the source. |
Set the group name to match the source. |
Groups are matched by name: group |
For example, group |
.Qq kristaps |
.Qq kristaps |
with id 1000 on a remote server will be properly assigned group |
with ID 1000 on a remote server is matched to group |
.Qq kristaps |
.Qq kristaps |
on the local machine with id 2000. |
on the local machine with ID 2000. |
If the sender's group is unknown on the local machine, it is used |
If |
verbatim. |
.Fl -numeric-ids |
|
is also given or if the remote group name is unknown on the local machine, |
|
set the numeric group ID to match the source instead. |
.It Fl l , -links |
.It Fl l , -links |
Transfer symbolic links. |
Also transfer symbolic links. |
The link is transferred as a standalone file: if the destination does |
The link is transferred as a standalone file: if the destination does |
not exist, it will be broken. |
not exist, it will be broken. |
.It Fl n , -dry-run |
.It Fl n , -dry-run |
Dry-run mode. |
Do not actually modify the destination. |
Does not actually modify the destination. |
Mainly useful in combination with |
.It Fl o , -owner |
.Fl v . |
Set user identifier to match the source. |
.It Fl -numeric-ids |
This behaves like |
Ignore user and group names, use numeric user and group IDs only. |
|
Has no effect unless |
.Fl g |
.Fl g |
and only works if run as root. |
or |
|
.Fl o |
|
is also given. |
|
.It Fl o , -owner |
|
Set the user name to match the source, with similar matching logic as for |
|
.Fl g . |
|
If |
|
.Fl -numeric-ids |
|
is also given or if the remote user name is unknown on the local machine, |
|
set the numeric user ID to match the source instead. |
|
Only works if run as root. |
.It Fl p , -perms |
.It Fl p , -perms |
Set destination file or directory permissions to match the source when |
Set destination file or directory permissions to match the source when |
it is updated. |
it is updated. |
.It Fl -port Ns = Ns Ar portnumber |
.It Fl -port Ns = Ns Ar service |
Specify alternative port number. |
Specify an alternative TCP port number. |
|
The |
|
.Ar service |
|
can be given as a decimal integer or as a name to be looked up in the |
|
.Xr services 5 |
|
database. |
|
The default is |
|
.Dq rsync . |
.It Fl r , -recursive |
.It Fl r , -recursive |
If |
If |
.Ar source |
.Ar source |
|
|
connected at that point. |
connected at that point. |
If |
If |
.Ar source |
.Ar source |
ends with a slash, only the subtree is synchronised, not the root |
ends with a slash, only the subtree is synchronised, not the |
directory. |
.Ar source |
|
directory itself. |
If |
If |
.Ar source |
.Ar source |
is a file, this has no effect. |
is a file, this has no effect. |
.It Fl -rsync-path Ns = Ns Ar program |
.It Fl -rsync-path Ns = Ns Ar program |
Run |
Run |
.Ar prog |
.Ar program |
on the remote host instead of the default |
on the remote host instead of the default |
.Ar rsync . |
.Pa rsync . |
.It Fl -specials |
.It Fl -specials |
Transfer fifo and unix domain socket files. |
Also transfer fifo and unix domain socket files. |
.It Fl t , -times |
.It Fl t , -times |
Set destination file and directory modification time to match the source |
Set destination file and directory modification time to match the source |
when it is updated or created. |
when it is updated or created. |
|
|
.Ar source |
.Ar source |
or |
or |
.Ar directory |
.Ar directory |
has syntax |
has the syntax |
.Ar host:path |
.Ar host : Ns Ar path |
for connecting via |
for connecting via |
.Xr ssh 1 , |
.Xr ssh 1 , |
or |
or |
.Ar rsync://host/path |
.Cm rsync Ns :// Ns Ar host Ns / Ns Ar path |
or |
or |
.Ar host::path |
.Ar host Ns :: Ns Ar path |
for connecting to a remote daemon. |
for connecting to a remote daemon. |
Subsequent to the first remote |
Subsequent to the first remote |
.Ar source , |
.Ar source , |
the host may be dropped to become just |
the host may be dropped to become just |
.Ar :path |
.Pf : Ar path |
or |
or |
.Ar ::path . |
.Pf :: Ar path . |
.Pp |
.Pp |
For connecting to a remote daemon with |
For connecting to a remote daemon with |
.Ar rsync://host |
.Cm rsync Ns :// Ns Ar host |
or |
or |
.Ar host::path , |
.Ar host Ns :: Ns Ar path , |
the first path component is interpreted as a |
the first path component is interpreted as a |
.Qq module : |
.Qq module : |
.Ar host::module/path . |
.Ar host Ns :: Ns Ar module Ns / Ns Ar path . |
This only applies to the first |
This only applies to the first |
.Ar source |
.Ar source |
invocation; subsequent to that, the module should not be specified. |
invocation; subsequent to that, the module should not be specified. |
|
|
The destination |
The destination |
.Ar directory |
.Ar directory |
must be a directory and is created if not found. |
must be a directory and is created if not found. |
.Pp |
|
.Nm |
|
is compatible with the GPL-licensed |
|
rsync protocol version 27. |
|
.\" The following requests should be uncommented and used where appropriate. |
|
.\" .Sh CONTEXT |
|
.\" For section 9 functions only. |
|
.\" .Sh RETURN VALUES |
|
.\" For sections 2, 3, and 9 function return values only. |
|
.\" .Sh ENVIRONMENT |
.\" .Sh ENVIRONMENT |
.\" For sections 1, 6, 7, and 8 only. |
|
.\" .Sh FILES |
.\" .Sh FILES |
.\" .Sh EXIT STATUS |
.Sh EXIT STATUS |
.\" For sections 1, 6, and 8 only. |
The |
|
.Nm |
|
utility exits 0 on success, 1 if an error occurs, or 2 if the remote |
|
protocol version is older than the local protocol version. |
.Sh EXAMPLES |
.Sh EXAMPLES |
All examples use |
All examples use |
.Fl t |
.Fl t |
|
|
with the local host running |
with the local host running |
.Nm : |
.Nm : |
.Pp |
.Pp |
.Dl % rsync --rsync-path rsync -t ../dest/* host:dest |
.Dl % rsync --rsync-path=rsync -t ../dest/* host:dest |
.\" .Sh DIAGNOSTICS |
.\" .Sh DIAGNOSTICS |
.\" For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only. |
|
.\" .Sh ERRORS |
|
.\" For sections 2, 3, 4, and 9 errno settings only. |
|
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr ssh 1 , |
.Xr ssh 1 , |
.Xr rsync 5 , |
.Xr rsync 5 , |
.Xr rsyncd 5 |
.Xr rsyncd 5 |
.\" .Sh STANDARDS |
.Sh STANDARDS |
.\" .Sh HISTORY |
.Nm |
.\" .Sh AUTHORS |
is compatible with rsync protocol version 27 |
|
as supported by the samba.org implementation of rsync. |
|
.Sh HISTORY |
|
The |
|
.Nm |
|
utility has been available since |
|
.Ox 6.5 . |
|
.Sh AUTHORS |
|
The |
|
.Nm |
|
utility was written by |
|
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . |
.\" .Sh CAVEATS |
.\" .Sh CAVEATS |
.\" .Sh BUGS |
.\" .Sh BUGS |