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