Documentation: improve "add", "pull" and "format-patch" examples
[git/dscho.git] / Documentation / gitk.txt
blob50d12da89fca37b60a024aeb2ac6de9cb2daf001
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>, --max-count=<number>::
30         Limits the number of commits to show.
32 --since=<date>::
34         Show commits more recent than a specific date.
36 --until=<date>::
38         Show commits older than a specific date.
40 --all::
42         Show all branches.
44 --merge::
46         After an attempt to merge stops with conflicts, show the commits on
47         the history between two branches (i.e. the HEAD and the MERGE_HEAD)
48         that modify the conflicted files.
50 <revs>::
52         Limit the revisions to show. This can be either a single revision
53         meaning show from the given revision and back, or it can be a range in
54         the form "'<from>'..'<to>'" to show all revisions between '<from>' and
55         back to '<to>'. Note, more advanced revision selection can be applied.
56         For a more complete list of ways to spell object names, see
57         "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
59 <path>::
61         Limit commits to the ones touching files in the given paths. Note, to
62         avoid ambiguity wrt. revision names use "--" to separate the paths
63         from any preceding options.
65 Examples
66 --------
67 gitk v2.6.12.. include/scsi drivers/scsi::
69         Show as the changes since version 'v2.6.12' that changed any
70         file in the include/scsi or drivers/scsi subdirectories
72 gitk --since="2 weeks ago" \-- gitk::
74         Show the changes during the last two weeks to the file 'gitk'.
75         The "--" is necessary to avoid confusion with the *branch* named
76         'gitk'
78 gitk --max-count=100 --all \-- Makefile::
80         Show at most 100 changes made to the file 'Makefile'. Instead of only
81         looking for changes in the current branch look in all branches.
83 Files
84 -----
85 Gitk creates the .gitk file in your $HOME directory to store preferences
86 such as display options, font, and colors.
88 See Also
89 --------
90 'qgit(1)'::
91         A repository browser written in C++ using Qt.
93 'gitview(1)'::
94         A repository browser written in Python using Gtk. It's based on
95         'bzrk(1)' and distributed in the contrib area of the git repository.
97 'tig(1)'::
98         A minimal repository browser and git tool output highlighter written
99         in C using Ncurses.
101 Author
102 ------
103 Written by Paul Mackerras <paulus@samba.org>.
105 Documentation
106 --------------
107 Documentation by Junio C Hamano, Jonas Fonseca, and the git-list
108 <git@vger.kernel.org>.
112 Part of the linkgit:git[7] suite