]> arthur.barton.de Git - bup.git/blobdiff - Documentation/bup-tag.md
Adjust rm-cmd and bup.rm for python 3 and enable test-rm
[bup.git] / Documentation / bup-tag.md
index 25339b228eb8104e694e32f49ba7ec9edf555f07..49416a4502ed1484f81c0383fd37f362f8ee041b 100644 (file)
@@ -10,15 +10,15 @@ bup-tag - tag a commit in the bup repository
 
 bup tag
 
-bup tag \<tag name\> \<committish\>
+bup tag [-f] \<tag name\> \<committish\>
 
-bup tag -d \<tag name\>
+bup tag -d [-f] \<tag name\>
 
 # DESCRIPTION
 
 `bup tag` lists, creates or deletes a tag in the bup repository.
 
-A tag is an easy way to retreive a specific commit. It can be used to mark a
+A tag is an easy way to retrieve a specific commit. It can be used to mark a
 specific backup for easier retrieval later.
 
 When called without any arguments, the command lists all tags that can
@@ -31,20 +31,17 @@ bup exposes the contents of backups with current tags, via any command that
 lists or shows backups. They can be found under the /.tag directory.  For
 example, the 'ftp' command will show the tag named 'tag1' under /.tag/tag1.
 
-Tags are also exposed under the branches from which they can be reached. For
-example, if you create a tag named 'important' under branch 'computerX', you
-will also be able to retrieve the contents of the backup that was tagged under
-/computerX/important. This is done as a convenience, and should the branch
-'computerX' be deleted, the contents of the tagged backup will be available
-through /.tag/important as long as the tag is not deleted.
-
 # OPTIONS
 
 -d, \--delete
 :   delete a tag
 
-# EXAMPLE
-    
+-f, \--force
+:  Overwrite the named tag even if it already exists. With -f, don't
+   report a missing tag as an error.
+
+# EXAMPLES
+
     $ bup tag new-puppet-version hostx-backup
     
     $ bup tag