| blob | a4bf29e5cb5110493ab38751baa130fd43a0dc24 |
1 '\" t
2 .\" Title: git-ls-files
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
5 .\" Date: 2024-09-20
6 .\" Manual: Git Manual
7 .\" Source: Git 2.46.1.603.g94b60adee3
8 .\" Language: English
9 .\"
10 .TH "GIT\-LS\-FILES" "1" "2024-09-20" "Git 2\&.46\&.1\&.603\&.g94b60a" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 git-ls-files \- Show information about files in the index and the working tree
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit ls\-files\fR [\-z] [\-t] [\-v] [\-f]
36 [\-c|\-\-cached] [\-d|\-\-deleted] [\-o|\-\-others] [\-i|\-\-ignored]
37 [\-s|\-\-stage] [\-u|\-\-unmerged] [\-k|\-\-killed] [\-m|\-\-modified]
38 [\-\-resolve\-undo]
39 [\-\-directory [\-\-no\-empty\-directory]] [\-\-eol]
40 [\-\-deduplicate]
41 [\-x <pattern>|\-\-exclude=<pattern>]
42 [\-X <file>|\-\-exclude\-from=<file>]
43 [\-\-exclude\-per\-directory=<file>]
44 [\-\-exclude\-standard]
45 [\-\-error\-unmatch] [\-\-with\-tree=<tree\-ish>]
46 [\-\-full\-name] [\-\-recurse\-submodules]
47 [\-\-abbrev[=<n>]] [\-\-format=<format>] [\-\-] [<file>\&...\:]
48 .fi
49 .SH "DESCRIPTION"
50 .sp
51 This command merges the file listing in the index with the actual working directory list, and shows different combinations of the two\&.
52 .sp
53 Several flags can be used to determine which files are shown, and each file may be printed multiple times if there are multiple entries in the index or if multiple statuses are applicable for the relevant file selection options\&.
54 .SH "OPTIONS"
55 .PP
56 \-c, \-\-cached
57 .RS 4
58 Show all files cached in Git\(cqs index, i\&.e\&. all tracked files\&. (This is the default if no \-c/\-s/\-d/\-o/\-u/\-k/\-m/\-\-resolve\-undo options are specified\&.)
59 .RE
60 .PP
61 \-d, \-\-deleted
62 .RS 4
63 Show files with an unstaged deletion
64 .RE
65 .PP
66 \-m, \-\-modified
67 .RS 4
68 Show files with an unstaged modification (note that an unstaged deletion also counts as an unstaged modification)
69 .RE
70 .PP
71 \-o, \-\-others
72 .RS 4
73 Show other (i\&.e\&. untracked) files in the output
74 .RE
75 .PP
76 \-i, \-\-ignored
77 .RS 4
78 Show only ignored files in the output\&. Must be used with either an explicit
79 \fI\-c\fR
80 or
81 \fI\-o\fR\&. When showing files in the index (i\&.e\&. when used with
82 \fI\-c\fR), print only those files matching an exclude pattern\&. When showing "other" files (i\&.e\&. when used with
83 \fI\-o\fR), show only those matched by an exclude pattern\&. Standard ignore rules are not automatically activated; therefore, at least one of the
84 \fB\-\-exclude*\fR
85 options is required\&.
86 .RE
87 .PP
88 \-s, \-\-stage
89 .RS 4
90 Show staged contents\*(Aq mode bits, object name and stage number in the output\&.
91 .RE
92 .PP
93 \-\-directory
94 .RS 4
95 If a whole directory is classified as "other", show just its name (with a trailing slash) and not its whole contents\&. Has no effect without \-o/\-\-others\&.
96 .RE
97 .PP
98 \-\-no\-empty\-directory
99 .RS 4
100 Do not list empty directories\&. Has no effect without \-\-directory\&.
101 .RE
102 .PP
103 \-u, \-\-unmerged
104 .RS 4
105 Show information about unmerged files in the output, but do not show any other tracked files (forces \-\-stage, overrides \-\-cached)\&.
106 .RE
107 .PP
108 \-k, \-\-killed
109 .RS 4
110 Show untracked files on the filesystem that need to be removed due to file/directory conflicts for tracked files to be able to be written to the filesystem\&.
111 .RE
112 .PP
113 \-\-resolve\-undo
114 .RS 4
115 Show files having resolve\-undo information in the index together with their resolve\-undo information\&. (resolve\-undo information is what is used to implement "git checkout \-m $PATH", i\&.e\&. to recreate merge conflicts that were accidentally resolved)
116 .RE
117 .PP
118 \-z
119 .RS 4
120 \e0 line termination on output and do not quote filenames\&. See OUTPUT below for more information\&.
121 .RE
122 .PP
123 \-\-deduplicate
124 .RS 4
125 When only filenames are shown, suppress duplicates that may come from having multiple stages during a merge, or giving
126 \fB\-\-deleted\fR
127 and
128 \fB\-\-modified\fR
129 option at the same time\&. When any of the
130 \fB\-t\fR,
131 \fB\-\-unmerged\fR, or
132 \fB\-\-stage\fR
133 option is in use, this option has no effect\&.
134 .RE
135 .PP
136 \-x <pattern>, \-\-exclude=<pattern>
137 .RS 4
138 Skip untracked files matching pattern\&. Note that pattern is a shell wildcard pattern\&. See EXCLUDE PATTERNS below for more information\&.
139 .RE
140 .PP
141 \-X <file>, \-\-exclude\-from=<file>
142 .RS 4
143 Read exclude patterns from <file>; 1 per line\&.
144 .RE
145 .PP
146 \-\-exclude\-per\-directory=<file>
147 .RS 4
148 Read additional exclude patterns that apply only to the directory and its subdirectories in <file>\&. If you are trying to emulate the way Porcelain commands work, using the
149 \fB\-\-exclude\-standard\fR
150 option instead is easier and more thorough\&.
151 .RE
152 .PP
153 \-\-exclude\-standard
154 .RS 4
155 Add the standard Git exclusions: \&.git/info/exclude, \&.gitignore in each directory, and the user\(cqs global exclusion file\&.
156 .RE
157 .PP
158 \-\-error\-unmatch
159 .RS 4
160 If any <file> does not appear in the index, treat this as an error (return 1)\&.
161 .RE
162 .PP
163 \-\-with\-tree=<tree\-ish>
164 .RS 4
165 When using \-\-error\-unmatch to expand the user supplied <file> (i\&.e\&. path pattern) arguments to paths, pretend that paths which were removed in the index since the named <tree\-ish> are still present\&. Using this option with
166 \fB\-s\fR
167 or
168 \fB\-u\fR
169 options does not make any sense\&.
170 .RE
171 .PP
172 \-t
173 .RS 4
174 Show status tags together with filenames\&. Note that for scripting purposes,
175 \fBgit-status\fR(1)
176 \fB\-\-porcelain\fR
177 and
178 \fBgit-diff-files\fR(1)
179 \fB\-\-name\-status\fR
180 are almost always superior alternatives; users should look at
181 \fBgit-status\fR(1)
182 \fB\-\-short\fR
183 or
184 \fBgit-diff\fR(1)
185 \fB\-\-name\-status\fR
186 for more user\-friendly alternatives\&.
187 .sp
188 This option provides a reason for showing each filename, in the form of a status tag (which is followed by a space and then the filename)\&. The status tags are all single characters from the following list:
189 .PP
190 H
191 .RS 4
192 tracked file that is not either unmerged or skip\-worktree
193 .RE
194 .PP
195 S
196 .RS 4
197 tracked file that is skip\-worktree
198 .RE
199 .PP
200 M
201 .RS 4
202 tracked file that is unmerged
203 .RE
204 .PP
205 R
206 .RS 4
207 tracked file with unstaged removal/deletion
208 .RE
209 .PP
210 C
211 .RS 4
212 tracked file with unstaged modification/change
213 .RE
214 .PP
215 K
216 .RS 4
217 untracked paths which are part of file/directory conflicts which prevent checking out tracked files
218 .RE
219 .PP
220 ?
221 .RS 4
222 untracked file
223 .RE
224 .PP
225 U
226 .RS 4
227 file with resolve\-undo information
228 .RE
229 .RE
230 .PP
231 \-v
232 .RS 4
233 Similar to
234 \fB\-t\fR, but use lowercase letters for files that are marked as
235 \fIassume unchanged\fR
236 (see
237 \fBgit-update-index\fR(1))\&.
238 .RE
239 .PP
240 \-f
241 .RS 4
242 Similar to
243 \fB\-t\fR, but use lowercase letters for files that are marked as
244 \fIfsmonitor valid\fR
245 (see
246 \fBgit-update-index\fR(1))\&.
247 .RE
248 .PP
249 \-\-full\-name
250 .RS 4
251 When run from a subdirectory, the command usually outputs paths relative to the current directory\&. This option forces paths to be output relative to the project top directory\&.
252 .RE
253 .PP
254 \-\-recurse\-submodules
255 .RS 4
256 Recursively calls ls\-files on each active submodule in the repository\&. Currently there is only support for the \-\-cached and \-\-stage modes\&.
257 .RE
258 .PP
259 \-\-abbrev[=<n>]
260 .RS 4
261 Instead of showing the full 40\-byte hexadecimal object lines, show the shortest prefix that is at least
262 \fI<n>\fR
263 hexdigits long that uniquely refers the object\&. Non default number of digits can be specified with \-\-abbrev=<n>\&.
264 .RE
265 .PP
266 \-\-debug
267 .RS 4
268 After each line that describes a file, add more data about its cache entry\&. This is intended to show as much information as possible for manual inspection; the exact format may change at any time\&.
269 .RE
270 .PP
271 \-\-eol
272 .RS 4
273 Show <eolinfo> and <eolattr> of files\&. <eolinfo> is the file content identification used by Git when the "text" attribute is "auto" (or not set and core\&.autocrlf is not false)\&. <eolinfo> is either "\-text", "none", "lf", "crlf", "mixed" or ""\&.
274 .sp
275 "" means the file is not a regular file, it is not in the index or not accessible in the working tree\&.
276 .sp
277 <eolattr> is the attribute that is used when checking out or committing, it is either "", "\-text", "text", "text=auto", "text eol=lf", "text eol=crlf"\&. Since Git 2\&.10 "text=auto eol=lf" and "text=auto eol=crlf" are supported\&.
278 .sp
279 Both the <eolinfo> in the index ("i/<eolinfo>") and in the working tree ("w/<eolinfo>") are shown for regular files, followed by the ("attr/<eolattr>")\&.
280 .RE
281 .PP
282 \-\-sparse
283 .RS 4
284 If the index is sparse, show the sparse directories without expanding to the contained files\&. Sparse directories will be shown with a trailing slash, such as "x/" for a sparse directory "x"\&.
285 .RE
286 .PP
287 \-\-format=<format>
288 .RS 4
289 A string that interpolates
290 \fB%(fieldname)\fR
291 from the result being shown\&. It also interpolates
292 \fB%%\fR
293 to
294 \fB%\fR, and
295 \fB%xXX\fR
296 where
297 \fBXX\fR
298 are hex digits interpolates to character with hex code
299 \fBXX\fR; for example
300 \fB%x00\fR
301 interpolates to
302 \fB\e0\fR
303 (NUL),
304 \fB%x09\fR
305 to
306 \fB\et\fR
307 (TAB) and %x0a to
308 \fB\en\fR
309 (LF)\&. \-\-format cannot be combined with
310 \fB\-s\fR,
311 \fB\-o\fR,
312 \fB\-k\fR,
313 \fB\-t\fR,
314 \fB\-\-resolve\-undo\fR
315 and
316 \fB\-\-eol\fR\&.
317 .RE
318 .PP
319 \-\-
320 .RS 4
321 Do not interpret any more arguments as options\&.
322 .RE
323 .PP
324 <file>
325 .RS 4
326 Files to show\&. If no files are given all files which match the other specified criteria are shown\&.
327 .RE
328 .SH "OUTPUT"
329 .sp
330 \fIgit ls\-files\fR just outputs the filenames unless \fB\-\-stage\fR is specified in which case it outputs:
331 .sp
332 .if n \{\
333 .RS 4
334 .\}
335 .nf
336 [<tag> ]<mode> <object> <stage> <file>
337 .fi
338 .if n \{\
339 .RE
340 .\}
341 .sp
342 \fIgit ls\-files \-\-eol\fR will show i/<eolinfo><SPACES>w/<eolinfo><SPACES>attr/<eolattr><SPACE*><TAB><file>
343 .sp
344 \fIgit ls\-files \-\-unmerged\fR and \fIgit ls\-files \-\-stage\fR can be used to examine detailed information on unmerged paths\&.
345 .sp
346 For an unmerged path, instead of recording a single mode/SHA\-1 pair, the index records up to three such pairs; one from tree O in stage 1, A in stage 2, and B in stage 3\&. This information can be used by the user (or the porcelain) to see what should eventually be recorded at the path\&. (see \fBgit-read-tree\fR(1) for more information on state)
347 .sp
348 Without the \fB\-z\fR option, pathnames with "unusual" characters are quoted as explained for the configuration variable \fBcore\&.quotePath\fR (see \fBgit-config\fR(1))\&. Using \fB\-z\fR the filename is output verbatim and the line is terminated by a NUL byte\&.
349 .sp
350 It is possible to print in a custom format by using the \fB\-\-format\fR option, which is able to interpolate different fields using a \fB%(fieldname)\fR notation\&. For example, if you only care about the "objectname" and "path" fields, you can execute with a specific "\-\-format" like
351 .sp
352 .if n \{\
353 .RS 4
354 .\}
355 .nf
356 git ls\-files \-\-format=\*(Aq%(objectname) %(path)\*(Aq
357 .fi
358 .if n \{\
359 .RE
360 .\}
361 .SH "FIELD NAMES"
362 .sp
363 The way each path is shown can be customized by using the \fB\-\-format=<format>\fR option, where the %(fieldname) in the <format> string for various aspects of the index entry are interpolated\&. The following "fieldname" are understood:
364 .PP
365 objectmode
366 .RS 4
367 The mode of the file which is recorded in the index\&.
368 .RE
369 .PP
370 objecttype
371 .RS 4
372 The object type of the file which is recorded in the index\&.
373 .RE
374 .PP
375 objectname
376 .RS 4
377 The name of the file which is recorded in the index\&.
378 .RE
379 .PP
380 objectsize[:padded]
381 .RS 4
382 The object size of the file which is recorded in the index ("\-" if the object is a
383 \fBcommit\fR
384 or
385 \fBtree\fR)\&. It also supports a padded format of size with "%(objectsize:padded)"\&.
386 .RE
387 .PP
388 stage
389 .RS 4
390 The stage of the file which is recorded in the index\&.
391 .RE
392 .PP
393 eolinfo:index, eolinfo:worktree
394 .RS 4
395 The <eolinfo> (see the description of the
396 \fB\-\-eol\fR
397 option) of the contents in the index or in the worktree for the path\&.
398 .RE
399 .PP
400 eolattr
401 .RS 4
402 The <eolattr> (see the description of the
403 \fB\-\-eol\fR
404 option) that applies to the path\&.
405 .RE
406 .PP
407 path
408 .RS 4
409 The pathname of the file which is recorded in the index\&.
410 .RE
411 .SH "EXCLUDE PATTERNS"
412 .sp
413 \fIgit ls\-files\fR can use a list of "exclude patterns" when traversing the directory tree and finding files to show when the flags \-\-others or \-\-ignored are specified\&. \fBgitignore\fR(5) specifies the format of exclude patterns\&.
414 .sp
415 These exclude patterns can be specified from the following places, in order:
416 .sp
417 .RS 4
418 .ie n \{\
419 \h'-04' 1.\h'+01'\c
420 .\}
421 .el \{\
422 .sp -1
423 .IP " 1." 4.2
424 .\}
425 The command\-line flag \-\-exclude=<pattern> specifies a single pattern\&. Patterns are ordered in the same order they appear in the command line\&.
426 .RE
427 .sp
428 .RS 4
429 .ie n \{\
430 \h'-04' 2.\h'+01'\c
431 .\}
432 .el \{\
433 .sp -1
434 .IP " 2." 4.2
435 .\}
436 The command\-line flag \-\-exclude\-from=<file> specifies a file containing a list of patterns\&. Patterns are ordered in the same order they appear in the file\&.
437 .RE
438 .sp
439 .RS 4
440 .ie n \{\
441 \h'-04' 3.\h'+01'\c
442 .\}
443 .el \{\
444 .sp -1
445 .IP " 3." 4.2
446 .\}
447 The command\-line flag \-\-exclude\-per\-directory=<name> specifies a name of the file in each directory
448 \fIgit ls\-files\fR
449 examines, normally
450 \fB\&.gitignore\fR\&. Files in deeper directories take precedence\&. Patterns are ordered in the same order they appear in the files\&.
451 .RE
452 .sp
453 A pattern specified on the command line with \-\-exclude or read from the file specified with \-\-exclude\-from is relative to the top of the directory tree\&. A pattern read from a file specified by \-\-exclude\-per\-directory is relative to the directory that the pattern file appears in\&.
454 .sp
455 Generally, you should be able to use \fB\-\-exclude\-standard\fR when you want the exclude rules applied the same way as what Porcelain commands do\&. To emulate what \fB\-\-exclude\-standard\fR specifies, you can give \fB\-\-exclude\-per\-directory=\&.gitignore\fR, and then specify:
456 .sp
457 .RS 4
458 .ie n \{\
459 \h'-04' 1.\h'+01'\c
460 .\}
461 .el \{\
462 .sp -1
463 .IP " 1." 4.2
464 .\}
465 The file specified by the
466 \fBcore\&.excludesfile\fR
467 configuration variable, if exists, or the
468 \fB$XDG_CONFIG_HOME/git/ignore\fR
469 file\&.
470 .RE
471 .sp
472 .RS 4
473 .ie n \{\
474 \h'-04' 2.\h'+01'\c
475 .\}
476 .el \{\
477 .sp -1
478 .IP " 2." 4.2
479 .\}
480 The
481 \fB$GIT_DIR/info/exclude\fR
482 file\&.
483 .RE
484 .sp
485 via the \fB\-\-exclude\-from=\fR option\&.
486 .SH "SEE ALSO"
487 .sp
488 \fBgit-read-tree\fR(1), \fBgitignore\fR(5)
489 .SH "GIT"
490 .sp
491 Part of the \fBgit\fR(1) suite