Documentation / git-status.txton commit Merge branch 'maint' (34c6dbd)
   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-----------
  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_
  18commit by running 'git add' before running 'git
  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
  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
  30If any paths have been touched in the working tree (that is,
  31their modification times have changed) but their contents and
  32permissions are identical to those in the index file, the command
  33updates the index file. Running `git-status` can thus speed up
  34subsequent operations such as `git-diff` if the working tree
  35contains many paths that have been touched but not modified.
  36
  37
  38OUTPUT
  39------
  40The output from this command is designed to be used as a commit
  41template comments, and all the output lines are prefixed with '#'.
  42
  43
  44CONFIGURATION
  45-------------
  46
  47The command honors `color.status` (or `status.color` -- they
  48mean the same thing and the latter is kept for backward
  49compatibility) and `color.status.<slot>` configuration variables
  50to colorize its output.
  51
  52See Also
  53--------
  54gitlink:gitignore[5]
  55
  56Author
  57------
  58Written by Linus Torvalds <torvalds@osdl.org> and
  59Junio C Hamano <junkio@cox.net>.
  60
  61Documentation
  62--------------
  63Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
  64
  65GIT
  66---
  67Part of the gitlink:git[7] suite