<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" | |
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> | |
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> | |
<head> | |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> | |
<meta name="generator" content="AsciiDoc 8.4.5" /> | |
<title>git-status(1)</title> | |
<style type="text/css"> | |
/* Debug borders */ | |
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { | |
/* | |
border: 1px solid red; | |
*/ | |
} | |
body { | |
margin: 1em 5% 1em 5%; | |
} | |
a { | |
color: blue; | |
text-decoration: underline; | |
} | |
a:visited { | |
color: fuchsia; | |
} | |
em { | |
font-style: italic; | |
color: navy; | |
} | |
strong { | |
font-weight: bold; | |
color: #083194; | |
} | |
tt { | |
color: navy; | |
} | |
h1, h2, h3, h4, h5, h6 { | |
color: #527bbd; | |
font-family: sans-serif; | |
margin-top: 1.2em; | |
margin-bottom: 0.5em; | |
line-height: 1.3; | |
} | |
h1, h2, h3 { | |
border-bottom: 2px solid silver; | |
} | |
h2 { | |
padding-top: 0.5em; | |
} | |
h3 { | |
float: left; | |
} | |
h3 + * { | |
clear: left; | |
} | |
div.sectionbody { | |
font-family: serif; | |
margin-left: 0; | |
} | |
hr { | |
border: 1px solid silver; | |
} | |
p { | |
margin-top: 0.5em; | |
margin-bottom: 0.5em; | |
} | |
ul, ol, li > p { | |
margin-top: 0; | |
} | |
pre { | |
padding: 0; | |
margin: 0; | |
} | |
span#author { | |
color: #527bbd; | |
font-family: sans-serif; | |
font-weight: bold; | |
font-size: 1.1em; | |
} | |
span#email { | |
} | |
span#revnumber, span#revdate, span#revremark { | |
font-family: sans-serif; | |
} | |
div#footer { | |
font-family: sans-serif; | |
font-size: small; | |
border-top: 2px solid silver; | |
padding-top: 0.5em; | |
margin-top: 4.0em; | |
} | |
div#footer-text { | |
float: left; | |
padding-bottom: 0.5em; | |
} | |
div#footer-badges { | |
float: right; | |
padding-bottom: 0.5em; | |
} | |
div#preamble { | |
margin-top: 1.5em; | |
margin-bottom: 1.5em; | |
} | |
div.tableblock, div.imageblock, div.exampleblock, div.verseblock, | |
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, | |
div.admonitionblock { | |
margin-top: 1.5em; | |
margin-bottom: 1.5em; | |
} | |
div.admonitionblock { | |
margin-top: 2.5em; | |
margin-bottom: 2.5em; | |
} | |
div.content { /* Block element content. */ | |
padding: 0; | |
} | |
/* Block element titles. */ | |
div.title, caption.title { | |
color: #527bbd; | |
font-family: sans-serif; | |
font-weight: bold; | |
text-align: left; | |
margin-top: 1.0em; | |
margin-bottom: 0.5em; | |
} | |
div.title + * { | |
margin-top: 0; | |
} | |
td div.title:first-child { | |
margin-top: 0.0em; | |
} | |
div.content div.title:first-child { | |
margin-top: 0.0em; | |
} | |
div.content + div.title { | |
margin-top: 0.0em; | |
} | |
div.sidebarblock > div.content { | |
background: #ffffee; | |
border: 1px solid silver; | |
padding: 0.5em; | |
} | |
div.listingblock > div.content { | |
border: 1px solid silver; | |
background: #f4f4f4; | |
padding: 0.5em; | |
} | |
div.quoteblock { | |
padding-left: 2.0em; | |
margin-right: 10%; | |
} | |
div.quoteblock > div.attribution { | |
padding-top: 0.5em; | |
text-align: right; | |
} | |
div.verseblock { | |
padding-left: 2.0em; | |
margin-right: 10%; | |
} | |
div.verseblock > div.content { | |
white-space: pre; | |
} | |
div.verseblock > div.attribution { | |
padding-top: 0.75em; | |
text-align: left; | |
} | |
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ | |
div.verseblock + div.attribution { | |
text-align: left; | |
} | |
div.admonitionblock .icon { | |
vertical-align: top; | |
font-size: 1.1em; | |
font-weight: bold; | |
text-decoration: underline; | |
color: #527bbd; | |
padding-right: 0.5em; | |
} | |
div.admonitionblock td.content { | |
padding-left: 0.5em; | |
border-left: 2px solid silver; | |
} | |
div.exampleblock > div.content { | |
border-left: 2px solid silver; | |
padding: 0.5em; | |
} | |
div.imageblock div.content { padding-left: 0; } | |
span.image img { border-style: none; } | |
a.image:visited { color: white; } | |
dl { | |
margin-top: 0.8em; | |
margin-bottom: 0.8em; | |
} | |
dt { | |
margin-top: 0.5em; | |
margin-bottom: 0; | |
font-style: normal; | |
color: navy; | |
} | |
dd > *:first-child { | |
margin-top: 0.1em; | |
} | |
ul, ol { | |
list-style-position: outside; | |
} | |
ol.arabic { | |
list-style-type: decimal; | |
} | |
ol.loweralpha { | |
list-style-type: lower-alpha; | |
} | |
ol.upperalpha { | |
list-style-type: upper-alpha; | |
} | |
ol.lowerroman { | |
list-style-type: lower-roman; | |
} | |
ol.upperroman { | |
list-style-type: upper-roman; | |
} | |
div.compact ul, div.compact ol, | |
div.compact p, div.compact p, | |
div.compact div, div.compact div { | |
margin-top: 0.1em; | |
margin-bottom: 0.1em; | |
} | |
div.tableblock > table { | |
border: 3px solid #527bbd; | |
} | |
thead { | |
font-family: sans-serif; | |
font-weight: bold; | |
} | |
tfoot { | |
font-weight: bold; | |
} | |
td > div.verse { | |
white-space: pre; | |
} | |
p.table { | |
margin-top: 0; | |
} | |
/* Because the table frame attribute is overriden by CSS in most browsers. */ | |
div.tableblock > table[frame="void"] { | |
border-style: none; | |
} | |
div.tableblock > table[frame="hsides"] { | |
border-left-style: none; | |
border-right-style: none; | |
} | |
div.tableblock > table[frame="vsides"] { | |
border-top-style: none; | |
border-bottom-style: none; | |
} | |
div.hdlist { | |
margin-top: 0.8em; | |
margin-bottom: 0.8em; | |
} | |
div.hdlist tr { | |
padding-bottom: 15px; | |
} | |
dt.hdlist1.strong, td.hdlist1.strong { | |
font-weight: bold; | |
} | |
td.hdlist1 { | |
vertical-align: top; | |
font-style: normal; | |
padding-right: 0.8em; | |
color: navy; | |
} | |
td.hdlist2 { | |
vertical-align: top; | |
} | |
div.hdlist.compact tr { | |
margin: 0; | |
padding-bottom: 0; | |
} | |
.comment { | |
background: yellow; | |
} | |
@media print { | |
div#footer-badges { display: none; } | |
} | |
div#toctitle { | |
color: #527bbd; | |
font-family: sans-serif; | |
font-size: 1.1em; | |
font-weight: bold; | |
margin-top: 1.0em; | |
margin-bottom: 0.1em; | |
} | |
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { | |
margin-top: 0; | |
margin-bottom: 0; | |
} | |
div.toclevel2 { | |
margin-left: 2em; | |
font-size: 0.9em; | |
} | |
div.toclevel3 { | |
margin-left: 4em; | |
font-size: 0.9em; | |
} | |
div.toclevel4 { | |
margin-left: 6em; | |
font-size: 0.9em; | |
} | |
/* Overrides for manpage documents */ | |
h1 { | |
padding-top: 0.5em; | |
padding-bottom: 0.5em; | |
border-top: 2px solid silver; | |
border-bottom: 2px solid silver; | |
} | |
h2 { | |
border-style: none; | |
} | |
div.sectionbody { | |
margin-left: 5%; | |
} | |
@media print { | |
div#toc { display: none; } | |
} | |
/* Workarounds for IE6's broken and incomplete CSS2. */ | |
div.sidebar-content { | |
background: #ffffee; | |
border: 1px solid silver; | |
padding: 0.5em; | |
} | |
div.sidebar-title, div.image-title { | |
color: #527bbd; | |
font-family: sans-serif; | |
font-weight: bold; | |
margin-top: 0.0em; | |
margin-bottom: 0.5em; | |
} | |
div.listingblock div.content { | |
border: 1px solid silver; | |
background: #f4f4f4; | |
padding: 0.5em; | |
} | |
div.quoteblock-attribution { | |
padding-top: 0.5em; | |
text-align: right; | |
} | |
div.verseblock-content { | |
white-space: pre; | |
} | |
div.verseblock-attribution { | |
padding-top: 0.75em; | |
text-align: left; | |
} | |
div.exampleblock-content { | |
border-left: 2px solid silver; | |
padding-left: 0.5em; | |
} | |
/* IE6 sets dynamically generated links as visited. */ | |
div#toc a:visited { color: blue; } | |
</style> | |
</head> | |
<body> | |
<div id="header"> | |
<h1> | |
git-status(1) Manual Page | |
</h1> | |
<h2>NAME</h2> | |
<div class="sectionbody"> | |
<p>git-status - | |
Show the working tree status | |
</p> | |
</div> | |
</div> | |
<h2 id="_synopsis">SYNOPSIS</h2> | |
<div class="sectionbody"> | |
<div class="paragraph"><p><em>git status</em> [<options>…] [--] [<pathspec>…]</p></div> | |
</div> | |
<h2 id="_description">DESCRIPTION</h2> | |
<div class="sectionbody"> | |
<div class="paragraph"><p>Displays paths that have differences between the index file and the | |
current HEAD commit, paths that have differences between the working | |
tree and the index file, and paths in the working tree that are not | |
tracked by git (and are not ignored by <a href="gitignore.html">gitignore(5)</a>). The first | |
are what you <em>would</em> commit by running <tt>git commit</tt>; the second and | |
third are what you <em>could</em> commit by running <em>git add</em> before running | |
<tt>git commit</tt>.</p></div> | |
</div> | |
<h2 id="_options">OPTIONS</h2> | |
<div class="sectionbody"> | |
<div class="dlist"><dl> | |
<dt class="hdlist1"> | |
-s | |
</dt> | |
<dt class="hdlist1"> | |
--short | |
</dt> | |
<dd> | |
<p> | |
Give the output in the short-format. | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
-b | |
</dt> | |
<dt class="hdlist1"> | |
--branch | |
</dt> | |
<dd> | |
<p> | |
Show the branch and tracking info even in short-format. | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
--porcelain | |
</dt> | |
<dd> | |
<p> | |
Give the output in a stable, easy-to-parse format for scripts. | |
Currently this is identical to --short output, but is guaranteed | |
not to change in the future, making it safe for scripts. | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
-u[<mode>] | |
</dt> | |
<dt class="hdlist1"> | |
--untracked-files[=<mode>] | |
</dt> | |
<dd> | |
<p> | |
Show untracked files. | |
</p> | |
<div class="paragraph"><p>The mode parameter is optional (defaults to <em>all</em>), and is used to | |
specify the handling of untracked files; when -u is not used, the | |
default is <em>normal</em>, i.e. show untracked files and directories.</p></div> | |
<div class="paragraph"><p>The possible options are:</p></div> | |
<div class="ulist"><ul> | |
<li> | |
<p> | |
<em>no</em> - Show no untracked files | |
</p> | |
</li> | |
<li> | |
<p> | |
<em>normal</em> - Shows untracked files and directories | |
</p> | |
</li> | |
<li> | |
<p> | |
<em>all</em> - Also shows individual files in untracked directories. | |
</p> | |
<div class="paragraph"><p>The default can be changed using the status.showUntrackedFiles | |
configuration variable documented in <a href="git-config.html">git-config(1)</a>.</p></div> | |
</li> | |
</ul></div> | |
</dd> | |
<dt class="hdlist1"> | |
--ignore-submodules[=<when>] | |
</dt> | |
<dd> | |
<p> | |
Ignore changes to submodules when looking for changes. <when> can be | |
either "none", "untracked", "dirty" or "all", which is the default. | |
Using "none" will consider the submodule modified when it either contains | |
untracked or modified files or its HEAD differs from the commit recorded | |
in the superproject and can be used to override any settings of the | |
<em>ignore</em> option in <a href="git-config.html">git-config(1)</a> or <a href="gitmodules.html">gitmodules(5)</a>. When | |
"untracked" is used submodules are not considered dirty when they only | |
contain untracked content (but they are still scanned for modified | |
content). Using "dirty" ignores all changes to the work tree of submodules, | |
only changes to the commits stored in the superproject are shown (this was | |
the behavior before 1.7.0). Using "all" hides all changes to submodules | |
(and suppresses the output of submodule summaries when the config option | |
<tt>status.submodulesummary</tt> is set). | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
-z | |
</dt> | |
<dd> | |
<p> | |
Terminate entries with NUL, instead of LF. This implies | |
the <tt>--porcelain</tt> output format if no other format is given. | |
</p> | |
</dd> | |
</dl></div> | |
</div> | |
<h2 id="_output">OUTPUT</h2> | |
<div class="sectionbody"> | |
<div class="paragraph"><p>The output from this command is designed to be used as a commit | |
template comment, and all the output lines are prefixed with <em>#</em>. | |
The default, long format, is designed to be human readable, | |
verbose and descriptive. They are subject to change in any time.</p></div> | |
<div class="paragraph"><p>The paths mentioned in the output, unlike many other git commands, are | |
made relative to the current directory if you are working in a | |
subdirectory (this is on purpose, to help cutting and pasting). See | |
the status.relativePaths config option below.</p></div> | |
<div class="paragraph"><p>In short-format, the status of each path is shown as</p></div> | |
<div class="literalblock"> | |
<div class="content"> | |
<pre><tt>XY PATH1 -> PATH2</tt></pre> | |
</div></div> | |
<div class="paragraph"><p>where <tt>PATH1</tt> is the path in the <tt>HEAD</tt>, and ` → PATH2` part is | |
shown only when <tt>PATH1</tt> corresponds to a different path in the | |
index/worktree (i.e. the file is renamed). The <em>XY</em> is a two-letter | |
status code.</p></div> | |
<div class="paragraph"><p>The fields (including the <tt>→</tt>) are separated from each other by a | |
single space. If a filename contains whitespace or other nonprintable | |
characters, that field will be quoted in the manner of a C string | |
literal: surrounded by ASCII double quote (34) characters, and with | |
interior special characters backslash-escaped.</p></div> | |
<div class="paragraph"><p>For paths with merge conflicts, <tt>X</tt> and <em>Y</em> show the modification | |
states of each side of the merge. For paths that do not have merge | |
conflicts, <tt>X</tt> shows the status of the index, and <tt>Y</tt> shows the status | |
of the work tree. For untracked paths, <tt>XY</tt> are <tt>??</tt>. Other status | |
codes can be interpreted as follows:</p></div> | |
<div class="ulist"><ul> | |
<li> | |
<p> | |
' ' = unmodified | |
</p> | |
</li> | |
<li> | |
<p> | |
<em>M</em> = modified | |
</p> | |
</li> | |
<li> | |
<p> | |
<em>A</em> = added | |
</p> | |
</li> | |
<li> | |
<p> | |
<em>D</em> = deleted | |
</p> | |
</li> | |
<li> | |
<p> | |
<em>R</em> = renamed | |
</p> | |
</li> | |
<li> | |
<p> | |
<em>C</em> = copied | |
</p> | |
</li> | |
<li> | |
<p> | |
<em>U</em> = updated but unmerged | |
</p> | |
</li> | |
</ul></div> | |
<div class="paragraph"><p>Ignored files are not listed.</p></div> | |
<div class="literalblock"> | |
<div class="content"> | |
<pre><tt>X Y Meaning | |
------------------------------------------------- | |
[MD] not updated | |
M [ MD] updated in index | |
A [ MD] added to index | |
D [ M] deleted from index | |
R [ MD] renamed in index | |
C [ MD] copied in index | |
[MARC] index and work tree matches | |
[ MARC] M work tree changed since index | |
[ MARC] D deleted in work tree | |
------------------------------------------------- | |
D D unmerged, both deleted | |
A U unmerged, added by us | |
U D unmerged, deleted by them | |
U A unmerged, added by them | |
D U unmerged, deleted by us | |
A A unmerged, both added | |
U U unmerged, both modified | |
------------------------------------------------- | |
? ? untracked | |
-------------------------------------------------</tt></pre> | |
</div></div> | |
<div class="paragraph"><p>If -b is used the short-format status is preceded by a line</p></div> | |
<div class="paragraph"><p>## branchname tracking info</p></div> | |
<div class="paragraph"><p>There is an alternate -z format recommended for machine parsing. In | |
that format, the status field is the same, but some other things | |
change. First, the <em>→</em> is omitted from rename entries and the field | |
order is reversed (e.g <em>from → to</em> becomes <em>to from</em>). Second, a NUL | |
(ASCII 0) follows each filename, replacing space as a field separator | |
and the terminating newline (but a space still separates the status | |
field from the first filename). Third, filenames containing special | |
characters are not specially formatted; no quoting or | |
backslash-escaping is performed. Fourth, there is no branch line.</p></div> | |
</div> | |
<h2 id="_configuration">CONFIGURATION</h2> | |
<div class="sectionbody"> | |
<div class="paragraph"><p>The command honors <tt>color.status</tt> (or <tt>status.color</tt> — they | |
mean the same thing and the latter is kept for backward | |
compatibility) and <tt>color.status.<slot></tt> configuration variables | |
to colorize its output.</p></div> | |
<div class="paragraph"><p>If the config variable <tt>status.relativePaths</tt> is set to false, then all | |
paths shown are relative to the repository root, not to the current | |
directory.</p></div> | |
<div class="paragraph"><p>If <tt>status.submodulesummary</tt> is set to a non zero number or true (identical | |
to -1 or an unlimited number), the submodule summary will be enabled for | |
the long format and a summary of commits for modified submodules will be | |
shown (see --summary-limit option of <a href="git-submodule.html">git-submodule(1)</a>).</p></div> | |
</div> | |
<h2 id="_see_also">SEE ALSO</h2> | |
<div class="sectionbody"> | |
<div class="paragraph"><p><a href="gitignore.html">gitignore(5)</a></p></div> | |
</div> | |
<h2 id="_git">GIT</h2> | |
<div class="sectionbody"> | |
<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div> | |
</div> | |
<div id="footer"> | |
<div id="footer-text"> | |
Last updated 2011-03-15 23:30:14 UTC | |
</div> | |
</div> | |
</body> | |
</html> |