git-commit: document --amend
[gitweb.git] / Documentation / git-tag.txt
index 1e0d4f5f46da084d7a956958f85cbff22c10de30..45476c2e415112347372f034276dec367f7a6a8d 100644 (file)
@@ -1,28 +1,64 @@
 git-tag(1)
 ==========
-v0.99.4, Aug 2005
 
 NAME
 ----
-git-tag -  Create a tag object signed with GPG
-
+git-tag - Create a tag object signed with GPG
 
 
 SYNOPSIS
 --------
-'git-tag' [-s | -a] [-f] <name>
+[verse]
+'git-tag' [-a | -s | -u <key-id>] [-f | -d] [-m <msg>] <name> [<head>]
+'git-tag' -l [<pattern>]
 
 DESCRIPTION
 -----------
-Adds a "tag" reference in .git/refs/tags/
+Adds a 'tag' reference in `.git/refs/tags/`
+
+Unless `-f` is given, the tag must not yet exist in
+`.git/refs/tags/` directory.
+
+If one of `-a`, `-s`, or `-u <key-id>` is passed, the command
+creates a 'tag' object, and requires the tag message.  Unless
+`-m <msg>` is given, an editor is started for the user to type
+in the tag message.
+
+Otherwise just the SHA1 object name of the commit object is
+written (i.e. a lightweight tag).
+
+A GnuPG signed tag object will be created when `-s` or `-u
+<key-id>` is used.  When `-u <key-id>` is not used, the
+committer identity for the current user is used to find the
+GnuPG key for signing.
+
+`-d <tag>` deletes the tag.
+
+`-l <pattern>` lists tags that match the given pattern (or all
+if no pattern is given).
+
+OPTIONS
+-------
+-a::
+       Make an unsigned, annotated tag object
+
+-s::
+       Make a GPG-signed tag, using the default e-mail address's key
+
+-u <key-id>::
+       Make a GPG-signed tag, using the given key
+
+-f::
+       Replace an existing tag with the given name (instead of failing)
 
-Unless "-f" is given, the tag must not yet exist in ".git/refs/tags"
+-d::
+       Delete an existing tag with the given name
 
-If "-s" or "-a" is passed, the user will be prompted for a tag message.
-and a tag object is created.  Otherwise just the SHA1 object
-name of the commit object is written.
+-l <pattern>::
+       List tags that match the given pattern (or all if no pattern is given).
 
-A GnuPG signed tag object will be created when "-s" is used.
+-m <msg>::
+       Use the given tag message (instead of prompting)
 
 
 Author