Autogenerated man pages for v1.3.0-rc3-gd53352
[git.git] / man1 / git-tag.1
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "GIT-TAG" 1 "" "" ""
21 .SH NAME
22 git-tag \- Create a tag object signed with GPG
23 .SH "SYNOPSIS"
24
25 .nf
26 \fIgit\-tag\fR [\-a | \-s | \-u <key\-id>] [\-f | \-d] [\-m <msg>] <name> [<head>]
27 \fIgit\-tag\fR \-l [<pattern>]
28 .fi
29
30 .SH "DESCRIPTION"
31
32
33 Adds a \fItag\fR reference in \&.git/refs/tags/
34
35
36 Unless \-f is given, the tag must not yet exist in \&.git/refs/tags/ directory\&.
37
38
39 If one of \-a, \-s, or \-u <key\-id> is passed, the command creates a \fItag\fR object, and requires the tag message\&. Unless \-m <msg> is given, an editor is started for the user to type in the tag message\&.
40
41
42 Otherwise just the SHA1 object name of the commit object is written (i\&.e\&. a lightweight tag)\&.
43
44
45 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\&.
46
47
48 \-d <tag> deletes the tag\&.
49
50
51 \-l <pattern> lists tags that match the given pattern (or all if no pattern is given)\&.
52
53 .SH "OPTIONS"
54
55 .TP
56 \-a
57 Make an unsigned, annotated tag object
58
59 .TP
60 \-s
61 Make a GPG\-signed tag, using the default e\-mail address's key
62
63 .TP
64 \-u <key\-id>
65 Make a GPG\-signed tag, using the given key
66
67 .TP
68 \-f
69 Replace an existing tag with the given name (instead of failing)
70
71 .TP
72 \-d
73 Delete an existing tag with the given name
74
75 .TP
76 \-l <pattern>
77 List tags that match the given pattern (or all if no pattern is given)\&.
78
79 .TP
80 \-m <msg>
81 Use the given tag message (instead of prompting)
82
83 .SH "AUTHOR"
84
85
86 Written by Linus Torvalds <torvalds@osdl\&.org>, Junio C Hamano <junkio@cox\&.net> and Chris Wright <chrisw@osdl\&.org>\&.
87
88 .SH "DOCUMENTATION"
89
90
91 Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
92
93 .SH "GIT"
94
95
96 Part of the \fBgit\fR(7) suite
97