<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<article lang="en" id="git-status(1)">
<articleinfo>
    <title>git-status(1)</title>
        <indexterm>
                <primary>git-status(1)</primary>
        </indexterm>
</articleinfo>
<simplesect id="_name">
<title>NAME</title>
<simpara>git-status - Show the working tree status</simpara>
</simplesect>
<simplesect id="_synopsis">
<title>SYNOPSIS</title>
<simpara><emphasis>git status</emphasis> &lt;options&gt;&#8230;</simpara>
</simplesect>
<simplesect id="_description">
<title>DESCRIPTION</title>
<simpara>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 <xref linkend="gitignore(5)"/>). The first
are what you <emphasis>would</emphasis> commit by running <literal>git commit</literal>; the second and
third are what you <emphasis>could</emphasis> commit by running <emphasis>git-add</emphasis> before running
<literal>git commit</literal>.</simpara>
<simpara>The command takes the same set of options as <emphasis>git-commit</emphasis>; it
shows what would be committed if the same options are given to
<emphasis>git-commit</emphasis>.</simpara>
<simpara>If there is no path that is different between the index file and
the current HEAD commit (i.e., there is nothing to commit by running
<literal>git commit</literal>), the command exits with non-zero status.</simpara>
</simplesect>
<simplesect id="_output">
<title>OUTPUT</title>
<simpara>The output from this command is designed to be used as a commit
template comment, and all the output lines are prefixed with <emphasis>#</emphasis>.</simpara>
<simpara>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.</simpara>
</simplesect>
<simplesect id="_configuration">
<title>CONFIGURATION</title>
<simpara>The command honors <literal>color.status</literal> (or <literal>status.color</literal>&#8201;&#8212;&#8201;they
mean the same thing and the latter is kept for backward
compatibility) and <literal>color.status.&lt;slot&gt;</literal> configuration variables
to colorize its output.</simpara>
<simpara>If the config variable <literal>status.relativePaths</literal> is set to false, then all
paths shown are relative to the repository root, not to the current
directory.</simpara>
<simpara>If <literal>status.submodulesummary</literal> is set to a non zero number or true (identical
to -1 or an unlimited number), the submodule summary will be enabled and a
summary of commits for modified submodules will be shown (see --summary-limit
option of <xref linkend="git-submodule(1)"/>).</simpara>
</simplesect>
<simplesect id="_see_also">
<title>SEE ALSO</title>
<simpara><xref linkend="gitignore(5)"/></simpara>
</simplesect>
<simplesect id="_author">
<title>Author</title>
<simpara>Written by Linus Torvalds &lt;<ulink url="mailto:torvalds@osdl.org">torvalds@osdl.org</ulink>&gt; and
Junio C Hamano &lt;<ulink url="mailto:gitster@pobox.com">gitster@pobox.com</ulink>&gt;.</simpara>
</simplesect>
<simplesect id="_documentation">
<title>Documentation</title>
<simpara>Documentation by David Greaves, Junio C Hamano and the git-list &lt;<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>&gt;.</simpara>
</simplesect>
<simplesect id="_git">
<title>GIT</title>
<simpara>Part of the <xref linkend="git(1)"/> suite</simpara>
</simplesect>
</article>
