同步命令 rsync 参数和使用方法

返回工具箱首页

简介

rsync 是一个常用的 Linux 应用程序,用于文件同步。同时rsync也有Windows版本,使用cygwin编译。

它可以在本地计算机与远程计算机之间,或者两个本地目录之间同步文件。

Rsync的命令格式六种

  1)拷贝本地文件。当SRC和DES路径信息都不包含有单个冒号”:”分隔符时就启动这种工作模式。如:rsync -a /data /backup

  2)使用一个远程shell程序(如rsh、ssh)来实现将本地机器的内容拷贝到远程机器。当DST路径地址包含单个冒号”:”分隔符时启动该模式。如:rsync -avz *.c foo:src

  3)使用一个远程shell程序(如rsh、ssh)来实现将远程机器的内容拷贝到本地机器。当SRC地址路径包含单个冒号”:”分隔符时启动该模式。如:rsync -avz foo:src/bar /data

  4)从远程rsync服务器中拷贝文件到本地机。当SRC路径信息包含”::”分隔符时启动该模式。如:rsync -av root@172.16.78.192::www /databack

  5)从本地机器拷贝文件到远程rsync服务器中。当DST路径信息包含”::”分隔符时启动该模式。如:rsync -av /databack root@172.16.78.192::www

  6)列远程机的文件列表。这类似于rsync传输,不过只要在命令中省略掉本地机信息即可。如:rsync -v rsync://172.16.78.192/www

rsync主要参数解释与常用用法

公共参数

1.1 执行方式

-n, --dry-run      试运行,不产生实际改变
--list-only        仅列出文件,不执行拷贝

1.2 执行过程

--progress         显示传输过程(速度、百分比)
-v, --verbose      显示传输汇总信息
--stats            显示详细传输信息及汇总信息,即包含`-v, --verbose`显示的信息
-q, --quiet        静默
-P                 等于 --partial --progress

1.3 其他

-e, --rsh=COMMAND  远程shell使用的命令,一般用于设置ssh非标端口,例如:【-e "ssh -p ${SSHD_PORT}"】
-z, --compress     压缩传输
-a, --archive      归档模式,等同:-rlptgoD (no -H,-A,-X)
--log-file=FILE    写日志到指定文件
--iconv=CONVERT_SPEC  转换文件名为指定字符集

2 用于源路径的参数

-d, --dirs        不递归目录(不拷贝目录)
-r, --recursive   递归目录拷贝
-R, --relative    使用相对路径名
-l, --links        拷贝软链接为软链接
-L, --copy-links   拷贝软链接指向的文件到目标路径
--exclude=PATTERN  排除匹配的PATTERN文件
--noatime          不修改原文件atime时间

3 用于目标路径的参数

--partial             保留部分文件,用于断点续传
--partial-dir=DIR       断点续传文件放到这个目录
-b, --backup          对于目标路径已经存在有同样的文件名时,将老的文件默认重新命名为~filename。可以使用--suffix选项来指定不同的备份文件前缀 (see --suffix & --backup-dir)
-u, --update          如果目标文件更新一些,则跳过
--delay-updates       传输结束时再更新目标文件
-T, --temp-dir=DIR    在这个目录下创建临时文件
--ignore-existing     如果目标文件已存在,则跳过
--existing            如果目标文件不存在,则跳过,不创建新文件
-I, --ignore-times    不跳过任何文件,哪怕文件大小及修改时间都相同
--size-only             仅跳过文件大小一样的
--remove-source-files 拷贝完后,删除源文件 (non-dirs)
--delete              删除目标路径中无关的文件(即源路径中不存在的文件)
--force                 强制删除目标路径中无关的目录(哪怕目录不为空)
-k, --copy-dirlinks   将目标路径上指向目录的符号链接转换为引用目录
-K, --keep-dirlinks   将目标路径上的符号链接的目录视为目录
-p, --perms           保留权限
-A, --acls            保留ACL(包含--perms)
-E, --executability   保留可执行权限
-X, --xattrs          保留扩展属性
--chmod=CHMOD         修改目标文件及目录的权限为这个
-o, --owner           保留owner(super-user only)
-g, --group           保留group
-t, --times           保留修改时间

