Merge branch 'jc/for-each-ref' into jc/ref-locking
[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 <revs>::
41
42 Limit the revisions to show. This can be either a single revision
43 meaning show from the given revision and back, or it can be a range in
44 the form "'<from>'..'<to>'" to show all revisions between '<from>' and
45 back to '<to>'. Note, more advanced revision selection can be applied.
46
47 <path>::
48
49 Limit commits to the ones touching files in the given paths. Note, to
50 avoid ambiguity wrt. revision names use "--" to separate the paths
51 from any preceeding options.
52
53 Examples
54 --------
55 gitk v2.6.12.. include/scsi drivers/scsi::
56
57 Show as the changes since version 'v2.6.12' that changed any
58 file in the include/scsi or drivers/scsi subdirectories
59
60 gitk --since="2 weeks ago" \-- gitk::
61
62 Show the changes during the last two weeks to the file 'gitk'.
63 The "--" is necessary to avoid confusion with the *branch* named
64 'gitk'
65
66 See Also
67 --------
68 'qgit(1)'::
69 A repository browser written in C++ using Qt.
70
71 'gitview(1)'::
72 A repository browser written in Python using Gtk. It's based on
73 'bzrk(1)' and distributed in the contrib area of the git repository.
74
75 'tig(1)'::
76 A minimal repository browser and git tool output highlighter written
77 in C using Ncurses.
78
79 Author
80 ------
81 Written by Paul Mackerras <paulus@samba.org>.
82
83 Documentation
84 --------------
85 Documentation by Junio C Hamano, Jonas Fonseca, and the git-list
86 <git@vger.kernel.org>.
87
88 GIT
89 ---
90 Part of the gitlink:git[7] suite
91