Documentation / git-status.txton commit Mark user-manual as UTF-8 (1cffddd)
   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
  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
  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
  45See Also
  46--------
  47gitlink:gitignore[5]
  48
  49Author
  50------
  51Written by Linus Torvalds <torvalds@osdl.org> and
  52Junio C Hamano <junkio@cox.net>.
  53
  54Documentation
  55--------------
  56Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
  57
  58GIT
  59---
  60Part of the gitlink:git[7] suite