| blob | 86dbe5e609ce660c3bd16a78c05b9ae58cf67f56 |
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>
417 <div class="paragraph"><p><em>git status</em> [<options>…] [--] [<pathspec>…]</p></div>
418 </div>
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
428 </div>
433 -s
434 </dt>
436 --short
437 </dt>
438 <dd>
439 <p>
440 Give the output in the short-format.
441 </p>
442 </dd>
444 -b
445 </dt>
447 --branch
448 </dt>
449 <dd>
450 <p>
451 Show the branch and tracking info even in short-format.
452 </p>
453 </dd>
455 --porcelain
456 </dt>
457 <dd>
458 <p>
459 Give the output in an easy-to-parse format for scripts.
460 This is similar to the short output, but will remain stable
461 across git versions and regardless of user configuration. See
462 below for details.
463 </p>
464 </dd>
467 </dt>
470 </dt>
471 <dd>
472 <p>
473 Show untracked files.
474 </p>
475 <div class="paragraph"><p>The mode parameter is optional (defaults to <em>all</em>), and is used to
476 specify the handling of untracked files; when -u is not used, the
480 <li>
481 <p>
483 </p>
484 </li>
485 <li>
486 <p>
488 </p>
489 </li>
490 <li>
491 <p>
493 </p>
496 </li>
497 </ul></div>
498 </dd>
501 </dt>
502 <dd>
503 <p>
506 Using "none" will consider the submodule modified when it either contains
507 untracked or modified files or its HEAD differs from the commit recorded
508 in the superproject and can be used to override any settings of the
509 <em>ignore</em> option in <a href="git-config.html">git-config(1)</a> or <a href="gitmodules.html">gitmodules(5)</a>. When
510 "untracked" is used submodules are not considered dirty when they only
511 contain untracked content (but they are still scanned for modified
512 content). Using "dirty" ignores all changes to the work tree of submodules,
513 only changes to the commits stored in the superproject are shown (this was
515 (and suppresses the output of submodule summaries when the config option
517 </p>
518 </dd>
520 -z
521 </dt>
522 <dd>
523 <p>
524 Terminate entries with NUL, instead of LF. This implies
526 </p>
527 </dd>
528 </dl></div>
529 </div>
534 The default, long format, is designed to be human readable,
535 verbose and descriptive. Its contents and format are subject to change
536 at any time.</p></div>
537 <div class="paragraph"><p>The paths mentioned in the output, unlike many other git commands, are
538 made relative to the current directory if you are working in a
539 subdirectory (this is on purpose, to help cutting and pasting). See
540 the status.relativePaths config option below.</p></div>
546 </div></div>
547 <div class="paragraph"><p>where <tt>PATH1</tt> is the path in the <tt>HEAD</tt>, and the ` -> PATH2` part is
550 status code.</p></div>
551 <div class="paragraph"><p>The fields (including the <tt>-></tt>) are separated from each other by a
552 single space. If a filename contains whitespace or other nonprintable
553 characters, that field will be quoted in the manner of a C string
554 literal: surrounded by ASCII double quote (34) characters, and with
555 interior special characters backslash-escaped.</p></div>
556 <div class="paragraph"><p>For paths with merge conflicts, <tt>X</tt> and <em>Y</em> show the modification
557 states of each side of the merge. For paths that do not have merge
560 codes can be interpreted as follows:</p></div>
562 <li>
563 <p>
564 ' ' = unmodified
565 </p>
566 </li>
567 <li>
568 <p>
570 </p>
571 </li>
572 <li>
573 <p>
575 </p>
576 </li>
577 <li>
578 <p>
580 </p>
581 </li>
582 <li>
583 <p>
585 </p>
586 </li>
587 <li>
588 <p>
590 </p>
591 </li>
592 <li>
593 <p>
595 </p>
596 </li>
597 </ul></div>
601 <pre><tt>X Y Meaning
602 -------------------------------------------------
603 [MD] not updated
604 M [ MD] updated in index
605 A [ MD] added to index
606 D [ M] deleted from index
607 R [ MD] renamed in index
608 C [ MD] copied in index
609 [MARC] index and work tree matches
610 [ MARC] M work tree changed since index
611 [ MARC] D deleted in work tree
612 -------------------------------------------------
613 D D unmerged, both deleted
614 A U unmerged, added by us
615 U D unmerged, deleted by them
616 U A unmerged, added by them
617 D U unmerged, deleted by us
618 A A unmerged, both added
619 U U unmerged, both modified
620 -------------------------------------------------
621 ? ? untracked
622 -------------------------------------------------</tt></pre>
623 </div></div>
627 <div class="paragraph"><p>The porcelain format is similar to the short format, but is guaranteed
628 not to change in a backwards-incompatible way between git versions or
629 based on user configuration. This makes it ideal for parsing by scripts.
630 The description of the short format above also describes the porcelain
631 format, with a few exceptions:</p></div>
633 <li>
634 <p>
635 The user’s color.status configuration is not respected; color will
636 always be off.
637 </p>
638 </li>
639 <li>
640 <p>
641 The user’s status.relativePaths configuration is not respected; paths
642 shown will always be relative to the repository root.
643 </p>
644 </li>
645 </ol></div>
646 <div class="paragraph"><p>There is also an alternate -z format recommended for machine parsing. In
647 that format, the status field is the same, but some other things
650 (ASCII 0) follows each filename, replacing space as a field separator
651 and the terminating newline (but a space still separates the status
652 field from the first filename). Third, filenames containing special
653 characters are not specially formatted; no quoting or
654 backslash-escaping is performed. Fourth, there is no branch line.</p></div>
655 </div>
658 <div class="paragraph"><p>The command honors <tt>color.status</tt> (or <tt>status.color</tt> — they
659 mean the same thing and the latter is kept for backward
661 to colorize its output.</p></div>
662 <div class="paragraph"><p>If the config variable <tt>status.relativePaths</tt> is set to false, then all
663 paths shown are relative to the repository root, not to the current
664 directory.</p></div>
665 <div class="paragraph"><p>If <tt>status.submodulesummary</tt> is set to a non zero number or true (identical
666 to -1 or an unlimited number), the submodule summary will be enabled for
667 the long format and a summary of commits for modified submodules will be
668 shown (see --summary-limit option of <a href="git-submodule.html">git-submodule(1)</a>).</p></div>
669 </div>
673 </div>
677 </div>
681 </div>
682 </div>
683 </body>
684 </html>