Document an alternate way to achieve the effect of this script
[rsync/rsync.git] / support / mnt-excl
1 #!/usr/bin/perl -w
2 # This script takes a command-line arg of a source directory
3 # that will be passed to rsync, and generates a set of excludes
4 # that will exclude all mount points from the list.  This is
5 # useful if you have "bind" mounts since the --one-file-system
6 # option won't notice the transition to a different spot on
7 # the same disk.  For example:
8 #
9 # mnt-excl /dir | rsync --exclude-from=- ... /dir /dest/
10 # mnt-excl /dir/ | rsync --exclude-from=- ... /dir/ /dest/
11 # ssh host mnt-excl /dir | rsync --exclude-from=- ... host:/dir /dest/
12 #
13 # Imagine that /dir/foo is a mount point: the first invocation of
14 # mnt-excl would have output /dir/foo, while the second would have
15 # output /foo (which are the properly anchored excludes).
16 #
17 # NOTE:  This script expects /proc/mounts to exist, but could be
18 # easily adapted to read /etc/mtab or similar.
19 #
20 # ADDENDUM:  The addition of the --filter option (which has support for
21 # absolute-anchored excludes) has made this script less useful than it
22 # was.  Beginning with 2.6.4, you can achieve the effect of this script
23 # though this command:
24 #
25 # awk '{print $2}' /proc/mounts | rsync -f 'merge,/- -' host:/dir /dest/
26
27 use strict;
28 use Cwd 'abs_path';
29
30 my $file = '/proc/mounts';
31 my $dir = shift || '/';
32 $dir = abs_path($dir);
33 $dir =~ s#([^/]*)$##;
34 my $trailing = $1;
35 $trailing = '' if $trailing eq '.' || !-d "$dir$trailing";
36 $trailing .= '/' if $trailing ne '';
37
38 open(IN, $file) or die "Unable to open $file: $!\n";
39 while (<IN>) {
40     $_ = (split)[1];
41     next unless s#^\Q$dir$trailing\E##o && $_ ne '';
42     print "- /$trailing$_\n";
43 }
44 close IN;