Difference between revisions of "Rsync"

From ArchWiki
Jump to: navigation, search
m (lowercase title)
(turned the "See also" at the bottom into an article summary, fixed the titles and applied some formatting)
Line 4: Line 4:
 
[[Category:System recovery]]
 
[[Category:System recovery]]
 
[[zh-CN:Rsync]]
 
[[zh-CN:Rsync]]
 +
{{Article summary start}}
 +
{{Article summary text|Instructions on using rsync.}}
 +
{{Article summary heading|Related}}
 +
{{Article summary wiki|Full System Backup with rsync}}
 +
{{Article summary wiki|Backup Programs}}
 +
{{Article summary end}}
 +
 
[http://samba.anu.edu.au/rsync/ rsync] is an open source utility that provides fast incremental file transfer.
 
[http://samba.anu.edu.au/rsync/ rsync] is an open source utility that provides fast incremental file transfer.
  
==Installation==
+
== Installation ==
 +
 
 
Install the {{Pkg|rsync}} package using [[pacman]]:
 
Install the {{Pkg|rsync}} package using [[pacman]]:
 +
 
  # pacman -S rsync
 
  # pacman -S rsync
  
==Usage==
+
== Usage ==
 +
 
 
For more examples, search the [http://bbs.archlinux.org/viewforum.php?id=27 Community Contributions] and [http://bbs.archlinux.org/viewforum.php?id=33 General Programming] forums.
 
For more examples, search the [http://bbs.archlinux.org/viewforum.php?id=27 Community Contributions] and [http://bbs.archlinux.org/viewforum.php?id=33 General Programming] forums.
  
===As a cp alternative===
+
=== As a cp alternative ===
rsync can be used as an advanced cp alternative, especially for copying larger files:
+
 
  $ rsync -P src dest
+
rsync can be used as an advanced alternative for the {{ic|cp}} command, especially for copying larger files:
 +
 
 +
  $ rsync -P source destination
  
 
The {{Ic|-P}} option is the same as {{Ic|--partial --progress}}, which keeps partially transferred files and shows a progress bar during transfer.
 
The {{Ic|-P}} option is the same as {{Ic|--partial --progress}}, which keeps partially transferred files and shows a progress bar during transfer.
Line 21: Line 33:
 
You may want to use the {{Ic|-r --recursive}} option to recurse into directories, or the {{Ic|-R}} option for using relative path names (recreating entire folder hierarchy on the destination folder).
 
You may want to use the {{Ic|-r --recursive}} option to recurse into directories, or the {{Ic|-R}} option for using relative path names (recreating entire folder hierarchy on the destination folder).
  
===As a backup utility===
+
=== As a backup utility ===
 +
 
 
The rsync protocol can easily be used for backups, only transferring files that have changed since the last backup. This section describes a very simple scheduled backup script using rsync, typically used for copying to removable media. For a more thorough example, see [[Full System Backup with rsync]].
 
The rsync protocol can easily be used for backups, only transferring files that have changed since the last backup. This section describes a very simple scheduled backup script using rsync, typically used for copying to removable media. For a more thorough example, see [[Full System Backup with rsync]].
  
====Automated backup====
+
==== Automated backup ====
 +
 
 
For the sake of this example, the script is created in the {{ic|/etc/cron.daily}} directory, and will be run on a daily basis if a cron [[daemon]] is installed and properly configured. Configuring and using [[cron]] is outside the scope of this article.
 
For the sake of this example, the script is created in the {{ic|/etc/cron.daily}} directory, and will be run on a daily basis if a cron [[daemon]] is installed and properly configured. Configuring and using [[cron]] is outside the scope of this article.
  
 
First, create a script containing the appropriate command options:
 
First, create a script containing the appropriate command options:
 +
 
{{hc|/etc/cron.daily/backup|
 
{{hc|/etc/cron.daily/backup|
 
#!/bin/bash
 
#!/bin/bash
Line 38: Line 53:
  
 
Finally, the script must be executable:
 
Finally, the script must be executable:
 +
 
  # chmod +x /etc/cron.daily/rsync.backup
 
  # chmod +x /etc/cron.daily/rsync.backup
  
====Automated backup with SSH====
+
==== Automated backup with SSH ====
 +
 
 
If backing-up to a remote host using [[SSH]], use this script instead:
 
If backing-up to a remote host using [[SSH]], use this script instead:
 +
 
{{hc|/etc/cron.daily/backup|
 
{{hc|/etc/cron.daily/backup|
 
#!/bin/bash
 
#!/bin/bash
Line 50: Line 68:
 
; {{Ic|-a}} : groups all these options {{Ic|-rlptgoD}} (recursive, links, perms, times, group, owner, devices)
 
; {{Ic|-a}} : groups all these options {{Ic|-rlptgoD}} (recursive, links, perms, times, group, owner, devices)
  
====Automated backup with NetworkManager====
+
==== Automated backup with NetworkManager ====
 +
 
 
This script starts a backup when you plugin your wire.
 
This script starts a backup when you plugin your wire.
  
 
First, create a script containing the appropriate command options:
 
First, create a script containing the appropriate command options:
 +
 
{{hc|/etc/NetworkManager/dispatcher.d/backup|2=
 
{{hc|/etc/NetworkManager/dispatcher.d/backup|2=
 
#!/bin/bash
 
#!/bin/bash
Line 65: Line 85:
 
; {{Ic|--bwlimit}} : limit I/O bandwidth; KBytes per second
 
; {{Ic|--bwlimit}} : limit I/O bandwidth; KBytes per second
  
====Differential backup on a week====
+
==== Differential backup on a week ====
 +
 
 
This is a useful option of rsync, creating a full backup and a differential backup for each day of a week.
 
This is a useful option of rsync, creating a full backup and a differential backup for each day of a week.
  
 
First, create a script containing the appropriate command options:
 
First, create a script containing the appropriate command options:
 +
 
{{hc|/etc/cron.daily/backup|2=
 
{{hc|/etc/cron.daily/backup|2=
 
#!/bin/bash
 
#!/bin/bash
Line 82: Line 104:
 
; {{Ic|--inplace}} : implies {{Ic|--partial}} update destination files in-place
 
; {{Ic|--inplace}} : implies {{Ic|--partial}} update destination files in-place
  
====Snapshot backup====
+
==== Snapshot backup ====
 +
 
 
The same idea can be used to maintain a tree of snapshots of your files. In other words, a directory with date-ordered copies of the files. The copies are made using hardlinks, which means that only files that did change will occupy space. Generally speaking, this is the idea behind Apple's TimeMachine.
 
The same idea can be used to maintain a tree of snapshots of your files. In other words, a directory with date-ordered copies of the files. The copies are made using hardlinks, which means that only files that did change will occupy space. Generally speaking, this is the idea behind Apple's TimeMachine.
  
 
This script implements a simple version of it:
 
This script implements a simple version of it:
  
{{hc|/usr/local/bin/rsnapshot.sh|2=<nowiki>
+
{{hc|/usr/local/bin/rsnapshot.sh|<nowiki>
 
#!/bin/bash
 
#!/bin/bash
  
Line 122: Line 145:
 
</nowiki>}}
 
</nowiki>}}
  
To make things really, really simple this script can be run out of /etc/rc.local (this is how i run it myself).
+
To make things really, really simple this script can be run out of {ic|/etc/rc.local}}.
 
+
==See also==
+
 
+
* [[Full System Backup with rsync]]
+
 
+
* [[Backup Programs]]
+

Revision as of 08:52, 12 September 2012

Template:Article summary start Template:Article summary text Template:Article summary heading Template:Article summary wiki Template:Article summary wiki Template:Article summary end

rsync is an open source utility that provides fast incremental file transfer.

Installation

Install the rsync package using pacman:

# pacman -S rsync

Usage

For more examples, search the Community Contributions and General Programming forums.

As a cp alternative

rsync can be used as an advanced alternative for the cp command, especially for copying larger files:

$ rsync -P source destination

The -P option is the same as --partial --progress, which keeps partially transferred files and shows a progress bar during transfer.

You may want to use the -r --recursive option to recurse into directories, or the -R option for using relative path names (recreating entire folder hierarchy on the destination folder).

As a backup utility

The rsync protocol can easily be used for backups, only transferring files that have changed since the last backup. This section describes a very simple scheduled backup script using rsync, typically used for copying to removable media. For a more thorough example, see Full System Backup with rsync.

Automated backup

For the sake of this example, the script is created in the /etc/cron.daily directory, and will be run on a daily basis if a cron daemon is installed and properly configured. Configuring and using cron is outside the scope of this article.

First, create a script containing the appropriate command options:

/etc/cron.daily/backup
#!/bin/bash
rsync -a --delete /folder/to/backup /location/to/backup &> /dev/null
-a 
indicates that files should be archived, meaning that all of their attributes are preserved
--delete 
means files deleted on the source are to be deleted on the backup aswell

Here, /folder/to/backup should be changed to what needs to be backed-up (/home, for example) and /location/to/backup is where the backup should be saved (/media/disk, for instance).

Finally, the script must be executable:

# chmod +x /etc/cron.daily/rsync.backup

Automated backup with SSH

If backing-up to a remote host using SSH, use this script instead:

/etc/cron.daily/backup
#!/bin/bash
rsync -a --delete -e ssh /folder/to/backup remoteuser@remotehost:/location/to/backup &> /dev/null
-e ssh 
tells rsync to use SSH
remoteuser 
is the user on the host remotehost
-a 
groups all these options -rlptgoD (recursive, links, perms, times, group, owner, devices)

Automated backup with NetworkManager

This script starts a backup when you plugin your wire.

First, create a script containing the appropriate command options:

/etc/NetworkManager/dispatcher.d/backup
#!/bin/bash

if [ x"$2" = "xup" ] ; then
  rsync --force --ignore-errors -a --delete --bwlimit=2000 --files-from=files.rsync /folder/to/backup /location/to/backup
fi
-a 
group all this options -rlptgoD recursive, links, perms, times, group, owner, devices
--files-from 
read the relative path of /folder/to/backup from this file
--bwlimit 
limit I/O bandwidth; KBytes per second

Differential backup on a week

This is a useful option of rsync, creating a full backup and a differential backup for each day of a week.

First, create a script containing the appropriate command options:

/etc/cron.daily/backup
#!/bin/bash

DAY=$(date +%A)

if [ -e /location/to/backup/incr/$DAY ] ; then
  rm -fr /location/to/backup/incr/$DAY
fi

rsync -a --delete --inplace --backup --backup-dir=/location/to/backup/incr/$DAY /folder/to/backup/ /location/to/backup/full/ &> /dev/null
--inplace 
implies --partial update destination files in-place

Snapshot backup

The same idea can be used to maintain a tree of snapshots of your files. In other words, a directory with date-ordered copies of the files. The copies are made using hardlinks, which means that only files that did change will occupy space. Generally speaking, this is the idea behind Apple's TimeMachine.

This script implements a simple version of it:

/usr/local/bin/rsnapshot.sh
#!/bin/bash

## my own rsync-based snapshot-style backup procedure
## (cc) marcio rps AT gmail.com

# config vars

SRC="/home/username/files/" #dont forget trailing slash!
SNAP="/snapshots/username"
OPTS="-rltgoi --delay-updates --delete --chmod=a-w"
MINCHANGES=20

# run this process with real low priority

ionice -c 3 -p $$
renice +12  -p $$

# sync

rsync $OPTS $SRC $SNAP/latest >> $SNAP/rsync.log

# check if enough has changed and if so
# make a hardlinked copy named as the date

COUNT=$( wc -l $SNAP/rsync.log|cut -d" " -f1 )
if [ $COUNT -gt $MINCHANGES ] ; then
   DATETAG=$(date +%Y-%m-%d)
   if [ ! -e $SNAP/$DATETAG ] ; then
      cp -al $SNAP/latest $SNAP/$DATETAG
      mv $SNAP/rsync.log $SNAP/$DATETAG
   fi
fi

To make things really, really simple this script can be run out of {ic|/etc/rc.local}}.