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