Documentation/bup-save.md

   1 % bup-save(1) Bup %BUP_VERSION%
   2 % Avery Pennarun <apenwarr@gmail.com>
   3 % %BUP_DATE%
   4
   5 # NAME
   6
   7 bup-save - create a new bup backup set
   8
   9 # SYNOPSIS
  10
  11 bup save [-r *host*:*path*] <-t|-c|-n *name*> [-v] [-q]
  12   [--smaller=*maxsize*] <paths...>
  13
  14 # DESCRIPTION
  15
  16 `bup save` saves the contents of the given files or paths
  17 into a new backup set and optionally names that backup set.
  18
  19 Before trying to save files using `bup save`, you should
  20 first update the index using `bup index`.  The reasons
  21 for separating the two steps are described in the man page
  22 for `bup-index`(1).
  23
  24 # OPTIONS
  25
  26 -r, --remote=*host*:*path*
  27 :   save the backup set to the given remote server.  If
  28     *path* is omitted, uses the default path on the remote
  29     server (you still need to include the ':')
  30
  31 -t, --tree
  32 :   after creating the backup set, print out the git tree
  33     id of the resulting backup.
  34
  35 -c, --commit
  36 :   after creating the backup set, print out the git commit
  37     id of the resulting backup.
  38
  39 -n, --name=*name*
  40 :   after creating the backup set, create a git branch
  41     named *name* so that the backup can be accessed using
  42     that name.  If *name* already exists, the new backup
  43     will be considered a descendant of the old *name*.
  44     (Thus, you can continually create new backup sets with
  45     the same name, and later view the history of that
  46     backup set to see how files have changed over time.)
  47
  48 -v, --verbose
  49 :   increase verbosity (can be used more than once).  With
  50     one -v, prints every directory name as it gets backed up.  With
  51     two -v, also prints every filename.
  52
  53 -q, --quiet
  54 :   disable progress messages.
  55
  56 --smaller=*maxsize*
  57 :   don't back up files >= *maxsize* bytes.  You can use
  58     this to run frequent incremental backups of your small
  59     files, which can usually be backed up quickly, and skip
  60     over large ones (like virtual machine images) which
  61     take longer.  Then you can back up the large files
  62     less frequently.  Use a suffix like k, M, or G to
  63     specify multiples of 1024, 1024*1024, 1024*1024*1024
  64     respectively.
  65
  66 --bwlimit=*bytes/sec*
  67 :   don't transmit more than *bytes/sec* bytes per second
  68     to the server.  This is good for making your backups
  69     not suck up all your network bandwidth.  Use a suffix
  70     like k, M, or G to specify multiples of 1024,
  71     1024*1024, 1024*1024*1024 respectively.
  72
  73
  74 # EXAMPLE
  75
  76     $ bup index -ux /etc
  77     Indexing: 1981, done.
  78
  79     $ bup save -r myserver: -n my-pc-backup --bwlimit=50k /etc
  80     Reading index: 1981, done.
  81     Saving: 100.00% (998/998k, 1981/1981 files), done.
  82
  83
  84 # SEE ALSO
  85
  86 `bup-index`(1), `bup-split`(1), `bup-on`(1),
  87 `bup-restore`(1)
  88
  89 # BUP
  90
  91 Part of the `bup`(1) suite.