gitcli.html

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   3     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   5 <head>
   6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
   7 <meta name="generator" content="AsciiDoc 10.2.0" />
   8 <title>gitcli(7)</title>
   9 <style type="text/css">
  10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
  11
  12 /* Default font. */
  13 body {
  14   font-family: Georgia,serif;
  15 }
  16
  17 /* Title font. */
  18 h1, h2, h3, h4, h5, h6,
  19 div.title, caption.title,
  20 thead, p.table.header,
  21 #toctitle,
  22 #author, #revnumber, #revdate, #revremark,
  23 #footer {
  24   font-family: Arial,Helvetica,sans-serif;
  25 }
  26
  27 body {
  28   margin: 1em 5% 1em 5%;
  29 }
  30
  31 a {
  32   color: blue;
  33   text-decoration: underline;
  34 }
  35 a:visited {
  36   color: fuchsia;
  37 }
  38
  39 em {
  40   font-style: italic;
  41   color: navy;
  42 }
  43
  44 strong {
  45   font-weight: bold;
  46   color: #083194;
  47 }
  48
  49 h1, h2, h3, h4, h5, h6 {
  50   color: #527bbd;
  51   margin-top: 1.2em;
  52   margin-bottom: 0.5em;
  53   line-height: 1.3;
  54 }
  55
  56 h1, h2, h3 {
  57   border-bottom: 2px solid silver;
  58 }
  59 h2 {
  60   padding-top: 0.5em;
  61 }
  62 h3 {
  63   float: left;
  64 }
  65 h3 + * {
  66   clear: left;
  67 }
  68 h5 {
  69   font-size: 1.0em;
  70 }
  71
  72 div.sectionbody {
  73   margin-left: 0;
  74 }
  75
  76 hr {
  77   border: 1px solid silver;
  78 }
  79
  80 p {
  81   margin-top: 0.5em;
  82   margin-bottom: 0.5em;
  83 }
  84
  85 ul, ol, li > p {
  86   margin-top: 0;
  87 }
  88 ul > li     { color: #aaa; }
  89 ul > li > * { color: black; }
  90
  91 .monospaced, code, pre {
  92   font-family: "Courier New", Courier, monospace;
  93   font-size: inherit;
  94   color: navy;
  95   padding: 0;
  96   margin: 0;
  97 }
  98 pre {
  99   white-space: pre-wrap;
 100 }
 101
 102 #author {
 103   color: #527bbd;
 104   font-weight: bold;
 105   font-size: 1.1em;
 106 }
 107 #email {
 108 }
 109 #revnumber, #revdate, #revremark {
 110 }
 111
 112 #footer {
 113   font-size: small;
 114   border-top: 2px solid silver;
 115   padding-top: 0.5em;
 116   margin-top: 4.0em;
 117 }
 118 #footer-text {
 119   float: left;
 120   padding-bottom: 0.5em;
 121 }
 122 #footer-badges {
 123   float: right;
 124   padding-bottom: 0.5em;
 125 }
 126
 127 #preamble {
 128   margin-top: 1.5em;
 129   margin-bottom: 1.5em;
 130 }
 131 div.imageblock, div.exampleblock, div.verseblock,
 132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 133 div.admonitionblock {
 134   margin-top: 1.0em;
 135   margin-bottom: 1.5em;
 136 }
 137 div.admonitionblock {
 138   margin-top: 2.0em;
 139   margin-bottom: 2.0em;
 140   margin-right: 10%;
 141   color: #606060;
 142 }
 143
 144 div.content { /* Block element content. */
 145   padding: 0;
 146 }
 147
 148 /* Block element titles. */
 149 div.title, caption.title {
 150   color: #527bbd;
 151   font-weight: bold;
 152   text-align: left;
 153   margin-top: 1.0em;
 154   margin-bottom: 0.5em;
 155 }
 156 div.title + * {
 157   margin-top: 0;
 158 }
 159
 160 td div.title:first-child {
 161   margin-top: 0.0em;
 162 }
 163 div.content div.title:first-child {
 164   margin-top: 0.0em;
 165 }
 166 div.content + div.title {
 167   margin-top: 0.0em;
 168 }
 169
 170 div.sidebarblock > div.content {
 171   background: #ffffee;
 172   border: 1px solid #dddddd;
 173   border-left: 4px solid #f0f0f0;
 174   padding: 0.5em;
 175 }
 176
 177 div.listingblock > div.content {
 178   border: 1px solid #dddddd;
 179   border-left: 5px solid #f0f0f0;
 180   background: #f8f8f8;
 181   padding: 0.5em;
 182 }
 183
 184 div.quoteblock, div.verseblock {
 185   padding-left: 1.0em;
 186   margin-left: 1.0em;
 187   margin-right: 10%;
 188   border-left: 5px solid #f0f0f0;
 189   color: #888;
 190 }
 191
 192 div.quoteblock > div.attribution {
 193   padding-top: 0.5em;
 194   text-align: right;
 195 }
 196
 197 div.verseblock > pre.content {
 198   font-family: inherit;
 199   font-size: inherit;
 200 }
 201 div.verseblock > div.attribution {
 202   padding-top: 0.75em;
 203   text-align: left;
 204 }
 205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 206 div.verseblock + div.attribution {
 207   text-align: left;
 208 }
 209
 210 div.admonitionblock .icon {
 211   vertical-align: top;
 212   font-size: 1.1em;
 213   font-weight: bold;
 214   text-decoration: underline;
 215   color: #527bbd;
 216   padding-right: 0.5em;
 217 }
 218 div.admonitionblock td.content {
 219   padding-left: 0.5em;
 220   border-left: 3px solid #dddddd;
 221 }
 222
 223 div.exampleblock > div.content {
 224   border-left: 3px solid #dddddd;
 225   padding-left: 0.5em;
 226 }
 227
 228 div.imageblock div.content { padding-left: 0; }
 229 span.image img { border-style: none; vertical-align: text-bottom; }
 230 a.image:visited { color: white; }
 231
 232 dl {
 233   margin-top: 0.8em;
 234   margin-bottom: 0.8em;
 235 }
 236 dt {
 237   margin-top: 0.5em;
 238   margin-bottom: 0;
 239   font-style: normal;
 240   color: navy;
 241 }
 242 dd > *:first-child {
 243   margin-top: 0.1em;
 244 }
 245
 246 ul, ol {
 247     list-style-position: outside;
 248 }
 249 ol.arabic {
 250   list-style-type: decimal;
 251 }
 252 ol.loweralpha {
 253   list-style-type: lower-alpha;
 254 }
 255 ol.upperalpha {
 256   list-style-type: upper-alpha;
 257 }
 258 ol.lowerroman {
 259   list-style-type: lower-roman;
 260 }
 261 ol.upperroman {
 262   list-style-type: upper-roman;
 263 }
 264
 265 div.compact ul, div.compact ol,
 266 div.compact p, div.compact p,
 267 div.compact div, div.compact div {
 268   margin-top: 0.1em;
 269   margin-bottom: 0.1em;
 270 }
 271
 272 tfoot {
 273   font-weight: bold;
 274 }
 275 td > div.verse {
 276   white-space: pre;
 277 }
 278
 279 div.hdlist {
 280   margin-top: 0.8em;
 281   margin-bottom: 0.8em;
 282 }
 283 div.hdlist tr {
 284   padding-bottom: 15px;
 285 }
 286 dt.hdlist1.strong, td.hdlist1.strong {
 287   font-weight: bold;
 288 }
 289 td.hdlist1 {
 290   vertical-align: top;
 291   font-style: normal;
 292   padding-right: 0.8em;
 293   color: navy;
 294 }
 295 td.hdlist2 {
 296   vertical-align: top;
 297 }
 298 div.hdlist.compact tr {
 299   margin: 0;
 300   padding-bottom: 0;
 301 }
 302
 303 .comment {
 304   background: yellow;
 305 }
 306
 307 .footnote, .footnoteref {
 308   font-size: 0.8em;
 309 }
 310
 311 span.footnote, span.footnoteref {
 312   vertical-align: super;
 313 }
 314
 315 #footnotes {
 316   margin: 20px 0 20px 0;
 317   padding: 7px 0 0 0;
 318 }
 319
 320 #footnotes div.footnote {
 321   margin: 0 0 5px 0;
 322 }
 323
 324 #footnotes hr {
 325   border: none;
 326   border-top: 1px solid silver;
 327   height: 1px;
 328   text-align: left;
 329   margin-left: 0;
 330   width: 20%;
 331   min-width: 100px;
 332 }
 333
 334 div.colist td {
 335   padding-right: 0.5em;
 336   padding-bottom: 0.3em;
 337   vertical-align: top;
 338 }
 339 div.colist td img {
 340   margin-top: 0.3em;
 341 }
 342
 343 @media print {
 344   #footer-badges { display: none; }
 345 }
 346
 347 #toc {
 348   margin-bottom: 2.5em;
 349 }
 350
 351 #toctitle {
 352   color: #527bbd;
 353   font-size: 1.1em;
 354   font-weight: bold;
 355   margin-top: 1.0em;
 356   margin-bottom: 0.1em;
 357 }
 358
 359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 360   margin-top: 0;
 361   margin-bottom: 0;
 362 }
 363 div.toclevel2 {
 364   margin-left: 2em;
 365   font-size: 0.9em;
 366 }
 367 div.toclevel3 {
 368   margin-left: 4em;
 369   font-size: 0.9em;
 370 }
 371 div.toclevel4 {
 372   margin-left: 6em;
 373   font-size: 0.9em;
 374 }
 375
 376 span.aqua { color: aqua; }
 377 span.black { color: black; }
 378 span.blue { color: blue; }
 379 span.fuchsia { color: fuchsia; }
 380 span.gray { color: gray; }
 381 span.green { color: green; }
 382 span.lime { color: lime; }
 383 span.maroon { color: maroon; }
 384 span.navy { color: navy; }
 385 span.olive { color: olive; }
 386 span.purple { color: purple; }
 387 span.red { color: red; }
 388 span.silver { color: silver; }
 389 span.teal { color: teal; }
 390 span.white { color: white; }
 391 span.yellow { color: yellow; }
 392
 393 span.aqua-background { background: aqua; }
 394 span.black-background { background: black; }
 395 span.blue-background { background: blue; }
 396 span.fuchsia-background { background: fuchsia; }
 397 span.gray-background { background: gray; }
 398 span.green-background { background: green; }
 399 span.lime-background { background: lime; }
 400 span.maroon-background { background: maroon; }
 401 span.navy-background { background: navy; }
 402 span.olive-background { background: olive; }
 403 span.purple-background { background: purple; }
 404 span.red-background { background: red; }
 405 span.silver-background { background: silver; }
 406 span.teal-background { background: teal; }
 407 span.white-background { background: white; }
 408 span.yellow-background { background: yellow; }
 409
 410 span.big { font-size: 2em; }
 411 span.small { font-size: 0.6em; }
 412
 413 span.underline { text-decoration: underline; }
 414 span.overline { text-decoration: overline; }
 415 span.line-through { text-decoration: line-through; }
 416
 417 div.unbreakable { page-break-inside: avoid; }
 418
 419
 420 /*
 421  * xhtml11 specific
 422  *
 423  * */
 424
 425 div.tableblock {
 426   margin-top: 1.0em;
 427   margin-bottom: 1.5em;
 428 }
 429 div.tableblock > table {
 430   border: 3px solid #527bbd;
 431 }
 432 thead, p.table.header {
 433   font-weight: bold;
 434   color: #527bbd;
 435 }
 436 p.table {
 437   margin-top: 0;
 438 }
 439 /* Because the table frame attribute is overridden by CSS in most browsers. */
 440 div.tableblock > table[frame="void"] {
 441   border-style: none;
 442 }
 443 div.tableblock > table[frame="hsides"] {
 444   border-left-style: none;
 445   border-right-style: none;
 446 }
 447 div.tableblock > table[frame="vsides"] {
 448   border-top-style: none;
 449   border-bottom-style: none;
 450 }
 451
 452
 453 /*
 454  * html5 specific
 455  *
 456  * */
 457
 458 table.tableblock {
 459   margin-top: 1.0em;
 460   margin-bottom: 1.5em;
 461 }
 462 thead, p.tableblock.header {
 463   font-weight: bold;
 464   color: #527bbd;
 465 }
 466 p.tableblock {
 467   margin-top: 0;
 468 }
 469 table.tableblock {
 470   border-width: 3px;
 471   border-spacing: 0px;
 472   border-style: solid;
 473   border-color: #527bbd;
 474   border-collapse: collapse;
 475 }
 476 th.tableblock, td.tableblock {
 477   border-width: 1px;
 478   padding: 4px;
 479   border-style: solid;
 480   border-color: #527bbd;
 481 }
 482
 483 table.tableblock.frame-topbot {
 484   border-left-style: hidden;
 485   border-right-style: hidden;
 486 }
 487 table.tableblock.frame-sides {
 488   border-top-style: hidden;
 489   border-bottom-style: hidden;
 490 }
 491 table.tableblock.frame-none {
 492   border-style: hidden;
 493 }
 494
 495 th.tableblock.halign-left, td.tableblock.halign-left {
 496   text-align: left;
 497 }
 498 th.tableblock.halign-center, td.tableblock.halign-center {
 499   text-align: center;
 500 }
 501 th.tableblock.halign-right, td.tableblock.halign-right {
 502   text-align: right;
 503 }
 504
 505 th.tableblock.valign-top, td.tableblock.valign-top {
 506   vertical-align: top;
 507 }
 508 th.tableblock.valign-middle, td.tableblock.valign-middle {
 509   vertical-align: middle;
 510 }
 511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
 512   vertical-align: bottom;
 513 }
 514
 515
 516 /*
 517  * manpage specific
 518  *
 519  * */
 520
 521 body.manpage h1 {
 522   padding-top: 0.5em;
 523   padding-bottom: 0.5em;
 524   border-top: 2px solid silver;
 525   border-bottom: 2px solid silver;
 526 }
 527 body.manpage h2 {
 528   border-style: none;
 529 }
 530 body.manpage div.sectionbody {
 531   margin-left: 3em;
 532 }
 533
 534 @media print {
 535   body.manpage div#toc { display: none; }
 536 }
 537
 538
 539 </style>
 540 <script type="text/javascript">
 541 /*<![CDATA[*/
 542 var asciidoc = {  // Namespace.
 543
 544 /////////////////////////////////////////////////////////////////////
 545 // Table Of Contents generator
 546 /////////////////////////////////////////////////////////////////////
 547
 548 /* Author: Mihai Bazon, September 2002
 549  * http://students.infoiasi.ro/~mishoo
 550  *
 551  * Table Of Content generator
 552  * Version: 0.4
 553  *
 554  * Feel free to use this script under the terms of the GNU General Public
 555  * License, as long as you do not remove or alter this notice.
 556  */
 557
 558  /* modified by Troy D. Hanson, September 2006. License: GPL */
 559  /* modified by Stuart Rackham, 2006, 2009. License: GPL */
 560
 561 // toclevels = 1..4.
 562 toc: function (toclevels) {
 563
 564   function getText(el) {
 565     var text = "";
 566     for (var i = el.firstChild; i != null; i = i.nextSibling) {
 567       if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
 568         text += i.data;
 569       else if (i.firstChild != null)
 570         text += getText(i);
 571     }
 572     return text;
 573   }
 574
 575   function TocEntry(el, text, toclevel) {
 576     this.element = el;
 577     this.text = text;
 578     this.toclevel = toclevel;
 579   }
 580
 581   function tocEntries(el, toclevels) {
 582     var result = new Array;
 583     var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
 584     // Function that scans the DOM tree for header elements (the DOM2
 585     // nodeIterator API would be a better technique but not supported by all
 586     // browsers).
 587     var iterate = function (el) {
 588       for (var i = el.firstChild; i != null; i = i.nextSibling) {
 589         if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
 590           var mo = re.exec(i.tagName);
 591           if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
 592             result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
 593           }
 594           iterate(i);
 595         }
 596       }
 597     }
 598     iterate(el);
 599     return result;
 600   }
 601
 602   var toc = document.getElementById("toc");
 603   if (!toc) {
 604     return;
 605   }
 606
 607   // Delete existing TOC entries in case we're reloading the TOC.
 608   var tocEntriesToRemove = [];
 609   var i;
 610   for (i = 0; i < toc.childNodes.length; i++) {
 611     var entry = toc.childNodes[i];
 612     if (entry.nodeName.toLowerCase() == 'div'
 613      && entry.getAttribute("class")
 614      && entry.getAttribute("class").match(/^toclevel/))
 615       tocEntriesToRemove.push(entry);
 616   }
 617   for (i = 0; i < tocEntriesToRemove.length; i++) {
 618     toc.removeChild(tocEntriesToRemove[i]);
 619   }
 620
 621   // Rebuild TOC entries.
 622   var entries = tocEntries(document.getElementById("content"), toclevels);
 623   for (var i = 0; i < entries.length; ++i) {
 624     var entry = entries[i];
 625     if (entry.element.id == "")
 626       entry.element.id = "_toc_" + i;
 627     var a = document.createElement("a");
 628     a.href = "#" + entry.element.id;
 629     a.appendChild(document.createTextNode(entry.text));
 630     var div = document.createElement("div");
 631     div.appendChild(a);
 632     div.className = "toclevel" + entry.toclevel;
 633     toc.appendChild(div);
 634   }
 635   if (entries.length == 0)
 636     toc.parentNode.removeChild(toc);
 637 },
 638
 639
 640 /////////////////////////////////////////////////////////////////////
 641 // Footnotes generator
 642 /////////////////////////////////////////////////////////////////////
 643
 644 /* Based on footnote generation code from:
 645  * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 646  */
 647
 648 footnotes: function () {
 649   // Delete existing footnote entries in case we're reloading the footnodes.
 650   var i;
 651   var noteholder = document.getElementById("footnotes");
 652   if (!noteholder) {
 653     return;
 654   }
 655   var entriesToRemove = [];
 656   for (i = 0; i < noteholder.childNodes.length; i++) {
 657     var entry = noteholder.childNodes[i];
 658     if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
 659       entriesToRemove.push(entry);
 660   }
 661   for (i = 0; i < entriesToRemove.length; i++) {
 662     noteholder.removeChild(entriesToRemove[i]);
 663   }
 664
 665   // Rebuild footnote entries.
 666   var cont = document.getElementById("content");
 667   var spans = cont.getElementsByTagName("span");
 668   var refs = {};
 669   var n = 0;
 670   for (i=0; i<spans.length; i++) {
 671     if (spans[i].className == "footnote") {
 672       n++;
 673       var note = spans[i].getAttribute("data-note");
 674       if (!note) {
 675         // Use [\s\S] in place of . so multi-line matches work.
 676         // Because JavaScript has no s (dotall) regex flag.
 677         note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
 678         spans[i].innerHTML =
 679           "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
 680           "' title='View footnote' class='footnote'>" + n + "</a>]";
 681         spans[i].setAttribute("data-note", note);
 682       }
 683       noteholder.innerHTML +=
 684         "<div class='footnote' id='_footnote_" + n + "'>" +
 685         "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
 686         n + "</a>. " + note + "</div>";
 687       var id =spans[i].getAttribute("id");
 688       if (id != null) refs["#"+id] = n;
 689     }
 690   }
 691   if (n == 0)
 692     noteholder.parentNode.removeChild(noteholder);
 693   else {
 694     // Process footnoterefs.
 695     for (i=0; i<spans.length; i++) {
 696       if (spans[i].className == "footnoteref") {
 697         var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
 698         href = href.match(/#.*/)[0];  // Because IE return full URL.
 699         n = refs[href];
 700         spans[i].innerHTML =
 701           "[<a href='#_footnote_" + n +
 702           "' title='View footnote' class='footnote'>" + n + "</a>]";
 703       }
 704     }
 705   }
 706 },
 707
 708 install: function(toclevels) {
 709   var timerId;
 710
 711   function reinstall() {
 712     asciidoc.footnotes();
 713     if (toclevels) {
 714       asciidoc.toc(toclevels);
 715     }
 716   }
 717
 718   function reinstallAndRemoveTimer() {
 719     clearInterval(timerId);
 720     reinstall();
 721   }
 722
 723   timerId = setInterval(reinstall, 500);
 724   if (document.addEventListener)
 725     document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
 726   else
 727     window.onload = reinstallAndRemoveTimer;
 728 }
 729
 730 }
 731 asciidoc.install();
 732 /*]]>*/
 733 </script>
 734 </head>
 735 <body class="manpage">
 736 <div id="header">
 737 <h1>
 738 gitcli(7) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>gitcli -
 743    Git command-line interface and conventions
 744 </p>
 745 </div>
 746 </div>
 747 <div id="content">
 748 <div class="sect1">
 749 <h2 id="_synopsis">SYNOPSIS</h2>
 750 <div class="sectionbody">
 751 <div class="paragraph"><p>gitcli</p></div>
 752 </div>
 753 </div>
 754 <div class="sect1">
 755 <h2 id="_description">DESCRIPTION</h2>
 756 <div class="sectionbody">
 757 <div class="paragraph"><p>This manual describes the convention used throughout Git CLI.</p></div>
 758 <div class="paragraph"><p>Many commands take revisions (most often "commits", but sometimes
 759 "tree-ish", depending on the context and command) and paths as their
 760 arguments.  Here are the rules:</p></div>
 761 <div class="ulist"><ul>
 762 <li>
 763 <p>
 764 Options come first and then args.
 765     A subcommand may take dashed options (which may take their own
 766     arguments, e.g. "--max-parents 2") and arguments.  You SHOULD
 767     give dashed options first and then arguments.  Some commands may
 768     accept dashed options after you have already given non-option
 769     arguments (which may make the command ambiguous), but you should
 770     not rely on it (because eventually we may find a way to fix
 771     these ambiguities by enforcing the "options then args" rule).
 772 </p>
 773 </li>
 774 <li>
 775 <p>
 776 Revisions come first and then paths.
 777    E.g. in <code>git diff v1.0 v2.0 arch/x86 include/asm-x86</code>,
 778    <code>v1.0</code> and <code>v2.0</code> are revisions and <code>arch/x86</code> and <code>include/asm-x86</code>
 779    are paths.
 780 </p>
 781 </li>
 782 <li>
 783 <p>
 784 When an argument can be misunderstood as either a revision or a path,
 785    they can be disambiguated by placing <code>--</code> between them.
 786    E.g. <code>git diff -- HEAD</code> is, "I have a file called HEAD in my work
 787    tree.  Please show changes between the version I staged in the index
 788    and what I have in the work tree for that file", not "show the difference
 789    between the HEAD commit and the work tree as a whole".  You can say
 790    <code>git diff HEAD --</code> to ask for the latter.
 791 </p>
 792 </li>
 793 <li>
 794 <p>
 795 Without disambiguating <code>--</code>, Git makes a reasonable guess, but errors
 796    out and asks you to disambiguate when ambiguous.  E.g. if you have a
 797    file called HEAD in your work tree, <code>git diff HEAD</code> is ambiguous, and
 798    you have to say either <code>git diff HEAD --</code> or <code>git diff -- HEAD</code> to
 799    disambiguate.
 800 </p>
 801 </li>
 802 <li>
 803 <p>
 804 Because <code>--</code> disambiguates revisions and paths in some commands, it
 805    cannot be used for those commands to separate options and revisions.
 806    You can use <code>--end-of-options</code> for this (it also works for commands
 807    that do not distinguish between revisions in paths, in which case it
 808    is simply an alias for <code>--</code>).
 809 </p>
 810 <div class="paragraph"><p>When writing a script that is expected to handle random user-input, it is
 811 a good practice to make it explicit which arguments are which by placing
 812 disambiguating <code>--</code> at appropriate places.</p></div>
 813 </li>
 814 <li>
 815 <p>
 816 Many commands allow wildcards in paths, but you need to protect
 817    them from getting globbed by the shell.  These two mean different
 818    things:
 819 </p>
 820 <div class="listingblock">
 821 <div class="content">
 822 <pre><code>$ git restore *.c
 823 $ git restore \*.c</code></pre>
 824 </div></div>
 825 <div class="paragraph"><p>The former lets your shell expand the fileglob, and you are asking
 826 the dot-C files in your working tree to be overwritten with the version
 827 in the index.  The latter passes the <code>*.c</code> to Git, and you are asking
 828 the paths in the index that match the pattern to be checked out to your
 829 working tree.  After running <code>git add hello.c; rm hello.c</code>, you will <em>not</em>
 830 see <code>hello.c</code> in your working tree with the former, but with the latter
 831 you will.</p></div>
 832 </li>
 833 <li>
 834 <p>
 835 Just as the filesystem <em>.</em> (period) refers to the current directory,
 836    using a <em>.</em> as a repository name in Git (a dot-repository) is a relative
 837    path and means your current repository.
 838 </p>
 839 </li>
 840 </ul></div>
 841 <div class="paragraph"><p>Here are the rules regarding the "flags" that you should follow when you are
 842 scripting Git:</p></div>
 843 <div class="ulist"><ul>
 844 <li>
 845 <p>
 846 Splitting short options to separate words (prefer <code>git foo -a -b</code>
 847    to <code>git foo -ab</code>, the latter may not even work).
 848 </p>
 849 </li>
 850 <li>
 851 <p>
 852 When a command-line option takes an argument, use the <em>stuck</em> form.  In
 853    other words, write <code>git foo -oArg</code> instead of <code>git foo -o Arg</code> for short
 854    options, and <code>git foo --long-opt=Arg</code> instead of <code>git foo --long-opt Arg</code>
 855    for long options.  An option that takes optional option-argument must be
 856    written in the <em>stuck</em> form.
 857 </p>
 858 </li>
 859 <li>
 860 <p>
 861 When you give a revision parameter to a command, make sure the parameter is
 862    not ambiguous with a name of a file in the work tree.  E.g. do not write
 863    <code>git log -1 HEAD</code> but write <code>git log -1 HEAD --</code>; the former will not work
 864    if you happen to have a file called <code>HEAD</code> in the work tree.
 865 </p>
 866 </li>
 867 <li>
 868 <p>
 869 Many commands allow a long option <code>--option</code> to be abbreviated
 870    only to their unique prefix (e.g. if there is no other option
 871    whose name begins with <code>opt</code>, you may be able to spell <code>--opt</code> to
 872    invoke the <code>--option</code> flag), but you should fully spell them out
 873    when writing your scripts; later versions of Git may introduce a
 874    new option whose name shares the same prefix, e.g. <code>--optimize</code>,
 875    to make a short prefix that used to be unique no longer unique.
 876 </p>
 877 </li>
 878 </ul></div>
 879 </div>
 880 </div>
 881 <div class="sect1">
 882 <h2 id="_enhanced_option_parser">ENHANCED OPTION PARSER</h2>
 883 <div class="sectionbody">
 884 <div class="paragraph"><p>From the Git 1.5.4 series and further, many Git commands (not all of them at the
 885 time of the writing though) come with an enhanced option parser.</p></div>
 886 <div class="paragraph"><p>Here is a list of the facilities provided by this option parser.</p></div>
 887 <div class="sect2">
 888 <h3 id="_magic_options">Magic Options</h3>
 889 <div class="paragraph"><p>Commands which have the enhanced option parser activated all understand a
 890 couple of magic command-line options:</p></div>
 891 <div class="dlist"><dl>
 892 <dt class="hdlist1">
 893 -h
 894 </dt>
 895 <dd>
 896 <p>
 897         gives a pretty printed usage of the command.
 898 </p>
 899 <div class="listingblock">
 900 <div class="content">
 901 <pre><code>$ git describe -h
 902 usage: git describe [&lt;options&gt;] &lt;commit-ish&gt;*
 903    or: git describe [&lt;options&gt;] --dirty
 904
 905     --contains            find the tag that comes after the commit
 906     --debug               debug search strategy on stderr
 907     --all                 use any ref
 908     --tags                use any tag, even unannotated
 909     --long                always use long format
 910     --abbrev[=&lt;n&gt;]        use &lt;n&gt; digits to display SHA-1s</code></pre>
 911 </div></div>
 912 <div class="paragraph"><p>Note that some subcommand (e.g. <code>git grep</code>) may behave differently
 913 when there are things on the command line other than <code>-h</code>, but <code>git
 914 subcmd -h</code> without anything else on the command line is meant to
 915 consistently give the usage.</p></div>
 916 </dd>
 917 <dt class="hdlist1">
 918 --help-all
 919 </dt>
 920 <dd>
 921 <p>
 922         Some Git commands take options that are only used for plumbing or that
 923         are deprecated, and such options are hidden from the default usage. This
 924         option gives the full list of options.
 925 </p>
 926 </dd>
 927 </dl></div>
 928 </div>
 929 <div class="sect2">
 930 <h3 id="_negating_options">Negating options</h3>
 931 <div class="paragraph"><p>Options with long option names can be negated by prefixing <code>--no-</code>. For
 932 example, <code>git branch</code> has the option <code>--track</code> which is <em>on</em> by default. You
 933 can use <code>--no-track</code> to override that behaviour. The same goes for <code>--color</code>
 934 and <code>--no-color</code>.</p></div>
 935 </div>
 936 <div class="sect2">
 937 <h3 id="_aggregating_short_options">Aggregating short options</h3>
 938 <div class="paragraph"><p>Commands that support the enhanced option parser allow you to aggregate short
 939 options. This means that you can for example use <code>git rm -rf</code> or
 940 <code>git clean -fdx</code>.</p></div>
 941 </div>
 942 <div class="sect2">
 943 <h3 id="_abbreviating_long_options">Abbreviating long options</h3>
 944 <div class="paragraph"><p>Commands that support the enhanced option parser accepts unique
 945 prefix of a long option as if it is fully spelled out, but use this
 946 with a caution.  For example, <code>git commit --amen</code> behaves as if you
 947 typed <code>git commit --amend</code>, but that is true only until a later version
 948 of Git introduces another option that shares the same prefix,
 949 e.g. <code>git commit --amenity</code> option.</p></div>
 950 </div>
 951 <div class="sect2">
 952 <h3 id="_separating_argument_from_the_option">Separating argument from the option</h3>
 953 <div class="paragraph"><p>You can write the mandatory option parameter to an option as a separate
 954 word on the command line.  That means that all the following uses work:</p></div>
 955 <div class="listingblock">
 956 <div class="content">
 957 <pre><code>$ git foo --long-opt=Arg
 958 $ git foo --long-opt Arg
 959 $ git foo -oArg
 960 $ git foo -o Arg</code></pre>
 961 </div></div>
 962 <div class="paragraph"><p>However, this is <strong>NOT</strong> allowed for switches with an optional value, where the
 963 <em>stuck</em> form must be used:</p></div>
 964 <div class="listingblock">
 965 <div class="content">
 966 <pre><code>$ git describe --abbrev HEAD     # correct
 967 $ git describe --abbrev=10 HEAD  # correct
 968 $ git describe --abbrev 10 HEAD  # NOT WHAT YOU MEANT</code></pre>
 969 </div></div>
 970 </div>
 971 </div>
 972 </div>
 973 <div class="sect1">
 974 <h2 id="_notes_on_frequently_confused_options">NOTES ON FREQUENTLY CONFUSED OPTIONS</h2>
 975 <div class="sectionbody">
 976 <div class="paragraph"><p>Many commands that can work on files in the working tree
 977 and/or in the index can take <code>--cached</code> and/or <code>--index</code>
 978 options.  Sometimes people incorrectly think that, because
 979 the index was originally called cache, these two are
 980 synonyms.  They are <strong>not</strong>&#8201;&#8212;&#8201;these two options mean very
 981 different things.</p></div>
 982 <div class="ulist"><ul>
 983 <li>
 984 <p>
 985 The <code>--cached</code> option is used to ask a command that
 986    usually works on files in the working tree to <strong>only</strong> work
 987    with the index.  For example, <code>git grep</code>, when used
 988    without a commit to specify from which commit to look for
 989    strings in, usually works on files in the working tree,
 990    but with the <code>--cached</code> option, it looks for strings in
 991    the index.
 992 </p>
 993 </li>
 994 <li>
 995 <p>
 996 The <code>--index</code> option is used to ask a command that
 997    usually works on files in the working tree to <strong>also</strong>
 998    affect the index.  For example, <code>git stash apply</code> usually
 999    merges changes recorded in a stash entry to the working tree,
