Documentation/bup-tag.md

   1 % bup-tag(1) Bup %BUP_VERSION%
   2 % Gabriel Filion <lelutin@gmail.com>
   3 % %BUP_DATE%
   4
   5 # NAME
   6
   7 bup-tag - tag a commit in the bup repository
   8
   9 # SYNOPSIS
  10
  11 bup tag
  12
  13 bup tag \<tag name\> \<committish\>
  14
  15 bup tag -d \<tag name\>
  16
  17 # DESCRIPTION
  18
  19 `bup tag` lists, creates or deletes a tag in the bup repository.
  20
  21 A tag is an easy way to retreive a specific commit. It can be used to mark a
  22 specific backup for easier retrieval later.
  23
  24 When called without any arguments, the command lists all tags that can
  25 be found in the repository. When called with a tag name and a commit ID
  26 or ref name, it creates a new tag with the given name, if it doesn't
  27 already exist, that points to the commit given in the second argument. When
  28 called with '-d' and a tag name, it removes the given tag, if it exists.
  29
  30 bup exposes the contents of backups with current tags, via any command that
  31 lists or shows backups. They can be found under the /.tag directory.  For
  32 example, the 'ftp' command will show the tag named 'tag1' under /.tag/tag1.
  33
  34 Tags are also exposed under the branches from which they can be reached. For
  35 example, if you create a tag named 'important' under branch 'computerX', you
  36 will also be able to retrieve the contents of the backup that was tagged under
  37 /computerX/important. This is done as a convenience, and should the branch
  38 'computerX' be deleted, the contents of the tagged backup will be available
  39 through /.tag/important as long as the tag is not deleted.
  40
  41 # OPTIONS
  42
  43 -d, --delete
  44 :   delete a tag
  45
  46 # EXAMPLE
  47
  48     $ bup tag new-puppet-version hostx-backup
  49
  50     $ bup tag
  51     new-puppet-version
  52
  53     $ bup ftp "ls /.tag/new-puppet-version"
  54     files..
  55
  56     $ bup tag -d new-puppet-version
  57
  58 # SEE ALSO
  59
  60 `bup-save`(1), `bup-split`(1), `bup-ftp`(1), `bup-fuse`(1), `bup-web`(1)
  61
  62 # BUP
  63
  64 Part of the `bup`(1) suite.