Autogenerated HTML docs for v1.7.5.1-339-gb602ed
[git/jnareb-git.git] / git-gui.html
blobbdc6a0fbda8f8e7698dd09232a752f37630c1246
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>git-gui(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 git-gui(1) Manual Page
407 </h1>
408 <h2>NAME</h2>
409 <div class="sectionbody">
410 <p>git-gui -
411 A portable graphical interface to Git
412 </p>
413 </div>
414 </div>
415 <h2 id="_synopsis">SYNOPSIS</h2>
416 <div class="sectionbody">
417 <div class="paragraph"><p><em>git gui</em> [&lt;command&gt;] [arguments]</p></div>
418 </div>
419 <h2 id="_description">DESCRIPTION</h2>
420 <div class="sectionbody">
421 <div class="paragraph"><p>A Tcl/Tk based graphical user interface to Git. <em>git gui</em> focuses
422 on allowing users to make changes to their repository by making
423 new commits, amending existing ones, creating branches, performing
424 local merges, and fetching/pushing to remote repositories.</p></div>
425 <div class="paragraph"><p>Unlike <em>gitk</em>, <em>git gui</em> focuses on commit generation
426 and single file annotation and does not show project history.
427 It does however supply menu actions to start a <em>gitk</em> session from
428 within <em>git gui</em>.</p></div>
429 <div class="paragraph"><p><em>git gui</em> is known to work on all popular UNIX systems, Mac OS X,
430 and Windows (under both Cygwin and MSYS). To the extent possible
431 OS specific user interface guidelines are followed, making <em>git gui</em>
432 a fairly native interface for users.</p></div>
433 </div>
434 <h2 id="_commands">COMMANDS</h2>
435 <div class="sectionbody">
436 <div class="dlist"><dl>
437 <dt class="hdlist1">
438 blame
439 </dt>
440 <dd>
442 Start a blame viewer on the specified file on the given
443 version (or working directory if not specified).
444 </p>
445 </dd>
446 <dt class="hdlist1">
447 browser
448 </dt>
449 <dd>
451 Start a tree browser showing all files in the specified
452 commit (or <em>HEAD</em> by default). Files selected through the
453 browser are opened in the blame viewer.
454 </p>
455 </dd>
456 <dt class="hdlist1">
457 citool
458 </dt>
459 <dd>
461 Start <em>git gui</em> and arrange to make exactly one commit before
462 exiting and returning to the shell. The interface is limited
463 to only commit actions, slightly reducing the application&#8217;s
464 startup time and simplifying the menubar.
465 </p>
466 </dd>
467 <dt class="hdlist1">
468 version
469 </dt>
470 <dd>
472 Display the currently running version of <em>git gui</em>.
473 </p>
474 </dd>
475 </dl></div>
476 </div>
477 <h2 id="_examples">Examples</h2>
478 <div class="sectionbody">
479 <div class="dlist"><dl>
480 <dt class="hdlist1">
481 git gui blame Makefile
482 </dt>
483 <dd>
485 Show the contents of the file <em>Makefile</em> in the current
486 working directory, and provide annotations for both the
487 original author of each line, and who moved the line to its
488 current location. The uncommitted file is annotated, and
489 uncommitted changes (if any) are explicitly attributed to
490 <em>Not Yet Committed</em>.
491 </p>
492 </dd>
493 <dt class="hdlist1">
494 git gui blame v0.99.8 Makefile
495 </dt>
496 <dd>
498 Show the contents of <em>Makefile</em> in revision <em>v0.99.8</em>
499 and provide annotations for each line. Unlike the above
500 example the file is read from the object database and not
501 the working directory.
502 </p>
503 </dd>
504 <dt class="hdlist1">
505 git gui blame --line=100 Makefile
506 </dt>
507 <dd>
509 Loads annotations as described above and automatically
510 scrolls the view to center on line <em>100</em>.
511 </p>
512 </dd>
513 <dt class="hdlist1">
514 git gui citool
515 </dt>
516 <dd>
518 Make one commit and return to the shell when it is complete.
519 This command returns a non-zero exit code if the window was
520 closed in any way other than by making a commit.
521 </p>
522 </dd>
523 <dt class="hdlist1">
524 git gui citool --amend
525 </dt>
526 <dd>
528 Automatically enter the <em>Amend Last Commit</em> mode of
529 the interface.
530 </p>
531 </dd>
532 <dt class="hdlist1">
533 git gui citool --nocommit
534 </dt>
535 <dd>
537 Behave as normal citool, but instead of making a commit
538 simply terminate with a zero exit code. It still checks
539 that the index does not contain any unmerged entries, so
540 you can use it as a GUI version of <a href="git-mergetool.html">git-mergetool(1)</a>
541 </p>
542 </dd>
543 <dt class="hdlist1">
544 git citool
545 </dt>
546 <dd>
548 Same as <tt>git gui citool</tt> (above).
549 </p>
550 </dd>
551 <dt class="hdlist1">
552 git gui browser maint
553 </dt>
554 <dd>
556 Show a browser for the tree of the <em>maint</em> branch. Files
557 selected in the browser can be viewed with the internal
558 blame viewer.
559 </p>
560 </dd>
561 </dl></div>
562 </div>
563 <h2 id="_see_also">SEE ALSO</h2>
564 <div class="sectionbody">
565 <div class="dlist"><dl>
566 <dt class="hdlist1">
567 <a href="gitk.html">gitk(1)</a>
568 </dt>
569 <dd>
571 The git repository browser. Shows branches, commit history
572 and file differences. gitk is the utility started by
573 <em>git gui</em>'s Repository Visualize actions.
574 </p>
575 </dd>
576 </dl></div>
577 </div>
578 <h2 id="_other">Other</h2>
579 <div class="sectionbody">
580 <div class="paragraph"><p><em>git gui</em> is actually maintained as an independent project, but stable
581 versions are distributed as part of the Git suite for the convenience
582 of end users.</p></div>
583 <div class="paragraph"><p>A <em>git gui</em> development repository can be obtained from:</p></div>
584 <div class="literalblock">
585 <div class="content">
586 <pre><tt>git clone git://repo.or.cz/git-gui.git</tt></pre>
587 </div></div>
588 <div class="paragraph"><p>or</p></div>
589 <div class="literalblock">
590 <div class="content">
591 <pre><tt>git clone http://repo.or.cz/r/git-gui.git</tt></pre>
592 </div></div>
593 <div class="paragraph"><p>or browsed online at <a href="http://repo.or.cz/w/git-gui.git/">http://repo.or.cz/w/git-gui.git/</a>.</p></div>
594 </div>
595 <h2 id="_git">GIT</h2>
596 <div class="sectionbody">
597 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
598 </div>
599 <div id="footer">
600 <div id="footer-text">
601 Last updated 2011-03-15 23:30:13 UTC
602 </div>
603 </div>
604 </body>
605 </html>