Autogenerated HTML docs for v1.7.5.2-315-g11bc3
[git/jnareb-git.git] / gitk.html
blob78166d337092bcec31d079a3a34cb79e4b57b459
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.4.5" />
7 <title>gitk(1)</title>
8 <style type="text/css">
9 /* Debug borders */
10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
42 h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
98 div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120 div.admonitionblock {
121 margin-top: 1.5em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.5em;
126 margin-bottom: 2.5em;
129 div.content { /* Block element content. */
130 padding: 0;
133 /* Block element titles. */
134 div.title, caption.title {
135 color: #527bbd;
136 font-family: sans-serif;
137 font-weight: bold;
138 text-align: left;
139 margin-top: 1.0em;
140 margin-bottom: 0.5em;
142 div.title + * {
143 margin-top: 0;
146 td div.title:first-child {
147 margin-top: 0.0em;
149 div.content div.title:first-child {
150 margin-top: 0.0em;
152 div.content + div.title {
153 margin-top: 0.0em;
156 div.sidebarblock > div.content {
157 background: #ffffee;
158 border: 1px solid silver;
159 padding: 0.5em;
162 div.listingblock > div.content {
163 border: 1px solid silver;
164 background: #f4f4f4;
165 padding: 0.5em;
168 div.quoteblock {
169 padding-left: 2.0em;
170 margin-right: 10%;
172 div.quoteblock > div.attribution {
173 padding-top: 0.5em;
174 text-align: right;
177 div.verseblock {
178 padding-left: 2.0em;
179 margin-right: 10%;
181 div.verseblock > div.content {
182 white-space: pre;
184 div.verseblock > div.attribution {
185 padding-top: 0.75em;
186 text-align: left;
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div.verseblock + div.attribution {
190 text-align: left;
193 div.admonitionblock .icon {
194 vertical-align: top;
195 font-size: 1.1em;
196 font-weight: bold;
197 text-decoration: underline;
198 color: #527bbd;
199 padding-right: 0.5em;
201 div.admonitionblock td.content {
202 padding-left: 0.5em;
203 border-left: 2px solid silver;
206 div.exampleblock > div.content {
207 border-left: 2px solid silver;
208 padding: 0.5em;
211 div.imageblock div.content { padding-left: 0; }
212 span.image img { border-style: none; }
213 a.image:visited { color: white; }
215 dl {
216 margin-top: 0.8em;
217 margin-bottom: 0.8em;
219 dt {
220 margin-top: 0.5em;
221 margin-bottom: 0;
222 font-style: normal;
223 color: navy;
225 dd > *:first-child {
226 margin-top: 0.1em;
229 ul, ol {
230 list-style-position: outside;
232 ol.arabic {
233 list-style-type: decimal;
235 ol.loweralpha {
236 list-style-type: lower-alpha;
238 ol.upperalpha {
239 list-style-type: upper-alpha;
241 ol.lowerroman {
242 list-style-type: lower-roman;
244 ol.upperroman {
245 list-style-type: upper-roman;
248 div.compact ul, div.compact ol,
249 div.compact p, div.compact p,
250 div.compact div, div.compact div {
251 margin-top: 0.1em;
252 margin-bottom: 0.1em;
255 div.tableblock > table {
256 border: 3px solid #527bbd;
258 thead {
259 font-family: sans-serif;
260 font-weight: bold;
262 tfoot {
263 font-weight: bold;
265 td > div.verse {
266 white-space: pre;
268 p.table {
269 margin-top: 0;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div.tableblock > table[frame="void"] {
273 border-style: none;
275 div.tableblock > table[frame="hsides"] {
276 border-left-style: none;
277 border-right-style: none;
279 div.tableblock > table[frame="vsides"] {
280 border-top-style: none;
281 border-bottom-style: none;
285 div.hdlist {
286 margin-top: 0.8em;
287 margin-bottom: 0.8em;
289 div.hdlist tr {
290 padding-bottom: 15px;
292 dt.hdlist1.strong, td.hdlist1.strong {
293 font-weight: bold;
295 td.hdlist1 {
296 vertical-align: top;
297 font-style: normal;
298 padding-right: 0.8em;
299 color: navy;
301 td.hdlist2 {
302 vertical-align: top;
304 div.hdlist.compact tr {
305 margin: 0;
306 padding-bottom: 0;
309 .comment {
310 background: yellow;
313 @media print {
314 div#footer-badges { display: none; }
317 div#toctitle {
318 color: #527bbd;
319 font-family: sans-serif;
320 font-size: 1.1em;
321 font-weight: bold;
322 margin-top: 1.0em;
323 margin-bottom: 0.1em;
326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
327 margin-top: 0;
328 margin-bottom: 0;
330 div.toclevel2 {
331 margin-left: 2em;
332 font-size: 0.9em;
334 div.toclevel3 {
335 margin-left: 4em;
336 font-size: 0.9em;
338 div.toclevel4 {
339 margin-left: 6em;
340 font-size: 0.9em;
342 /* Overrides for manpage documents */
343 h1 {
344 padding-top: 0.5em;
345 padding-bottom: 0.5em;
346 border-top: 2px solid silver;
347 border-bottom: 2px solid silver;
349 h2 {
350 border-style: none;
352 div.sectionbody {
353 margin-left: 5%;
356 @media print {
357 div#toc { display: none; }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
362 div.sidebar-content {
363 background: #ffffee;
364 border: 1px solid silver;
365 padding: 0.5em;
367 div.sidebar-title, div.image-title {
368 color: #527bbd;
369 font-family: sans-serif;
370 font-weight: bold;
371 margin-top: 0.0em;
372 margin-bottom: 0.5em;
375 div.listingblock div.content {
376 border: 1px solid silver;
377 background: #f4f4f4;
378 padding: 0.5em;
381 div.quoteblock-attribution {
382 padding-top: 0.5em;
383 text-align: right;
386 div.verseblock-content {
387 white-space: pre;
389 div.verseblock-attribution {
390 padding-top: 0.75em;
391 text-align: left;
394 div.exampleblock-content {
395 border-left: 2px solid silver;
396 padding-left: 0.5em;
399 /* IE6 sets dynamically generated links as visited. */
400 div#toc a:visited { color: blue; }
401 </style>
402 </head>
403 <body>
404 <div id="header">
405 <h1>
406 gitk(1) Manual Page
407 </h1>
408 <h2>NAME</h2>
409 <div class="sectionbody">
410 <p>gitk -
411 The git repository browser
412 </p>
413 </div>
414 </div>
415 <h2 id="_synopsis">SYNOPSIS</h2>
416 <div class="sectionbody">
417 <div class="paragraph"><p><em>gitk</em> [&lt;option&gt;&#8230;] [&lt;revs&gt;] [--] [&lt;path&gt;&#8230;]</p></div>
418 </div>
419 <h2 id="_description">DESCRIPTION</h2>
420 <div class="sectionbody">
421 <div class="paragraph"><p>Displays changes in a repository or a selected set of commits. This includes
422 visualizing the commit graph, showing information related to each commit, and
423 the files in the trees of each revision.</p></div>
424 <div class="paragraph"><p>Historically, gitk was the first repository browser. It&#8217;s written in tcl/tk
425 and started off in a separate repository but was later merged into the main
426 git repository.</p></div>
427 </div>
428 <h2 id="_options">OPTIONS</h2>
429 <div class="sectionbody">
430 <div class="paragraph"><p>To control which revisions to show, the command takes options applicable to
431 the <em>git rev-list</em> command (see <a href="git-rev-list.html">git-rev-list(1)</a>).
432 This manual page describes only the most
433 frequently used options.</p></div>
434 <div class="dlist"><dl>
435 <dt class="hdlist1">
436 -n &lt;number&gt;
437 </dt>
438 <dt class="hdlist1">
439 --max-count=&lt;number&gt;
440 </dt>
441 <dd>
443 Limits the number of commits to show.
444 </p>
445 </dd>
446 <dt class="hdlist1">
447 --since=&lt;date&gt;
448 </dt>
449 <dd>
451 Show commits more recent than a specific date.
452 </p>
453 </dd>
454 <dt class="hdlist1">
455 --until=&lt;date&gt;
456 </dt>
457 <dd>
459 Show commits older than a specific date.
460 </p>
461 </dd>
462 <dt class="hdlist1">
463 --all
464 </dt>
465 <dd>
467 Show all branches.
468 </p>
469 </dd>
470 <dt class="hdlist1">
471 --merge
472 </dt>
473 <dd>
475 After an attempt to merge stops with conflicts, show the commits on
476 the history between two branches (i.e. the HEAD and the MERGE_HEAD)
477 that modify the conflicted files and do not exist on all the heads
478 being merged.
479 </p>
480 </dd>
481 <dt class="hdlist1">
482 --argscmd=&lt;command&gt;
483 </dt>
484 <dd>
486 Command to be run each time gitk has to determine the list of
487 &lt;revs&gt; to show. The command is expected to print on its standard
488 output a list of additional revs to be shown, one per line.
489 Use this instead of explicitly specifying &lt;revs&gt; if the set of
490 commits to show may vary between refreshes.
491 </p>
492 </dd>
493 <dt class="hdlist1">
494 --select-commit=&lt;ref&gt;
495 </dt>
496 <dd>
498 Automatically select the specified commit after loading the graph.
499 Default behavior is equivalent to specifying <em>--select-commit=HEAD</em>.
500 </p>
501 </dd>
502 <dt class="hdlist1">
503 &lt;revs&gt;
504 </dt>
505 <dd>
507 Limit the revisions to show. This can be either a single revision
508 meaning show from the given revision and back, or it can be a range in
509 the form "<em>&lt;from&gt;</em>..<em>&lt;to&gt;</em>" to show all revisions between <em>&lt;from&gt;</em> and
510 back to <em>&lt;to&gt;</em>. Note, more advanced revision selection can be applied.
511 For a more complete list of ways to spell object names, see
512 <a href="gitrevisions.html">gitrevisions(7)</a>.
513 </p>
514 </dd>
515 <dt class="hdlist1">
516 &lt;path&gt;&#8230;
517 </dt>
518 <dd>
520 Limit commits to the ones touching files in the given paths. Note, to
521 avoid ambiguity with respect to revision names use "--" to separate the paths
522 from any preceding options.
523 </p>
524 </dd>
525 </dl></div>
526 </div>
527 <h2 id="_examples">Examples</h2>
528 <div class="sectionbody">
529 <div class="dlist"><dl>
530 <dt class="hdlist1">
531 gitk v2.6.12.. include/scsi drivers/scsi
532 </dt>
533 <dd>
535 Show the changes since version <em>v2.6.12</em> that changed any
536 file in the include/scsi or drivers/scsi subdirectories
537 </p>
538 </dd>
539 <dt class="hdlist1">
540 gitk --since="2 weeks ago" -- gitk
541 </dt>
542 <dd>
544 Show the changes during the last two weeks to the file <em>gitk</em>.
545 The "--" is necessary to avoid confusion with the <strong>branch</strong> named
546 <em>gitk</em>
547 </p>
548 </dd>
549 <dt class="hdlist1">
550 gitk --max-count=100 --all -- Makefile
551 </dt>
552 <dd>
554 Show at most 100 changes made to the file <em>Makefile</em>. Instead of only
555 looking for changes in the current branch look in all branches.
556 </p>
557 </dd>
558 </dl></div>
559 </div>
560 <h2 id="_files">Files</h2>
561 <div class="sectionbody">
562 <div class="paragraph"><p>Gitk creates the .gitk file in your $HOME directory to store preferences
563 such as display options, font, and colors.</p></div>
564 </div>
565 <h2 id="_see_also">SEE ALSO</h2>
566 <div class="sectionbody">
567 <div class="dlist"><dl>
568 <dt class="hdlist1">
569 <em>qgit(1)</em>
570 </dt>
571 <dd>
573 A repository browser written in C++ using Qt.
574 </p>
575 </dd>
576 <dt class="hdlist1">
577 <em>gitview(1)</em>
578 </dt>
579 <dd>
581 A repository browser written in Python using Gtk. It&#8217;s based on
582 <em>bzrk(1)</em> and distributed in the contrib area of the git repository.
583 </p>
584 </dd>
585 <dt class="hdlist1">
586 <em>tig(1)</em>
587 </dt>
588 <dd>
590 A minimal repository browser and git tool output highlighter written
591 in C using Ncurses.
592 </p>
593 </dd>
594 </dl></div>
595 </div>
596 <h2 id="_git">GIT</h2>
597 <div class="sectionbody">
598 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
599 </div>
600 <div id="footer">
601 <div id="footer-text">
602 Last updated 2011-03-15 23:30:15 UTC
603 </div>
604 </div>
605 </body>
606 </html>