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 OPTIONS
  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
  33 DESCRIPTION
  34 -----------
  35 Adds a 'tag' reference in .git/refs/tags/
  36
  37 Unless `-f` is given, the tag must not yet exist in
  38 `.git/refs/tags/` directory.
  39
  40 If one of `-a`, `-s`, or `-u <key-id>` is passed, the command
  41 creates a 'tag' object, and requires the tag message.  Unless
  42 `-m <msg>` is given, an editor is started for the user to type
  43 in the tag message.
  44
  45 Otherwise just the SHA1 object name of the commit object is
  46 written (i.e. a lightweight tag).
  47
  48 A GnuPG signed tag object will be created when `-s` or `-u
  49 <key-id>` is used.  When `-u <key-id>` is not used, the
  50 committer identity for the current user is used to find the
  51 GnuPG key for signing.
  52
  53 `-d <tag>` deletes the tag.
  54
  55
  56 Author
  57 ------
  58 Written by Linus Torvalds <torvalds@osdl.org>,
  59 Junio C Hamano <junkio@cox.net> and Chris Wright <chrisw@osdl.org>.
  60
  61 Documentation
  62 --------------
  63 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
  64
  65 GIT
  66 ---
  67 Part of the gitlink:git[7] suite