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 instead of the
  30     local one. *path* may be blank, in which case the default remote
  31     repository is used.  The connection to the remote server is made
  32     with SSH.  If you'd like to specify which port, user or private
  33     key to use for the SSH connection, we recommend you use the
  34     `~/.ssh/config` file.  Even though the data source is remote, a
  35     local bup repository is still required.
  36
  37 # EXAMPLES
  38     # split and then rejoin a file using its tree id
  39     TREE=$(tar -cvf - /etc | bup split -t)
  40     bup join $TREE | tar -tf -
  41
  42     # make two backups, then get the second-most-recent.
  43     # mybackup~1 is git(1) notation for the second most
  44     # recent commit on the branch named mybackup.
  45     tar -cvf - /etc | bup split -n mybackup
  46     tar -cvf - /etc | bup split -n mybackup
  47     bup join mybackup~1 | tar -tf -
  48
  49 # SEE ALSO
  50
  51 `bup-split`(1), `bup-save`(1), `bup-cat-file`, `ssh_config`(5)
  52
  53 # BUP
  54
  55 Part of the `bup`(1) suite.