Autogenerated man pages for v1.2.4-gf61c2
[git.git] / man1 / git-status.1
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "GIT-STATUS" 1 "" "" ""
21 .SH NAME
22 git-status \- Show working tree status
23 .SH "SYNOPSIS"
24
25
26 \fIgit\-status\fR
27
28 .SH "DESCRIPTION"
29
30
31 Examines paths in the working tree that has changes unrecorded to the index file, and changes between the index file and the current HEAD commit\&. The former paths are what you _could_ commit by running \fIgit\-update\-index\fR before running \fIgit commit\fR, and the latter paths are what you _would_ commit by running \fIgit commit\fR\&.
32
33
34 If there is no path that is different between the index file and the current HEAD commit, the command exits with non\-zero status\&.
35
36 .SH "OUTPUT"
37
38
39 The output from this command is designed to be used as a commit template comments, and all the output lines are prefixed with \fI#\fR\&.
40
41 .SH "AUTHOR"
42
43
44 Written by Linus Torvalds <torvalds@osdl\&.org> and Junio C Hamano <junkio@cox\&.net>\&.
45
46 .SH "DOCUMENTATION"
47
48
49 Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
50
51 .SH "GIT"
52
53
54 Part of the \fBgit\fR(7) suite
55