1git-status(1) 2============= 3 4NAME 5---- 6git-status - Show the working tree status 7 8 9SYNOPSIS 10-------- 11'git-status' <options>... 12 13DESCRIPTION 14----------- 15Displays paths that have differences between the index file and the 16current HEAD commit, paths that have differences between the working 17tree and the index file, and paths in the working tree that are not 18tracked by git (and are not ignored by linkgit:gitignore[5]). The first 19are what you _would_ commit by running `git commit`; the second and 20third are what you _could_ commit by running `git add` before running 21`git commit`. 22 23The command takes the same set of options as `git-commit`; it 24shows what would be committed if the same options are given to 25`git-commit`. 26 27If there is no path that is different between the index file and 28the current HEAD commit (i.e., there is nothing to commit by running 29`git-commit`), the command exits with non-zero status. 30 31 32OUTPUT 33------ 34The output from this command is designed to be used as a commit 35template comment, and all the output lines are prefixed with '#'. 36 37The paths mentioned in the output, unlike many other git commands, are 38made relative to the current directory if you are working in a 39subdirectory (this is on purpose, to help cutting and pasting). See 40the status.relativePaths config option below. 41 42 43CONFIGURATION 44------------- 45 46The command honors `color.status` (or `status.color` -- they 47mean the same thing and the latter is kept for backward 48compatibility) and `color.status.<slot>` configuration variables 49to colorize its output. 50 51If the config variable `status.relativePaths` is set to false, then all 52paths shown are relative to the repository root, not to the current 53directory. 54 55If `status.submodulesummary` is set to a non zero number or true (identical 56to -1 or an unlimited number), the submodule summary will be enabled and a 57summary of commits for modified submodules will be shown (see --summary-limit 58option of linkgit:git-submodule[1]). 59 60SEE ALSO 61-------- 62linkgit:gitignore[5] 63 64Author 65------ 66Written by Linus Torvalds <torvalds@osdl.org> and 67Junio C Hamano <junkio@cox.net>. 68 69Documentation 70-------------- 71Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>. 72 73GIT 74--- 75Part of the linkgit:git[1] suite