/
git-ls-files.html
711 lines (674 loc) · 14.2 KB
/
git-ls-files.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.2.5" />
<style type="text/css">
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
/*
border: 1px solid red;
*/
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
}
strong {
font-weight: bold;
}
tt {
color: navy;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
font-family: sans-serif;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
div.sectionbody {
font-family: serif;
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
pre {
padding: 0;
margin: 0;
}
span#author {
color: #527bbd;
font-family: sans-serif;
font-weight: bold;
font-size: 1.1em;
}
span#email {
}
span#revision {
font-family: sans-serif;
}
div#footer {
font-family: sans-serif;
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
div#footer-text {
float: left;
padding-bottom: 0.5em;
}
div#footer-badges {
float: right;
padding-bottom: 0.5em;
}
div#preamble,
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-right: 10%;
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.5em;
margin-bottom: 2.5em;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
font-family: sans-serif;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.listingblock {
margin-right: 0%;
}
div.listingblock > div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock > div.content {
padding-left: 2.0em;
}
div.attribution {
text-align: right;
}
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 2px solid silver;
}
div.exampleblock > div.content {
border-left: 2px solid silver;
padding: 0.5em;
}
div.verseblock div.content {
white-space: pre;
}
div.imageblock div.content { padding-left: 0; }
div.imageblock img { border: 1px solid silver; }
span.image img { border-style: none; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: italic;
}
dd > *:first-child {
margin-top: 0;
}
ul, ol {
list-style-position: outside;
}
div.olist2 ol {
list-style-type: lower-alpha;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead {
font-family: sans-serif;
font-weight: bold;
}
tfoot {
font-weight: bold;
}
div.hlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hlist td {
padding-bottom: 5px;
}
td.hlist1 {
vertical-align: top;
font-style: italic;
padding-right: 0.8em;
}
td.hlist2 {
vertical-align: top;
}
@media print {
div#footer-badges { display: none; }
}
div#toctitle {
color: #527bbd;
font-family: sans-serif;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
include1::./stylesheets/xhtml11-manpage.css[]
/* Workarounds for IE6's broken and incomplete CSS2. */
div.sidebar-content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.sidebar-title, div.image-title {
font-family: sans-serif;
font-weight: bold;
margin-top: 0.0em;
margin-bottom: 0.5em;
}
div.listingblock div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock-content {
padding-left: 2.0em;
}
div.exampleblock-content {
border-left: 2px solid silver;
padding-left: 0.5em;
}
/* IE6 sets dynamically generated links as visited. */
div#toc a:visited { color: blue; }
</style>
<title>git-ls-files(1)</title>
</head>
<body>
<div id="header">
<h1>
git-ls-files(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>git-ls-files -
Show information about files in the index and the working tree
</p>
</div>
</div>
<h2>SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
<div class="content"><em>git ls-files</em> [-z] [-t] [-v]
(--[cached|deleted|others|ignored|stage|unmerged|killed|modified])*
(-[c|d|o|i|s|u|k|m])*
[-x <pattern>|--exclude=<pattern>]
[-X <file>|--exclude-from=<file>]
[--exclude-per-directory=<file>]
[--exclude-standard]
[--error-unmatch] [--with-tree=<tree-ish>]
[--full-name] [--abbrev] [--] [<file>]*</div></div>
</div>
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="para"><p>This merges the file listing in the directory cache index with the
actual working directory list, and shows different combinations of the
two.</p></div>
<div class="para"><p>One or more of the options below may be used to determine the files
shown:</p></div>
</div>
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
<div class="vlist"><dl>
<dt>
-c
</dt>
<dt>
--cached
</dt>
<dd>
<p>
Show cached files in the output (default)
</p>
</dd>
<dt>
-d
</dt>
<dt>
--deleted
</dt>
<dd>
<p>
Show deleted files in the output
</p>
</dd>
<dt>
-m
</dt>
<dt>
--modified
</dt>
<dd>
<p>
Show modified files in the output
</p>
</dd>
<dt>
-o
</dt>
<dt>
--others
</dt>
<dd>
<p>
Show other files in the output
</p>
</dd>
<dt>
-i
</dt>
<dt>
--ignored
</dt>
<dd>
<p>
Show ignored files in the output.
Note that this also reverses any exclude list present.
</p>
</dd>
<dt>
-s
</dt>
<dt>
--stage
</dt>
<dd>
<p>
Show staged contents' object name, mode bits and stage number in the output.
</p>
</dd>
<dt>
--directory
</dt>
<dd>
<p>
If a whole directory is classified as "other", show just its
name (with a trailing slash) and not its whole contents.
</p>
</dd>
<dt>
--no-empty-directory
</dt>
<dd>
<p>
Do not list empty directories. Has no effect without --directory.
</p>
</dd>
<dt>
-u
</dt>
<dt>
--unmerged
</dt>
<dd>
<p>
Show unmerged files in the output (forces --stage)
</p>
</dd>
<dt>
-k
</dt>
<dt>
--killed
</dt>
<dd>
<p>
Show files on the filesystem that need to be removed due
to file/directory conflicts for checkout-index to
succeed.
</p>
</dd>
<dt>
-z
</dt>
<dd>
<p>
\0 line termination on output.
</p>
</dd>
<dt>
-x <pattern>
</dt>
<dt>
--exclude=<pattern>
</dt>
<dd>
<p>
Skips files matching pattern.
Note that pattern is a shell wildcard pattern.
</p>
</dd>
<dt>
-X <file>
</dt>
<dt>
--exclude-from=<file>
</dt>
<dd>
<p>
exclude patterns are read from <file>; 1 per line.
</p>
</dd>
<dt>
--exclude-per-directory=<file>
</dt>
<dd>
<p>
read additional exclude patterns that apply only to the
directory and its subdirectories in <file>.
</p>
</dd>
<dt>
--exclude-standard
</dt>
<dd>
<p>
Add the standard git exclusions: .git/info/exclude, .gitignore
in each directory, and the user's global exclusion file.
</p>
</dd>
<dt>
--error-unmatch
</dt>
<dd>
<p>
If any <file> does not appear in the index, treat this as an
error (return 1).
</p>
</dd>
<dt>
--with-tree=<tree-ish>
</dt>
<dd>
<p>
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 <tt>-s</tt> or <tt>-u</tt> options does not make any sense.
</p>
</dd>
<dt>
-t
</dt>
<dd>
<p>
Identify the file status with the following tags (followed by
a space) at the start of each line:
</p>
<div class="hlist"><table>
<tr>
<td class="hlist1">
H
</td>
<td class="hlist2">
cached
</td>
</tr>
<tr>
<td class="hlist1">
M
</td>
<td class="hlist2">
unmerged
</td>
</tr>
<tr>
<td class="hlist1">
R
</td>
<td class="hlist2">
removed/deleted
</td>
</tr>
<tr>
<td class="hlist1">
C
</td>
<td class="hlist2">
modified/changed
</td>
</tr>
<tr>
<td class="hlist1">
K
</td>
<td class="hlist2">
to be killed
</td>
</tr>
<tr>
<td class="hlist1">
?
</td>
<td class="hlist2">
other
</td>
</tr>
</table></div>
</dd>
<dt>
-v
</dt>
<dd>
<p>
Similar to <tt>-t</tt>, but use lowercase letters for files
that are marked as <em>assume unchanged</em> (see
<a href="git-update-index.html">git-update-index(1)</a>).
</p>
</dd>
<dt>
--full-name
</dt>
<dd>
<p>
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.
</p>
</dd>
<dt>
--abbrev[=<n>]
</dt>
<dd>
<p>
Instead of showing the full 40-byte hexadecimal object
lines, show only a partial prefix.
Non default number of digits can be specified with --abbrev=<n>.
</p>
</dd>
<dt>
--
</dt>
<dd>
<p>
Do not interpret any more arguments as options.
</p>
</dd>
<dt>
<file>
</dt>
<dd>
<p>
Files to show. If no files are given all files which match the other
specified criteria are shown.
</p>
</dd>
</dl></div>
</div>
<h2 id="_output">Output</h2>
<div class="sectionbody">
<div class="para"><p>show files just outputs the filename unless <em>--stage</em> is specified in
which case it outputs:</p></div>
<div class="literalblock">
<div class="content">
<pre><tt>[<tag> ]<mode> <object> <stage> <file></tt></pre>
</div></div>
<div class="para"><p><em>git-ls-files --unmerged</em> and <em>git-ls-files --stage</em> can be used to examine
detailed information on unmerged paths.</p></div>
<div class="para"><p>For an unmerged path, instead of recording a single mode/SHA1 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 <a href="git-read-tree.html">git-read-tree(1)</a> for more information on state)</p></div>
<div class="para"><p>When <tt>-z</tt> option is not used, TAB, LF, and backslash characters
in pathnames are represented as <tt>\t</tt>, <tt>\n</tt>, and <tt>\\</tt>,
respectively.</p></div>
</div>
<h2 id="_exclude_patterns">Exclude Patterns</h2>
<div class="sectionbody">
<div class="para"><p><em>git-ls-files</em> 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. <a href="gitignore.html">gitignore(5)</a>
specifies the format of exclude patterns.</p></div>
<div class="para"><p>These exclude patterns come from these places, in order:</p></div>
<div class="olist"><ol>
<li>
<p>
The command line flag --exclude=<pattern> specifies a
single pattern. Patterns are ordered in the same order
they appear in the command line.
</p>
</li>
<li>
<p>
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.
</p>
</li>
<li>
<p>
command line flag --exclude-per-directory=<name> specifies
a name of the file in each directory <em>git-ls-files</em>
examines, normally <tt>.gitignore</tt>. Files in deeper
directories take precedence. Patterns are ordered in the
same order they appear in the files.
</p>
</li>
</ol></div>
<div class="para"><p>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.</p></div>
</div>
<h2 id="_see_also">SEE ALSO</h2>
<div class="sectionbody">
<div class="para"><p><a href="git-read-tree.html">git-read-tree(1)</a>, <a href="gitignore.html">gitignore(5)</a></p></div>
</div>
<h2 id="_author">Author</h2>
<div class="sectionbody">
<div class="para"><p>Written by Linus Torvalds <torvalds@osdl.org></p></div>
</div>
<h2 id="_documentation">Documentation</h2>
<div class="sectionbody">
<div class="para"><p>Documentation by David Greaves, Junio C Hamano, Josh Triplett, and the git-list <git@vger.kernel.org>.</p></div>
</div>
<h2 id="_git">GIT</h2>
<div class="sectionbody">
<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2009-02-14 08:18:22 UTC
</div>
</div>
</body>
</html>