Merge http://www.kernel.org/pub/scm/gitk/gitk
[git.git] / Documentation / git-tag.txt
1 git-tag(1)
2 ==========
3
4 NAME
5 ----
6 git-tag -  Create a tag object signed with GPG
7
8
9 SYNOPSIS
10 --------
11 'git-tag' [-a | -s | -u <key-id>] [-f | -d] [-m <msg>] <name> [<head>]
12
13 DESCRIPTION
14 -----------
15 Adds a 'tag' reference in .git/refs/tags/
16
17 Unless `-f` is given, the tag must not yet exist in
18 `.git/refs/tags/` directory.
19
20 If one of `-a`, `-s`, or `-u <key-id>` is passed, the command
21 creates a 'tag' object, and requires the tag message.  Unless
22 `-m <msg>` is given, an editor is started for the user to type
23 in the tag message.
24
25 Otherwise just the SHA1 object name of the commit object is
26 written (i.e. an lightweight tag).
27
28 A GnuPG signed tag object will be created when `-s` or `-u
29 <key-id>` is used.  When `-u <key-id>` is not used, the
30 committer identity for the current user is used to find the
31 GnuPG key for signing.
32
33 `-d <tag>` deletes the tag.
34
35
36 Author
37 ------
38 Written by Linus Torvalds <torvalds@osdl.org>,
39 Junio C Hamano <junkio@cox.net> and Chris Wright <chrisw@osdl.org>.
40
41 Documentation
42 --------------
43 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
44
45 GIT
46 ---
47 Part of the gitlink:git[7] suite