Documentation/config.txt: explain multi-valued variables once
[alt-git.git] / Documentation / gitk.txt
blobd44e14c13850a1b98cae914357cc7eed7676e65f
1 gitk(1)
2 =======
4 NAME
5 ----
6 gitk - The Git repository browser
8 SYNOPSIS
9 --------
10 [verse]
11 'gitk' [<options>] [<revision range>] [\--] [<path>...]
13 DESCRIPTION
14 -----------
15 Displays changes in a repository or a selected set of commits. This includes
16 visualizing the commit graph, showing information related to each commit, and
17 the files in the trees of each revision.
19 OPTIONS
20 -------
22 To control which revisions to show, gitk supports most options
23 applicable to the 'git rev-list' command.  It also supports a few
24 options applicable to the 'git diff-*' commands to control how the
25 changes each commit introduces are shown.  Finally, it supports some
26 gitk-specific options.
28 gitk generally only understands options with arguments in the
29 'sticked' form (see linkgit:gitcli[7]) due to limitations in the
30 command line parser.
32 rev-list options and arguments
33 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35 This manual page describes only the most frequently used options.  See
36 linkgit:git-rev-list[1] for a complete list.
38 --all::
40         Show all refs (branches, tags, etc.).
42 --branches[=<pattern>]::
43 --tags[=<pattern>]::
44 --remotes[=<pattern>]::
46         Pretend as if all the branches (tags, remote branches, resp.)
47         are listed on the command line as '<commit>'. If '<pattern>'
48         is given, limit refs to ones matching given shell glob. If
49         pattern lacks '?', '{asterisk}', or '[', '/{asterisk}' at the
50         end is implied.
52 --since=<date>::
54         Show commits more recent than a specific date.
56 --until=<date>::
58         Show commits older than a specific date.
60 --date-order::
62         Sort commits by date when possible.
64 --merge::
66         After an attempt to merge stops with conflicts, show the commits on
67         the history between two branches (i.e. the HEAD and the MERGE_HEAD)
68         that modify the conflicted files and do not exist on all the heads
69         being merged.
71 --left-right::
73         Mark which side of a symmetric diff a commit is reachable
74         from.  Commits from the left side are prefixed with a `<`
75         symbol and those from the right with a `>` symbol.
77 --full-history::
79         When filtering history with '<path>...', does not prune some
80         history.  (See "History simplification" in linkgit:git-log[1]
81         for a more detailed explanation.)
83 --simplify-merges::
85         Additional option to '--full-history' to remove some needless
86         merges from the resulting history, as there are no selected
87         commits contributing to this merge.  (See "History
88         simplification" in linkgit:git-log[1] for a more detailed
89         explanation.)
91 --ancestry-path::
93         When given a range of commits to display
94         (e.g. 'commit1..commit2' or 'commit2 {caret}commit1'), only
95         display commits that exist directly on the ancestry chain
96         between the 'commit1' and 'commit2', i.e. commits that are
97         both descendants of 'commit1', and ancestors of 'commit2'.
98         (See "History simplification" in linkgit:git-log[1] for a more
99         detailed explanation.)
101 <revision range>::
103         Limit the revisions to show. This can be either a single revision
104         meaning show from the given revision and back, or it can be a range in
105         the form "'<from>'..'<to>'" to show all revisions between '<from>' and
106         back to '<to>'. Note, more advanced revision selection can be applied.
107         For a more complete list of ways to spell object names, see
108         linkgit:gitrevisions[7].
110 <path>...::
112         Limit commits to the ones touching files in the given paths. Note, to
113         avoid ambiguity with respect to revision names use "--" to separate the paths
114         from any preceding options.
116 gitk-specific options
117 ~~~~~~~~~~~~~~~~~~~~~
119 --argscmd=<command>::
121         Command to be run each time gitk has to determine the revision
122         range to show.  The command is expected to print on its
123         standard output a list of additional revisions to be shown,
124         one per line.  Use this instead of explicitly specifying a
125         '<revision range>' if the set of commits to show may vary
126         between refreshes.
128 --select-commit=<ref>::
130         Select the specified commit after loading the graph.
131         Default behavior is equivalent to specifying '--select-commit=HEAD'.
133 Examples
134 --------
135 gitk v2.6.12.. include/scsi drivers/scsi::
137         Show the changes since version 'v2.6.12' that changed any
138         file in the include/scsi or drivers/scsi subdirectories
140 gitk --since="2 weeks ago" \-- gitk::
142         Show the changes during the last two weeks to the file 'gitk'.
143         The "--" is necessary to avoid confusion with the *branch* named
144         'gitk'
146 gitk --max-count=100 --all \-- Makefile::
148         Show at most 100 changes made to the file 'Makefile'. Instead of only
149         looking for changes in the current branch look in all branches.
151 Files
152 -----
153 Gitk creates the .gitk file in your $HOME directory to store preferences
154 such as display options, font, and colors.
156 History
157 -------
158 Gitk was the first graphical repository browser. It's written in
159 tcl/tk and started off in a separate repository but was later merged
160 into the main Git repository.
163 SEE ALSO
164 --------
165 'qgit(1)'::
166         A repository browser written in C++ using Qt.
168 'gitview(1)'::
169         A repository browser written in Python using Gtk. It's based on
170         'bzrk(1)' and distributed in the contrib area of the Git repository.
172 'tig(1)'::
173         A minimal repository browser and Git tool output highlighter written
174         in C using Ncurses.
178 Part of the linkgit:git[1] suite