Merge branch 'bd/tests'
[gitweb.git] / Documentation / git-shortlog.txt
index 2220ef6ea8d3bfa58f3c1279dfcf4f735c2dae0a..d7cb4c0468e713543042d41ff57a638a7fda2881 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|--numbered] [-s|--summary] [<committish>...]
+git-log --pretty=short | 'git-shortlog' [-h] [-n] [-s] [-e] [-w]
+git-shortlog [-n|--numbered] [-s|--summary] [-e|--email] [-w[<width>[,<indent1>[,<indent2>]]]] [<committish>...]
 
 DESCRIPTION
 -----------
@@ -32,18 +32,28 @@ OPTIONS
 -s, \--summary::
        Suppress commit description and provide a commit count summary only.
 
+-e, \--email::
+       Show the email address of each author.
+
+-w[<width>[,<indent1>[,<indent2>]]]::
+       Linewrap the output by wrapping each line at `width`.  The first
+       line of each entry is indented by `indent1` spaces, and the second
+       and subsequent lines are indented by `indent2` spaces. `width`,
+       `indent1`, and `indent2` default to 76, 6 and 9 respectively.
+
 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
 ------
@@ -55,4 +65,4 @@ Documentation by Junio C Hamano.
 
 GIT
 ---
-Part of the gitlink:git[7] suite
+Part of the linkgit:git[7] suite