Google Git
Sign in
chromium / external / gitster / git-htmldocs / 7bd050fbdc12530213c7058bbba1b4a333ec7c02 / . / git-status.html
blob: eba951806b17838f87407e5645ba7d1a5aae1097 [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:23[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>git-status(1)</title>
Junio C Hamano1a4e8412005-12-27 08:17:23[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 Hamanoba4b9282008-07-06 05:20:31[diff] [blame]20a {
21 color: blue;
22 text-decoration: underline;
23}
24a:visited {
25 color: fuchsia;
26}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]27
28em {
29 font-style: italic;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]30 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]31}
32
33strong {
34 font-weight: bold;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]35 color: #083194;
Junio C Hamano1a4e8412005-12-27 08:17:23[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 Hamanoba4b9282008-07-06 05:20:31[diff] [blame]50h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]51 border-bottom: 2px solid silver;
52}
53h2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]54 padding-top: 0.5em;
55}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]56h3 {
57 float: left;
58}
59h3 + * {
60 clear: left;
61}
Junio C Hamano1a4e8412005-12-27 08:17:23[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 Hamano1a4e8412005-12-27 08:17:23[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 Hamanoba4b9282008-07-06 05:20:31[diff] [blame]90 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]91}
92span#email {
93}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]94span#revnumber, span#revdate, span#revremark {
Junio C Hamano1a4e8412005-12-27 08:17:23[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 Hamano1a4e8412005-12-27 08:17:23[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 Hamano1a4e8412005-12-27 08:17:23[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 Hamano1a4e8412005-12-27 08:17:23[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 Hamano1a4e8412005-12-27 08:17:23[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 Hamano1a4e8412005-12-27 08:17:23[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 Hamano1a4e8412005-12-27 08:17:23[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 Hamanoba4b9282008-07-06 05:20:31[diff] [blame]191div.verseblock + div.attribution {
192 text-align: left;
193}
Junio C Hamano1a4e8412005-12-27 08:17:23[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 Hamano1a4e8412005-12-27 08:17:23[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 Hamano1a4e8412005-12-27 08:17:23[diff] [blame]211}
212
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]213div.imageblock div.content { padding-left: 0; }
Junio C Hamano1a4e8412005-12-27 08:17:23[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 Hamano1a4e8412005-12-27 08:17:23[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 Hamano1a4e8412005-12-27 08:17:23[diff] [blame]226}
227dd > *:first-child {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]228 margin-top: 0.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[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 Hamano1a4e8412005-12-27 08:17:23[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 Hamano1a4e8412005-12-27 08:17:23[diff] [blame]256
257div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]258 border: 3px solid #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]259}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame^]260thead, p.table.header {
Junio C Hamano1a4e8412005-12-27 08:17:23[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 Hamano1a4e8412005-12-27 08:17:23[diff] [blame]285
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]286
287div.hdlist {
Junio C Hamano1a4e8412005-12-27 08:17:23[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 Hamanoba4b9282008-07-06 05:20:31[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 Hamano1a4e8412005-12-27 08:17:23[diff] [blame]298 vertical-align: top;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]299 font-style: normal;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]300 padding-right: 0.8em;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]301 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]302}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]303td.hdlist2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[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 Hamano1a4e8412005-12-27 08:17:23[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 Hamano1a4e8412005-12-27 08:17:23[diff] [blame]343@media print {
344 div#footer-badges { display: none; }
345}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]346
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame^]347div#toc {
348 margin-bottom: 2.5em;
349}
350
Junio C Hamanoba4b9282008-07-06 05:20:31[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 Hamano1a4e8412005-12-27 08:17:23[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 Hamano1a4e8412005-12-27 08:17:23[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 Hamano1a4e8412005-12-27 08:17:23[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 Hamano1a4e8412005-12-27 08:17:23[diff] [blame]430 padding-left: 0.5em;
431}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]432
433/* IE6 sets dynamically generated links as visited. */
434div#toc a:visited { color: blue; }
Junio C Hamano1a4e8412005-12-27 08:17:23[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 Hamano1a4e8412005-12-27 08:17:23[diff] [blame]569</head>
570<body>
571<div id="header">
572<h1>
573git-status(1) Manual Page
574</h1>
575<h2>NAME</h2>
576<div class="sectionbody">
577<p>git-status -
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]578 Show the working tree status
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]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 Hamano1a4e8412005-12-27 08:17:23[diff] [blame]584<div class="sectionbody">
Junio C Hamano15567bc2011-07-23 00:51:59[diff] [blame]585<div class="verseblock">
586<div class="verseblock-content"><em>git status</em> [&lt;options&gt;&#8230;] [--] [&lt;pathspec&gt;&#8230;]</div>
587<div class="verseblock-attribution">
588</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]589</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]590<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]591<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]592<div class="paragraph"><p>Displays paths that have differences between the index file and the
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]593current HEAD commit, paths that have differences between the working
594tree and the index file, and paths in the working tree that are not
595tracked by git (and are not ignored by <a href="gitignore.html">gitignore(5)</a>). The first
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]596are what you <em>would</em> commit by running <tt>git commit</tt>; the second and
597third are what you <em>could</em> commit by running <em>git add</em> before running
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]598<tt>git commit</tt>.</p></div>
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]599</div>
600<h2 id="_options">OPTIONS</h2>
601<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]602<div class="dlist"><dl>
603<dt class="hdlist1">
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]604-s
605</dt>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]606<dt class="hdlist1">
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]607--short
608</dt>
609<dd>
610<p>
611 Give the output in the short-format.
612</p>
613</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]614<dt class="hdlist1">
Junio C Hamanof5de4cf2010-06-19 00:33:17[diff] [blame]615-b
616</dt>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]617<dt class="hdlist1">
Junio C Hamanof5de4cf2010-06-19 00:33:17[diff] [blame]618--branch
619</dt>
620<dd>
621<p>
622 Show the branch and tracking info even in short-format.
623</p>
624</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]625<dt class="hdlist1">
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]626--porcelain
627</dt>
628<dd>
629<p>
Junio C Hamanoef5a2f92011-05-31 19:53:33[diff] [blame]630 Give the output in an easy-to-parse format for scripts.
631 This is similar to the short output, but will remain stable
632 across git versions and regardless of user configuration. See
633 below for details.
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]634</p>
635</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]636<dt class="hdlist1">
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]637-u[&lt;mode&gt;]
638</dt>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]639<dt class="hdlist1">
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]640--untracked-files[=&lt;mode&gt;]
641</dt>
642<dd>
643<p>
Junio C Hamano36a4dbc2011-02-22 07:51:32[diff] [blame]644 Show untracked files.
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]645</p>
Junio C Hamano36a4dbc2011-02-22 07:51:32[diff] [blame]646<div class="paragraph"><p>The mode parameter is optional (defaults to <em>all</em>), and is used to
647specify the handling of untracked files; when -u is not used, the
648default is <em>normal</em>, i.e. show untracked files and directories.</p></div>
649<div class="paragraph"><p>The possible options are:</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]650<div class="ulist"><ul>
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]651<li>
652<p>
653<em>no</em> - Show no untracked files
654</p>
655</li>
656<li>
657<p>
658<em>normal</em> - Shows untracked files and directories
659</p>
660</li>
661<li>
662<p>
663<em>all</em> - Also shows individual files in untracked directories.
664</p>
Junio C Hamano36a4dbc2011-02-22 07:51:32[diff] [blame]665<div class="paragraph"><p>The default can be changed using the status.showUntrackedFiles
666configuration variable documented in <a href="git-config.html">git-config(1)</a>.</p></div>
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]667</li>
668</ul></div>
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]669</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]670<dt class="hdlist1">
Junio C Hamano7d449522010-07-01 00:08:51[diff] [blame]671--ignore-submodules[=&lt;when&gt;]
672</dt>
673<dd>
674<p>
675 Ignore changes to submodules when looking for changes. &lt;when&gt; can be
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame]676 either "none", "untracked", "dirty" or "all", which is the default.
677 Using "none" will consider the submodule modified when it either contains
678 untracked or modified files or its HEAD differs from the commit recorded
679 in the superproject and can be used to override any settings of the
680 <em>ignore</em> option in <a href="git-config.html">git-config(1)</a> or <a href="gitmodules.html">gitmodules(5)</a>. When
Junio C Hamano7d449522010-07-01 00:08:51[diff] [blame]681 "untracked" is used submodules are not considered dirty when they only
682 contain untracked content (but they are still scanned for modified
683 content). Using "dirty" ignores all changes to the work tree of submodules,
684 only changes to the commits stored in the superproject are shown (this was
685 the behavior before 1.7.0). Using "all" hides all changes to submodules
686 (and suppresses the output of submodule summaries when the config option
687 <tt>status.submodulesummary</tt> is set).
688</p>
689</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]690<dt class="hdlist1">
Junio C Hamano4c4b0122011-06-30 01:19:32[diff] [blame]691--ignored
692</dt>
693<dd>
694<p>
695 Show ignored files as well.
696</p>
697</dd>
698<dt class="hdlist1">
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]699-z
700</dt>
701<dd>
702<p>
703 Terminate entries with NUL, instead of LF. This implies
704 the <tt>--porcelain</tt> output format if no other format is given.
705</p>
706</dd>
707</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]708</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]709<h2 id="_output">OUTPUT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]710<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]711<div class="paragraph"><p>The output from this command is designed to be used as a commit
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]712template comment, and all the output lines are prefixed with <em>#</em>.
713The default, long format, is designed to be human readable,
Junio C Hamanoef5a2f92011-05-31 19:53:33[diff] [blame]714verbose and descriptive. Its contents and format are subject to change
715at any time.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]716<div class="paragraph"><p>The paths mentioned in the output, unlike many other git commands, are
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]717made relative to the current directory if you are working in a
718subdirectory (this is on purpose, to help cutting and pasting). See
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]719the status.relativePaths config option below.</p></div>
Junio C Hamanoef5a2f92011-05-31 19:53:33[diff] [blame]720<h3 id="_short_format">Short Format</h3><div style="clear:left"></div>
721<div class="paragraph"><p>In the short-format, the status of each path is shown as</p></div>
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]722<div class="literalblock">
723<div class="content">
724<pre><tt>XY PATH1 -&gt; PATH2</tt></pre>
725</div></div>
Junio C Hamanoef5a2f92011-05-31 19:53:33[diff] [blame]726<div class="paragraph"><p>where <tt>PATH1</tt> is the path in the <tt>HEAD</tt>, and the ` -&gt; PATH2` part is
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]727shown only when <tt>PATH1</tt> corresponds to a different path in the
Junio C Hamanofc5d7352010-04-24 02:59:11[diff] [blame]728index/worktree (i.e. the file is renamed). The <em>XY</em> is a two-letter
729status code.</p></div>
Junio C Hamanoef5a2f92011-05-31 19:53:33[diff] [blame]730<div class="paragraph"><p>The fields (including the <tt>-&gt;</tt>) are separated from each other by a
Junio C Hamanofc5d7352010-04-24 02:59:11[diff] [blame]731single space. If a filename contains whitespace or other nonprintable
732characters, that field will be quoted in the manner of a C string
733literal: surrounded by ASCII double quote (34) characters, and with
734interior special characters backslash-escaped.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]735<div class="paragraph"><p>For paths with merge conflicts, <tt>X</tt> and <em>Y</em> show the modification
Junio C Hamanofc5d7352010-04-24 02:59:11[diff] [blame]736states of each side of the merge. For paths that do not have merge
737conflicts, <tt>X</tt> shows the status of the index, and <tt>Y</tt> shows the status
738of the work tree. For untracked paths, <tt>XY</tt> are <tt>??</tt>. Other status
739codes can be interpreted as follows:</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]740<div class="ulist"><ul>
Junio C Hamanofc5d7352010-04-24 02:59:11[diff] [blame]741<li>
742<p>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]743' ' = unmodified
Junio C Hamanofc5d7352010-04-24 02:59:11[diff] [blame]744</p>
745</li>
746<li>
747<p>
748<em>M</em> = modified
749</p>
750</li>
751<li>
752<p>
753<em>A</em> = added
754</p>
755</li>
756<li>
757<p>
758<em>D</em> = deleted
759</p>
760</li>
761<li>
762<p>
763<em>R</em> = renamed
764</p>
765</li>
766<li>
767<p>
768<em>C</em> = copied
769</p>
770</li>
771<li>
772<p>
773<em>U</em> = updated but unmerged
774</p>
775</li>
776</ul></div>
Junio C Hamano4c4b0122011-06-30 01:19:32[diff] [blame]777<div class="paragraph"><p>Ignored files are not listed, unless <tt>--ignored</tt> option is in effect,
778in which case <tt>XY</tt> are <tt>!!</tt>.</p></div>
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]779<div class="literalblock">
780<div class="content">
781<pre><tt>X Y Meaning
782-------------------------------------------------
783 [MD] not updated
784M [ MD] updated in index
785A [ MD] added to index
Junio C Hamanofc5d7352010-04-24 02:59:11[diff] [blame]786D [ M] deleted from index
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]787R [ MD] renamed in index
788C [ MD] copied in index
789[MARC] index and work tree matches
790[ MARC] M work tree changed since index
791[ MARC] D deleted in work tree
792-------------------------------------------------
793D D unmerged, both deleted
794A U unmerged, added by us
795U D unmerged, deleted by them
796U A unmerged, added by them
797D U unmerged, deleted by us
798A A unmerged, both added
799U U unmerged, both modified
800-------------------------------------------------
801? ? untracked
Junio C Hamano4c4b0122011-06-30 01:19:32[diff] [blame]802! ! ignored
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]803-------------------------------------------------</tt></pre>
804</div></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]805<div class="paragraph"><p>If -b is used the short-format status is preceded by a line</p></div>
806<div class="paragraph"><p>## branchname tracking info</p></div>
Junio C Hamanoef5a2f92011-05-31 19:53:33[diff] [blame]807<h3 id="_porcelain_format">Porcelain Format</h3><div style="clear:left"></div>
808<div class="paragraph"><p>The porcelain format is similar to the short format, but is guaranteed
809not to change in a backwards-incompatible way between git versions or
810based on user configuration. This makes it ideal for parsing by scripts.
811The description of the short format above also describes the porcelain
812format, with a few exceptions:</p></div>
813<div class="olist arabic"><ol class="arabic">
814<li>
815<p>
816The user&#8217;s color.status configuration is not respected; color will
817 always be off.
818</p>
819</li>
820<li>
821<p>
822The user&#8217;s status.relativePaths configuration is not respected; paths
823 shown will always be relative to the repository root.
824</p>
825</li>
826</ol></div>
827<div class="paragraph"><p>There is also an alternate -z format recommended for machine parsing. In
Junio C Hamanofc5d7352010-04-24 02:59:11[diff] [blame]828that format, the status field is the same, but some other things
Junio C Hamanoef5a2f92011-05-31 19:53:33[diff] [blame]829change. First, the <em>-&gt;</em> is omitted from rename entries and the field
830order is reversed (e.g <em>from -&gt; to</em> becomes <em>to from</em>). Second, a NUL
Junio C Hamanofc5d7352010-04-24 02:59:11[diff] [blame]831(ASCII 0) follows each filename, replacing space as a field separator
832and the terminating newline (but a space still separates the status
833field from the first filename). Third, filenames containing special
834characters are not specially formatted; no quoting or
Junio C Hamanof5de4cf2010-06-19 00:33:17[diff] [blame]835backslash-escaping is performed. Fourth, there is no branch line.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]836</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]837<h2 id="_configuration">CONFIGURATION</h2>
Junio C Hamanof9771f62007-01-17 17:42:30[diff] [blame]838<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]839<div class="paragraph"><p>The command honors <tt>color.status</tt> (or <tt>status.color</tt>&#8201;&#8212;&#8201;they
Junio C Hamanof9771f62007-01-17 17:42:30[diff] [blame]840mean the same thing and the latter is kept for backward
841compatibility) and <tt>color.status.&lt;slot&gt;</tt> configuration variables
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]842to colorize its output.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]843<div class="paragraph"><p>If the config variable <tt>status.relativePaths</tt> is set to false, then all
Junio C Hamano942b35e2007-12-09 10:19:33[diff] [blame]844paths shown are relative to the repository root, not to the current
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]845directory.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]846<div class="paragraph"><p>If <tt>status.submodulesummary</tt> is set to a non zero number or true (identical
Junio C Hamanoa0fae262009-12-28 09:33:50[diff] [blame]847to -1 or an unlimited number), the submodule summary will be enabled for
848the long format and a summary of commits for modified submodules will be
849shown (see --summary-limit option of <a href="git-submodule.html">git-submodule(1)</a>).</p></div>
Junio C Hamano679d22d2007-06-02 21:13:44[diff] [blame]850</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]851<h2 id="_see_also">SEE ALSO</h2>
Junio C Hamano679d22d2007-06-02 21:13:44[diff] [blame]852<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]853<div class="paragraph"><p><a href="gitignore.html">gitignore(5)</a></p></div>
Junio C Hamanof9771f62007-01-17 17:42:30[diff] [blame]854</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]855<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]856<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]857<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]858</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame^]859</div>
860<div id="footnotes"><hr /></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]861<div id="footer">
862<div id="footer-text">
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame^]863Last updated 2011-09-21 23:01:14 PDT
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]864</div>
865</div>
866</body>
867</html>