Use 'trash directory' thoroughly in t/test-lib.sh
[git/jnareb-git/bp-gitweb.git] / Documentation / gitk.txt
blobf843f39bf2f0d42f568595e1b29192d203b3e403
1 gitk(1)
2 =======
4 NAME
5 ----
6 gitk - The git repository browser
8 SYNOPSIS
9 --------
10 'gitk' [<option>...] [<revs>] [--] [<path>...]
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.
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.
22 OPTIONS
23 -------
24 To control which revisions to shown, the command takes options applicable to
25 the linkgit:git-rev-list[1] command. This manual page describes only the most
26 frequently used options.
28 -n <number>::
29 --max-count=<number>::
31         Limits the number of commits to show.
33 --since=<date>::
35         Show commits more recent than a specific date.
37 --until=<date>::
39         Show commits older than a specific date.
41 --all::
43         Show all branches.
45 --merge::
47         After an attempt to merge stops with conflicts, show the commits on
48         the history between two branches (i.e. the HEAD and the MERGE_HEAD)
49         that modify the conflicted files.
51 <revs>::
53         Limit the revisions to show. This can be either a single revision
54         meaning show from the given revision and back, or it can be a range in
55         the form "'<from>'..'<to>'" to show all revisions between '<from>' and
56         back to '<to>'. Note, more advanced revision selection can be applied.
57         For a more complete list of ways to spell object names, see
58         "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
60 <path>::
62         Limit commits to the ones touching files in the given paths. Note, to
63         avoid ambiguity wrt. revision names use "--" to separate the paths
64         from any preceding options.
66 Examples
67 --------
68 gitk v2.6.12.. include/scsi drivers/scsi::
70         Show as the changes since version 'v2.6.12' that changed any
71         file in the include/scsi or drivers/scsi subdirectories
73 gitk --since="2 weeks ago" \-- gitk::
75         Show the changes during the last two weeks to the file 'gitk'.
76         The "--" is necessary to avoid confusion with the *branch* named
77         'gitk'
79 gitk --max-count=100 --all \-- Makefile::
81         Show at most 100 changes made to the file 'Makefile'. Instead of only
82         looking for changes in the current branch look in all branches.
84 Files
85 -----
86 Gitk creates the .gitk file in your $HOME directory to store preferences
87 such as display options, font, and colors.
89 SEE ALSO
90 --------
91 'qgit(1)'::
92         A repository browser written in C++ using Qt.
94 'gitview(1)'::
95         A repository browser written in Python using Gtk. It's based on
96         'bzrk(1)' and distributed in the contrib area of the git repository.
98 'tig(1)'::
99         A minimal repository browser and git tool output highlighter written
100         in C using Ncurses.
102 Author
103 ------
104 Written by Paul Mackerras <paulus@samba.org>.
106 Documentation
107 --------------
108 Documentation by Junio C Hamano, Jonas Fonseca, and the git-list
109 <git@vger.kernel.org>.
113 Part of the linkgit:git[1] suite