Merge branch 'master' into lj/refs
[git/git.git] / Documentation / gitk.txt
1 gitk(1)
2 =======
3
4 NAME
5 ----
6 gitk - git repository browser
7
8 SYNOPSIS
9 --------
10 'gitk' [<option>...] [<revs>] [--] [<path>...]
11
12 DESCRIPTION
13 -----------
14 Displays changes in a repository or a selected set of commits. This includes
15 visualizing the commit graph, showing information related to each commit, and
16 the files in the trees of each revision.
17
18 Historically, gitk was the first repository browser. It's written in tcl/tk
19 and started off in a separate repository but was later merged into the main
20 git repository.
21
22 OPTIONS
23 -------
24 To control which revisions to shown, the command takes options applicable to
25 the gitlink:git-rev-list[1] command. This manual page describes only the most
26 frequently used options.
27
28 -n <number>, --max-count=<number>::
29
30 Limits the number of commits to show.
31
32 --since=<date>::
33
34 Show commits more recent than a specific date.
35
36 --until=<date>::
37
38 Show commits older than a specific date.
39
40 --all::
41
42 Show all branches.
43
44 <revs>::
45
46 Limit the revisions to show. This can be either a single revision
47 meaning show from the given revision and back, or it can be a range in
48 the form "'<from>'..'<to>'" to show all revisions between '<from>' and
49 back to '<to>'. Note, more advanced revision selection can be applied.
50
51 <path>::
52
53 Limit commits to the ones touching files in the given paths. Note, to
54 avoid ambiguity wrt. revision names use "--" to separate the paths
55 from any preceeding options.
56
57 Examples
58 --------
59 gitk v2.6.12.. include/scsi drivers/scsi::
60
61 Show as the changes since version 'v2.6.12' that changed any
62 file in the include/scsi or drivers/scsi subdirectories
63
64 gitk --since="2 weeks ago" \-- gitk::
65
66 Show the changes during the last two weeks to the file 'gitk'.
67 The "--" is necessary to avoid confusion with the *branch* named
68 'gitk'
69
70 gitk --max-count=100 --all -- Makefile::
71
72 Show at most 100 changes made to the file 'Makefile'. Instead of only
73 looking for changes in the current branch look in all branches.
74
75 See Also
76 --------
77 'qgit(1)'::
78 A repository browser written in C++ using Qt.
79
80 'gitview(1)'::
81 A repository browser written in Python using Gtk. It's based on
82 'bzrk(1)' and distributed in the contrib area of the git repository.
83
84 'tig(1)'::
85 A minimal repository browser and git tool output highlighter written
86 in C using Ncurses.
87
88 Author
89 ------
90 Written by Paul Mackerras <paulus@samba.org>.
91
92 Documentation
93 --------------
94 Documentation by Junio C Hamano, Jonas Fonseca, and the git-list
95 <git@vger.kernel.org>.
96
97 GIT
98 ---
99 Part of the gitlink:git[7] suite
100