GIT 1.5.4-rc2
[gitweb.git] / Documentation / git-shortlog.txt
index 1c8c55ef6eac57d5bcc1cad7afbecd354af9d3ab..36510a845125a806992fddce125883a749569235 100644 (file)
@@ -8,8 +8,8 @@ git-shortlog - Summarize 'git log' output
 SYNOPSIS
 --------
 [verse]
-git-log --pretty=short | 'git-shortlog' [-h] [-n] [-s]
-git-shortlog [-n|--number] [-s|--summary] [<committish>...]
+git-log --pretty=short | 'git-shortlog' [-h] [-n] [-s] [-e]
+git-shortlog [-n|--numbered] [-s|--summary] [-e|--email] [<committish>...]
 
 DESCRIPTION
 -----------
@@ -22,28 +22,32 @@ Additionally, "[PATCH]" will be stripped from the commit description.
 OPTIONS
 -------
 
--h::
+-h, \--help::
        Print a short usage message and exit.
 
--n::
+-n, \--numbered::
        Sort output according to the number of commits per author instead
        of author alphabetic order.
 
--s::
+-s, \--summary::
        Suppress commit description and provide a commit count summary only.
 
+-e, \--email::
+       Show the email address of each author.
+
 FILES
 -----
 
-.mailmap::
-       If this file exists, it will be used for mapping author email
-       addresses to a real author name. One mapping per line, first
-       the author name followed by the email address enclosed by
-       '<' and '>'. Use hash '#' for comments. Example:
+If the file `.mailmap` exists, it will be used for mapping author
+email addresses to a real author name. One mapping per line, first
+the author name followed by the email address enclosed by
+'<' and '>'. Use hash '#' for comments. Example:
 
-               # Keep alphabetized
-               Adam Morrow <adam@localhost.localdomain>
-               Eve Jones <eve@laptop.(none)>
+------------
+# Keep alphabetized
+Adam Morrow <adam@localhost.localdomain>
+Eve Jones <eve@laptop.(none)>
+------------
 
 Author
 ------
@@ -56,4 +60,3 @@ Documentation by Junio C Hamano.
 GIT
 ---
 Part of the gitlink:git[7] suite
-