Google Git
Sign in
chromium / external / gitster / git-htmldocs / 01dc5cac58624882e0859d91b9d259780e83fb22 / . / gitcli.html
blob: c215a93b0478a7083a152885a8f573a829246fe6 [file] [log] [blame]
Junio C Hamanof556fc22007-12-23 08:16:38[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 Hamano7bd050f2011-09-22 06:32:22[diff] [blame]6<meta name="generator" content="AsciiDoc 8.5.2" />
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]7<title>gitcli(7)</title>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]8<style type="text/css">
9/* Debug borders */
10p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11/*
12 border: 1px solid red;
13*/
14}
15
16body {
17 margin: 1em 5% 1em 5%;
18}
19
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]20a {
21 color: blue;
22 text-decoration: underline;
23}
24a:visited {
25 color: fuchsia;
26}
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]27
28em {
29 font-style: italic;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]30 color: navy;
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]31}
32
33strong {
34 font-weight: bold;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]35 color: #083194;
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]36}
37
38tt {
39 color: navy;
40}
41
42h1, 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;
48}
49
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]50h1, h2, h3 {
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]51 border-bottom: 2px solid silver;
52}
53h2 {
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]54 padding-top: 0.5em;
55}
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]56h3 {
57 float: left;
58}
59h3 + * {
60 clear: left;
61}
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]62
63div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
66}
67
68hr {
69 border: 1px solid silver;
70}
71
72p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
75}
76
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]77ul, ol, li > p {
78 margin-top: 0;
79}
80
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]81pre {
82 padding: 0;
83 margin: 0;
84}
85
86span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]90 font-size: 1.1em;
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]91}
92span#email {
93}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]94span#revnumber, span#revdate, span#revremark {
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]95 font-family: sans-serif;
96}
97
98div#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;
104}
105div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
108}
109div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
112}
113
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]114div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
117}
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]118div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]121 margin-top: 1.0em;
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]122 margin-bottom: 1.5em;
123}
124div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]129}
130
131div.content { /* Block element content. */
132 padding: 0;
133}
134
135/* Block element titles. */
136div.title, caption.title {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]137 color: #527bbd;
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
143}
144div.title + * {
145 margin-top: 0;
146}
147
148td div.title:first-child {
149 margin-top: 0.0em;
150}
151div.content div.title:first-child {
152 margin-top: 0.0em;
153}
154div.content + div.title {
155 margin-top: 0.0em;
156}
157
158div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
162}
163
164div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
168}
169
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]170div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]173 margin-right: 10%;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]174 border-left: 5px solid #dddddd;
175 color: #777777;
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]176}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]177
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]178div.quoteblock > div.attribution {
179 padding-top: 0.5em;
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]180 text-align: right;
181}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]182
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]183div.verseblock > div.content {
184 white-space: pre;
185}
186div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
189}
190/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]191div.verseblock + div.attribution {
192 text-align: left;
193}
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]194
195div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
202}
203div.admonitionblock td.content {
204 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]205 border-left: 3px solid #dddddd;
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]206}
207
208div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]211}
212
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]213div.imageblock div.content { padding-left: 0; }
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]214span.image img { border-style: none; }
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]215a.image:visited { color: white; }
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]216
217dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
220}
221dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]224 font-style: normal;
225 color: navy;
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]226}
227dd > *:first-child {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]228 margin-top: 0.1em;
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]229}
230
231ul, ol {
232 list-style-position: outside;
233}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]234ol.arabic {
235 list-style-type: decimal;
236}
237ol.loweralpha {
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]238 list-style-type: lower-alpha;
239}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]240ol.upperalpha {
241 list-style-type: upper-alpha;
242}
243ol.lowerroman {
244 list-style-type: lower-roman;
245}
246ol.upperroman {
247 list-style-type: upper-roman;
248}
249
250div.compact ul, div.compact ol,
251div.compact p, div.compact p,
252div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
255}
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]256
257div.tableblock > table {
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]258 border: 3px solid #527bbd;
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]259}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]260thead, p.table.header {
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]261 font-family: sans-serif;
262 font-weight: bold;
263}
264tfoot {
265 font-weight: bold;
266}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]267td > div.verse {
268 white-space: pre;
269}
270p.table {
271 margin-top: 0;
272}
273/* Because the table frame attribute is overriden by CSS in most browsers. */
274div.tableblock > table[frame="void"] {
275 border-style: none;
276}
277div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
280}
281div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
284}
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]285
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]286
287div.hdlist {
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
290}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]291div.hdlist tr {
292 padding-bottom: 15px;
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]293}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]294dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
296}
297td.hdlist1 {
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]298 vertical-align: top;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]299 font-style: normal;
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]300 padding-right: 0.8em;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]301 color: navy;
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]302}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]303td.hdlist2 {
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]304 vertical-align: top;
305}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]306div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
309}
310
311.comment {
312 background: yellow;
313}
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]314
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]315.footnote, .footnoteref {
316 font-size: 0.8em;
317}
318
319span.footnote, span.footnoteref {
320 vertical-align: super;
321}
322
323#footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
326}
327
328#footnotes div.footnote {
329 margin: 0 0 5px 0;
330}
331
332#footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
340}
341
342
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]343@media print {
344 div#footer-badges { display: none; }
345}
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]346
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]347div#toc {
348 margin-bottom: 2.5em;
349}
350
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]351div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
358}
359
360div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
363}
364div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
367}
368div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
371}
372div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
375}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]376/* Overrides for manpage documents */
377h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
382}
383h2 {
384 border-style: none;
385}
386div.sectionbody {
387 margin-left: 5%;
388}
389
390@media print {
391 div#toc { display: none; }
392}
393
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]394/* Workarounds for IE6's broken and incomplete CSS2. */
395
396div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
400}
401div.sidebar-title, div.image-title {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]402 color: #527bbd;
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
407}
408
409div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
413}
414
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]415div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
418}
419
420div.verseblock-content {
421 white-space: pre;
422}
423div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]426}
427
428div.exampleblock-content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]429 border-left: 3px solid #dddddd;
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]430 padding-left: 0.5em;
431}
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]432
433/* IE6 sets dynamically generated links as visited. */
434div#toc a:visited { color: blue; }
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]435</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]436<script type="text/javascript">
437/*<![CDATA[*/
438window.onload = function(){asciidoc.footnotes();}
439var asciidoc = { // Namespace.
440
441/////////////////////////////////////////////////////////////////////
442// Table Of Contents generator
443/////////////////////////////////////////////////////////////////////
444
445/* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
447 *
448 * Table Of Content generator
449 * Version: 0.4
450 *
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
453 */
454
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
457
458// toclevels = 1..4.
459toc: function (toclevels) {
460
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
468 }
469 return text;
470 }
471
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
476 }
477
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
490 }
491 iterate(i);
492 }
493 }
494 }
495 iterate(el);
496 return result;
497 }
498
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
512 }
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
515},
516
517
518/////////////////////////////////////////////////////////////////////
519// Footnotes generator
520/////////////////////////////////////////////////////////////////////
521
522/* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
524 */
525
526footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
547 }
548 }
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
561 }
562 }
563 }
564}
565
566}
567/*]]>*/
568</script>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]569</head>
570<body>
571<div id="header">
572<h1>
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]573gitcli(7) Manual Page
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]574</h1>
575<h2>NAME</h2>
576<div class="sectionbody">
577<p>gitcli -
578 git command line interface and conventions
579</p>
580</div>
581</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]582<div id="content">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]583<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]584<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]585<div class="paragraph"><p>gitcli</p></div>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]586</div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]587<h2 id="_description">DESCRIPTION</h2>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]588<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]589<div class="paragraph"><p>This manual describes the convention used throughout git CLI.</p></div>
590<div class="paragraph"><p>Many commands take revisions (most often "commits", but sometimes
Junio C Hamanoc4fec202008-06-28 10:07:24[diff] [blame]591"tree-ish", depending on the context and command) and paths as their
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]592arguments. Here are the rules:</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]593<div class="ulist"><ul>
Junio C Hamanoc4fec202008-06-28 10:07:24[diff] [blame]594<li>
595<p>
596Revisions come first and then paths.
597 E.g. in <tt>git diff v1.0 v2.0 arch/x86 include/asm-x86</tt>,
598 <tt>v1.0</tt> and <tt>v2.0</tt> are revisions and <tt>arch/x86</tt> and <tt>include/asm-x86</tt>
599 are paths.
600</p>
601</li>
602<li>
603<p>
604When an argument can be misunderstood as either a revision or a path,
605 they can be disambiguated by placing <tt>--</tt> between them.
606 E.g. <tt>git diff -- HEAD</tt> is, "I have a file called HEAD in my work
607 tree. Please show changes between the version I staged in the index
608 and what I have in the work tree for that file". not "show difference
609 between the HEAD commit and the work tree as a whole". You can say
610 <tt>git diff HEAD --</tt> to ask for the latter.
611</p>
612</li>
613<li>
614<p>
615Without disambiguating <tt>--</tt>, git makes a reasonable guess, but errors
616 out and asking you to disambiguate when ambiguous. E.g. if you have a
617 file called HEAD in your work tree, <tt>git diff HEAD</tt> is ambiguous, and
618 you have to say either <tt>git diff HEAD --</tt> or <tt>git diff -- HEAD</tt> to
619 disambiguate.
620</p>
621</li>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]622</ul></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]623<div class="paragraph"><p>When writing a script that is expected to handle random user-input, it is
Junio C Hamanoc4fec202008-06-28 10:07:24[diff] [blame]624a good practice to make it explicit which arguments are which by placing
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]625disambiguating <tt>--</tt> at appropriate places.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]626<div class="paragraph"><p>Here are the rules regarding the "flags" that you should follow when you are
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]627scripting git:</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]628<div class="ulist"><ul>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]629<li>
630<p>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]631it&#8217;s preferred to use the non dashed form of git commands, which means that
Junio C Hamanoea82cff2009-03-18 01:54:48[diff] [blame]632 you should prefer <tt>git foo</tt> to <tt>git-foo</tt>.
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]633</p>
634</li>
635<li>
636<p>
Junio C Hamanoea82cff2009-03-18 01:54:48[diff] [blame]637splitting short options to separate words (prefer <tt>git foo -a -b</tt>
638 to <tt>git foo -ab</tt>, the latter may not even work).
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]639</p>
640</li>
641<li>
642<p>
643when a command line option takes an argument, use the <em>sticked</em> form. In
Junio C Hamanoea82cff2009-03-18 01:54:48[diff] [blame]644 other words, write <tt>git foo -oArg</tt> instead of <tt>git foo -o Arg</tt> for short
645 options, and <tt>git foo --long-opt=Arg</tt> instead of <tt>git foo --long-opt Arg</tt>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]646 for long options. An option that takes optional option-argument must be
647 written in the <em>sticked</em> form.
648</p>
649</li>
650<li>
651<p>
652when you give a revision parameter to a command, make sure the parameter is
653 not ambiguous with a name of a file in the work tree. E.g. do not write
Junio C Hamanoea82cff2009-03-18 01:54:48[diff] [blame]654 <tt>git log -1 HEAD</tt> but write <tt>git log -1 HEAD --</tt>; the former will not work
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]655 if you happen to have a file called <tt>HEAD</tt> in the work tree.
656</p>
657</li>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]658</ul></div>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]659</div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]660<h2 id="_enhanced_option_parser">ENHANCED OPTION PARSER</h2>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]661<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]662<div class="paragraph"><p>From the git 1.5.4 series and further, many git commands (not all of them at the
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]663time of the writing though) come with an enhanced option parser.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]664<div class="paragraph"><p>Here is an exhaustive list of the facilities provided by this option parser.</p></div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]665<h3 id="_magic_options">Magic Options</h3><div style="clear:left"></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]666<div class="paragraph"><p>Commands which have the enhanced option parser activated all understand a
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]667couple of magic command line options:</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]668<div class="dlist"><dl>
669<dt class="hdlist1">
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]670-h
671</dt>
672<dd>
673<p>
674 gives a pretty printed usage of the command.
675</p>
676<div class="listingblock">
677<div class="content">
678<pre><tt>$ git describe -h
Junio C Hamanoe74124b2009-09-23 06:51:01[diff] [blame]679usage: git describe [options] &lt;committish&gt;*
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]680
681 --contains find the tag that comes after the commit
682 --debug debug search strategy on stderr
683 --all use any ref in .git/refs
684 --tags use any tag in .git/refs/tags
685 --abbrev [&lt;n&gt;] use &lt;n&gt; digits to display SHA-1s
686 --candidates &lt;n&gt; consider &lt;n&gt; most recent tags (default: 10)</tt></pre>
687</div></div>
688</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]689<dt class="hdlist1">
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]690--help-all
691</dt>
692<dd>
693<p>
694 Some git commands take options that are only used for plumbing or that
695 are deprecated, and such options are hidden from the default usage. This
696 option gives the full list of options.
697</p>
698</dd>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]699</dl></div>
700<h3 id="_negating_options">Negating options</h3><div style="clear:left"></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]701<div class="paragraph"><p>Options with long option names can be negated by prefixing <tt>--no-</tt>. For
Junio C Hamanoea82cff2009-03-18 01:54:48[diff] [blame]702example, <tt>git branch</tt> has the option <tt>--track</tt> which is <em>on</em> by default. You
703can use <tt>--no-track</tt> to override that behaviour. The same goes for <tt>--color</tt>
704and <tt>--no-color</tt>.</p></div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]705<h3 id="_aggregating_short_options">Aggregating short options</h3><div style="clear:left"></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]706<div class="paragraph"><p>Commands that support the enhanced option parser allow you to aggregate short
Junio C Hamanoea82cff2009-03-18 01:54:48[diff] [blame]707options. This means that you can for example use <tt>git rm -rf</tt> or
708<tt>git clean -fdx</tt>.</p></div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]709<h3 id="_separating_argument_from_the_option">Separating argument from the option</h3><div style="clear:left"></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]710<div class="paragraph"><p>You can write the mandatory option parameter to an option as a separate
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]711word on the command line. That means that all the following uses work:</p></div>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]712<div class="listingblock">
713<div class="content">
714<pre><tt>$ git foo --long-opt=Arg
715$ git foo --long-opt Arg
716$ git foo -oArg
717$ git foo -o Arg</tt></pre>
718</div></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]719<div class="paragraph"><p>However, this is <strong>NOT</strong> allowed for switches with an optional value, where the
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]720<em>sticked</em> form must be used:</p></div>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]721<div class="listingblock">
722<div class="content">
723<pre><tt>$ git describe --abbrev HEAD # correct
724$ git describe --abbrev=10 HEAD # correct
725$ git describe --abbrev 10 HEAD # NOT WHAT YOU MEANT</tt></pre>
726</div></div>
727</div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]728<h2 id="_notes_on_frequently_confused_options">NOTES ON FREQUENTLY CONFUSED OPTIONS</h2>
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]729<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]730<div class="paragraph"><p>Many commands that can work on files in the working tree
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]731and/or in the index can take <tt>--cached</tt> and/or <tt>--index</tt>
732options. Sometimes people incorrectly think that, because
733the index was originally called cache, these two are
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]734synonyms. They are <strong>not</strong>&#8201;&#8212;&#8201;these two options mean very
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]735different things.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]736<div class="ulist"><ul>
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]737<li>
738<p>
739The <tt>--cached</tt> option is used to ask a command that
740 usually works on files in the working tree to <strong>only</strong> work
741 with the index. For example, <tt>git grep</tt>, when used
742 without a commit to specify from which commit to look for
743 strings in, usually works on files in the working tree,
744 but with the <tt>--cached</tt> option, it looks for strings in
745 the index.
746</p>
747</li>
748<li>
749<p>
750The <tt>--index</tt> option is used to ask a command that
751 usually works on files in the working tree to <strong>also</strong>
752 affect the index. For example, <tt>git stash apply</tt> usually
753 merges changes recorded in a stash to the working tree,
754 but with the <tt>--index</tt> option, it also merges changes to
755 the index as well.
756</p>
757</li>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]758</ul></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]759<div class="paragraph"><p><tt>git apply</tt> command can be used with <tt>--cached</tt> and
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]760<tt>--index</tt> (but not at the same time). Usually the command
761only affects the files in the working tree, but with
762<tt>--index</tt>, it patches both the files and their index
763entries, and with <tt>--cached</tt>, it modifies only the index
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]764entries.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]765<div class="paragraph"><p>See also <a href="http://marc.info/?l=git&amp;m=116563135620359">http://marc.info/?l=git&amp;m=116563135620359</a> and
766<a href="http://marc.info/?l=git&amp;m=119150393620273">http://marc.info/?l=git&amp;m=119150393620273</a> for further
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]767information.</p></div>
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]768</div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]769<h2 id="_git">GIT</h2>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]770<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]771<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]772</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]773</div>
774<div id="footnotes"><hr /></div>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]775<div id="footer">
776<div id="footer-text">
Junio C Hamano02194af2011-11-17 20:33:59[diff] [blame]777Last updated 2011-11-15 13:45:02 PDT
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]778</div>
779</div>
780</body>
781</html>