Documentation/bup-join.md

   1 % bup-join(1) Bup %BUP_VERSION%
   2 % Avery Pennarun <apenwarr@gmail.com>
   3 % %BUP_DATE%
   4
   5 # NAME
   6
   7 bup-join - concatenate files from a bup repository
   8
   9 # SYNOPSIS
  10
  11 bup join [-r *host*:*path*] [refs or hashes...]
  12
  13 # DESCRIPTION
  14
  15 `bup join` is roughly the opposite operation to
  16 `bup-split`(1).  You can use it to retrieve the contents of
  17 a file from a local or remote bup repository.
  18
  19 The supplied list of refs or hashes can be in any format
  20 accepted by `git`(1), including branch names, commit ids,
  21 tree ids, or blob ids.
  22
  23 If no refs or hashes are given on the command line, `bup
  24 join` reads them from stdin instead.
  25
  26 # OPTIONS
  27
  28 -r, \--remote=*host*:*path*
  29 :   Retrieves objects from the given remote repository
  30     instead of the local one. *path* may be blank, in which
  31     case the default remote repository is used.  The connection to the
  32     remote server is made with SSH.  If you'd like to specify which port, user
  33     or private key to use for the SSH connection, we recommend you use the
  34     `~/.ssh/config` file.
  35
  36
  37 # EXAMPLE
  38
  39     # split and then rejoin a file using its tree id
  40     TREE=$(tar -cvf - /etc | bup split -t)
  41     bup join $TREE | tar -tf -
  42
  43     # make two backups, then get the second-most-recent.
  44     # mybackup~1 is git(1) notation for the second most
  45     # recent commit on the branch named mybackup.
  46     tar -cvf - /etc | bup split -n mybackup
  47     tar -cvf - /etc | bup split -n mybackup
  48     bup join mybackup~1 | tar -tf -
  49
  50 # SEE ALSO
  51
  52 `bup-split`(1), `bup-save`(1), `bup-cat-file`, `ssh_config`(5)
  53
  54 # BUP
  55
  56 Part of the `bup`(1) suite.