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 [verse]
  12 'git-tag' [-a | -s | -u <key-id>] [-f | -d] [-m <msg>] <name> [<head>]
  13 'git-tag' -l [<pattern>]
  14
  15 DESCRIPTION
  16 -----------
  17 Adds a 'tag' reference in `.git/refs/tags/`
  18
  19 Unless `-f` is given, the tag must not yet exist in
  20 `.git/refs/tags/` directory.
  21
  22 If one of `-a`, `-s`, or `-u <key-id>` is passed, the command
  23 creates a 'tag' object, and requires the tag message.  Unless
  24 `-m <msg>` is given, an editor is started for the user to type
  25 in the tag message.
  26
  27 Otherwise just the SHA1 object name of the commit object is
  28 written (i.e. a lightweight tag).
  29
  30 A GnuPG signed tag object will be created when `-s` or `-u
  31 <key-id>` is used.  When `-u <key-id>` is not used, the
  32 committer identity for the current user is used to find the
  33 GnuPG key for signing.
  34
  35 `-d <tag>` deletes the tag.
  36
  37 `-l <pattern>` lists tags that match the given pattern (or all
  38 if no pattern is given).
  39
  40 OPTIONS
  41 -------
  42 -a::
  43         Make an unsigned, annotated tag object
  44
  45 -s::
  46         Make a GPG-signed tag, using the default e-mail address's key
  47
  48 -u <key-id>::
  49         Make a GPG-signed tag, using the given key
  50
  51 -f::
  52         Replace an existing tag with the given name (instead of failing)
  53
  54 -d::
  55         Delete an existing tag with the given name
  56
  57 -l <pattern>::
  58         List tags that match the given pattern (or all if no pattern is given).
  59
  60 -m <msg>::
  61         Use the given tag message (instead of prompting)
  62
  63
  64 Author
  65 ------
  66 Written by Linus Torvalds <torvalds@osdl.org>,
  67 Junio C Hamano <junkio@cox.net> and Chris Wright <chrisw@osdl.org>.
  68
  69 Documentation
  70 --------------
  71 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
  72
  73 GIT
  74 ---
  75 Part of the gitlink:git[7] suite