git-svn: dcommit prints out the URL to be committed to
[gitweb.git] / Documentation / git-tag.txt
index 70235e8ddb3e43805d699dd0bf264f585409697e..119117f0bdc689a4da1c1ba4b8ae9a41fd8f05fd 100644 (file)
@@ -9,9 +9,10 @@ git-tag - Create, list, delete or verify a tag object signed with GPG
 SYNOPSIS
 --------
 [verse]
-'git-tag' [-a | -s | -u <key-id>] [-f | -v] [-m <msg> | -F <file>]  <name> [<head>]
+'git-tag' [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>]  <name> [<head>]
 'git-tag' -d <name>...
-'git-tag' -l [<pattern>]
+'git-tag' [-n [<num>]] -l [<pattern>]
+'git-tag' -v <name>...
 
 DESCRIPTION
 -----------
@@ -22,7 +23,7 @@ Unless `-f` is given, the tag must not yet exist in
 
 If one of `-a`, `-s`, or `-u <key-id>` is passed, the command
 creates a 'tag' object, and requires the tag message.  Unless
-`-m <msg>` is given, an editor is started for the user to type
+`-m <msg>` or `-F <file>` is given, an editor is started for the user to type
 in the tag message.
 
 Otherwise just the SHA1 object name of the commit object is
@@ -37,8 +38,8 @@ GnuPG key for signing.
 
 `-v <tag>` verifies the gpg signature of the tag.
 
-`-l <pattern>` lists tags that match the given pattern (or all
-if no pattern is given).
+`-l <pattern>` lists tags with names that match the given pattern
+(or all if no pattern is given).
 
 OPTIONS
 -------
@@ -58,10 +59,17 @@ OPTIONS
        Delete existing tags with the given names.
 
 -v::
-       Verify the gpg signature of given the tag
+       Verify the gpg signature of the given tag names.
+
+-n <num>::
+       <num> specifies how many lines from the annotation, if any,
+       are printed when using -l.
+       The default is not to print any annotation lines.
+       If no number is given to `-n`, only the first line is printed.
 
 -l <pattern>::
-       List tags that match the given pattern (or all if no pattern is given).
+       List tags with names that match the given pattern (or all if no pattern is given).
+       Typing "git tag" without arguments, also lists all tags.
 
 -m <msg>::
        Use the given tag message (instead of prompting)
@@ -77,8 +85,10 @@ committer identity (of the form "Your Name <your@email.address>") to
 find a key.  If you want to use a different default key, you can specify
 it in the repository configuration as follows:
 
+-------------------------------------
 [user]
     signingkey = <gpg-key-id>
+-------------------------------------
 
 
 DISCUSSION