git-tag: update usage string and documentation.
[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] [-f] [-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 ".git/refs/tags"
18
19 If "-s" or "-a" is passed, the user will be prompted for a tag message.
20 and a tag object is created.  Otherwise just the SHA1 object
21 name of the commit object is written.
22
23 A GnuPG signed tag object will be created when "-s" is used.
24
25
26 Author
27 ------
28 Written by Linus Torvalds <torvalds@osdl.org>,
29 Junio C Hamano <junkio@cox.net> and Chris Wright <chrisw@osdl.org>.
30
31 Documentation
32 --------------
33 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
34
35 GIT
36 ---
37 Part of the gitlink:git[7] suite