Documentation/gitk.txt

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