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' [<option>...] [<revs>] [--] [<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 Historically, gitk was the first repository browser. It's written in tcl/tk
  20 and started off in a separate repository but was later merged into the main
  21 git repository.
  22
  23 OPTIONS
  24 -------
  25 To control which revisions to show, the command takes options applicable to
  26 the 'git rev-list' command (see linkgit:git-rev-list[1]).
  27 This manual page describes only the most
  28 frequently used options.
  29
  30 -n <number>::
  31 --max-count=<number>::
  32
  33         Limits the number of commits to show.
  34
  35 --since=<date>::
  36
  37         Show commits more recent than a specific date.
  38
  39 --until=<date>::
  40
  41         Show commits older than a specific date.
  42
  43 --all::
  44
  45         Show all branches.
  46
  47 --merge::
  48
  49         After an attempt to merge stops with conflicts, show the commits on
  50         the history between two branches (i.e. the HEAD and the MERGE_HEAD)
  51         that modify the conflicted files and do not exist on all the heads
  52         being merged.
  53
  54 --argscmd=<command>::
  55         Command to be run each time gitk has to determine the list of
  56         <revs> to show.  The command is expected to print on its standard
  57         output a list of additional revs to be shown, one per line.
  58         Use this instead of explicitly specifying <revs> if the set of
  59         commits to show may vary between refreshes.
  60
  61 --select-commit=<ref>::
  62
  63         Automatically select the specified commit after loading the graph.
  64         Default behavior is equivalent to specifying '--select-commit=HEAD'.
  65
  66 <revs>::
  67
  68         Limit the revisions to show. This can be either a single revision
  69         meaning show from the given revision and back, or it can be a range in
  70         the form "'<from>'..'<to>'" to show all revisions between '<from>' and
  71         back to '<to>'. Note, more advanced revision selection can be applied.
  72         For a more complete list of ways to spell object names, see
  73         linkgit:gitrevisions[7].
  74
  75 <path>...::
  76
  77         Limit commits to the ones touching files in the given paths. Note, to
  78         avoid ambiguity with respect to revision names use "--" to separate the paths
  79         from any preceding options.
  80
  81 Examples
  82 --------
  83 gitk v2.6.12.. include/scsi drivers/scsi::
  84
  85         Show the changes since version 'v2.6.12' that changed any
  86         file in the include/scsi or drivers/scsi subdirectories
  87
  88 gitk --since="2 weeks ago" \-- gitk::
  89
  90         Show the changes during the last two weeks to the file 'gitk'.
  91         The "--" is necessary to avoid confusion with the *branch* named
  92         'gitk'
  93
  94 gitk --max-count=100 --all \-- Makefile::
  95
  96         Show at most 100 changes made to the file 'Makefile'. Instead of only
  97         looking for changes in the current branch look in all branches.
  98
  99 Files
 100 -----
 101 Gitk creates the .gitk file in your $HOME directory to store preferences
 102 such as display options, font, and colors.
 103
 104 SEE ALSO
 105 --------
 106 'qgit(1)'::
 107         A repository browser written in C++ using Qt.
 108
 109 'gitview(1)'::
 110         A repository browser written in Python using Gtk. It's based on
 111         'bzrk(1)' and distributed in the contrib area of the git repository.
 112
 113 'tig(1)'::
 114         A minimal repository browser and git tool output highlighter written
 115         in C using Ncurses.
 116
 117 GIT
 118 ---
 119 Part of the linkgit:git[1] suite