1000    but with the <code>--index</code> option, it also merges changes to
1001    the index as well.
1002 </p>
1003 </li>
1004 </ul></div>
1005 <div class="paragraph"><p><code>git apply</code> command can be used with <code>--cached</code> and
1006 <code>--index</code> (but not at the same time).  Usually the command
1007 only affects the files in the working tree, but with
1008 <code>--index</code>, it patches both the files and their index
1009 entries, and with <code>--cached</code>, it modifies only the index
1010 entries.</p></div>
1011 <div class="paragraph"><p>See also <a href="https://lore.kernel.org/git/7v64clg5u9.fsf@assigned-by-dhcp.cox.net/">https://lore.kernel.org/git/7v64clg5u9.fsf@assigned-by-dhcp.cox.net/</a> and
1012 <a href="https://lore.kernel.org/git/7vy7ej9g38.fsf@gitster.siamese.dyndns.org/">https://lore.kernel.org/git/7vy7ej9g38.fsf@gitster.siamese.dyndns.org/</a> for further
1013 information.</p></div>
1014 <div class="paragraph"><p>Some other commands that also work on files in the working tree and/or
1015 in the index can take <code>--staged</code> and/or <code>--worktree</code>.</p></div>
1016 <div class="ulist"><ul>
1017 <li>
1018 <p>
1019 <code>--staged</code> is exactly like <code>--cached</code>, which is used to ask a
1020   command to only work on the index, not the working tree.
1021 </p>
1022 </li>
1023 <li>
1024 <p>
1025 <code>--worktree</code> is the opposite, to ask a command to work on the
1026   working tree only, not the index.
1027 </p>
1028 </li>
1029 <li>
1030 <p>
1031 The two options can be specified together to ask a command to work
1032   on both the index and the working tree.
1033 </p>
1034 </li>
1035 </ul></div>
1036 </div>
1037 </div>
1038 <div class="sect1">
1039 <h2 id="_git">GIT</h2>
1040 <div class="sectionbody">
1041 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1042 </div>
1043 </div>
1044 </div>
1045 <div id="footnotes"><hr /></div>
1046 <div id="footer">
1047 <div id="footer-text">
1048 Last updated
1049  2024-03-11 15:39:49 PDT
1050 </div>
1051 </div>
1052 </body>
1053 </html>