]>
Commit | Line | Data |
---|---|---|
2cf565c5 DG |
1 | git-ls-files(1) |
2 | =============== | |
2cf565c5 DG |
3 | |
4 | NAME | |
5 | ---- | |
c3f0baac | 6 | git-ls-files - Show information about files in the index and the working tree |
2cf565c5 DG |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
f9666adf | 11 | [verse] |
b1889c36 | 12 | 'git ls-files' [-z] [-t] [-v] |
12378c0a JN |
13 | (--[cached|deleted|others|ignored|stage|unmerged|killed|modified])* |
14 | (-[c|d|o|i|s|u|k|m])* | |
a7630bd4 | 15 | [--eol] |
2cf565c5 DG |
16 | [-x <pattern>|--exclude=<pattern>] |
17 | [-X <file>|--exclude-from=<file>] | |
ad0cae4c | 18 | [--exclude-per-directory=<file>] |
8e7b07c8 | 19 | [--exclude-standard] |
a7a0f3d3 | 20 | [--error-unmatch] [--with-tree=<tree-ish>] |
e77aa336 BW |
21 | [--full-name] [--recurse-submodules] |
22 | [--abbrev] [--] [<file>...] | |
2cf565c5 DG |
23 | |
24 | DESCRIPTION | |
25 | ----------- | |
26 | This merges the file listing in the directory cache index with the | |
27 | actual working directory list, and shows different combinations of the | |
28 | two. | |
29 | ||
30 | One or more of the options below may be used to determine the files | |
31 | shown: | |
32 | ||
33 | OPTIONS | |
34 | ------- | |
3240240f SB |
35 | -c:: |
36 | --cached:: | |
2cf565c5 DG |
37 | Show cached files in the output (default) |
38 | ||
3240240f SB |
39 | -d:: |
40 | --deleted:: | |
2cf565c5 DG |
41 | Show deleted files in the output |
42 | ||
3240240f SB |
43 | -m:: |
44 | --modified:: | |
b0391890 JH |
45 | Show modified files in the output |
46 | ||
3240240f SB |
47 | -o:: |
48 | --others:: | |
4d590f06 | 49 | Show other (i.e. untracked) files in the output |
2cf565c5 | 50 | |
3240240f SB |
51 | -i:: |
52 | --ignored:: | |
500348aa JK |
53 | Show only ignored files in the output. When showing files in the |
54 | index, print only those matched by an exclude pattern. When | |
55 | showing "other" files, show only those matched by an exclude | |
56 | pattern. | |
2cf565c5 | 57 | |
3240240f SB |
58 | -s:: |
59 | --stage:: | |
c297432d | 60 | Show staged contents' object name, mode bits and stage number in the output. |
2cf565c5 | 61 | |
a3259570 PB |
62 | --directory:: |
63 | If a whole directory is classified as "other", show just its | |
64 | name (with a trailing slash) and not its whole contents. | |
65 | ||
b0a3de42 PB |
66 | --no-empty-directory:: |
67 | Do not list empty directories. Has no effect without --directory. | |
68 | ||
3240240f SB |
69 | -u:: |
70 | --unmerged:: | |
2cf565c5 DG |
71 | Show unmerged files in the output (forces --stage) |
72 | ||
3240240f SB |
73 | -k:: |
74 | --killed:: | |
6ca45943 | 75 | Show files on the filesystem that need to be removed due |
ab182478 | 76 | to file/directory conflicts for checkout-index to |
6ca45943 JH |
77 | succeed. |
78 | ||
2cf565c5 | 79 | -z:: |
d88156e9 | 80 | \0 line termination on output. |
2cf565c5 | 81 | |
3240240f SB |
82 | -x <pattern>:: |
83 | --exclude=<pattern>:: | |
4c608520 | 84 | Skip untracked files matching pattern. |
75609a0d JS |
85 | Note that pattern is a shell wildcard pattern. See EXCLUDE PATTERNS |
86 | below for more information. | |
2cf565c5 | 87 | |
3240240f SB |
88 | -X <file>:: |
89 | --exclude-from=<file>:: | |
4c608520 | 90 | Read exclude patterns from <file>; 1 per line. |
30b0535f JH |
91 | |
92 | --exclude-per-directory=<file>:: | |
4c608520 | 93 | Read additional exclude patterns that apply only to the |
30b0535f | 94 | directory and its subdirectories in <file>. |
2cf565c5 | 95 | |
8e7b07c8 | 96 | --exclude-standard:: |
2de9b711 | 97 | Add the standard Git exclusions: .git/info/exclude, .gitignore |
8e7b07c8 JK |
98 | in each directory, and the user's global exclusion file. |
99 | ||
c8af25ca CW |
100 | --error-unmatch:: |
101 | If any <file> does not appear in the index, treat this as an | |
102 | error (return 1). | |
103 | ||
a7a0f3d3 JH |
104 | --with-tree=<tree-ish>:: |
105 | When using --error-unmatch to expand the user supplied | |
106 | <file> (i.e. path pattern) arguments to paths, pretend | |
107 | that paths which were removed in the index since the | |
108 | named <tree-ish> are still present. Using this option | |
109 | with `-s` or `-u` options does not make any sense. | |
110 | ||
2cf565c5 | 111 | -t:: |
5bc0e247 MM |
112 | This feature is semi-deprecated. For scripting purpose, |
113 | linkgit:git-status[1] `--porcelain` and | |
114 | linkgit:git-diff-files[1] `--name-status` are almost always | |
115 | superior alternatives, and users should look at | |
116 | linkgit:git-status[1] `--short` or linkgit:git-diff[1] | |
117 | `--name-status` for more user-friendly alternatives. | |
118 | + | |
119 | This option identifies the file status with the following tags (followed by | |
120 | a space) at the start of each line: | |
121 | ||
df8baa42 | 122 | H:: cached |
44a36913 | 123 | S:: skip-worktree |
df8baa42 JF |
124 | M:: unmerged |
125 | R:: removed/deleted | |
89438677 | 126 | C:: modified/changed |
df8baa42 | 127 | K:: to be killed |
41ac06c7 | 128 | ?:: other |
2cf565c5 | 129 | |
f9666adf JH |
130 | -v:: |
131 | Similar to `-t`, but use lowercase letters for files | |
56c3eb17 | 132 | that are marked as 'assume unchanged' (see |
5162e697 | 133 | linkgit:git-update-index[1]). |
f9666adf | 134 | |
9a84074d JH |
135 | --full-name:: |
136 | When run from a subdirectory, the command usually | |
137 | outputs paths relative to the current directory. This | |
138 | option forces paths to be output relative to the project | |
139 | top directory. | |
140 | ||
e77aa336 BW |
141 | --recurse-submodules:: |
142 | Recursively calls ls-files on each submodule in the repository. | |
75a6315f | 143 | Currently there is only support for the --cached mode. |
e77aa336 | 144 | |
ad0cae4c EW |
145 | --abbrev[=<n>]:: |
146 | Instead of showing the full 40-byte hexadecimal object | |
323b9db8 | 147 | lines, show only a partial prefix. |
ad0cae4c EW |
148 | Non default number of digits can be specified with --abbrev=<n>. |
149 | ||
84974217 TR |
150 | --debug:: |
151 | After each line that describes a file, add more data about its | |
152 | cache entry. This is intended to show as much information as | |
153 | possible for manual inspection; the exact format may change at | |
154 | any time. | |
155 | ||
a7630bd4 TB |
156 | --eol:: |
157 | Show <eolinfo> and <eolattr> of files. | |
158 | <eolinfo> is the file content identification used by Git when | |
159 | the "text" attribute is "auto" (or not set and core.autocrlf is not false). | |
160 | <eolinfo> is either "-text", "none", "lf", "crlf", "mixed" or "". | |
161 | + | |
162 | "" means the file is not a regular file, it is not in the index or | |
d285ab0a | 163 | not accessible in the working tree. |
a7630bd4 TB |
164 | + |
165 | <eolattr> is the attribute that is used when checking out or committing, | |
166 | it is either "", "-text", "text", "text=auto", "text eol=lf", "text eol=crlf". | |
41a616da | 167 | Since Git 2.10 "text=auto eol=lf" and "text=auto eol=crlf" are supported. |
a7630bd4 TB |
168 | + |
169 | Both the <eolinfo> in the index ("i/<eolinfo>") | |
170 | and in the working tree ("w/<eolinfo>") are shown for regular files, | |
171 | followed by the ("attr/<eolattr>"). | |
172 | ||
e994004f | 173 | \--:: |
500b97e4 FK |
174 | Do not interpret any more arguments as options. |
175 | ||
176 | <file>:: | |
177 | Files to show. If no files are given all files which match the other | |
178 | specified criteria are shown. | |
179 | ||
2cf565c5 DG |
180 | Output |
181 | ------ | |
bcf9626a | 182 | 'git ls-files' just outputs the filenames unless `--stage` is specified in |
2cf565c5 DG |
183 | which case it outputs: |
184 | ||
185 | [<tag> ]<mode> <object> <stage> <file> | |
186 | ||
a7630bd4 TB |
187 | 'git ls-files --eol' will show |
188 | i/<eolinfo><SPACES>w/<eolinfo><SPACES>attr/<eolattr><SPACE*><TAB><file> | |
189 | ||
0b444cdb | 190 | 'git ls-files --unmerged' and 'git ls-files --stage' can be used to examine |
2cf565c5 DG |
191 | detailed information on unmerged paths. |
192 | ||
d5fa1f1a | 193 | For an unmerged path, instead of recording a single mode/SHA-1 pair, |
5adf317b | 194 | the index records up to three such pairs; one from tree O in stage |
2cf565c5 | 195 | 1, A in stage 2, and B in stage 3. This information can be used by |
2c6e4771 | 196 | the user (or the porcelain) to see what should eventually be recorded at the |
483bc4f0 | 197 | path. (see linkgit:git-read-tree[1] for more information on state) |
2cf565c5 | 198 | |
d88156e9 JH |
199 | When `-z` option is not used, TAB, LF, and backslash characters |
200 | in pathnames are represented as `\t`, `\n`, and `\\`, | |
201 | respectively. | |
202 | ||
30b0535f JH |
203 | |
204 | Exclude Patterns | |
205 | ---------------- | |
206 | ||
0b444cdb | 207 | 'git ls-files' can use a list of "exclude patterns" when |
30b0535f | 208 | traversing the directory tree and finding files to show when the |
5162e697 | 209 | flags --others or --ignored are specified. linkgit:gitignore[5] |
cedb8d5d | 210 | specifies the format of exclude patterns. |
30b0535f | 211 | |
cedb8d5d | 212 | These exclude patterns come from these places, in order: |
30b0535f | 213 | |
06ab60c0 | 214 | 1. The command-line flag --exclude=<pattern> specifies a |
cedb8d5d JT |
215 | single pattern. Patterns are ordered in the same order |
216 | they appear in the command line. | |
30b0535f | 217 | |
06ab60c0 | 218 | 2. The command-line flag --exclude-from=<file> specifies a |
cedb8d5d JT |
219 | file containing a list of patterns. Patterns are ordered |
220 | in the same order they appear in the file. | |
30b0535f | 221 | |
06ab60c0 | 222 | 3. The command-line flag --exclude-per-directory=<name> specifies |
0b444cdb | 223 | a name of the file in each directory 'git ls-files' |
cedb8d5d JT |
224 | examines, normally `.gitignore`. Files in deeper |
225 | directories take precedence. Patterns are ordered in the | |
226 | same order they appear in the files. | |
30b0535f JH |
227 | |
228 | A pattern specified on the command line with --exclude or read | |
229 | from the file specified with --exclude-from is relative to the | |
230 | top of the directory tree. A pattern read from a file specified | |
231 | by --exclude-per-directory is relative to the directory that the | |
232 | pattern file appears in. | |
233 | ||
56ae8df5 | 234 | SEE ALSO |
c1bdacf9 | 235 | -------- |
5162e697 | 236 | linkgit:git-read-tree[1], linkgit:gitignore[5] |
2cf565c5 | 237 | |
2cf565c5 DG |
238 | GIT |
239 | --- | |
9e1f0a85 | 240 | Part of the linkgit:git[1] suite |