doc/source/en/TortoiseGit/git_doc/gitk.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
   3 \r
   4 <article lang="en" id="gitk(1)">\r
   5 <articleinfo>\r
   6     <title>gitk(1)</title>\r
   7 <indexterm>\r
   8 <primary>gitk(1)</primary>\r
   9 </indexterm>\r
  10 </articleinfo>\r
  11 <simplesect id="_name">\r
  12 <title>NAME</title>\r
  13 <simpara>gitk - The git repository browser</simpara>\r
  14 </simplesect>\r
  15 <simplesect id="_synopsis">\r
  16 <title>SYNOPSIS</title>\r
  17 <blockquote>\r
  18 <literallayout><emphasis>gitk</emphasis> [&lt;option&gt;&#8230;] [&lt;revs&gt;] [--] [&lt;path&gt;&#8230;]</literallayout>\r
  19 </blockquote>\r
  20 </simplesect>\r
  21 <simplesect id="_description">\r
  22 <title>DESCRIPTION</title>\r
  23 <simpara>Displays changes in a repository or a selected set of commits. This includes\r
  24 visualizing the commit graph, showing information related to each commit, and\r
  25 the files in the trees of each revision.</simpara>\r
  26 <simpara>Historically, gitk was the first repository browser. It's written in tcl/tk\r
  27 and started off in a separate repository but was later merged into the main\r
  28 git repository.</simpara>\r
  29 </simplesect>\r
  30 <simplesect id="_options">\r
  31 <title>OPTIONS</title>\r
  32 <simpara>To control which revisions to show, the command takes options applicable to\r
  33 the <emphasis>git rev-list</emphasis> command (see <xref linkend="git-rev-list(1)" />).\r
  34 This manual page describes only the most\r
  35 frequently used options.</simpara>\r
  36 <variablelist>\r
  37 <varlistentry>\r
  38 <term>\r
  39 -n &lt;number&gt;\r
  40 </term>\r
  41 <term>\r
  42 --max-count=&lt;number&gt;\r
  43 </term>\r
  44 <listitem>\r
  45 <simpara>\r
  46         Limits the number of commits to show.\r
  47 </simpara>\r
  48 </listitem>\r
  49 </varlistentry>\r
  50 <varlistentry>\r
  51 <term>\r
  52 --since=&lt;date&gt;\r
  53 </term>\r
  54 <listitem>\r
  55 <simpara>\r
  56         Show commits more recent than a specific date.\r
  57 </simpara>\r
  58 </listitem>\r
  59 </varlistentry>\r
  60 <varlistentry>\r
  61 <term>\r
  62 --until=&lt;date&gt;\r
  63 </term>\r
  64 <listitem>\r
  65 <simpara>\r
  66         Show commits older than a specific date.\r
  67 </simpara>\r
  68 </listitem>\r
  69 </varlistentry>\r
  70 <varlistentry>\r
  71 <term>\r
  72 --all\r
  73 </term>\r
  74 <listitem>\r
  75 <simpara>\r
  76         Show all branches.\r
  77 </simpara>\r
  78 </listitem>\r
  79 </varlistentry>\r
  80 <varlistentry>\r
  81 <term>\r
  82 --merge\r
  83 </term>\r
  84 <listitem>\r
  85 <simpara>\r
  86         After an attempt to merge stops with conflicts, show the commits on\r
  87         the history between two branches (i.e. the HEAD and the MERGE_HEAD)\r
  88         that modify the conflicted files and do not exist on all the heads\r
  89         being merged.\r
  90 </simpara>\r
  91 </listitem>\r
  92 </varlistentry>\r
  93 <varlistentry>\r
  94 <term>\r
  95 --argscmd=&lt;command&gt;\r
  96 </term>\r
  97 <listitem>\r
  98 <simpara>\r
  99         Command to be run each time gitk has to determine the list of\r
 100         &lt;revs&gt; to show.  The command is expected to print on its standard\r
 101         output a list of additional revs to be shown, one per line.\r
 102         Use this instead of explicitly specifying &lt;revs&gt; if the set of\r
 103         commits to show may vary between refreshes.\r
 104 </simpara>\r
 105 </listitem>\r
 106 </varlistentry>\r
 107 <varlistentry>\r
 108 <term>\r
 109 --select-commit=&lt;ref&gt;\r
 110 </term>\r
 111 <listitem>\r
 112 <simpara>\r
 113         Automatically select the specified commit after loading the graph.\r
 114         Default behavior is equivalent to specifying <emphasis>--select-commit=HEAD</emphasis>.\r
 115 </simpara>\r
 116 </listitem>\r
 117 </varlistentry>\r
 118 <varlistentry>\r
 119 <term>\r
 120 &lt;revs&gt;\r
 121 </term>\r
 122 <listitem>\r
 123 <simpara>\r
 124         Limit the revisions to show. This can be either a single revision\r
 125         meaning show from the given revision and back, or it can be a range in\r
 126         the form "<emphasis>&lt;from&gt;</emphasis>..<emphasis>&lt;to&gt;</emphasis>" to show all revisions between <emphasis>&lt;from&gt;</emphasis> and\r
 127         back to <emphasis>&lt;to&gt;</emphasis>. Note, more advanced revision selection can be applied.\r
 128         For a more complete list of ways to spell object names, see\r
 129         <xref linkend="gitrevisions(7)" />.\r
 130 </simpara>\r
 131 </listitem>\r
 132 </varlistentry>\r
 133 <varlistentry>\r
 134 <term>\r
 135 &lt;path&gt;&#8230;\r
 136 </term>\r
 137 <listitem>\r
 138 <simpara>\r
 139         Limit commits to the ones touching files in the given paths. Note, to\r
 140         avoid ambiguity with respect to revision names use "--" to separate the paths\r
 141         from any preceding options.\r
 142 </simpara>\r
 143 </listitem>\r
 144 </varlistentry>\r
 145 </variablelist>\r
 146 </simplesect>\r
 147 <simplesect id="_examples">\r
 148 <title>Examples</title>\r
 149 <variablelist>\r
 150 <varlistentry>\r
 151 <term>\r
 152 gitk v2.6.12.. include/scsi drivers/scsi\r
 153 </term>\r
 154 <listitem>\r
 155 <simpara>\r
 156         Show the changes since version <emphasis>v2.6.12</emphasis> that changed any\r
 157         file in the include/scsi or drivers/scsi subdirectories\r
 158 </simpara>\r
 159 </listitem>\r
 160 </varlistentry>\r
 161 <varlistentry>\r
 162 <term>\r
 163 gitk --since="2 weeks ago" -- gitk\r
 164 </term>\r
 165 <listitem>\r
 166 <simpara>\r
 167         Show the changes during the last two weeks to the file <emphasis>gitk</emphasis>.\r
 168         The "--" is necessary to avoid confusion with the <emphasis role="strong">branch</emphasis> named\r
 169         <emphasis>gitk</emphasis>\r
 170 </simpara>\r
 171 </listitem>\r
 172 </varlistentry>\r
 173 <varlistentry>\r
 174 <term>\r
 175 gitk --max-count=100 --all -- Makefile\r
 176 </term>\r
 177 <listitem>\r
 178 <simpara>\r
 179         Show at most 100 changes made to the file <emphasis>Makefile</emphasis>. Instead of only\r
 180         looking for changes in the current branch look in all branches.\r
 181 </simpara>\r
 182 </listitem>\r
 183 </varlistentry>\r
 184 </variablelist>\r
 185 </simplesect>\r
 186 <simplesect id="_files">\r
 187 <title>Files</title>\r
 188 <simpara>Gitk creates the .gitk file in your $HOME directory to store preferences\r
 189 such as display options, font, and colors.</simpara>\r
 190 </simplesect>\r
 191 <simplesect id="_see_also">\r
 192 <title>SEE ALSO</title>\r
 193 <variablelist>\r
 194 <varlistentry>\r
 195 <term>\r
 196 <emphasis>qgit(1)</emphasis>\r
 197 </term>\r
 198 <listitem>\r
 199 <simpara>\r
 200         A repository browser written in C++ using Qt.\r
 201 </simpara>\r
 202 </listitem>\r
 203 </varlistentry>\r
 204 <varlistentry>\r
 205 <term>\r
 206 <emphasis>gitview(1)</emphasis>\r
 207 </term>\r
 208 <listitem>\r
 209 <simpara>\r
 210         A repository browser written in Python using Gtk. It's based on\r
 211         <emphasis>bzrk(1)</emphasis> and distributed in the contrib area of the git repository.\r
 212 </simpara>\r
 213 </listitem>\r
 214 </varlistentry>\r
 215 <varlistentry>\r
 216 <term>\r
 217 <emphasis>tig(1)</emphasis>\r
 218 </term>\r
 219 <listitem>\r
 220 <simpara>\r
 221         A minimal repository browser and git tool output highlighter written\r
 222         in C using Ncurses.\r
 223 </simpara>\r
 224 </listitem>\r
 225 </varlistentry>\r
 226 </variablelist>\r
 227 </simplesect>\r
 228 <simplesect id="_git">\r
 229 <title>GIT</title>\r
 230 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
 231 </simplesect>\r
 232 </article>\r