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