]> git.ipfire.org Git - thirdparty/git.git/blame - Documentation/git-tag.txt
Documentation: push/receive hook references.
[thirdparty/git.git] / Documentation / git-tag.txt
CommitLineData
215a7ad1
JH
1git-tag(1)
2==========
2cf565c5
DG
3
4NAME
5----
215a7ad1 6git-tag - Create a tag object signed with GPG
2cf565c5
DG
7
8
2cf565c5
DG
9SYNOPSIS
10--------
61f81518 11'git-tag' [-a | -s | -u <key-id>] [-f | -d] [-m <msg>] <name> [<head>]
2cf565c5 12
56b5e946 13OPTIONS
14-------
15-a::
16 Make an unsigned, annotated tag object
17
18-s::
19 Make a GPG-signed tag, using the default e-mail address's key
20
21-u <key-id>::
22 Make a GPG-signed tag, using the given key
23
24-f::
25 Replace an existing tag with the given name (instead of failing)
26
27-d::
28 Delete an existing tag with the given name
29
30-m <msg>::
31 Use the given tag message (instead of prompting)
32
2cf565c5
DG
33DESCRIPTION
34-----------
bc162e40 35Adds a 'tag' reference in .git/refs/tags/
b7e438f9 36
bc162e40
LT
37Unless `-f` is given, the tag must not yet exist in
38`.git/refs/tags/` directory.
b7e438f9 39
bc162e40
LT
40If one of `-a`, `-s`, or `-u <key-id>` is passed, the command
41creates a 'tag' object, and requires the tag message. Unless
42`-m <msg>` is given, an editor is started for the user to type
43in the tag message.
b7e438f9 44
bc162e40 45Otherwise just the SHA1 object name of the commit object is
56b5e946 46written (i.e. a lightweight tag).
bc162e40
LT
47
48A GnuPG signed tag object will be created when `-s` or `-u
49<key-id>` is used. When `-u <key-id>` is not used, the
50committer identity for the current user is used to find the
51GnuPG key for signing.
2cf565c5 52
61f81518
KR
53`-d <tag>` deletes the tag.
54
2cf565c5
DG
55
56Author
57------
3f971fc4
JH
58Written by Linus Torvalds <torvalds@osdl.org>,
59Junio C Hamano <junkio@cox.net> and Chris Wright <chrisw@osdl.org>.
2cf565c5
DG
60
61Documentation
62--------------
63Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
64
65GIT
66---
a7154e91 67Part of the gitlink:git[7] suite