| blob | d3b263423b356e8f88454ee7a63f57338bcbc999 |
4 <head>
9 /* Debug borders */
11 /*
12 border: 1px solid red;
13 */
14 }
16 body {
18 }
20 a {
23 }
26 }
28 em {
31 }
33 strong {
36 }
38 tt {
40 }
48 }
52 }
53 h2 {
55 }
56 h3 {
58 }
59 h3 + * {
61 }
66 }
68 hr {
70 }
72 p {
75 }
79 }
81 pre {
84 }
86 span#author {
91 }
92 span#email {
93 }
96 }
98 div#footer {
104 }
105 div#footer-text {
108 }
109 div#footer-badges {
112 }
114 div#preamble {
117 }
123 }
127 }
131 }
133 /* Block element titles. */
141 }
144 }
148 }
151 }
154 }
160 }
166 }
171 }
175 }
180 }
183 }
187 }
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 }
200 }
204 }
209 }
215 dl {
218 }
219 dt {
224 }
227 }
231 }
234 }
237 }
240 }
243 }
246 }
253 }
257 }
258 thead {
261 }
262 tfoot {
264 }
267 }
270 }
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 }
278 }
282 }
288 }
291 }
294 }
300 }
303 }
307 }
311 }
315 }
317 div#toctitle {
324 }
329 }
333 }
337 }
341 }
342 /* Overrides for manpage documents */
343 h1 {
348 }
349 h2 {
351 }
354 }
358 }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
366 }
373 }
379 }
384 }
388 }
392 }
397 }
399 /* IE6 sets dynamically generated links as visited. */
401 </style>
402 </head>
403 <body>
405 <h1>
406 git-status(1) Manual Page
407 </h1>
410 <p>git-status -
411 Show the working tree status
412 </p>
413 </div>
414 </div>
418 <div class="verseblock-content"><em>git status</em> [<options>…] [--] [<pathspec>…]</div>
420 </div></div>
421 </div>
425 current HEAD commit, paths that have differences between the working
426 tree and the index file, and paths in the working tree that are not
431 </div>
436 -s
437 </dt>
439 --short
440 </dt>
441 <dd>
442 <p>
443 Give the output in the short-format.
444 </p>
445 </dd>
447 -b
448 </dt>
450 --branch
451 </dt>
452 <dd>
453 <p>
454 Show the branch and tracking info even in short-format.
455 </p>
456 </dd>
458 --porcelain
459 </dt>
460 <dd>
461 <p>
462 Give the output in an easy-to-parse format for scripts.
463 This is similar to the short output, but will remain stable
464 across git versions and regardless of user configuration. See
465 below for details.
466 </p>
467 </dd>
470 </dt>
473 </dt>
474 <dd>
475 <p>
476 Show untracked files.
477 </p>
478 <div class="paragraph"><p>The mode parameter is optional (defaults to <em>all</em>), and is used to
479 specify the handling of untracked files; when -u is not used, the
483 <li>
484 <p>
486 </p>
487 </li>
488 <li>
489 <p>
491 </p>
492 </li>
493 <li>
494 <p>
496 </p>
499 </li>
500 </ul></div>
501 </dd>
504 </dt>
505 <dd>
506 <p>
509 Using "none" will consider the submodule modified when it either contains
510 untracked or modified files or its HEAD differs from the commit recorded
511 in the superproject and can be used to override any settings of the
512 <em>ignore</em> option in <a href="git-config.html">git-config(1)</a> or <a href="gitmodules.html">gitmodules(5)</a>. When
513 "untracked" is used submodules are not considered dirty when they only
514 contain untracked content (but they are still scanned for modified
515 content). Using "dirty" ignores all changes to the work tree of submodules,
516 only changes to the commits stored in the superproject are shown (this was
518 (and suppresses the output of submodule summaries when the config option
520 </p>
521 </dd>
523 --ignored
524 </dt>
525 <dd>
526 <p>
527 Show ignored files as well.
528 </p>
529 </dd>
531 -z
532 </dt>
533 <dd>
534 <p>
535 Terminate entries with NUL, instead of LF. This implies
537 </p>
538 </dd>
539 </dl></div>
540 </div>
545 The default, long format, is designed to be human readable,
546 verbose and descriptive. Its contents and format are subject to change
547 at any time.</p></div>
548 <div class="paragraph"><p>The paths mentioned in the output, unlike many other git commands, are
549 made relative to the current directory if you are working in a
550 subdirectory (this is on purpose, to help cutting and pasting). See
551 the status.relativePaths config option below.</p></div>
557 </div></div>
558 <div class="paragraph"><p>where <tt>PATH1</tt> is the path in the <tt>HEAD</tt>, and the ` -> PATH2` part is
561 status code.</p></div>
562 <div class="paragraph"><p>The fields (including the <tt>-></tt>) are separated from each other by a
563 single space. If a filename contains whitespace or other nonprintable
564 characters, that field will be quoted in the manner of a C string
565 literal: surrounded by ASCII double quote (34) characters, and with
566 interior special characters backslash-escaped.</p></div>
567 <div class="paragraph"><p>For paths with merge conflicts, <tt>X</tt> and <em>Y</em> show the modification
568 states of each side of the merge. For paths that do not have merge
571 codes can be interpreted as follows:</p></div>
573 <li>
574 <p>
575 ' ' = unmodified
576 </p>
577 </li>
578 <li>
579 <p>
581 </p>
582 </li>
583 <li>
584 <p>
586 </p>
587 </li>
588 <li>
589 <p>
591 </p>
592 </li>
593 <li>
594 <p>
596 </p>
597 </li>
598 <li>
599 <p>
601 </p>
602 </li>
603 <li>
604 <p>
606 </p>
607 </li>
608 </ul></div>
609 <div class="paragraph"><p>Ignored files are not listed, unless <tt>--ignored</tt> option is in effect,
613 <pre><tt>X Y Meaning
614 -------------------------------------------------
615 [MD] not updated
616 M [ MD] updated in index
617 A [ MD] added to index
618 D [ M] deleted from index
619 R [ MD] renamed in index
620 C [ MD] copied in index
621 [MARC] index and work tree matches
622 [ MARC] M work tree changed since index
623 [ MARC] D deleted in work tree
624 -------------------------------------------------
625 D D unmerged, both deleted
626 A U unmerged, added by us
627 U D unmerged, deleted by them
628 U A unmerged, added by them
629 D U unmerged, deleted by us
630 A A unmerged, both added
631 U U unmerged, both modified
632 -------------------------------------------------
633 ? ? untracked
634 ! ! ignored
635 -------------------------------------------------</tt></pre>
636 </div></div>
640 <div class="paragraph"><p>The porcelain format is similar to the short format, but is guaranteed
641 not to change in a backwards-incompatible way between git versions or
642 based on user configuration. This makes it ideal for parsing by scripts.
643 The description of the short format above also describes the porcelain
644 format, with a few exceptions:</p></div>
646 <li>
647 <p>
648 The user’s color.status configuration is not respected; color will
649 always be off.
650 </p>
651 </li>
652 <li>
653 <p>
654 The user’s status.relativePaths configuration is not respected; paths
655 shown will always be relative to the repository root.
656 </p>
657 </li>
658 </ol></div>
659 <div class="paragraph"><p>There is also an alternate -z format recommended for machine parsing. In
660 that format, the status field is the same, but some other things
663 (ASCII 0) follows each filename, replacing space as a field separator
664 and the terminating newline (but a space still separates the status
665 field from the first filename). Third, filenames containing special
666 characters are not specially formatted; no quoting or
667 backslash-escaping is performed. Fourth, there is no branch line.</p></div>
668 </div>
671 <div class="paragraph"><p>The command honors <tt>color.status</tt> (or <tt>status.color</tt> — they
672 mean the same thing and the latter is kept for backward
674 to colorize its output.</p></div>
675 <div class="paragraph"><p>If the config variable <tt>status.relativePaths</tt> is set to false, then all
676 paths shown are relative to the repository root, not to the current
677 directory.</p></div>
678 <div class="paragraph"><p>If <tt>status.submodulesummary</tt> is set to a non zero number or true (identical
679 to -1 or an unlimited number), the submodule summary will be enabled for
680 the long format and a summary of commits for modified submodules will be
681 shown (see --summary-limit option of <a href="git-submodule.html">git-submodule(1)</a>).</p></div>
682 </div>
686 </div>
690 </div>
694 </div>
695 </div>
696 </body>
697 </html>