Autogenerated HTML docs for v1.7.5.1-339-gb602ed
[git/jnareb-git.git] / git-status.html
blob9ce68e5e274d74ee4194328534fe3ec37ccac854
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.4.5" />
7 <title>git-status(1)</title>
8 <style type="text/css">
9 /* Debug borders */
10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
42 h1, 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;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
98 div#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;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120 div.admonitionblock {
121 margin-top: 1.5em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.5em;
126 margin-bottom: 2.5em;
129 div.content { /* Block element content. */
130 padding: 0;
133 /* Block element titles. */
134 div.title, caption.title {
135 color: #527bbd;
136 font-family: sans-serif;
137 font-weight: bold;
138 text-align: left;
139 margin-top: 1.0em;
140 margin-bottom: 0.5em;
142 div.title + * {
143 margin-top: 0;
146 td div.title:first-child {
147 margin-top: 0.0em;
149 div.content div.title:first-child {
150 margin-top: 0.0em;
152 div.content + div.title {
153 margin-top: 0.0em;
156 div.sidebarblock > div.content {
157 background: #ffffee;
158 border: 1px solid silver;
159 padding: 0.5em;
162 div.listingblock > div.content {
163 border: 1px solid silver;
164 background: #f4f4f4;
165 padding: 0.5em;
168 div.quoteblock {
169 padding-left: 2.0em;
170 margin-right: 10%;
172 div.quoteblock > div.attribution {
173 padding-top: 0.5em;
174 text-align: right;
177 div.verseblock {
178 padding-left: 2.0em;
179 margin-right: 10%;
181 div.verseblock > div.content {
182 white-space: pre;
184 div.verseblock > div.attribution {
185 padding-top: 0.75em;
186 text-align: left;
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div.verseblock + div.attribution {
190 text-align: left;
193 div.admonitionblock .icon {
194 vertical-align: top;
195 font-size: 1.1em;
196 font-weight: bold;
197 text-decoration: underline;
198 color: #527bbd;
199 padding-right: 0.5em;
201 div.admonitionblock td.content {
202 padding-left: 0.5em;
203 border-left: 2px solid silver;
206 div.exampleblock > div.content {
207 border-left: 2px solid silver;
208 padding: 0.5em;
211 div.imageblock div.content { padding-left: 0; }
212 span.image img { border-style: none; }
213 a.image:visited { color: white; }
215 dl {
216 margin-top: 0.8em;
217 margin-bottom: 0.8em;
219 dt {
220 margin-top: 0.5em;
221 margin-bottom: 0;
222 font-style: normal;
223 color: navy;
225 dd > *:first-child {
226 margin-top: 0.1em;
229 ul, ol {
230 list-style-position: outside;
232 ol.arabic {
233 list-style-type: decimal;
235 ol.loweralpha {
236 list-style-type: lower-alpha;
238 ol.upperalpha {
239 list-style-type: upper-alpha;
241 ol.lowerroman {
242 list-style-type: lower-roman;
244 ol.upperroman {
245 list-style-type: upper-roman;
248 div.compact ul, div.compact ol,
249 div.compact p, div.compact p,
250 div.compact div, div.compact div {
251 margin-top: 0.1em;
252 margin-bottom: 0.1em;
255 div.tableblock > table {
256 border: 3px solid #527bbd;
258 thead {
259 font-family: sans-serif;
260 font-weight: bold;
262 tfoot {
263 font-weight: bold;
265 td > div.verse {
266 white-space: pre;
268 p.table {
269 margin-top: 0;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div.tableblock > table[frame="void"] {
273 border-style: none;
275 div.tableblock > table[frame="hsides"] {
276 border-left-style: none;
277 border-right-style: none;
279 div.tableblock > table[frame="vsides"] {
280 border-top-style: none;
281 border-bottom-style: none;
285 div.hdlist {
286 margin-top: 0.8em;
287 margin-bottom: 0.8em;
289 div.hdlist tr {
290 padding-bottom: 15px;
292 dt.hdlist1.strong, td.hdlist1.strong {
293 font-weight: bold;
295 td.hdlist1 {
296 vertical-align: top;
297 font-style: normal;
298 padding-right: 0.8em;
299 color: navy;
301 td.hdlist2 {
302 vertical-align: top;
304 div.hdlist.compact tr {
305 margin: 0;
306 padding-bottom: 0;
309 .comment {
310 background: yellow;
313 @media print {
314 div#footer-badges { display: none; }
317 div#toctitle {
318 color: #527bbd;
319 font-family: sans-serif;
320 font-size: 1.1em;
321 font-weight: bold;
322 margin-top: 1.0em;
323 margin-bottom: 0.1em;
326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
327 margin-top: 0;
328 margin-bottom: 0;
330 div.toclevel2 {
331 margin-left: 2em;
332 font-size: 0.9em;
334 div.toclevel3 {
335 margin-left: 4em;
336 font-size: 0.9em;
338 div.toclevel4 {
339 margin-left: 6em;
340 font-size: 0.9em;
342 /* Overrides for manpage documents */
343 h1 {
344 padding-top: 0.5em;
345 padding-bottom: 0.5em;
346 border-top: 2px solid silver;
347 border-bottom: 2px solid silver;
349 h2 {
350 border-style: none;
352 div.sectionbody {
353 margin-left: 5%;
356 @media print {
357 div#toc { display: none; }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
362 div.sidebar-content {
363 background: #ffffee;
364 border: 1px solid silver;
365 padding: 0.5em;
367 div.sidebar-title, div.image-title {
368 color: #527bbd;
369 font-family: sans-serif;
370 font-weight: bold;
371 margin-top: 0.0em;
372 margin-bottom: 0.5em;
375 div.listingblock div.content {
376 border: 1px solid silver;
377 background: #f4f4f4;
378 padding: 0.5em;
381 div.quoteblock-attribution {
382 padding-top: 0.5em;
383 text-align: right;
386 div.verseblock-content {
387 white-space: pre;
389 div.verseblock-attribution {
390 padding-top: 0.75em;
391 text-align: left;
394 div.exampleblock-content {
395 border-left: 2px solid silver;
396 padding-left: 0.5em;
399 /* IE6 sets dynamically generated links as visited. */
400 div#toc a:visited { color: blue; }
401 </style>
402 </head>
403 <body>
404 <div id="header">
405 <h1>
406 git-status(1) Manual Page
407 </h1>
408 <h2>NAME</h2>
409 <div class="sectionbody">
410 <p>git-status -
411 Show the working tree status
412 </p>
413 </div>
414 </div>
415 <h2 id="_synopsis">SYNOPSIS</h2>
416 <div class="sectionbody">
417 <div class="paragraph"><p><em>git status</em> [&lt;options&gt;&#8230;] [--] [&lt;pathspec&gt;&#8230;]</p></div>
418 </div>
419 <h2 id="_description">DESCRIPTION</h2>
420 <div class="sectionbody">
421 <div class="paragraph"><p>Displays paths that have differences between the index file and the
422 current HEAD commit, paths that have differences between the working
423 tree and the index file, and paths in the working tree that are not
424 tracked by git (and are not ignored by <a href="gitignore.html">gitignore(5)</a>). The first
425 are what you <em>would</em> commit by running <tt>git commit</tt>; the second and
426 third are what you <em>could</em> commit by running <em>git add</em> before running
427 <tt>git commit</tt>.</p></div>
428 </div>
429 <h2 id="_options">OPTIONS</h2>
430 <div class="sectionbody">
431 <div class="dlist"><dl>
432 <dt class="hdlist1">
434 </dt>
435 <dt class="hdlist1">
436 --short
437 </dt>
438 <dd>
440 Give the output in the short-format.
441 </p>
442 </dd>
443 <dt class="hdlist1">
445 </dt>
446 <dt class="hdlist1">
447 --branch
448 </dt>
449 <dd>
451 Show the branch and tracking info even in short-format.
452 </p>
453 </dd>
454 <dt class="hdlist1">
455 --porcelain
456 </dt>
457 <dd>
459 Give the output in a stable, easy-to-parse format for scripts.
460 Currently this is identical to --short output, but is guaranteed
461 not to change in the future, making it safe for scripts.
462 </p>
463 </dd>
464 <dt class="hdlist1">
465 -u[&lt;mode&gt;]
466 </dt>
467 <dt class="hdlist1">
468 --untracked-files[=&lt;mode&gt;]
469 </dt>
470 <dd>
472 Show untracked files.
473 </p>
474 <div class="paragraph"><p>The mode parameter is optional (defaults to <em>all</em>), and is used to
475 specify the handling of untracked files; when -u is not used, the
476 default is <em>normal</em>, i.e. show untracked files and directories.</p></div>
477 <div class="paragraph"><p>The possible options are:</p></div>
478 <div class="ulist"><ul>
479 <li>
481 <em>no</em> - Show no untracked files
482 </p>
483 </li>
484 <li>
486 <em>normal</em> - Shows untracked files and directories
487 </p>
488 </li>
489 <li>
491 <em>all</em> - Also shows individual files in untracked directories.
492 </p>
493 <div class="paragraph"><p>The default can be changed using the status.showUntrackedFiles
494 configuration variable documented in <a href="git-config.html">git-config(1)</a>.</p></div>
495 </li>
496 </ul></div>
497 </dd>
498 <dt class="hdlist1">
499 --ignore-submodules[=&lt;when&gt;]
500 </dt>
501 <dd>
503 Ignore changes to submodules when looking for changes. &lt;when&gt; can be
504 either "none", "untracked", "dirty" or "all", which is the default.
505 Using "none" will consider the submodule modified when it either contains
506 untracked or modified files or its HEAD differs from the commit recorded
507 in the superproject and can be used to override any settings of the
508 <em>ignore</em> option in <a href="git-config.html">git-config(1)</a> or <a href="gitmodules.html">gitmodules(5)</a>. When
509 "untracked" is used submodules are not considered dirty when they only
510 contain untracked content (but they are still scanned for modified
511 content). Using "dirty" ignores all changes to the work tree of submodules,
512 only changes to the commits stored in the superproject are shown (this was
513 the behavior before 1.7.0). Using "all" hides all changes to submodules
514 (and suppresses the output of submodule summaries when the config option
515 <tt>status.submodulesummary</tt> is set).
516 </p>
517 </dd>
518 <dt class="hdlist1">
520 </dt>
521 <dd>
523 Terminate entries with NUL, instead of LF. This implies
524 the <tt>--porcelain</tt> output format if no other format is given.
525 </p>
526 </dd>
527 </dl></div>
528 </div>
529 <h2 id="_output">OUTPUT</h2>
530 <div class="sectionbody">
531 <div class="paragraph"><p>The output from this command is designed to be used as a commit
532 template comment, and all the output lines are prefixed with <em>#</em>.
533 The default, long format, is designed to be human readable,
534 verbose and descriptive. They are subject to change in any time.</p></div>
535 <div class="paragraph"><p>The paths mentioned in the output, unlike many other git commands, are
536 made relative to the current directory if you are working in a
537 subdirectory (this is on purpose, to help cutting and pasting). See
538 the status.relativePaths config option below.</p></div>
539 <div class="paragraph"><p>In short-format, the status of each path is shown as</p></div>
540 <div class="literalblock">
541 <div class="content">
542 <pre><tt>XY PATH1 -&gt; PATH2</tt></pre>
543 </div></div>
544 <div class="paragraph"><p>where <tt>PATH1</tt> is the path in the <tt>HEAD</tt>, and ` &#8594; PATH2` part is
545 shown only when <tt>PATH1</tt> corresponds to a different path in the
546 index/worktree (i.e. the file is renamed). The <em>XY</em> is a two-letter
547 status code.</p></div>
548 <div class="paragraph"><p>The fields (including the <tt>&#8594;</tt>) are separated from each other by a
549 single space. If a filename contains whitespace or other nonprintable
550 characters, that field will be quoted in the manner of a C string
551 literal: surrounded by ASCII double quote (34) characters, and with
552 interior special characters backslash-escaped.</p></div>
553 <div class="paragraph"><p>For paths with merge conflicts, <tt>X</tt> and <em>Y</em> show the modification
554 states of each side of the merge. For paths that do not have merge
555 conflicts, <tt>X</tt> shows the status of the index, and <tt>Y</tt> shows the status
556 of the work tree. For untracked paths, <tt>XY</tt> are <tt>??</tt>. Other status
557 codes can be interpreted as follows:</p></div>
558 <div class="ulist"><ul>
559 <li>
561 ' ' = unmodified
562 </p>
563 </li>
564 <li>
566 <em>M</em> = modified
567 </p>
568 </li>
569 <li>
571 <em>A</em> = added
572 </p>
573 </li>
574 <li>
576 <em>D</em> = deleted
577 </p>
578 </li>
579 <li>
581 <em>R</em> = renamed
582 </p>
583 </li>
584 <li>
586 <em>C</em> = copied
587 </p>
588 </li>
589 <li>
591 <em>U</em> = updated but unmerged
592 </p>
593 </li>
594 </ul></div>
595 <div class="paragraph"><p>Ignored files are not listed.</p></div>
596 <div class="literalblock">
597 <div class="content">
598 <pre><tt>X Y Meaning
599 -------------------------------------------------
600 [MD] not updated
601 M [ MD] updated in index
602 A [ MD] added to index
603 D [ M] deleted from index
604 R [ MD] renamed in index
605 C [ MD] copied in index
606 [MARC] index and work tree matches
607 [ MARC] M work tree changed since index
608 [ MARC] D deleted in work tree
609 -------------------------------------------------
610 D D unmerged, both deleted
611 A U unmerged, added by us
612 U D unmerged, deleted by them
613 U A unmerged, added by them
614 D U unmerged, deleted by us
615 A A unmerged, both added
616 U U unmerged, both modified
617 -------------------------------------------------
618 ? ? untracked
619 -------------------------------------------------</tt></pre>
620 </div></div>
621 <div class="paragraph"><p>If -b is used the short-format status is preceded by a line</p></div>
622 <div class="paragraph"><p>## branchname tracking info</p></div>
623 <div class="paragraph"><p>There is an alternate -z format recommended for machine parsing. In
624 that format, the status field is the same, but some other things
625 change. First, the <em>&#8594;</em> is omitted from rename entries and the field
626 order is reversed (e.g <em>from &#8594; to</em> becomes <em>to from</em>). Second, a NUL
627 (ASCII 0) follows each filename, replacing space as a field separator
628 and the terminating newline (but a space still separates the status
629 field from the first filename). Third, filenames containing special
630 characters are not specially formatted; no quoting or
631 backslash-escaping is performed. Fourth, there is no branch line.</p></div>
632 </div>
633 <h2 id="_configuration">CONFIGURATION</h2>
634 <div class="sectionbody">
635 <div class="paragraph"><p>The command honors <tt>color.status</tt> (or <tt>status.color</tt>&#8201;&#8212;&#8201;they
636 mean the same thing and the latter is kept for backward
637 compatibility) and <tt>color.status.&lt;slot&gt;</tt> configuration variables
638 to colorize its output.</p></div>
639 <div class="paragraph"><p>If the config variable <tt>status.relativePaths</tt> is set to false, then all
640 paths shown are relative to the repository root, not to the current
641 directory.</p></div>
642 <div class="paragraph"><p>If <tt>status.submodulesummary</tt> is set to a non zero number or true (identical
643 to -1 or an unlimited number), the submodule summary will be enabled for
644 the long format and a summary of commits for modified submodules will be
645 shown (see --summary-limit option of <a href="git-submodule.html">git-submodule(1)</a>).</p></div>
646 </div>
647 <h2 id="_see_also">SEE ALSO</h2>
648 <div class="sectionbody">
649 <div class="paragraph"><p><a href="gitignore.html">gitignore(5)</a></p></div>
650 </div>
651 <h2 id="_git">GIT</h2>
652 <div class="sectionbody">
653 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
654 </div>
655 <div id="footer">
656 <div id="footer-text">
657 Last updated 2011-03-15 23:30:14 UTC
658 </div>
659 </div>
660 </body>
661 </html>