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 gitlink: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 31If any paths have been touched in the working tree (that is, 32their modification times have changed) but their contents and 33permissions are identical to those in the index file, the command 34updates the index file. Running `git-status` can thus speed up 35subsequent operations such as `git-diff` if the working tree 36contains many paths that have been touched but not modified. 37 38 39OUTPUT 40------ 41The output from this command is designed to be used as a commit 42template comment, and all the output lines are prefixed with '#'. 43 44The paths mentioned in the output, unlike many other git commands, are 45made relative to the current directory if you are working in a 46subdirectory (this is on purpose, to help cutting and pasting). See 47the status.relativePaths config option below. 48 49 50CONFIGURATION 51------------- 52 53The command honors `color.status` (or `status.color` -- they 54mean the same thing and the latter is kept for backward 55compatibility) and `color.status.<slot>` configuration variables 56to colorize its output. 57 58If the config variable `status.relativePaths` is set to false, then all 59paths shown are relative to the repository root, not to the current 60directory. 61 62See Also 63-------- 64gitlink:gitignore[5] 65 66Author 67------ 68Written by Linus Torvalds <torvalds@osdl.org> and 69Junio C Hamano <junkio@cox.net>. 70 71Documentation 72-------------- 73Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>. 74 75GIT 76--- 77Part of the gitlink:git[7] suite