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