Linux rsync 使用指南

# source_child1 -> destination_parent/source_child1
# source_child2 -> destination_parent/source_child2

# -a will keep permissions,etc, and -h will be human readable. 
# -z 参数指定同步时压缩数据
# --progress2 which shows the overall percentage
# -P参数是--progress和--partial这两个参数的结合。--progress参数表示显示进展 --partial参数允许恢复中断的传输

rsync -ah --info=progress2 source/ dest   # source == dest

rsync -ahzP --delete source_child1 source_child2 dest_parent  # source_child1 => dest_parent/source_child1

rsync -ahzP -e 'ssh -p 22222' source_child user@remote_host:/destination_parent

# 传输的双方都必须安装 rsync
apt install rsync

# -r表示递归，即包含子目录。注意，-r是必须的，否则 rsync 运行不会成功。
# source目录表示源目录，destination表示目标目录。上面命令执行以后，目标目录下就会出现destination/source这个子目录
rsync -r source destination

# source1、source2都会被同步到destination/目录
rsync -r source1 source2 destination

# -a参数可以替代-r，除了可以递归同步以外，还可以同步元信息（比如修改时间、权限等）。由于 rsync 默认使用文件大小和修改时间决定文件是否需要更新，所以-a比-r更有用。下面的用法才是常见的写法。
# 目标目录destination如果不存在，rsync 会自动创建。执行上面的命令后，源目录source被完整地复制到了目标目录destination下面，即形成了destination/source的目录结构
rsync -a source destination

# 如果只想同步源目录source里面的内容到目标目录destination，则需要在源目录后面加上斜杠。
# source目录里面的内容，就都被复制到了destination目录里面，并不会在destination下面创建一个source子目录
rsync -a source/ destination

# -n或--dry-run参数模拟执行的结果
# -n参数模拟命令执行的结果，并不真的执行命令。
# verbose, -v参数则是将结果输出到终端，这样就可以看到哪些内容会被同步 
rsync -anv source/ destination

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

# 同步时排除某些文件或目录
### 排除了所有 TXT 文件
rsync -av --exclude '*.txt' source/ destination
### 如果要排除某个目录里面的所有文件，但不希望排除目录本身，可以写成下面这样
rsync -av --exclude 'dir1/*' source/ destination
### 排除多个文件
rsync -av --exclude 'file1.txt' --exclude 'dir1/*' source/ destination
rsync -av --exclude={'file1.txt','dir1/*'} source/ destination
### 如果排除模式很多，可以将它们写入一个文件，每个模式一行，然后用--exclude-from参数指定这个文件
rsync -av --exclude-from='exclude-file.txt' source/ destination

# --include参数用来指定必须同步的文件模式，往往与--exclude结合使用
### 指定同步时，排除所有文件，但是会包括 TXT 文件。
rsync -av --include="*.txt" --exclude='*' source/ destination


# rsync 除了支持本地两个目录之间的同步，也支持远程同步。它可以将本地内容，同步到远程服务器。
rsync -av source/ username@remote_host:destination
rsync -av username@remote_host:source/ destination

# 由于早期 rsync 不使用 SSH 协议，需要用-e参数指定协议，后来才改的。所以，下面-e ssh可以省略
# 如果 ssh 命令有附加的参数，则必须使用-e参数指定所要执行的 SSH 命令
rsync -av -e 'ssh -p 22222' source/ user@remote_host:/destination

# 地址中的module并不是实际路径名，而是 rsync 守护程序指定的一个资源名，由管理员分配
rsync -av source/ 10.0.0.99::module/destination
# 如果想知道 rsync 守护程序分配的所有 module 列表，可以执行下面命令。
rsync rsync://10.0.0.99

rsync -a --delete --link-dest /compare/path /source/path /target/path

#!/bin/bash
# A script to perform incremental backups using rsync

###
# 每一次同步都会生成一个新目录${BACKUP_DIR}/${DATETIME}，并将软链接${BACKUP_DIR}/latest指向这个目录。
# 下一次备份时，就将${BACKUP_DIR}/latest作为基准目录，生成新的备份目录。
# 最后，再将软链接${BACKUP_DIR}/latest指向新的备份目录。
### 

set -o errexit
set -o nounset
set -o pipefail

readonly SOURCE_DIR="${HOME}"
readonly BACKUP_DIR="/mnt/data/backups"
readonly DATETIME="$(date '+%Y-%m-%d_%H:%M:%S')"
readonly BACKUP_PATH="${BACKUP_DIR}/${DATETIME}"
readonly LATEST_LINK="${BACKUP_DIR}/latest"

mkdir -p "${BACKUP_DIR}"

rsync -av --delete \
  "${SOURCE_DIR}/" \
  --link-dest "${LATEST_LINK}" \
  --exclude=".cache" \
  "${BACKUP_PATH}"

rm -rf "${LATEST_LINK}"
ln -s "${BACKUP_PATH}" "${LATEST_LINK}"

# rsync - can add multiple sources
*/30 * * * * shared_folder="/Volumes/Akitio24TRaid0/__Cloud/_QDrive/_qhdrive_tmp_screenshot/__syncthing/_shared"; mkdir $shared_folder/$(hostname); rsync -azP --delete ~/__run $shared_folder/$(hostname) 2>&1 >>~/cron_output.log

-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参数指定同步时压缩数据