git-status.html

   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.2.5" />
   7 <style type="text/css">
   8 /* Debug borders */
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  10 /*
  11   border: 1px solid red;
  12 */
  13 }
  14
  15 body {
  16   margin: 1em 5% 1em 5%;
  17 }
  18
  19 a {
  20   color: blue;
  21   text-decoration: underline;
  22 }
  23 a:visited {
  24   color: fuchsia;
  25 }
  26
  27 em {
  28   font-style: italic;
  29 }
  30
  31 strong {
  32   font-weight: bold;
  33 }
  34
  35 tt {
  36   color: navy;
  37 }
  38
  39 h1, h2, h3, h4, h5, h6 {
  40   color: #527bbd;
  41   font-family: sans-serif;
  42   margin-top: 1.2em;
  43   margin-bottom: 0.5em;
  44   line-height: 1.3;
  45 }
  46
  47 h1, h2, h3 {
  48   border-bottom: 2px solid silver;
  49 }
  50 h2 {
  51   padding-top: 0.5em;
  52 }
  53 h3 {
  54   float: left;
  55 }
  56 h3 + * {
  57   clear: left;
  58 }
  59
  60 div.sectionbody {
  61   font-family: serif;
  62   margin-left: 0;
  63 }
  64
  65 hr {
  66   border: 1px solid silver;
  67 }
  68
  69 p {
  70   margin-top: 0.5em;
  71   margin-bottom: 0.5em;
  72 }
  73
  74 pre {
  75   padding: 0;
  76   margin: 0;
  77 }
  78
  79 span#author {
  80   color: #527bbd;
  81   font-family: sans-serif;
  82   font-weight: bold;
  83   font-size: 1.1em;
  84 }
  85 span#email {
  86 }
  87 span#revision {
  88   font-family: sans-serif;
  89 }
  90
  91 div#footer {
  92   font-family: sans-serif;
  93   font-size: small;
  94   border-top: 2px solid silver;
  95   padding-top: 0.5em;
  96   margin-top: 4.0em;
  97 }
  98 div#footer-text {
  99   float: left;
 100   padding-bottom: 0.5em;
 101 }
 102 div#footer-badges {
 103   float: right;
 104   padding-bottom: 0.5em;
 105 }
 106
 107 div#preamble,
 108 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 109 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 110 div.admonitionblock {
 111   margin-right: 10%;
 112   margin-top: 1.5em;
 113   margin-bottom: 1.5em;
 114 }
 115 div.admonitionblock {
 116   margin-top: 2.5em;
 117   margin-bottom: 2.5em;
 118 }
 119
 120 div.content { /* Block element content. */
 121   padding: 0;
 122 }
 123
 124 /* Block element titles. */
 125 div.title, caption.title {
 126   font-family: sans-serif;
 127   font-weight: bold;
 128   text-align: left;
 129   margin-top: 1.0em;
 130   margin-bottom: 0.5em;
 131 }
 132 div.title + * {
 133   margin-top: 0;
 134 }
 135
 136 td div.title:first-child {
 137   margin-top: 0.0em;
 138 }
 139 div.content div.title:first-child {
 140   margin-top: 0.0em;
 141 }
 142 div.content + div.title {
 143   margin-top: 0.0em;
 144 }
 145
 146 div.sidebarblock > div.content {
 147   background: #ffffee;
 148   border: 1px solid silver;
 149   padding: 0.5em;
 150 }
 151
 152 div.listingblock {
 153   margin-right: 0%;
 154 }
 155 div.listingblock > div.content {
 156   border: 1px solid silver;
 157   background: #f4f4f4;
 158   padding: 0.5em;
 159 }
 160
 161 div.quoteblock > div.content {
 162   padding-left: 2.0em;
 163 }
 164
 165 div.attribution {
 166   text-align: right;
 167 }
 168 div.verseblock + div.attribution {
 169   text-align: left;
 170 }
 171
 172 div.admonitionblock .icon {
 173   vertical-align: top;
 174   font-size: 1.1em;
 175   font-weight: bold;
 176   text-decoration: underline;
 177   color: #527bbd;
 178   padding-right: 0.5em;
 179 }
 180 div.admonitionblock td.content {
 181   padding-left: 0.5em;
 182   border-left: 2px solid silver;
 183 }
 184
 185 div.exampleblock > div.content {
 186   border-left: 2px solid silver;
 187   padding: 0.5em;
 188 }
 189
 190 div.verseblock div.content {
 191   white-space: pre;
 192 }
 193
 194 div.imageblock div.content { padding-left: 0; }
 195 div.imageblock img { border: 1px solid silver; }
 196 span.image img { border-style: none; }
 197
 198 dl {
 199   margin-top: 0.8em;
 200   margin-bottom: 0.8em;
 201 }
 202 dt {
 203   margin-top: 0.5em;
 204   margin-bottom: 0;
 205   font-style: italic;
 206 }
 207 dd > *:first-child {
 208   margin-top: 0;
 209 }
 210
 211 ul, ol {
 212     list-style-position: outside;
 213 }
 214 div.olist2 ol {
 215   list-style-type: lower-alpha;
 216 }
 217
 218 div.tableblock > table {
 219   border: 3px solid #527bbd;
 220 }
 221 thead {
 222   font-family: sans-serif;
 223   font-weight: bold;
 224 }
 225 tfoot {
 226   font-weight: bold;
 227 }
 228
 229 div.hlist {
 230   margin-top: 0.8em;
 231   margin-bottom: 0.8em;
 232 }
 233 div.hlist td {
 234   padding-bottom: 5px;
 235 }
 236 td.hlist1 {
 237   vertical-align: top;
 238   font-style: italic;
 239   padding-right: 0.8em;
 240 }
 241 td.hlist2 {
 242   vertical-align: top;
 243 }
 244
 245 @media print {
 246   div#footer-badges { display: none; }
 247 }
 248
 249 div#toctitle {
 250   color: #527bbd;
 251   font-family: sans-serif;
 252   font-size: 1.1em;
 253   font-weight: bold;
 254   margin-top: 1.0em;
 255   margin-bottom: 0.1em;
 256 }
 257
 258 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 259   margin-top: 0;
 260   margin-bottom: 0;
 261 }
 262 div.toclevel2 {
 263   margin-left: 2em;
 264   font-size: 0.9em;
 265 }
 266 div.toclevel3 {
 267   margin-left: 4em;
 268   font-size: 0.9em;
 269 }
 270 div.toclevel4 {
 271   margin-left: 6em;
 272   font-size: 0.9em;
 273 }
 274 include1::./stylesheets/xhtml11-manpage.css[]
 275 /* Workarounds for IE6's broken and incomplete CSS2. */
 276
 277 div.sidebar-content {
 278   background: #ffffee;
 279   border: 1px solid silver;
 280   padding: 0.5em;
 281 }
 282 div.sidebar-title, div.image-title {
 283   font-family: sans-serif;
 284   font-weight: bold;
 285   margin-top: 0.0em;
 286   margin-bottom: 0.5em;
 287 }
 288
 289 div.listingblock div.content {
 290   border: 1px solid silver;
 291   background: #f4f4f4;
 292   padding: 0.5em;
 293 }
 294
 295 div.quoteblock-content {
 296   padding-left: 2.0em;
 297 }
 298
 299 div.exampleblock-content {
 300   border-left: 2px solid silver;
 301   padding-left: 0.5em;
 302 }
 303
 304 /* IE6 sets dynamically generated links as visited. */
 305 div#toc a:visited { color: blue; }
 306 </style>
 307 <title>git-status(1)</title>
 308 </head>
 309 <body>
 310 <div id="header">
 311 <h1>
 312 git-status(1) Manual Page
 313 </h1>
 314 <h2>NAME</h2>
 315 <div class="sectionbody">
 316 <p>git-status -
 317    Show the working tree status
 318 </p>
 319 </div>
 320 </div>
 321 <h2>SYNOPSIS</h2>
 322 <div class="sectionbody">
 323 <div class="para"><p><em>git status</em> [&lt;options&gt;&#8230;] [--] [&lt;pathspec&gt;&#8230;]</p></div>
 324 </div>
 325 <h2 id="_description">DESCRIPTION</h2>
 326 <div class="sectionbody">
 327 <div class="para"><p>Displays paths that have differences between the index file and the
 328 current HEAD commit, paths that have differences between the working
 329 tree and the index file, and paths in the working tree that are not
 330 tracked by git (and are not ignored by <a href="gitignore.html">gitignore(5)</a>). The first
 331 are what you _would_ commit by running <tt>git commit</tt>; the second and
 332 third are what you _could_ commit by running <em>git add</em> before running
 333 <tt>git commit</tt>.</p></div>
 334 </div>
 335 <h2 id="_options">OPTIONS</h2>
 336 <div class="sectionbody">
 337 <div class="vlist"><dl>
 338 <dt>
 339 -s
 340 </dt>
 341 <dt>
 342 --short
 343 </dt>
 344 <dd>
 345 <p>
 346         Give the output in the short-format.
 347 </p>
 348 </dd>
 349 <dt>
 350 --porcelain
 351 </dt>
 352 <dd>
 353 <p>
 354         Give the output in a stable, easy-to-parse format for scripts.
 355         Currently this is identical to --short output, but is guaranteed
 356         not to change in the future, making it safe for scripts.
 357 </p>
 358 </dd>
 359 <dt>
 360 -u[&lt;mode&gt;]
 361 </dt>
 362 <dt>
 363 --untracked-files[=&lt;mode&gt;]
 364 </dt>
 365 <dd>
 366 <p>
 367         Show untracked files (Default: <em>all</em>).
 368 </p>
 369 <div class="para"><p>The mode parameter is optional, and is used to specify
 370 the handling of untracked files. The possible options are:</p></div>
 371 <div class="ilist"><ul>
 372 <li>
 373 <p>
 374 <em>no</em>     - Show no untracked files
 375 </p>
 376 </li>
 377 <li>
 378 <p>
 379 <em>normal</em> - Shows untracked files and directories
 380 </p>
 381 </li>
 382 <li>
 383 <p>
 384 <em>all</em>    - Also shows individual files in untracked directories.
 385 </p>
 386 </li>
 387 </ul></div>
 388 <div class="para"><p>See <a href="git-config.html">git-config(1)</a> for configuration variable
 389 used to change the default for when the option is not
 390 specified.</p></div>
 391 </dd>
 392 <dt>
 393 -z
 394 </dt>
 395 <dd>
 396 <p>
 397         Terminate entries with NUL, instead of LF.  This implies
 398         the <tt>--porcelain</tt> output format if no other format is given.
 399 </p>
 400 </dd>
 401 </dl></div>
 402 </div>
 403 <h2 id="_output">OUTPUT</h2>
 404 <div class="sectionbody">
 405 <div class="para"><p>The output from this command is designed to be used as a commit
 406 template comment, and all the output lines are prefixed with <em>#</em>.
 407 The default, long format, is designed to be human readable,
 408 verbose and descriptive.  They are subject to change in any time.</p></div>
 409 <div class="para"><p>The paths mentioned in the output, unlike many other git commands, are
 410 made relative to the current directory if you are working in a
 411 subdirectory (this is on purpose, to help cutting and pasting). See
 412 the status.relativePaths config option below.</p></div>
 413 <div class="para"><p>In short-format, the status of each path is shown as</p></div>
 414 <div class="literalblock">
 415 <div class="content">
 416 <pre><tt>XY PATH1 -&gt; PATH2</tt></pre>
 417 </div></div>
 418 <div class="para"><p>where <tt>PATH1</tt> is the path in the <tt>HEAD</tt>, and <tt> -&gt; PATH2</tt> part is
 419 shown only when <tt>PATH1</tt> corresponds to a different path in the
 420 index/worktree (i.e. the file is renamed). The <em>XY</em> is a two-letter
 421 status code.</p></div>
 422 <div class="para"><p>The fields (including the <tt>-&gt;</tt>) are separated from each other by a
 423 single space. If a filename contains whitespace or other nonprintable
 424 characters, that field will be quoted in the manner of a C string
 425 literal: surrounded by ASCII double quote (34) characters, and with
 426 interior special characters backslash-escaped.</p></div>
 427 <div class="para"><p>For paths with merge conflicts, <tt>X</tt> and <em>Y</em> show the modification
 428 states of each side of the merge. For paths that do not have merge
 429 conflicts, <tt>X</tt> shows the status of the index, and <tt>Y</tt> shows the status
 430 of the work tree.  For untracked paths, <tt>XY</tt> are <tt>??</tt>.  Other status
 431 codes can be interpreted as follows:</p></div>
 432 <div class="ilist"><ul>
 433 <li>
 434 <p>
 435 <em> </em> = unmodified
 436 </p>
 437 </li>
 438 <li>
 439 <p>
 440 <em>M</em> = modified
 441 </p>
 442 </li>
 443 <li>
 444 <p>
 445 <em>A</em> = added
 446 </p>
 447 </li>
 448 <li>
 449 <p>
 450 <em>D</em> = deleted
 451 </p>
 452 </li>
 453 <li>
 454 <p>
 455 <em>R</em> = renamed
 456 </p>
 457 </li>
 458 <li>
 459 <p>
 460 <em>C</em> = copied
 461 </p>
 462 </li>
 463 <li>
 464 <p>
 465 <em>U</em> = updated but unmerged
 466 </p>
 467 </li>
 468 </ul></div>
 469 <div class="para"><p>Ignored files are not listed.</p></div>
 470 <div class="literalblock">
 471 <div class="content">
 472 <pre><tt>X          Y     Meaning
 473 -------------------------------------------------
 474           [MD]   not updated
 475 M        [ MD]   updated in index
 476 A        [ MD]   added to index
 477 D         [ M]   deleted from index
 478 R        [ MD]   renamed in index
 479 C        [ MD]   copied in index
 480 [MARC]           index and work tree matches
 481 [ MARC]     M    work tree changed since index
 482 [ MARC]     D    deleted in work tree
 483 -------------------------------------------------
 484 D           D    unmerged, both deleted
 485 A           U    unmerged, added by us
 486 U           D    unmerged, deleted by them
 487 U           A    unmerged, added by them
 488 D           U    unmerged, deleted by us
 489 A           A    unmerged, both added
 490 U           U    unmerged, both modified
 491 -------------------------------------------------
 492 ?           ?    untracked
 493 -------------------------------------------------</tt></pre>
 494 </div></div>
 495 <div class="para"><p>There is an alternate -z format recommended for machine parsing.  In
 496 that format, the status field is the same, but some other things
 497 change.  First, the <em>-&gt;</em> is omitted from rename entries and the field
 498 order is reversed (e.g <em>from -&gt; to</em> becomes <em>to from</em>). Second, a NUL
 499 (ASCII 0) follows each filename, replacing space as a field separator
 500 and the terminating newline (but a space still separates the status
 501 field from the first filename).  Third, filenames containing special
 502 characters are not specially formatted; no quoting or
 503 backslash-escaping is performed.</p></div>
 504 </div>
 505 <h2 id="_configuration">CONFIGURATION</h2>
 506 <div class="sectionbody">
 507 <div class="para"><p>The command honors <tt>color.status</tt> (or <tt>status.color</tt> &#8212; they
 508 mean the same thing and the latter is kept for backward
 509 compatibility) and <tt>color.status.&lt;slot&gt;</tt> configuration variables
 510 to colorize its output.</p></div>
 511 <div class="para"><p>If the config variable <tt>status.relativePaths</tt> is set to false, then all
 512 paths shown are relative to the repository root, not to the current
 513 directory.</p></div>
 514 <div class="para"><p>If <tt>status.submodulesummary</tt> is set to a non zero number or true (identical
 515 to -1 or an unlimited number), the submodule summary will be enabled for
 516 the long format and a summary of commits for modified submodules will be
 517 shown (see --summary-limit option of <a href="git-submodule.html">git-submodule(1)</a>).</p></div>
 518 </div>
 519 <h2 id="_see_also">SEE ALSO</h2>
 520 <div class="sectionbody">
 521 <div class="para"><p><a href="gitignore.html">gitignore(5)</a></p></div>
 522 </div>
 523 <h2 id="_author">Author</h2>
 524 <div class="sectionbody">
 525 <div class="para"><p>Written by Junio C Hamano &lt;gitster@pobox.com&gt;.</p></div>
 526 </div>
 527 <h2 id="_documentation">Documentation</h2>
 528 <div class="sectionbody">
 529 <div class="para"><p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p></div>
 530 </div>
 531 <h2 id="_git">GIT</h2>
 532 <div class="sectionbody">
 533 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 534 </div>
 535 <div id="footer">
 536 <div id="footer-text">
 537 Last updated 2010-04-24 02:56:09 UTC
 538 </div>
 539 </div>
 540 </body>
 541 </html>