git-gui.html

   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.2.5" />
   7 <style type="text/css">
   8 /* Debug borders */
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  10 /*
  11   border: 1px solid red;
  12 */
  13 }
  14
  15 body {
  16   margin: 1em 5% 1em 5%;
  17 }
  18
  19 a {
  20   color: blue;
  21   text-decoration: underline;
  22 }
  23 a:visited {
  24   color: fuchsia;
  25 }
  26
  27 em {
  28   font-style: italic;
  29 }
  30
  31 strong {
  32   font-weight: bold;
  33 }
  34
  35 tt {
  36   color: navy;
  37 }
  38
  39 h1, 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
  47 h1, h2, h3 {
  48   border-bottom: 2px solid silver;
  49 }
  50 h2 {
  51   padding-top: 0.5em;
  52 }
  53 h3 {
  54   float: left;
  55 }
  56 h3 + * {
  57   clear: left;
  58 }
  59
  60 div.sectionbody {
  61   font-family: serif;
  62   margin-left: 0;
  63 }
  64
  65 hr {
  66   border: 1px solid silver;
  67 }
  68
  69 p {
  70   margin-top: 0.5em;
  71   margin-bottom: 0.5em;
  72 }
  73
  74 pre {
  75   padding: 0;
  76   margin: 0;
  77 }
  78
  79 span#author {
  80   color: #527bbd;
  81   font-family: sans-serif;
  82   font-weight: bold;
  83   font-size: 1.1em;
  84 }
  85 span#email {
  86 }
  87 span#revision {
  88   font-family: sans-serif;
  89 }
  90
  91 div#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 }
  98 div#footer-text {
  99   float: left;
 100   padding-bottom: 0.5em;
 101 }
 102 div#footer-badges {
 103   float: right;
 104   padding-bottom: 0.5em;
 105 }
 106
 107 div#preamble,
 108 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 109 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 110 div.admonitionblock {
 111   margin-right: 10%;
 112   margin-top: 1.5em;
 113   margin-bottom: 1.5em;
 114 }
 115 div.admonitionblock {
 116   margin-top: 2.5em;
 117   margin-bottom: 2.5em;
 118 }
 119
 120 div.content { /* Block element content. */
 121   padding: 0;
 122 }
 123
 124 /* Block element titles. */
 125 div.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 }
 132 div.title + * {
 133   margin-top: 0;
 134 }
 135
 136 td div.title:first-child {
 137   margin-top: 0.0em;
 138 }
 139 div.content div.title:first-child {
 140   margin-top: 0.0em;
 141 }
 142 div.content + div.title {
 143   margin-top: 0.0em;
 144 }
 145
 146 div.sidebarblock > div.content {
 147   background: #ffffee;
 148   border: 1px solid silver;
 149   padding: 0.5em;
 150 }
 151
 152 div.listingblock {
 153   margin-right: 0%;
 154 }
 155 div.listingblock > div.content {
 156   border: 1px solid silver;
 157   background: #f4f4f4;
 158   padding: 0.5em;
 159 }
 160
 161 div.quoteblock > div.content {
 162   padding-left: 2.0em;
 163 }
 164
 165 div.attribution {
 166   text-align: right;
 167 }
 168 div.verseblock + div.attribution {
 169   text-align: left;
 170 }
 171
 172 div.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 }
 180 div.admonitionblock td.content {
 181   padding-left: 0.5em;
 182   border-left: 2px solid silver;
 183 }
 184
 185 div.exampleblock > div.content {
 186   border-left: 2px solid silver;
 187   padding: 0.5em;
 188 }
 189
 190 div.verseblock div.content {
 191   white-space: pre;
 192 }
 193
 194 div.imageblock div.content { padding-left: 0; }
 195 div.imageblock img { border: 1px solid silver; }
 196 span.image img { border-style: none; }
 197
 198 dl {
 199   margin-top: 0.8em;
 200   margin-bottom: 0.8em;
 201 }
 202 dt {
 203   margin-top: 0.5em;
 204   margin-bottom: 0;
 205   font-style: italic;
 206 }
 207 dd > *:first-child {
 208   margin-top: 0;
 209 }
 210
 211 ul, ol {
 212     list-style-position: outside;
 213 }
 214 div.olist2 ol {
 215   list-style-type: lower-alpha;
 216 }
 217
 218 div.tableblock > table {
 219   border: 3px solid #527bbd;
 220 }
 221 thead {
 222   font-family: sans-serif;
 223   font-weight: bold;
 224 }
 225 tfoot {
 226   font-weight: bold;
 227 }
 228
 229 div.hlist {
 230   margin-top: 0.8em;
 231   margin-bottom: 0.8em;
 232 }
 233 div.hlist td {
 234   padding-bottom: 5px;
 235 }
 236 td.hlist1 {
 237   vertical-align: top;
 238   font-style: italic;
 239   padding-right: 0.8em;
 240 }
 241 td.hlist2 {
 242   vertical-align: top;
 243 }
 244
 245 @media print {
 246   div#footer-badges { display: none; }
 247 }
 248
 249 div#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
 258 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 259   margin-top: 0;
 260   margin-bottom: 0;
 261 }
 262 div.toclevel2 {
 263   margin-left: 2em;
 264   font-size: 0.9em;
 265 }
 266 div.toclevel3 {
 267   margin-left: 4em;
 268   font-size: 0.9em;
 269 }
 270 div.toclevel4 {
 271   margin-left: 6em;
 272   font-size: 0.9em;
 273 }
 274 include1::./stylesheets/xhtml11-manpage.css[]
 275 /* Workarounds for IE6's broken and incomplete CSS2. */
 276
 277 div.sidebar-content {
 278   background: #ffffee;
 279   border: 1px solid silver;
 280   padding: 0.5em;
 281 }
 282 div.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
 289 div.listingblock div.content {
 290   border: 1px solid silver;
 291   background: #f4f4f4;
 292   padding: 0.5em;
 293 }
 294
 295 div.quoteblock-content {
 296   padding-left: 2.0em;
 297 }
 298
 299 div.exampleblock-content {
 300   border-left: 2px solid silver;
 301   padding-left: 0.5em;
 302 }
 303
 304 /* IE6 sets dynamically generated links as visited. */
 305 div#toc a:visited { color: blue; }
 306 </style>
 307 <title>git-gui(1)</title>
 308 </head>
 309 <body>
 310 <div id="header">
 311 <h1>
 312 git-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">
 323 <div class="para"><p><em>git gui</em> [&lt;command&gt;] [arguments]</p></div>
 324 </div>
 325 <h2 id="_description">DESCRIPTION</h2>
 326 <div class="sectionbody">
 327 <div class="para"><p>A Tcl/Tk based graphical user interface to Git.  <em>git gui</em> focuses
 328 on allowing users to make changes to their repository by making
 329 new commits, amending existing ones, creating branches, performing
 330 local merges, and fetching/pushing to remote repositories.</p></div>
 331 <div class="para"><p>Unlike <em>gitk</em>, <em>git gui</em> focuses on commit generation
 332 and single file annotation and does not show project history.
 333 It does however supply menu actions to start a <em>gitk</em> session from
 334 within <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,
 336 and Windows (under both Cygwin and MSYS).  To the extent possible
 337 OS specific user interface guidelines are followed, making <em>git gui</em>
 338 a fairly native interface for users.</p></div>
 339 </div>
 340 <h2 id="_commands">COMMANDS</h2>
 341 <div class="sectionbody">
 342 <div class="vlist"><dl>
 343 <dt>
 344 blame
 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>
 353 browser
 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>
 363 citool
 364 </dt>
 365 <dd>
 366 <p>
 367         Start <em>git gui</em> and arrange to make exactly one commit before
 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>
 374 version
 375 </dt>
 376 <dd>
 377 <p>
 378         Display the currently running version of <em>git gui</em>.
 379 </p>
 380 </dd>
 381 </dl></div>
 382 </div>
 383 <h2 id="_examples">Examples</h2>
 384 <div class="sectionbody">
 385 <div class="vlist"><dl>
 386 <dt>
 387 git 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>
 400 git 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>
 411 git 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>
 420 git gui citool
 421 </dt>
 422 <dd>
 423 <p>
 424         Make one commit and return to the shell when it is complete.
 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>
 430 git 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>
 439 git 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>
 447 </p>
 448 </dd>
 449 <dt>
 450 git citool
 451 </dt>
 452 <dd>
 453 <p>
 454         Same as <tt>git gui citool</tt> (above).
 455 </p>
 456 </dd>
 457 <dt>
 458 git 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>
 467 </dl></div>
 468 </div>
 469 <h2 id="_see_also">SEE ALSO</h2>
 470 <div class="sectionbody">
 471 <div class="vlist"><dl>
 472 <dt>
 473 <a href="gitk.html">gitk(1)</a>
 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
 479         <em>git gui</em>'s Repository Visualize actions.
 480 </p>
 481 </dd>
 482 </dl></div>
 483 </div>
 484 <h2 id="_other">Other</h2>
 485 <div class="sectionbody">
 486 <div class="para"><p><em>git gui</em> is actually maintained as an independent project, but stable
 487 versions are distributed as part of the Git suite for the convenience
 488 of end users.</p></div>
 489 <div class="para"><p>A <em>git gui</em> development repository can be obtained from:</p></div>
 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>
 494 <div class="para"><p>or</p></div>
 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>
 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>
 500 </div>
 501 <h2 id="_author">Author</h2>
 502 <div class="sectionbody">
 503 <div class="para"><p>Written by Shawn O. Pearce &lt;spearce@spearce.org&gt;.</p></div>
 504 </div>
 505 <h2 id="_documentation">Documentation</h2>
 506 <div class="sectionbody">
 507 <div class="para"><p>Documentation by Shawn O. Pearce &lt;spearce@spearce.org&gt;.</p></div>
 508 </div>
 509 <h2 id="_git">GIT</h2>
 510 <div class="sectionbody">
 511 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 512 </div>
 513 <div id="footer">
 514 <div id="footer-text">
 515 Last updated 2010-09-18 23:56:45 UTC
 516 </div>
 517 </div>
 518 </body>
 519 </html>