`bup save` saves the contents of the given files or paths
into a new backup set and optionally names that backup set.
+Note that in order to refer to your backup set later (i.e. for
+restoration), you must either specify `--name` (the normal case), or
+record the tree or commit id printed by `--tree` or `--commit`.
+
Before trying to save files using `bup save`, you should
first update the index using `bup index`. The reasons
for separating the two steps are described in the man page
for `bup-index`(1).
+By default, metadata will be saved for every path, and the metadata
+for any unindexed parent directories of indexed paths will be taken
+directly from the filesystem. However, if `--strip`, `--strip-path`,
+or `--graft` is specified, metadata will not be saved for the root
+directory (*/*). See `bup-restore`(1) for more information about the
+handling of metadata.
+
# OPTIONS
-r, \--remote=*host*:*path*
-f, \--indexfile=*indexfile*
: use a different index filename instead of
- `~/.bup/bupindex`.
+ `$BUP_DIR/bupindex`.
-v, \--verbose
: increase verbosity (can be used more than once). With
\--strip
: strips the path that is given from all files and directories.
- A directory */root/chroot/etc* saved with
- "bup save -n chroot \--strip /root/chroot" would be saved
- as */etc*.
+ A directory */root/chroot/etc* saved with "bup save -n chroot
+ \--strip /root/chroot" would be saved as */etc*. Note that
+ currently, metadata will not be saved for the root directory (*/*)
+ when this option is specified.
\--strip-path=*path-prefix*
: strips the given path prefix *path-prefix* from all
files and directories.
- A directory */root/chroots/webserver* saved with
- "bup save -n webserver \--strip-path=/root/chroots" would
- be saved as */webserver/etc*
+ A directory */root/chroot/webserver* saved with "bup save -n
+ webserver \--strip-path=/root/chroot" would be saved as
+ */webserver/etc*. Note that currently, metadata will not be saved
+ for the root directory (*/*) when this option is specified.
\--graft=*old_path*=*new_path*
: a graft point *old_path*=*new_path* (can be used more than
once).
- A directory */root/chroot/a/etc* saved with
- "bup save -n chroots \--graft /root/chroot/a/etc=/chroots/a"
- would be saved as */chroots/a/etc*
+ A directory */root/chroot/a/etc* saved with "bup save -n chroot
+ \--graft /root/chroot/a=/chroot/a" would be saved as
+ */chroot/a/etc*. Note that currently, metadata will not be saved
+ for the root directory (*/*) when this option is specified.
-*#*, \--compress=*#*
: set the compression level to # (a value from 0-9, where
is 1 (fast, loose compression)
-# EXAMPLE
-
+# EXAMPLES
$ bup index -ux /etc
Indexing: 1981, done.
- $ ls /home/joe/chroots/httpd
+ $ ls /home/joe/chroot/httpd
bin var
- $ bup index -ux /home/joe/chroots/httpd
+ $ bup index -ux /home/joe/chroot/httpd
Indexing: 1337, done.
- $ bup save --strip -n joes-httpd-chroot /home/joe/chroots/httpd
+ $ bup save --strip -n joes-httpd-chroot /home/joe/chroot/httpd
Reading index: 1337, done.
Saving: 100.00% (998/998k, 1337/1337 files), done.
var/
- $ bup save --strip-prefix=/home/joe/chroots -n joes-chroots \
- /home/joe/chroots/httpd
+ $ bup save --strip-path=/home/joe/chroot -n joes-chroot \
+ /home/joe/chroot/httpd
Reading index: 1337, done.
Saving: 100.00% (998/998k, 1337/1337 files), done.
- $ bup ls joes-chroots/latest/
+ $ bup ls joes-chroot/latest/
httpd/
- $ bup save --graft /home/joe/chroots/httpd=/http-chroot \
+ $ bup save --graft /home/joe/chroot/httpd=/http-chroot \
-n joe
- /home/joe/chroots/httpd
+ /home/joe/chroot/httpd
Reading index: 1337, done.
Saving: 100.00% (998/998k, 1337/1337 files), done.