]> git.ipfire.org Git - thirdparty/git.git/blame - Documentation/git-tag.txt
Documentation: generated cmds-*.txt does not depend on git.txt
[thirdparty/git.git] / Documentation / git-tag.txt
CommitLineData
215a7ad1
JH
1git-tag(1)
2==========
2cf565c5
DG
3
4NAME
5----
79d5b81f 6git-tag - Create or verify a tag object signed with GPG
2cf565c5
DG
7
8
2cf565c5
DG
9SYNOPSIS
10--------
b867c7c2 11[verse]
0bc72abd 12'git-tag' [-a | -s | -u <key-id>] [-f | -d | -v] [-m <msg> | -F <file>]
f79c73ce 13 <name> [<head>]
b867c7c2 14'git-tag' -l [<pattern>]
2cf565c5
DG
15
16DESCRIPTION
17-----------
b867c7c2 18Adds a 'tag' reference in `.git/refs/tags/`
b7e438f9 19
bc162e40
LT
20Unless `-f` is given, the tag must not yet exist in
21`.git/refs/tags/` directory.
b7e438f9 22
bc162e40
LT
23If one of `-a`, `-s`, or `-u <key-id>` is passed, the command
24creates a 'tag' object, and requires the tag message. Unless
25`-m <msg>` is given, an editor is started for the user to type
26in the tag message.
b7e438f9 27
bc162e40 28Otherwise just the SHA1 object name of the commit object is
56b5e946 29written (i.e. a lightweight tag).
bc162e40
LT
30
31A GnuPG signed tag object will be created when `-s` or `-u
32<key-id>` is used. When `-u <key-id>` is not used, the
33committer identity for the current user is used to find the
34GnuPG key for signing.
2cf565c5 35
61f81518
KR
36`-d <tag>` deletes the tag.
37
0bc72abd
SB
38`-v <tag>` verifies the gpg signature of the tag.
39
b867c7c2
JH
40`-l <pattern>` lists tags that match the given pattern (or all
41if no pattern is given).
42
d839091d
NW
43OPTIONS
44-------
45-a::
46 Make an unsigned, annotated tag object
47
48-s::
49 Make a GPG-signed tag, using the default e-mail address's key
50
51-u <key-id>::
52 Make a GPG-signed tag, using the given key
53
54-f::
55 Replace an existing tag with the given name (instead of failing)
56
57-d::
58 Delete an existing tag with the given name
59
0bc72abd
SB
60-v::
61 Verify the gpg signature of given the tag
62
b867c7c2
JH
63-l <pattern>::
64 List tags that match the given pattern (or all if no pattern is given).
65
d839091d
NW
66-m <msg>::
67 Use the given tag message (instead of prompting)
68
f79c73ce
JS
69-F <file>::
70 Take the tag message from the given file. Use '-' to
71 read the message from the standard input.
2cf565c5
DG
72
73Author
74------
3f971fc4
JH
75Written by Linus Torvalds <torvalds@osdl.org>,
76Junio C Hamano <junkio@cox.net> and Chris Wright <chrisw@osdl.org>.
2cf565c5
DG
77
78Documentation
79--------------
80Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
81
82GIT
83---
a7154e91 84Part of the gitlink:git[7] suite