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">
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">
9 p
, li
, dt
, dd
, div
, pre
, h1
, h2
, h3
, h4
, h5
, h6
{
11 border: 1px solid red;
16 margin: 1em 5% 1em 5%;
21 text-decoration: underline
;
39 h1
, h2
, h3
, h4
, h5
, h6
{
41 font-family: sans-serif
;
48 border-bottom: 2px solid silver
;
66 border: 1px solid silver
;
81 font-family: sans-serif
;
88 font-family: sans-serif
;
92 font-family: sans-serif
;
94 border-top: 2px solid silver
;
100 padding-bottom: 0.5em;
104 padding-bottom: 0.5em;
108 div
.tableblock
, div
.imageblock
, div
.exampleblock
, div
.verseblock
,
109 div
.quoteblock
, div
.literalblock
, div
.listingblock
, div
.sidebarblock
,
110 div
.admonitionblock
{
113 margin-bottom: 1.5em;
115 div
.admonitionblock
{
117 margin-bottom: 2.5em;
120 div
.content
{ /* Block element content. */
124 /* Block element titles. */
125 div
.title
, caption
.title
{
126 font-family: sans-serif
;
130 margin-bottom: 0.5em;
136 td div
.title:first-child
{
139 div
.content div
.title:first-child
{
142 div
.content
+ div
.title
{
146 div
.sidebarblock
> div
.content
{
148 border: 1px solid silver
;
155 div
.listingblock
> div
.content
{
156 border: 1px solid silver
;
161 div
.quoteblock
> div
.content
{
168 div
.verseblock
+ div
.attribution
{
172 div
.admonitionblock
.icon
{
176 text-decoration: underline
;
178 padding-right: 0.5em;
180 div
.admonitionblock td
.content
{
182 border-left: 2px solid silver
;
185 div
.exampleblock
> div
.content
{
186 border-left: 2px solid silver
;
190 div
.verseblock div
.content
{
194 div
.imageblock div
.content
{ padding-left: 0; }
195 div
.imageblock img
{ border: 1px solid silver
; }
196 span
.image img
{ border-style: none
; }
200 margin-bottom: 0.8em;
212 list-style-position: outside
;
215 list-style-type: lower-alpha
;
218 div
.tableblock
> table
{
219 border: 3px solid
#527bbd;
222 font-family: sans-serif
;
231 margin-bottom: 0.8em;
239 padding-right: 0.8em;
246 div#footer-badges
{ display: none
; }
251 font-family: sans-serif
;
255 margin-bottom: 0.1em;
258 div
.toclevel1
, div
.toclevel2
, div
.toclevel3
, div
.toclevel4
{
274 include1::./stylesheets
/xhtml11-manpage
.css
[]
275 /* Workarounds for IE6's broken and incomplete CSS2. */
277 div
.sidebar-content
{
279 border: 1px solid silver
;
282 div
.sidebar-title
, div
.image-title
{
283 font-family: sans-serif
;
286 margin-bottom: 0.5em;
289 div
.listingblock div
.content
{
290 border: 1px solid silver
;
295 div
.quoteblock-content
{
299 div
.exampleblock-content
{
300 border-left: 2px solid silver
;
304 /* IE6 sets dynamically generated links as visited. */
305 div#toc
a:visited
{ color: blue
; }
307 <title>git-status(
1)
</title>
312 git-status(
1) Manual Page
315 <div class=
"sectionbody">
317 Show the working tree status
322 <div class=
"sectionbody">
323 <div class=
"para"><p><em>git status
</em> [
<options
>…] [--] [
<pathspec
>…]
</p></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>
335 <h2 id=
"_options">OPTIONS
</h2>
336 <div class=
"sectionbody">
337 <div class=
"vlist"><dl>
346 Give the output in the short-format.
357 Show the branch and tracking info even in short-format.
365 Give the output in a stable, easy-to-parse format for scripts.
366 Currently this is identical to --short output, but is guaranteed
367 not to change in the future, making it safe for scripts.
374 --untracked-files[=
<mode
>]
378 Show untracked files (Default:
<em>all
</em>).
380 <div class=
"para"><p>The mode parameter is optional, and is used to specify
381 the handling of untracked files. The possible options are:
</p></div>
382 <div class=
"ilist"><ul>
385 <em>no
</em> - Show no untracked files
390 <em>normal
</em> - Shows untracked files and directories
395 <em>all
</em> - Also shows individual files in untracked directories.
399 <div class=
"para"><p>See
<a href=
"git-config.html">git-config(
1)
</a> for configuration variable
400 used to change the default for when the option is not
404 --ignore-submodules[=
<when
>]
408 Ignore changes to submodules when looking for changes.
<when
> can be
409 either
"none",
"untracked",
"dirty" or
"all", which is the default.
410 Using
"none" will consider the submodule modified when it either contains
411 untracked or modified files or its HEAD differs from the commit recorded
412 in the superproject and can be used to override any settings of the
413 <em>ignore
</em> option in
<a href=
"git-config.html">git-config(
1)
</a> or
<a href=
"gitmodules.html">gitmodules(
5)
</a>. When
414 "untracked" is used submodules are not considered dirty when they only
415 contain untracked content (but they are still scanned for modified
416 content). Using
"dirty" ignores all changes to the work tree of submodules,
417 only changes to the commits stored in the superproject are shown (this was
418 the behavior before
1.7.0). Using
"all" hides all changes to submodules
419 (and suppresses the output of submodule summaries when the config option
420 <tt>status.submodulesummary
</tt> is set).
428 Terminate entries with NUL, instead of LF. This implies
429 the
<tt>--porcelain
</tt> output format if no other format is given.
434 <h2 id=
"_output">OUTPUT
</h2>
435 <div class=
"sectionbody">
436 <div class=
"para"><p>The output from this command is designed to be used as a commit
437 template comment, and all the output lines are prefixed with
<em>#
</em>.
438 The default, long format, is designed to be human readable,
439 verbose and descriptive. They are subject to change in any time.
</p></div>
440 <div class=
"para"><p>The paths mentioned in the output, unlike many other git commands, are
441 made relative to the current directory if you are working in a
442 subdirectory (this is on purpose, to help cutting and pasting). See
443 the status.relativePaths config option below.
</p></div>
444 <div class=
"para"><p>In short-format, the status of each path is shown as
</p></div>
445 <div class=
"literalblock">
446 <div class=
"content">
447 <pre><tt>XY PATH1 -
> PATH2
</tt></pre>
449 <div class=
"para"><p>where
<tt>PATH1
</tt> is the path in the
<tt>HEAD
</tt>, and
<tt> -
> PATH2
</tt> part is
450 shown only when
<tt>PATH1
</tt> corresponds to a different path in the
451 index/worktree (i.e. the file is renamed). The
<em>XY
</em> is a two-letter
452 status code.
</p></div>
453 <div class=
"para"><p>The fields (including the
<tt>-
></tt>) are separated from each other by a
454 single space. If a filename contains whitespace or other nonprintable
455 characters, that field will be quoted in the manner of a C string
456 literal: surrounded by ASCII double quote (
34) characters, and with
457 interior special characters backslash-escaped.
</p></div>
458 <div class=
"para"><p>For paths with merge conflicts,
<tt>X
</tt> and
<em>Y
</em> show the modification
459 states of each side of the merge. For paths that do not have merge
460 conflicts,
<tt>X
</tt> shows the status of the index, and
<tt>Y
</tt> shows the status
461 of the work tree. For untracked paths,
<tt>XY
</tt> are
<tt>??
</tt>. Other status
462 codes can be interpreted as follows:
</p></div>
463 <div class=
"ilist"><ul>
466 <em> </em> = unmodified
471 <em>M
</em> = modified
496 <em>U
</em> = updated but unmerged
500 <div class=
"para"><p>Ignored files are not listed.
</p></div>
501 <div class=
"literalblock">
502 <div class=
"content">
504 -------------------------------------------------
506 M [ MD] updated in index
507 A [ MD] added to index
508 D [ M] deleted from index
509 R [ MD] renamed in index
510 C [ MD] copied in index
511 [MARC] index and work tree matches
512 [ MARC] M work tree changed since index
513 [ MARC] D deleted in work tree
514 -------------------------------------------------
515 D D unmerged, both deleted
516 A U unmerged, added by us
517 U D unmerged, deleted by them
518 U A unmerged, added by them
519 D U unmerged, deleted by us
520 A A unmerged, both added
521 U U unmerged, both modified
522 -------------------------------------------------
524 -------------------------------------------------
</tt></pre>
526 <div class=
"para"><p>If -b is used the short-format status is preceded by a line
</p></div>
527 <div class=
"para"><p>## branchname tracking info
</p></div>
528 <div class=
"para"><p>There is an alternate -z format recommended for machine parsing. In
529 that format, the status field is the same, but some other things
530 change. First, the
<em>-
></em> is omitted from rename entries and the field
531 order is reversed (e.g
<em>from -
> to
</em> becomes
<em>to from
</em>). Second, a NUL
532 (ASCII
0) follows each filename, replacing space as a field separator
533 and the terminating newline (but a space still separates the status
534 field from the first filename). Third, filenames containing special
535 characters are not specially formatted; no quoting or
536 backslash-escaping is performed. Fourth, there is no branch line.
</p></div>
538 <h2 id=
"_configuration">CONFIGURATION
</h2>
539 <div class=
"sectionbody">
540 <div class=
"para"><p>The command honors
<tt>color.status
</tt> (or
<tt>status.color
</tt> — they
541 mean the same thing and the latter is kept for backward
542 compatibility) and
<tt>color.status.
<slot
></tt> configuration variables
543 to colorize its output.
</p></div>
544 <div class=
"para"><p>If the config variable
<tt>status.relativePaths
</tt> is set to false, then all
545 paths shown are relative to the repository root, not to the current
547 <div class=
"para"><p>If
<tt>status.submodulesummary
</tt> is set to a non zero number or true (identical
548 to -
1 or an unlimited number), the submodule summary will be enabled for
549 the long format and a summary of commits for modified submodules will be
550 shown (see --summary-limit option of
<a href=
"git-submodule.html">git-submodule(
1)
</a>).
</p></div>
552 <h2 id=
"_see_also">SEE ALSO
</h2>
553 <div class=
"sectionbody">
554 <div class=
"para"><p><a href=
"gitignore.html">gitignore(
5)
</a></p></div>
556 <h2 id=
"_author">Author
</h2>
557 <div class=
"sectionbody">
558 <div class=
"para"><p>Written by Junio C Hamano
<gitster@pobox.com
>.
</p></div>
560 <h2 id=
"_documentation">Documentation
</h2>
561 <div class=
"sectionbody">
562 <div class=
"para"><p>Documentation by David Greaves, Junio C Hamano and the git-list
<git@vger.kernel.org
>.
</p></div>
564 <h2 id=
"_git">GIT
</h2>
565 <div class=
"sectionbody">
566 <div class=
"para"><p>Part of the
<a href=
"git.html">git(
1)
</a> suite
</p></div>
569 <div id=
"footer-text">
570 Last updated
2010-
09-
03 21:
30:
32 UTC