Documentation/git-status.txt: mention color configuration
[git/git.git] / Documentation / git-status.txt
CommitLineData
215a7ad1
JH
1git-status(1)
2=============
3f971fc4
JH
3
4NAME
5----
7bd7f280 6git-status - Show working tree status
3f971fc4
JH
7
8
9SYNOPSIS
10--------
fb6ff943 11'git-status' <options>...
3f971fc4
JH
12
13DESCRIPTION
14-----------
15Examines paths in the working tree that has changes unrecorded
16to the index file, and changes between the index file and the
17current HEAD commit. The former paths are what you _could_
215a7ad1 18commit by running 'git-update-index' before running 'git
3f971fc4
JH
19commit', and the latter paths are what you _would_ commit by
20running 'git commit'.
21
22If there is no path that is different between the index file and
23the current HEAD commit, the command exits with non-zero
24status.
25
fb6ff943
JH
26The command takes the same set of options as `git-commit`; it
27shows what would be committed if the same options are given to
28`git-commit`.
29
3f971fc4
JH
30
31OUTPUT
32------
33The output from this command is designed to be used as a commit
34template comments, and all the output lines are prefixed with '#'.
35
36
31fcd63c
JH
37CONFIGURATION
38-------------
39
40The command honors `color.status` (or `status.color` -- they
41mean the same thing and the latter is kept for backward
42compatibility) and `color.status.<slot>` configuration variables
43to colorize its output.
44
45
3f971fc4
JH
46Author
47------
48Written by Linus Torvalds <torvalds@osdl.org> and
49Junio C Hamano <junkio@cox.net>.
50
51Documentation
52--------------
53Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
54
55GIT
56---
a7154e91 57Part of the gitlink:git[7] suite
3f971fc4 58