Google Git
Sign in
chromium / external / gitster / git-htmldocs / 85c44a9175871f71ce4f18363a471d0eca43fb08 / . / git-gui.html
blob: 4d56596a9cdf151de0dcf169b0a1c90884e66dbf [file] [log] [blame]
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]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" />
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]6<meta name="generator" content="AsciiDoc 8.2.5" />
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]7<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]19a {
20 color: blue;
21 text-decoration: underline;
22}
23a:visited {
24 color: fuchsia;
25}
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]26
27em {
28 font-style: italic;
29}
30
31strong {
32 font-weight: bold;
33}
34
35tt {
36 color: navy;
37}
38
39h1, h2, h3, h4, h5, h6 {
40 color: #527bbd;
41 font-family: sans-serif;
42 margin-top: 1.2em;
43 margin-bottom: 0.5em;
44 line-height: 1.3;
45}
46
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]47h1, h2, h3 {
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]48 border-bottom: 2px solid silver;
49}
50h2 {
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]51 padding-top: 0.5em;
52}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]53h3 {
54 float: left;
55}
56h3 + * {
57 clear: left;
58}
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]59
60div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
63}
64
65hr {
66 border: 1px solid silver;
67}
68
69p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
72}
73
74pre {
75 padding: 0;
76 margin: 0;
77}
78
79span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]83 font-size: 1.1em;
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]84}
85span#email {
86}
87span#revision {
88 font-family: sans-serif;
89}
90
91div#footer {
92 font-family: sans-serif;
93 font-size: small;
94 border-top: 2px solid silver;
95 padding-top: 0.5em;
96 margin-top: 4.0em;
97}
98div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
101}
102div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
105}
106
107div#preamble,
108div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
114}
115div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
118}
119
120div.content { /* Block element content. */
121 padding: 0;
122}
123
124/* Block element titles. */
125div.title, caption.title {
126 font-family: sans-serif;
127 font-weight: bold;
128 text-align: left;
129 margin-top: 1.0em;
130 margin-bottom: 0.5em;
131}
132div.title + * {
133 margin-top: 0;
134}
135
136td div.title:first-child {
137 margin-top: 0.0em;
138}
139div.content div.title:first-child {
140 margin-top: 0.0em;
141}
142div.content + div.title {
143 margin-top: 0.0em;
144}
145
146div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
150}
151
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]152div.listingblock {
153 margin-right: 0%;
154}
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]155div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
159}
160
161div.quoteblock > div.content {
162 padding-left: 2.0em;
163}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]164
165div.attribution {
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]166 text-align: right;
167}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]168div.verseblock + div.attribution {
169 text-align: left;
170}
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]171
172div.admonitionblock .icon {
173 vertical-align: top;
174 font-size: 1.1em;
175 font-weight: bold;
176 text-decoration: underline;
177 color: #527bbd;
178 padding-right: 0.5em;
179}
180div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
183}
184
185div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
188}
189
190div.verseblock div.content {
191 white-space: pre;
192}
193
194div.imageblock div.content { padding-left: 0; }
195div.imageblock img { border: 1px solid silver; }
196span.image img { border-style: none; }
197
198dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
201}
202dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
206}
207dd > *:first-child {
208 margin-top: 0;
209}
210
211ul, ol {
212 list-style-position: outside;
213}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]214div.olist2 ol {
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]215 list-style-type: lower-alpha;
216}
217
218div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]219 border: 3px solid #527bbd;
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]220}
221thead {
222 font-family: sans-serif;
223 font-weight: bold;
224}
225tfoot {
226 font-weight: bold;
227}
228
229div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
232}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]233div.hlist td {
234 padding-bottom: 5px;
235}
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]236td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
240}
241td.hlist2 {
242 vertical-align: top;
243}
244
245@media print {
246 div#footer-badges { display: none; }
247}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]248
249div#toctitle {
250 color: #527bbd;
251 font-family: sans-serif;
252 font-size: 1.1em;
253 font-weight: bold;
254 margin-top: 1.0em;
255 margin-bottom: 0.1em;
256}
257
258div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
261}
262div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
265}
266div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
269}
270div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
273}
274include1::./stylesheets/xhtml11-manpage.css[]
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]275/* Workarounds for IE6's broken and incomplete CSS2. */
276
277div.sidebar-content {
278 background: #ffffee;
279 border: 1px solid silver;
280 padding: 0.5em;
281}
282div.sidebar-title, div.image-title {
283 font-family: sans-serif;
284 font-weight: bold;
285 margin-top: 0.0em;
286 margin-bottom: 0.5em;
287}
288
289div.listingblock div.content {
290 border: 1px solid silver;
291 background: #f4f4f4;
292 padding: 0.5em;
293}
294
295div.quoteblock-content {
296 padding-left: 2.0em;
297}
298
299div.exampleblock-content {
300 border-left: 2px solid silver;
301 padding-left: 0.5em;
302}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]303
304/* IE6 sets dynamically generated links as visited. */
305div#toc a:visited { color: blue; }
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]306</style>
307<title>git-gui(1)</title>
308</head>
309<body>
310<div id="header">
311<h1>
312git-gui(1) Manual Page
313</h1>
314<h2>NAME</h2>
315<div class="sectionbody">
316<p>git-gui -
317 A portable graphical interface to Git
318</p>
319</div>
320</div>
321<h2>SYNOPSIS</h2>
322<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]323<div class="para"><p><em>git gui</em> [&lt;command&gt;] [arguments]</p></div>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]324</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]325<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]326<div class="sectionbody">
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]327<div class="para"><p>A Tcl/Tk based graphical user interface to Git. <em>git gui</em> focuses
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]328on allowing users to make changes to their repository by making
329new commits, amending existing ones, creating branches, performing
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]330local merges, and fetching/pushing to remote repositories.</p></div>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]331<div class="para"><p>Unlike <em>gitk</em>, <em>git gui</em> focuses on commit generation
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]332and single file annotation and does not show project history.
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]333It does however supply menu actions to start a <em>gitk</em> session from
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]334within <em>git gui</em>.</p></div>
335<div class="para"><p><em>git gui</em> is known to work on all popular UNIX systems, Mac OS X,
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]336and Windows (under both Cygwin and MSYS). To the extent possible
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]337OS specific user interface guidelines are followed, making <em>git gui</em>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]338a fairly native interface for users.</p></div>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]339</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]340<h2 id="_commands">COMMANDS</h2>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]341<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]342<div class="vlist"><dl>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]343<dt>
344blame
345</dt>
346<dd>
347<p>
348 Start a blame viewer on the specified file on the given
349 version (or working directory if not specified).
350</p>
351</dd>
352<dt>
353browser
354</dt>
355<dd>
356<p>
357 Start a tree browser showing all files in the specified
358 commit (or <em>HEAD</em> by default). Files selected through the
359 browser are opened in the blame viewer.
360</p>
361</dd>
362<dt>
363citool
364</dt>
365<dd>
366<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]367 Start <em>git gui</em> and arrange to make exactly one commit before
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]368 exiting and returning to the shell. The interface is limited
369 to only commit actions, slightly reducing the application's
370 startup time and simplifying the menubar.
371</p>
372</dd>
373<dt>
374version
375</dt>
376<dd>
377<p>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]378 Display the currently running version of <em>git gui</em>.
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]379</p>
380</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]381</dl></div>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]382</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]383<h2 id="_examples">Examples</h2>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]384<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]385<div class="vlist"><dl>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]386<dt>
387git gui blame Makefile
388</dt>
389<dd>
390<p>
391 Show the contents of the file <em>Makefile</em> in the current
392 working directory, and provide annotations for both the
393 original author of each line, and who moved the line to its
394 current location. The uncommitted file is annotated, and
395 uncommitted changes (if any) are explicitly attributed to
396 <em>Not Yet Committed</em>.
397</p>
398</dd>
399<dt>
400git gui blame v0.99.8 Makefile
401</dt>
402<dd>
403<p>
404 Show the contents of <em>Makefile</em> in revision <em>v0.99.8</em>
405 and provide annotations for each line. Unlike the above
406 example the file is read from the object database and not
407 the working directory.
408</p>
409</dd>
410<dt>
Junio C Hamanod3452a02008-11-15 08:07:55[diff] [blame]411git gui blame --line=100 Makefile
412</dt>
413<dd>
414<p>
415 Loads annotations as described above and automatically
416 scrolls the view to center on line <em>100</em>.
417</p>
418</dd>
419<dt>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]420git gui citool
421</dt>
422<dd>
423<p>
424 Make one commit and return to the shell when it is complete.
Junio C Hamanod3452a02008-11-15 08:07:55[diff] [blame]425 This command returns a non-zero exit code if the window was
426 closed in any way other than by making a commit.
427</p>
428</dd>
429<dt>
430git gui citool --amend
431</dt>
432<dd>
433<p>
434 Automatically enter the <em>Amend Last Commit</em> mode of
435 the interface.
436</p>
437</dd>
438<dt>
439git gui citool --nocommit
440</dt>
441<dd>
442<p>
443 Behave as normal citool, but instead of making a commit
444 simply terminate with a zero exit code. It still checks
445 that the index does not contain any unmerged entries, so
446 you can use it as a GUI version of <a href="git-mergetool.html">git-mergetool(1)</a>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]447</p>
448</dd>
449<dt>
450git citool
451</dt>
452<dd>
453<p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]454 Same as <tt>git gui citool</tt> (above).
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]455</p>
456</dd>
457<dt>
458git gui browser maint
459</dt>
460<dd>
461<p>
462 Show a browser for the tree of the <em>maint</em> branch. Files
463 selected in the browser can be viewed with the internal
464 blame viewer.
465</p>
466</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]467</dl></div>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]468</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]469<h2 id="_see_also">SEE ALSO</h2>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]470<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]471<div class="vlist"><dl>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]472<dt>
Junio C Hamano9049d912008-05-29 02:09:50[diff] [blame]473<a href="gitk.html">gitk(1)</a>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]474</dt>
475<dd>
476<p>
477 The git repository browser. Shows branches, commit history
478 and file differences. gitk is the utility started by
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]479 <em>git gui</em>'s Repository Visualize actions.
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]480</p>
481</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]482</dl></div>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]483</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]484<h2 id="_other">Other</h2>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]485<div class="sectionbody">
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]486<div class="para"><p><em>git gui</em> is actually maintained as an independent project, but stable
Junio C Hamanoa6387422007-08-25 03:54:27[diff] [blame]487versions are distributed as part of the Git suite for the convenience
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]488of end users.</p></div>
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]489<div class="para"><p>A <em>git gui</em> development repository can be obtained from:</p></div>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]490<div class="literalblock">
491<div class="content">
492<pre><tt>git clone git://repo.or.cz/git-gui.git</tt></pre>
493</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]494<div class="para"><p>or</p></div>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]495<div class="literalblock">
496<div class="content">
497<pre><tt>git clone http://repo.or.cz/r/git-gui.git</tt></pre>
498</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]499<div class="para"><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>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]500</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]501<h2 id="_author">Author</h2>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]502<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]503<div class="para"><p>Written by Shawn O. Pearce &lt;spearce@spearce.org&gt;.</p></div>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]504</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]505<h2 id="_documentation">Documentation</h2>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]506<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]507<div class="para"><p>Documentation by Shawn O. Pearce &lt;spearce@spearce.org&gt;.</p></div>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]508</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]509<h2 id="_git">GIT</h2>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]510<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]511<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]512</div>
513<div id="footer">
514<div id="footer-text">
Junio C Hamanodca34822010-02-13 01:02:52[diff] [blame]515Last updated 2010-02-13 00:59:45 UTC
Junio C Hamano58784fc2007-06-23 08:48:57[diff] [blame]516</div>
517</div>
518</body>
519</html>