常见的用法


## 保留修改时间
rsync  -r -P -v -t    /SRC/a.txt  /DEST/
## 保留可执行权限
rsync  -r -P -v -t -E    /SRC/a.txt  /DEST/
## 保留备份(默认重新命名为~filename)
rsync  -r -P -v -t -E -b    /SRC/a.txt  /DEST/
## 排除匹配的PATTERN文件
rsync  -r -P -v -t -E -b --exclude=PATTERN    /SRC/a.txt  /DEST/

常用参数用法举例

1 -r 参数


$ rsync -r source destination

上面命令中,-r表示递归,即包含子目录。注意,-r是必须的,否则 rsync 运行不会成功。source目录表示源目录,destination表示目标目录。

如果有多个文件或目录需要同步,可以写成下面这样。


$ rsync -r source1 source2 destination

上面命令中,source1source2都会被同步到destination目录。

2 -a 参数

-a参数可以替代-r,除了可以递归同步以外,还可以同步元信息(比如修改时间、权限等)。由于 rsync 默认使用文件大小和修改时间决定文件是否需要更新,所以-a-r更有用。下面的用法才是常见的写法。


$ rsync -a source destination

目标目录destination如果不存在,rsync 会自动创建。执行上面的命令后,源目录source被完整地复制到了目标目录destination下面,即形成了destination/source的目录结构。

如果只想同步源目录source里面的内容到目标目录destination,则需要在源目录后面加上斜杠。


$ rsync -a source/ destination

上面命令执行后,source目录里面的内容,就都被复制到了destination目录里面,并不会在destination下面创建一个source子目录。

3 -n 参数

如果不确定 rsync 执行后会产生什么结果,可以先用-n--dry-run参数模拟执行的结果。


$ rsync -anv source/ destination

上面命令中,-n参数模拟命令执行的结果,并不真的执行命令。-v参数则是将结果输出到终端,这样就可以看到哪些内容会被同步。

4 --delete 参数

默认情况下,rsync 只确保源目录的所有内容(明确排除的文件除外)都复制到目标目录。它不会使两个目录保持相同,并且不会删除文件。如果要使得目标目录成为源目录的镜像副本,则必须使用--delete参数,这将删除只存在于目标目录、不存在于源目录的文件。


$ rsync -av --delete source/ destination

上面命令中,--delete参数会使得destination成为source的一个镜像。

排除文件

1 --exclude 参数

有时,我们希望同步时排除某些文件或目录,这时可以用--exclude参数指定排除模式。


$ rsync -av --exclude='*.txt' source/ destination
# 或者
$ rsync -av --exclude '*.txt' source/ destination

上面命令排除了所有 TXT 文件。

注意,rsync 会同步以"点"开头的隐藏文件,如果要排除隐藏文件,可以这样写--exclude=".*"

如果要排除某个目录里面的所有文件,但不希望排除目录本身,可以写成下面这样。


$ rsync -av --exclude 'dir1/*' source/ destination

多个排除模式,可以用多个--exclude参数。


$ rsync -av --exclude 'file1.txt' --exclude 'dir1/*' source/ destination

多个排除模式也可以利用 Bash 的大扩号的扩展功能,只用一个--exclude参数。


$ rsync -av --exclude={'file1.txt','dir1/*'} source/ destination

如果排除模式很多,可以将它们写入一个文件,每个模式一行,然后用--exclude-from参数指定这个文件。


$ rsync -av --exclude-from='exclude-file.txt' source/ destination

2 --include 参数

--include参数用来指定必须同步的文件模式,往往与--exclude结合使用。


$ rsync -av --include="*.txt" --exclude='*' source/ destination

上面命令指定同步时,排除所有文件,但是会包括 TXT 文件。

远程同步

