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.
  51
  52 --argscmd=<command>::
  53         Command to be run each time gitk has to determine the list of
  54         <revs> to show.  The command is expected to print on its standard
  55         output a list of additional revs to be shown, one per line.
  56         Use this instead of explicitly specifying <revs> if the set of
  57         commits to show may vary between refreshes.
  58
  59 --select-commit=<ref>::
  60
  61         Automatically select the specified commit after loading the graph.
  62         Default behavior is equivalent to specifying '--select-commit=HEAD'.
  63
  64 <revs>::
  65
  66         Limit the revisions to show. This can be either a single revision
  67         meaning show from the given revision and back, or it can be a range in
  68         the form "'<from>'..'<to>'" to show all revisions between '<from>' and
  69         back to '<to>'. Note, more advanced revision selection can be applied.
  70         For a more complete list of ways to spell object names, see
  71         "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
  72
  73 <path>...::
  74
  75         Limit commits to the ones touching files in the given paths. Note, to
  76         avoid ambiguity wrt. revision names use "--" to separate the paths
  77         from any preceding options.
  78
  79 Examples
  80 --------
  81 gitk v2.6.12.. include/scsi drivers/scsi::
  82
  83         Show the changes since version 'v2.6.12' that changed any
  84         file in the include/scsi or drivers/scsi subdirectories
  85
  86 gitk --since="2 weeks ago" \-- gitk::
  87
  88         Show the changes during the last two weeks to the file 'gitk'.
  89         The "--" is necessary to avoid confusion with the *branch* named
  90         'gitk'
  91
  92 gitk --max-count=100 --all \-- Makefile::
  93
  94         Show at most 100 changes made to the file 'Makefile'. Instead of only
  95         looking for changes in the current branch look in all branches.
  96
  97 Files
  98 -----
  99 Gitk creates the .gitk file in your $HOME directory to store preferences
 100 such as display options, font, and colors.
 101
 102 SEE ALSO
 103 --------
 104 'qgit(1)'::
 105         A repository browser written in C++ using Qt.
 106
 107 'gitview(1)'::
 108         A repository browser written in Python using Gtk. It's based on
 109         'bzrk(1)' and distributed in the contrib area of the git repository.
 110
 111 'tig(1)'::
 112         A minimal repository browser and git tool output highlighter written
 113         in C using Ncurses.
 114
 115 Author
 116 ------
 117 Written by Paul Mackerras <paulus@samba.org>.
 118
 119 Documentation
 120 --------------
 121 Documentation by Junio C Hamano, Jonas Fonseca, and the git-list
 122 <git@vger.kernel.org>.
 123
 124 GIT
 125 ---
 126 Part of the linkgit:git[1] suite