]> git.ipfire.org Git - thirdparty/git.git/blame - Documentation/git-runstatus.txt
War on whitespace
[thirdparty/git.git] / Documentation / git-runstatus.txt
CommitLineData
fd931411
RS
1git-runstatus(1)
2================
3
4NAME
5----
6git-runstatus - A helper for git-status and git-commit
7
8
9SYNOPSIS
10--------
11'git-runstatus' [--color|--nocolor] [--amend] [--verbose] [--untracked]
12
13
14DESCRIPTION
15-----------
16Examines paths in the working tree that has changes unrecorded
17to the index file, and changes between the index file and the
18current HEAD commit. The former paths are what you _could_
d7f078b8 19commit by running 'git add' (or 'git rm' if you are deleting) before running 'git
fd931411
RS
20commit', and the latter paths are what you _would_ commit by
21running 'git commit'.
22
23If there is no path that is different between the index file and
24the current HEAD commit, the command exits with non-zero status.
25
26Note that this is _not_ the user level command you would want to
27run from the command line. Use 'git-status' instead.
28
29
30OPTIONS
31-------
32--color::
33 Show colored status, highlighting modified file names.
34
35--nocolor::
36 Turn off coloring.
37
38--amend::
39 Show status based on HEAD^1, not HEAD, i.e. show what
40 'git-commit --amend' would do.
41
42--verbose::
43 Show unified diff of all file changes.
44
45--untracked::
46 Show files in untracked directories, too. Without this
47 option only its name and a trailing slash are displayed
48 for each untracked directory.
49
50
51OUTPUT
52------
53The output from this command is designed to be used as a commit
54template comments, and all the output lines are prefixed with '#'.
55
56
57Author
58------
59Originally written by Linus Torvalds <torvalds@osdl.org> as part
60of git-commit, and later rewritten in C by Jeff King.
61
62Documentation
63--------------
64Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
65
66GIT
67---
68Part of the gitlink:git[7] suite