git-blame(1): mention options in the synopsis and advertise pickaxe
[git/jnareb-git.git] / Documentation / git-blame.txt
blobe1f89444a95618a1e520940a79389c854cf9d576
1 git-blame(1)
2 ============
4 NAME
5 ----
6 git-blame - Show what revision and author last modified each line of a file
8 SYNOPSIS
9 --------
10 'git-blame' [-c] [-l] [-t] [-S <revs-file>] [--] <file> [<rev>]
12 DESCRIPTION
13 -----------
15 Annotates each line in the given file with information from the revision which
16 last modified the line. Optionally, start annotating from the given revision.
18 This report doesn't tell you anything about lines which have been deleted or
19 replaced; you need to use a tool such as gitlink:git-diff[1] or the "pickaxe"
20 interface briefly mentioned in the following paragraph.
22 Apart from supporting file annotation, git also supports searching the
23 development history for when a code snippet occured in a change. This makes it
24 possible to track when a code snippet was added to a file, moved or copied
25 between files, and eventually deleted or replaced. It works by searching for
26 a text string in the diff. A small example:
28 -----------------------------------------------------------------------------
29 $ git log --pretty=oneline -S'blame_usage'
30 5040f17eba15504bad66b14a645bddd9b015ebb7 blame -S <ancestry-file>
31 ea4c7f9bf69e781dd0cd88d2bccb2bf5cc15c9a7 git-blame: Make the output
32 -----------------------------------------------------------------------------
34 OPTIONS
35 -------
36 -c, --compatibility::
37         Use the same output mode as gitlink:git-annotate[1] (Default: off).
39 -l, --long::
40         Show long rev (Default: off).
42 -t, --time::
43         Show raw timestamp (Default: off).
45 -S, --rev-file <revs-file>::
46         Use revs from revs-file instead of calling gitlink:git-rev-list[1].
48 -h, --help::
49         Show help message.
52 SEE ALSO
53 --------
54 gitlink:git-annotate[1]
56 AUTHOR
57 ------
58 Written by Fredrik Kuivinen <freku045@student.liu.se>.
60 GIT
61 ---
62 Part of the gitlink:git[7] suite