1git-status(1) 2============= 3 4NAME 5---- 6git-status - Show the working tree status 7 8 9SYNOPSIS 10-------- 11'git status' [<options>...] [--] [<pathspec>...] 12 13DESCRIPTION 14----------- 15Displays paths that have differences between the index file and the 16current HEAD commit, paths that have differences between the working 17tree and the index file, and paths in the working tree that are not 18tracked by git (and are not ignored by linkgit:gitignore[5]). The first 19are what you _would_ commit by running `git commit`; the second and 20third are what you _could_ commit by running 'git add' before running 21`git commit`. 22 23OPTIONS 24------- 25 26-s:: 27--short:: 28 Give the output in the short-format. 29 30-b:: 31--branch:: 32 Show the branch and tracking info even in short-format. 33 34--porcelain:: 35 Give the output in a stable, easy-to-parse format for scripts. 36 Currently this is identical to --short output, but is guaranteed 37 not to change in the future, making it safe for scripts. 38 39-u[<mode>]:: 40--untracked-files[=<mode>]:: 41 Show untracked files. 42+ 43The mode parameter is optional (defaults to 'all'), and is used to 44specify the handling of untracked files; when -u is not used, the 45default is 'normal', i.e. show untracked files and directories. 46+ 47The possible options are: 48+ 49 - 'no' - Show no untracked files 50 - 'normal' - Shows untracked files and directories 51 - 'all' - Also shows individual files in untracked directories. 52+ 53The default can be changed using the status.showUntrackedFiles 54configuration variable documented in linkgit:git-config[1]. 55 56--ignore-submodules[=<when>]:: 57 Ignore changes to submodules when looking for changes. <when> can be 58 either "none", "untracked", "dirty" or "all", which is the default. 59 Using "none" will consider the submodule modified when it either contains 60 untracked or modified files or its HEAD differs from the commit recorded 61 in the superproject and can be used to override any settings of the 62 'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When 63 "untracked" is used submodules are not considered dirty when they only 64 contain untracked content (but they are still scanned for modified 65 content). Using "dirty" ignores all changes to the work tree of submodules, 66 only changes to the commits stored in the superproject are shown (this was 67 the behavior before 1.7.0). Using "all" hides all changes to submodules 68 (and suppresses the output of submodule summaries when the config option 69 `status.submodulesummary` is set). 70 71-z:: 72 Terminate entries with NUL, instead of LF. This implies 73 the `--porcelain` output format if no other format is given. 74 75 76OUTPUT 77------ 78The output from this command is designed to be used as a commit 79template comment, and all the output lines are prefixed with '#'. 80The default, long format, is designed to be human readable, 81verbose and descriptive. Its contents and format are subject to change 82at any time. 83 84The paths mentioned in the output, unlike many other git commands, are 85made relative to the current directory if you are working in a 86subdirectory (this is on purpose, to help cutting and pasting). See 87the status.relativePaths config option below. 88 89In the short-format, the status of each path is shown as 90 91 XY PATH1 -> PATH2 92 93where `PATH1` is the path in the `HEAD`, and the ` -> PATH2` part is 94shown only when `PATH1` corresponds to a different path in the 95index/worktree (i.e. the file is renamed). The 'XY' is a two-letter 96status code. 97 98The fields (including the `->`) are separated from each other by a 99single space. If a filename contains whitespace or other nonprintable 100characters, that field will be quoted in the manner of a C string 101literal: surrounded by ASCII double quote (34) characters, and with 102interior special characters backslash-escaped. 103 104For paths with merge conflicts, `X` and 'Y' show the modification 105states of each side of the merge. For paths that do not have merge 106conflicts, `X` shows the status of the index, and `Y` shows the status 107of the work tree. For untracked paths, `XY` are `??`. Other status 108codes can be interpreted as follows: 109 110* ' ' = unmodified 111* 'M' = modified 112* 'A' = added 113* 'D' = deleted 114* 'R' = renamed 115* 'C' = copied 116* 'U' = updated but unmerged 117 118Ignored files are not listed. 119 120 X Y Meaning 121 ------------------------------------------------- 122 [MD] not updated 123 M [ MD] updated in index 124 A [ MD] added to index 125 D [ M] deleted from index 126 R [ MD] renamed in index 127 C [ MD] copied in index 128 [MARC] index and work tree matches 129 [ MARC] M work tree changed since index 130 [ MARC] D deleted in work tree 131 ------------------------------------------------- 132 D D unmerged, both deleted 133 A U unmerged, added by us 134 U D unmerged, deleted by them 135 U A unmerged, added by them 136 D U unmerged, deleted by us 137 A A unmerged, both added 138 U U unmerged, both modified 139 ------------------------------------------------- 140 ? ? untracked 141 ------------------------------------------------- 142 143If -b is used the short-format status is preceded by a line 144 145## branchname tracking info 146 147There is an alternate -z format recommended for machine parsing. In 148that format, the status field is the same, but some other things 149change. First, the '->' is omitted from rename entries and the field 150order is reversed (e.g 'from -> to' becomes 'to from'). Second, a NUL 151(ASCII 0) follows each filename, replacing space as a field separator 152and the terminating newline (but a space still separates the status 153field from the first filename). Third, filenames containing special 154characters are not specially formatted; no quoting or 155backslash-escaping is performed. Fourth, there is no branch line. 156 157CONFIGURATION 158------------- 159 160The command honors `color.status` (or `status.color` -- they 161mean the same thing and the latter is kept for backward 162compatibility) and `color.status.<slot>` configuration variables 163to colorize its output. 164 165If the config variable `status.relativePaths` is set to false, then all 166paths shown are relative to the repository root, not to the current 167directory. 168 169If `status.submodulesummary` is set to a non zero number or true (identical 170to -1 or an unlimited number), the submodule summary will be enabled for 171the long format and a summary of commits for modified submodules will be 172shown (see --summary-limit option of linkgit:git-submodule[1]). 173 174SEE ALSO 175-------- 176linkgit:gitignore[5] 177 178GIT 179--- 180Part of the linkgit:git[1] suite