rsync 除了支持本地两个目录之间的同步,也支持远程同步。它可以将本地内容,同步到远程服务器。


$ rsync -av source/ username@remote_host:destination

也可以将远程内容同步到本地。


$ rsync -av username@remote_host:source/ destination

rsync 默认使用 SSH 进行远程登录和数据传输。

由于早期 rsync 不使用 SSH 协议,需要用-e参数指定协议,后来才改的。所以,下面-e ssh可以省略。


$ rsync -av -e ssh source/ user@remote_host:/destination

但是,如果 ssh 命令有附加的参数,则必须使用-e参数指定所要执行的 SSH 命令。


$ rsync -av -e 'ssh -p 2234' source/ user@remote_host:/destination

上面命令中,-e参数指定 SSH 使用2234端口。

rsync 参数一览表

-a--archive参数表示存档模式,保存所有的元数据,比如修改时间(modification time)、权限、所有者等,并且软链接也会同步过去。

--append参数指定文件接着上次中断的地方,继续传输。

--append-verify参数跟--append参数类似,但会对传输完成后的文件进行一次校验。如果校验失败,将重新发送整个文件。

-b--backup参数指定在删除或更新目标目录已经存在的文件时,将该文件更名后进行备份,默认行为是删除。更名规则是添加由--suffix参数指定的文件后缀名,默认是~

--backup-dir参数指定文件备份时存放的目录,比如--backup-dir=/path/to/backups

--bwlimit参数指定带宽限制,默认单位是 KB/s,比如--bwlimit=100

-c--checksum参数改变rsync的校验方式。默认情况下,rsync 只检查文件的大小和最后修改日期是否发生变化,如果发生变化,就重新传输;使用这个参数以后,则通过判断文件内容的校验和,决定是否重新传输。

--delete参数删除只存在于目标目录、不存在于源目标的文件,即保证目标目录是源目标的镜像。

-e参数指定使用 SSH 协议传输数据。

--exclude参数指定排除不进行同步的文件,比如--exclude="*.iso"

--exclude-from参数指定一个本地文件,里面是需要排除的文件模式,每个模式一行。

--existing--ignore-non-existing参数表示不同步目标目录中不存在的文件和目录。

-h参数表示以人类可读的格式输出。

-h--help参数返回帮助信息。

-i参数表示输出源目录与目标目录之间文件差异的详细情况。

--ignore-existing参数表示只要该文件在目标目录中已经存在,就跳过去,不再同步这些文件。

--include参数指定同步时要包括的文件,一般与--exclude结合使用。

--link-dest参数指定增量备份的基准目录。

-m参数指定不同步空目录。

--max-size参数设置传输的最大文件的大小限制,比如不超过200KB(--max-size='200k')。

--min-size参数设置传输的最小文件的大小限制,比如不小于10KB(--min-size=10k)。

-n参数或--dry-run参数模拟将要执行的操作,而并不真的执行。配合-v参数使用,可以看到哪些内容会被同步过去。

-P参数是--progress--partial这两个参数的结合。

--partial参数允许恢复中断的传输。不使用该参数时,rsync会删除传输到一半被打断的文件;使用该参数后,传输到一半的文件也会同步到目标目录,下次同步时再恢复中断的传输。一般需要与--append--append-verify配合使用。

--partial-dir参数指定将传输到一半的文件保存到一个临时目录,比如--partial-dir=.rsync-partial。一般需要与--append--append-verify配合使用。

--progress参数表示显示进展。

-r参数表示递归,即包含子目录。

--remove-source-files参数表示传输成功后,删除发送方的文件。

--size-only参数表示只同步大小有变化的文件,不考虑文件修改时间的差异。

--suffix参数指定文件名备份时,对文件名添加的后缀,默认是~

-u--update参数表示同步时跳过目标目录中修改时间更新的文件,即不同步这些有更新的时间戳的文件。

-v参数表示输出细节。-vv表示输出更详细的信息,-vvv表示输出最详细的信息。

--version参数返回 rsync 的版本。

-z参数指定同步时压缩数据。