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 [-f] \<tag name\> \<committish\>
  14
  15 bup tag -d [-f] \<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 retrieve 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 # OPTIONS
  35
  36 -d, \--delete
  37 :   delete a tag
  38
  39 -f, \--force
  40 :  Overwrite the named tag even if it already exists. With -f, don't
  41    report a missing tag as an error.
  42
  43 # EXAMPLES
  44
  45     $ bup tag new-puppet-version hostx-backup
  46
  47     $ bup tag
  48     new-puppet-version
  49
  50     $ bup ftp "ls /.tag/new-puppet-version"
  51     files..
  52
  53     $ bup tag -d new-puppet-version
  54
  55 # SEE ALSO
  56
  57 `bup-save`(1), `bup-split`(1), `bup-ftp`(1), `bup-fuse`(1), `bup-web`(1)
  58
  59 # BUP
  60
  61 Part of the `bup`(1) suite.