GIT 1.6.1
[git/git.git] / Documentation / git-shortlog.txt
CommitLineData
3f971fc4
JH
1git-shortlog(1)
2===============
3f971fc4
JH
3
4NAME
5----
467c0197 6git-shortlog - Summarize 'git-log' output
3f971fc4 7
3f971fc4
JH
8SYNOPSIS
9--------
0ad64fd0 10[verse]
b1889c36
JN
11git log --pretty=short | 'git shortlog' [-h] [-n] [-s] [-e] [-w]
12git shortlog [-n|--numbered] [-s|--summary] [-e|--email] [-w[<width>[,<indent1>[,<indent2>]]]] [<committish>...]
3f971fc4
JH
13
14DESCRIPTION
15-----------
ba020ef5 16Summarizes 'git-log' output in a format suitable for inclusion
4e27fb06 17in release announcements. Each commit will be grouped by author and
74237d62
JF
18the first line of the commit message will be shown.
19
20Additionally, "[PATCH]" will be stripped from the commit description.
21
4e27fb06
NP
22OPTIONS
23-------
24
3240240f
SB
25-h::
26--help::
4e27fb06
NP
27 Print a short usage message and exit.
28
3240240f
SB
29-n::
30--numbered::
4e27fb06
NP
31 Sort output according to the number of commits per author instead
32 of author alphabetic order.
33
3240240f
SB
34-s::
35--summary::
23bfbb81 36 Suppress commit description and provide a commit count summary only.
4e27fb06 37
3240240f
SB
38-e::
39--email::
6508bb75
JK
40 Show the email address of each author.
41
55ef8a46
JH
42-w[<width>[,<indent1>[,<indent2>]]]::
43 Linewrap the output by wrapping each line at `width`. The first
44 line of each entry is indented by `indent1` spaces, and the second
45 and subsequent lines are indented by `indent2` spaces. `width`,
46 `indent1`, and `indent2` default to 76, 6 and 9 respectively.
47
74237d62
JF
48FILES
49-----
0ad64fd0 50
ba4c32bd
GH
51If the file `.mailmap` exists, it will be used for mapping author
52email addresses to a real author name. One mapping per line, first
53the author name followed by the email address enclosed by
54'<' and '>'. Use hash '#' for comments. Example:
55
56------------
57# Keep alphabetized
58Adam Morrow <adam@localhost.localdomain>
59Eve Jones <eve@laptop.(none)>
60------------
3f971fc4
JH
61
62Author
63------
64Written by Jeff Garzik <jgarzik@pobox.com>
65
66Documentation
67--------------
68Documentation by Junio C Hamano.
69
70GIT
71---
9e1f0a85 72Part of the linkgit:git[1] suite