Documentation/gitk.txt

   1 gitk(1)
   2 =======
   3
   4 NAME
   5 ----
   6 gitk - The Git repository browser
   7
   8 SYNOPSIS
   9 --------
  10 [verse]
  11 'gitk' [<options>] [<revision range>] [--] [<path>...]
  12
  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.
  18
  19 OPTIONS
  20 -------
  21
  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.
  27
  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.
  31
  32 rev-list options and arguments
  33 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  34
  35 This manual page describes only the most frequently used options.  See
  36 linkgit:git-rev-list[1] for a complete list.
  37
  38 --all::
  39
  40         Show all refs (branches, tags, etc.).
  41
  42 --branches[=<pattern>]::
  43 --tags[=<pattern>]::
  44 --remotes[=<pattern>]::
  45
  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.
  51
  52 --since=<date>::
  53
  54         Show commits more recent than a specific date.
  55
  56 --until=<date>::
  57
  58         Show commits older than a specific date.
  59
  60 --date-order::
  61
  62         Sort commits by date when possible.
  63
  64 --merge::
  65
  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.
  70
  71 --left-right::
  72
  73         Mark which side of a symmetric difference 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.
  76
  77 --full-history::
  78
  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.)
  82
  83 --simplify-merges::
  84
  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.)
  90
  91 --ancestry-path::
  92
  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.)
 100
 101 -L<start>,<end>:<file>::
 102 -L:<funcname>:<file>::
 103
 104         Trace the evolution of the line range given by "<start>,<end>"
 105         (or the function name regex <funcname>) within the <file>.  You may
 106         not give any pathspec limiters.  This is currently limited to
 107         a walk starting from a single revision, i.e., you may only
 108         give zero or one positive revision arguments, and
 109         <start> and <end> (or <funcname>) must exist in the starting revision.
 110         You can specify this option more than once. Implies `--patch`.
 111         Patch output can be suppressed using `--no-patch`, but other diff formats
 112         (namely `--raw`, `--numstat`, `--shortstat`, `--dirstat`, `--summary`,
 113         `--name-only`, `--name-status`, `--check`) are not currently implemented.
 114 +
 115 *Note:* gitk (unlike linkgit:git-log[1]) currently only understands
 116 this option if you specify it "glued together" with its argument.  Do
 117 *not* put a space after `-L`.
 118 +
 119 include::line-range-format.txt[]
 120
 121 <revision range>::
 122
 123         Limit the revisions to show. This can be either a single revision
 124         meaning show from the given revision and back, or it can be a range in
 125         the form "'<from>'..'<to>'" to show all revisions between '<from>' and
 126         back to '<to>'. Note, more advanced revision selection can be applied.
 127         For a more complete list of ways to spell object names, see
 128         linkgit:gitrevisions[7].
 129
 130 <path>...::
 131
 132         Limit commits to the ones touching files in the given paths. Note, to
 133         avoid ambiguity with respect to revision names use "--" to separate the paths
 134         from any preceding options.
 135
 136 gitk-specific options
 137 ~~~~~~~~~~~~~~~~~~~~~
 138
 139 --argscmd=<command>::
 140
 141         Command to be run each time gitk has to determine the revision
 142         range to show.  The command is expected to print on its
 143         standard output a list of additional revisions to be shown,
 144         one per line.  Use this instead of explicitly specifying a
 145         '<revision range>' if the set of commits to show may vary
 146         between refreshes.
 147
 148 --select-commit=<ref>::
 149
 150         Select the specified commit after loading the graph.
 151         Default behavior is equivalent to specifying '--select-commit=HEAD'.
 152
 153 Examples
 154 --------
 155 gitk v2.6.12.. include/scsi drivers/scsi::
 156
 157         Show the changes since version 'v2.6.12' that changed any
 158         file in the include/scsi or drivers/scsi subdirectories
 159
 160 gitk --since="2 weeks ago" \-- gitk::
 161
 162         Show the changes during the last two weeks to the file 'gitk'.
 163         The "--" is necessary to avoid confusion with the *branch* named
 164         'gitk'
 165
 166 gitk --max-count=100 --all \-- Makefile::
 167
 168         Show at most 100 changes made to the file 'Makefile'. Instead of only
 169         looking for changes in the current branch look in all branches.
 170
 171 Files
 172 -----
 173 User configuration and preferences are stored at:
 174
 175 * `$XDG_CONFIG_HOME/git/gitk` if it exists, otherwise
 176 * `$HOME/.gitk` if it exists
 177
 178 If neither of the above exist then `$XDG_CONFIG_HOME/git/gitk` is created and
 179 used by default. If '$XDG_CONFIG_HOME' is not set it defaults to
 180 `$HOME/.config` in all cases.
 181
 182 History
 183 -------
 184 Gitk was the first graphical repository browser. It's written in
 185 tcl/tk.
 186
 187 'gitk' is actually maintained as an independent project, but stable
 188 versions are distributed as part of the Git suite for the convenience
 189 of end users.
 190
 191 gitk-git/ comes from Paul Mackerras's gitk project:
 192
 193         git://ozlabs.org/~paulus/gitk
 194
 195 SEE ALSO
 196 --------
 197 'qgit(1)'::
 198         A repository browser written in C++ using Qt.
 199
 200 'tig(1)'::
 201         A minimal repository browser and Git tool output highlighter written
 202         in C using Ncurses.
 203
 204 GIT
 205 ---
 206 Part of the linkgit:git[1] suite