git-commit.txt: Add missing long/short options
[git/git.git] / Documentation / git-shortlog.txt
CommitLineData
3f971fc4
JH
1git-shortlog(1)
2===============
3f971fc4
JH
3
4NAME
5----
7bd7f280 6git-shortlog - Summarize 'git log' output
3f971fc4 7
3f971fc4
JH
8SYNOPSIS
9--------
0ad64fd0 10[verse]
55ef8a46
JH
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-----------
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
bb924cb3 25-h, \--help::
4e27fb06
NP
26 Print a short usage message and exit.
27
bb924cb3 28-n, \--numbered::
4e27fb06
NP
29 Sort output according to the number of commits per author instead
30 of author alphabetic order.
31
bb924cb3 32-s, \--summary::
23bfbb81 33 Suppress commit description and provide a commit count summary only.
4e27fb06 34
6508bb75
JK
35-e, \--email::
36 Show the email address of each author.
37
55ef8a46
JH
38-w[<width>[,<indent1>[,<indent2>]]]::
39 Linewrap the output by wrapping each line at `width`. The first
40 line of each entry is indented by `indent1` spaces, and the second
41 and subsequent lines are indented by `indent2` spaces. `width`,
42 `indent1`, and `indent2` default to 76, 6 and 9 respectively.
43
74237d62
JF
44FILES
45-----
0ad64fd0 46
ba4c32bd
GH
47If the file `.mailmap` exists, it will be used for mapping author
48email addresses to a real author name. One mapping per line, first
49the author name followed by the email address enclosed by
50'<' and '>'. Use hash '#' for comments. Example:
51
52------------
53# Keep alphabetized
54Adam Morrow <adam@localhost.localdomain>
55Eve Jones <eve@laptop.(none)>
56------------
3f971fc4
JH
57
58Author
59------
60Written by Jeff Garzik <jgarzik@pobox.com>
61
62Documentation
63--------------
64Documentation by Junio C Hamano.
65
66GIT
67---
9e1f0a85 68Part of the linkgit:git[1] suite