Google Git
Sign in
chromium / external / gitster / git-htmldocs / b358e217ee50e22d66a3a5ababe7e84c41d553c4 / . / git-ls-files.html
blob: a88d93da183915c44b5fd2894c205ff5d758057c [file] [log] [blame]
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]1<!DOCTYPE html>
2<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
3<head>
4<meta charset="UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=edge"/>
6<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
Junio C Hamanod6a33e42025-02-18 23:45:11[diff] [blame]7<meta name="generator" content="Asciidoctor 2.0.23"/>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]8<title>git-ls-files(1)</title>
9<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"/>
10<style>
11/*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
12/* Uncomment the following line when using as a custom stylesheet */
13/* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
14html{font-family:sans-serif;-webkit-text-size-adjust:100%}
15a{background:none}
16a:focus{outline:thin dotted}
17a:active,a:hover{outline:0}
18h1{font-size:2em;margin:.67em 0}
19b,strong{font-weight:bold}
20abbr{font-size:.9em}
21abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
22dfn{font-style:italic}
23hr{height:0}
24mark{background:#ff0;color:#000}
25code,kbd,pre,samp{font-family:monospace;font-size:1em}
26pre{white-space:pre-wrap}
27q{quotes:"\201C" "\201D" "\2018" "\2019"}
28small{font-size:80%}
29sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
30sup{top:-.5em}
31sub{bottom:-.25em}
32img{border:0}
33svg:not(:root){overflow:hidden}
34figure{margin:0}
35audio,video{display:inline-block}
36audio:not([controls]){display:none;height:0}
37fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
38legend{border:0;padding:0}
39button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
40button,input{line-height:normal}
41button,select{text-transform:none}
42button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
43button[disabled],html input[disabled]{cursor:default}
44input[type=checkbox],input[type=radio]{padding:0}
45button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
46textarea{overflow:auto;vertical-align:top}
47table{border-collapse:collapse;border-spacing:0}
48*,::before,::after{box-sizing:border-box}
49html,body{font-size:100%}
50body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
51a:hover{cursor:pointer}
52img,object,embed{max-width:100%;height:auto}
53object,embed{height:100%}
54img{-ms-interpolation-mode:bicubic}
55.left{float:left!important}
56.right{float:right!important}
57.text-left{text-align:left!important}
58.text-right{text-align:right!important}
59.text-center{text-align:center!important}
60.text-justify{text-align:justify!important}
61.hide{display:none}
62img,object,svg{display:inline-block;vertical-align:middle}
63textarea{height:auto;min-height:50px}
64select{width:100%}
65.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
66div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
67a{color:#2156a5;text-decoration:underline;line-height:inherit}
68a:hover,a:focus{color:#1d4b8f}
69a img{border:0}
70p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
71p aside{font-size:.875em;line-height:1.35;font-style:italic}
72h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
73h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
74h1{font-size:2.125em}
75h2{font-size:1.6875em}
76h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
77h4,h5{font-size:1.125em}
78h6{font-size:1em}
79hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
80em,i{font-style:italic;line-height:inherit}
81strong,b{font-weight:bold;line-height:inherit}
82small{font-size:60%;line-height:inherit}
83code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
84ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
85ul,ol{margin-left:1.5em}
86ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
87ul.circle{list-style-type:circle}
88ul.disc{list-style-type:disc}
89ul.square{list-style-type:square}
90ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
91ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
92dl dt{margin-bottom:.3125em;font-weight:bold}
93dl dd{margin-bottom:1.25em}
94blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
95blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
96@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
97h1{font-size:2.75em}
98h2{font-size:2.3125em}
99h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
100h4{font-size:1.4375em}}
101table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
102table thead,table tfoot{background:#f7f8f7}
103table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
104table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
105table tr.even,table tr.alt{background:#f8f8f7}
106table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
107h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
108h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
109.center{margin-left:auto;margin-right:auto}
110.stretch{width:100%}
111.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
112.clearfix::after,.float-group::after{clear:both}
113:not(pre).nobreak{word-wrap:normal}
114:not(pre).nowrap{white-space:nowrap}
115:not(pre).pre-wrap{white-space:pre-wrap}
116:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
117pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
118pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
119pre>code{display:block}
120pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
121em em{font-style:normal}
122strong strong{font-weight:400}
123.keyseq{color:rgba(51,51,51,.8)}
124kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
125.keyseq kbd:first-child{margin-left:0}
126.keyseq kbd:last-child{margin-right:0}
127.menuseq,.menuref{color:#000}
128.menuseq b:not(.caret),.menuref{font-weight:inherit}
129.menuseq{word-spacing:-.02em}
130.menuseq b.caret{font-size:1.25em;line-height:.8}
131.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
132b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
133b.button::before{content:"[";padding:0 3px 0 2px}
134b.button::after{content:"]";padding:0 2px 0 3px}
135p a>code:hover{color:rgba(0,0,0,.9)}
136#header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
137#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
138#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
139#content{margin-top:1.25em}
140#content::before{content:none}
141#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
142#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
Junio C Hamanod6a33e42025-02-18 23:45:11[diff] [blame]143#header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px}
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]144#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
145#header .details span:first-child{margin-left:-.125em}
146#header .details span.email a{color:rgba(0,0,0,.85)}
147#header .details br{display:none}
148#header .details br+span::before{content:"\00a0\2013\00a0"}
149#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
150#header .details br+span#revremark::before{content:"\00a0|\00a0"}
151#header #revnumber{text-transform:capitalize}
152#header #revnumber::after{content:"\00a0"}
153#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
154#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
155#toc>ul{margin-left:.125em}
156#toc ul.sectlevel0>li>a{font-style:italic}
157#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
158#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
159#toc li{line-height:1.3334;margin-top:.3334em}
160#toc a{text-decoration:none}
161#toc a:active{text-decoration:underline}
162#toctitle{color:#7a2518;font-size:1.2em}
163@media screen and (min-width:768px){#toctitle{font-size:1.375em}
164body.toc2{padding-left:15em;padding-right:0}
Junio C Hamanod6a33e42025-02-18 23:45:11[diff] [blame]165body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]166#toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
167#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
168#toc.toc2>ul{font-size:.9em;margin-bottom:0}
169#toc.toc2 ul ul{margin-left:0;padding-left:1em}
170#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
171body.toc2.toc-right{padding-left:0;padding-right:15em}
172body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
173@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
174#toc.toc2{width:20em}
175#toc.toc2 #toctitle{font-size:1.375em}
176#toc.toc2>ul{font-size:.95em}
177#toc.toc2 ul ul{padding-left:1.25em}
178body.toc2.toc-right{padding-left:0;padding-right:20em}}
179#content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
180#content #toc>:first-child{margin-top:0}
181#content #toc>:last-child{margin-bottom:0}
182#footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
183#footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
184#content{margin-bottom:.625em}
185.sect1{padding-bottom:.625em}
186@media screen and (min-width:768px){#content{margin-bottom:1.25em}
187.sect1{padding-bottom:1.25em}}
188.sect1:last-child{padding-bottom:0}
189.sect1+.sect1{border-top:1px solid #e7e7e9}
190#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
191#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
192#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
193#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
194#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
195details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
196details{margin-left:1.25rem}
197details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
198details>summary::-webkit-details-marker{display:none}
199details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
200details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
201details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
202.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
203table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
204.paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
205.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
206.admonitionblock>table td.icon{text-align:center;width:80px}
207.admonitionblock>table td.icon img{max-width:none}
208.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
209.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
210.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
211.exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
212.sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
213.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
214.exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
215.exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
216.literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
217@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
218@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
219.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
220.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
221.listingblock>.content{position:relative}
222.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
223.listingblock:hover code[data-lang]::before{display:block}
224.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
225.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
226.listingblock pre.highlightjs{padding:0}
227.listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
228.listingblock pre.prettyprint{border-width:0}
229.prettyprint{background:#f7f7f8}
230pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
231pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
232pre.prettyprint li code[data-lang]::before{opacity:1}
233pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
234table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
235table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
236table.linenotable td.code{padding-left:.75em}
237table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
238pre.pygments span.linenos{display:inline-block;margin-right:.75em}
239.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
240.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
241.quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
242.quoteblock blockquote{margin:0;padding:0;border:0}
243.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
244.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
245.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
246.verseblock{margin:0 1em 1.25em}
247.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
248.verseblock pre strong{font-weight:400}
249.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
250.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
251.quoteblock .attribution br,.verseblock .attribution br{display:none}
252.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
253.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
254.quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
255.quoteblock.abstract{margin:0 1em 1.25em;display:block}
256.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
257.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
258.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
259.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
260.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
261p.tableblock:last-child{margin-bottom:0}
262td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
263td.tableblock>.content>:last-child{margin-bottom:-1.25em}
264table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
265table.grid-all>*>tr>*{border-width:1px}
266table.grid-cols>*>tr>*{border-width:0 1px}
267table.grid-rows>*>tr>*{border-width:1px 0}
268table.frame-all{border-width:1px}
269table.frame-ends{border-width:1px 0}
270table.frame-sides{border-width:0 1px}
271table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
272table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
273table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
274table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
275table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
276th.halign-left,td.halign-left{text-align:left}
277th.halign-right,td.halign-right{text-align:right}
278th.halign-center,td.halign-center{text-align:center}
279th.valign-top,td.valign-top{vertical-align:top}
280th.valign-bottom,td.valign-bottom{vertical-align:bottom}
281th.valign-middle,td.valign-middle{vertical-align:middle}
282table thead th,table tfoot th{font-weight:bold}
283tbody tr th{background:#f7f8f7}
284tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
285p.tableblock>code:only-child{background:none;padding:0}
286p.tableblock{font-size:1em}
287ol{margin-left:1.75em}
288ul li ol{margin-left:1.5em}
289dl dd{margin-left:1.125em}
290dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
291li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
292ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
293ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
294ul.unstyled,ol.unstyled{margin-left:0}
295li>p:empty:only-child::before{content:"";display:inline-block}
296ul.checklist>li>p:first-child{margin-left:-1em}
297ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
298ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
299ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
300ul.inline>li{margin-left:1.25em}
301.unstyled dl dt{font-weight:400;font-style:normal}
302ol.arabic{list-style-type:decimal}
303ol.decimal{list-style-type:decimal-leading-zero}
304ol.loweralpha{list-style-type:lower-alpha}
305ol.upperalpha{list-style-type:upper-alpha}
306ol.lowerroman{list-style-type:lower-roman}
307ol.upperroman{list-style-type:upper-roman}
308ol.lowergreek{list-style-type:lower-greek}
309.hdlist>table,.colist>table{border:0;background:none}
310.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
311td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
312td.hdlist1{font-weight:bold;padding-bottom:1.25em}
313td.hdlist2{word-wrap:anywhere}
314.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
315.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
316.colist td:not([class]):first-child img{max-width:none}
317.colist td:not([class]):last-child{padding:.25em 0}
318.thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
319.imageblock.left{margin:.25em .625em 1.25em 0}
320.imageblock.right{margin:.25em 0 1.25em .625em}
321.imageblock>.title{margin-bottom:0}
322.imageblock.thumb,.imageblock.th{border-width:6px}
323.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
324.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
325.image.left{margin-right:.625em}
326.image.right{margin-left:.625em}
327a.image{text-decoration:none;display:inline-block}
328a.image object{pointer-events:none}
329sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
330sup.footnote a,sup.footnoteref a{text-decoration:none}
Junio C Hamanod6a33e42025-02-18 23:45:11[diff] [blame]331sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline}
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]332#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
333#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
334#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
335#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
336#footnotes .footnote:last-of-type{margin-bottom:0}
337#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
338div.unbreakable{page-break-inside:avoid}
339.big{font-size:larger}
340.small{font-size:smaller}
341.underline{text-decoration:underline}
342.overline{text-decoration:overline}
343.line-through{text-decoration:line-through}
344.aqua{color:#00bfbf}
345.aqua-background{background:#00fafa}
346.black{color:#000}
347.black-background{background:#000}
348.blue{color:#0000bf}
349.blue-background{background:#0000fa}
350.fuchsia{color:#bf00bf}
351.fuchsia-background{background:#fa00fa}
352.gray{color:#606060}
353.gray-background{background:#7d7d7d}
354.green{color:#006000}
355.green-background{background:#007d00}
356.lime{color:#00bf00}
357.lime-background{background:#00fa00}
358.maroon{color:#600000}
359.maroon-background{background:#7d0000}
360.navy{color:#000060}
361.navy-background{background:#00007d}
362.olive{color:#606000}
363.olive-background{background:#7d7d00}
364.purple{color:#600060}
365.purple-background{background:#7d007d}
366.red{color:#bf0000}
367.red-background{background:#fa0000}
368.silver{color:#909090}
369.silver-background{background:#bcbcbc}
370.teal{color:#006060}
371.teal-background{background:#007d7d}
372.white{color:#bfbfbf}
373.white-background{background:#fafafa}
374.yellow{color:#bfbf00}
375.yellow-background{background:#fafa00}
376span.icon>.fa{cursor:default}
377a span.icon>.fa{cursor:inherit}
378.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
379.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
380.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
381.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
382.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
383.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
384.conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
385.conum[data-value] *{color:#fff!important}
386.conum[data-value]+b{display:none}
387.conum[data-value]::after{content:attr(data-value)}
388pre .conum[data-value]{position:relative;top:-.125em}
389b.conum *{color:inherit!important}
390.conum:not([data-value]):empty{display:none}
391dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
392h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
393p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
394p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
395p{margin-bottom:1.25rem}
396.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
397.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
398.print-only{display:none!important}
399@page{margin:1.25cm .75cm}
400@media print{*{box-shadow:none!important;text-shadow:none!important}
401html{font-size:80%}
402a{color:inherit!important;text-decoration:underline!important}
403a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
404a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
405abbr[title]{border-bottom:1px dotted}
406abbr[title]::after{content:" (" attr(title) ")"}
407pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
408thead{display:table-header-group}
409svg{max-width:100%}
410p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
411h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
412#header,#content,#footnotes,#footer{max-width:none}
413#toc,.sidebarblock,.exampleblock>.content{background:none!important}
414#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
415body.book #header{text-align:center}
416body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
417body.book #header .details{border:0!important;display:block;padding:0!important}
418body.book #header .details span:first-child{margin-left:0!important}
419body.book #header .details br{display:block}
420body.book #header .details br+span::before{content:none!important}
421body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
422body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
423.listingblock code[data-lang]::before{display:block}
424#footer{padding:0 .9375em}
425.hide-on-print{display:none!important}
426.print-only{display:block!important}
427.hide-for-print{display:none!important}
428.show-for-print{display:inherit!important}}
429@media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
430.sect1{padding:0!important}
431.sect1+.sect1{border:0}
432#footer{background:none}
433#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
434@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
435</style>
436<style>
437pre>code {
438 display: inline;
439}
440</style>
441</head>
442<body class="manpage">
443<div id="header">
444<h1>git-ls-files(1) Manual Page</h1>
445<h2 id="_name">NAME</h2>
446<div class="sectionbody">
447<p>git-ls-files - Show information about files in the index and the working tree</p>
448</div>
449</div>
450<div id="content">
451<div class="sect1">
452<h2 id="_synopsis">SYNOPSIS</h2>
453<div class="sectionbody">
454<div class="verseblock">
455<pre class="content"><em>git ls-files</em> [-z] [-t] [-v] [-f]
456 [-c|--cached] [-d|--deleted] [-o|--others] [-i|--ignored]
457 [-s|--stage] [-u|--unmerged] [-k|--killed] [-m|--modified]
458 [--resolve-undo]
459 [--directory [--no-empty-directory]] [--eol]
460 [--deduplicate]
461 [-x &lt;pattern&gt;|--exclude=&lt;pattern&gt;]
462 [-X &lt;file&gt;|--exclude-from=&lt;file&gt;]
463 [--exclude-per-directory=&lt;file&gt;]
464 [--exclude-standard]
465 [--error-unmatch] [--with-tree=&lt;tree-ish&gt;]
466 [--full-name] [--recurse-submodules]
467 [--abbrev[=&lt;n&gt;]] [--format=&lt;format&gt;] [--] [&lt;file&gt;&#8230;&#8203;]</pre>
468</div>
469</div>
470</div>
471<div class="sect1">
472<h2 id="_description">DESCRIPTION</h2>
473<div class="sectionbody">
474<div class="paragraph">
475<p>This command merges the file listing in the index with the actual working
476directory list, and shows different combinations of the two.</p>
477</div>
478<div class="paragraph">
479<p>Several flags can be used to determine which files are
480shown, and each file may be printed multiple times if there are
481multiple entries in the index or if multiple statuses are applicable for
482the relevant file selection options.</p>
483</div>
484</div>
485</div>
486<div class="sect1">
487<h2 id="_options">OPTIONS</h2>
488<div class="sectionbody">
489<div class="dlist">
490<dl>
491<dt class="hdlist1">-c</dt>
492<dt class="hdlist1">--cached</dt>
493<dd>
494<p>Show all files cached in Git&#8217;s index, i.e. all tracked files.
495(This is the default if no -c/-s/-d/-o/-u/-k/-m/--resolve-undo
496options are specified.)</p>
497</dd>
498<dt class="hdlist1">-d</dt>
499<dt class="hdlist1">--deleted</dt>
500<dd>
501<p>Show files with an unstaged deletion</p>
502</dd>
503<dt class="hdlist1">-m</dt>
504<dt class="hdlist1">--modified</dt>
505<dd>
506<p>Show files with an unstaged modification (note that an unstaged
507deletion also counts as an unstaged modification)</p>
508</dd>
509<dt class="hdlist1">-o</dt>
510<dt class="hdlist1">--others</dt>
511<dd>
512<p>Show other (i.e. untracked) files in the output</p>
513</dd>
514<dt class="hdlist1">-i</dt>
515<dt class="hdlist1">--ignored</dt>
516<dd>
517<p>Show only ignored files in the output. Must be used with
518either an explicit <em>-c</em> or <em>-o</em>. When showing files in the
519index (i.e. when used with <em>-c</em>), print only those files
520matching an exclude pattern. When showing "other" files
521(i.e. when used with <em>-o</em>), show only those matched by an
522exclude pattern. Standard ignore rules are not automatically
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]523activated; therefore, at least one of the <code>--exclude</code>* options
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]524is required.</p>
525</dd>
526<dt class="hdlist1">-s</dt>
527<dt class="hdlist1">--stage</dt>
528<dd>
529<p>Show staged contents' mode bits, object name and stage number in the output.</p>
530</dd>
531<dt class="hdlist1">--directory</dt>
532<dd>
533<p>If a whole directory is classified as "other", show just its
534name (with a trailing slash) and not its whole contents.
535Has no effect without -o/--others.</p>
536</dd>
537<dt class="hdlist1">--no-empty-directory</dt>
538<dd>
539<p>Do not list empty directories. Has no effect without --directory.</p>
540</dd>
541<dt class="hdlist1">-u</dt>
542<dt class="hdlist1">--unmerged</dt>
543<dd>
544<p>Show information about unmerged files in the output, but do
545not show any other tracked files (forces --stage, overrides
546--cached).</p>
547</dd>
548<dt class="hdlist1">-k</dt>
549<dt class="hdlist1">--killed</dt>
550<dd>
551<p>Show untracked files on the filesystem that need to be removed
552due to file/directory conflicts for tracked files to be able to
553be written to the filesystem.</p>
554</dd>
555<dt class="hdlist1">--resolve-undo</dt>
556<dd>
557<p>Show files having resolve-undo information in the index
558together with their resolve-undo information. (resolve-undo
559information is what is used to implement "git checkout -m
560$PATH", i.e. to recreate merge conflicts that were
561accidentally resolved)</p>
562</dd>
563<dt class="hdlist1">-z</dt>
564<dd>
565<p>\0 line termination on output and do not quote filenames.
566See OUTPUT below for more information.</p>
567</dd>
568<dt class="hdlist1">--deduplicate</dt>
569<dd>
570<p>When only filenames are shown, suppress duplicates that may
571come from having multiple stages during a merge, or giving
572<code>--deleted</code> and <code>--modified</code> option at the same time.
573When any of the <code>-t</code>, <code>--unmerged</code>, or <code>--stage</code> option is
574in use, this option has no effect.</p>
575</dd>
576<dt class="hdlist1">-x &lt;pattern&gt;</dt>
577<dt class="hdlist1">--exclude=&lt;pattern&gt;</dt>
578<dd>
579<p>Skip untracked files matching pattern.
580Note that pattern is a shell wildcard pattern. See EXCLUDE PATTERNS
581below for more information.</p>
582</dd>
583<dt class="hdlist1">-X &lt;file&gt;</dt>
584<dt class="hdlist1">--exclude-from=&lt;file&gt;</dt>
585<dd>
586<p>Read exclude patterns from &lt;file&gt;; 1 per line.</p>
587</dd>
588<dt class="hdlist1">--exclude-per-directory=&lt;file&gt;</dt>
589<dd>
590<p>Read additional exclude patterns that apply only to the
591directory and its subdirectories in &lt;file&gt;. If you are
592trying to emulate the way Porcelain commands work, using
593the <code>--exclude-standard</code> option instead is easier and more
594thorough.</p>
595</dd>
596<dt class="hdlist1">--exclude-standard</dt>
597<dd>
598<p>Add the standard Git exclusions: .git/info/exclude, .gitignore
599in each directory, and the user&#8217;s global exclusion file.</p>
600</dd>
601<dt class="hdlist1">--error-unmatch</dt>
602<dd>
603<p>If any &lt;file&gt; does not appear in the index, treat this as an
604error (return 1).</p>
605</dd>
606<dt class="hdlist1">--with-tree=&lt;tree-ish&gt;</dt>
607<dd>
608<p>When using --error-unmatch to expand the user supplied
609&lt;file&gt; (i.e. path pattern) arguments to paths, pretend
610that paths which were removed in the index since the
611named &lt;tree-ish&gt; are still present. Using this option
612with <code>-s</code> or <code>-u</code> options does not make any sense.</p>
613</dd>
614<dt class="hdlist1">-t</dt>
615<dd>
616<p>Show status tags together with filenames. Note that for
617scripting purposes, <a href="git-status.html">git-status(1)</a> <code>--porcelain</code> and
618<a href="git-diff-files.html">git-diff-files(1)</a> <code>--name-status</code> are almost always
619superior alternatives; users should look at
620<a href="git-status.html">git-status(1)</a> <code>--short</code> or <a href="git-diff.html">git-diff(1)</a>
621<code>--name-status</code> for more user-friendly alternatives.</p>
622<div class="openblock">
623<div class="content">
624<div class="paragraph">
625<p>This option provides a reason for showing each filename, in the form
626of a status tag (which is followed by a space and then the filename).
627The status tags are all single characters from the following list:</p>
628</div>
629<div class="dlist">
630<dl>
631<dt class="hdlist1">H</dt>
632<dd>
633<p>tracked file that is not either unmerged or skip-worktree</p>
634</dd>
635<dt class="hdlist1">S</dt>
636<dd>
637<p>tracked file that is skip-worktree</p>
638</dd>
639<dt class="hdlist1">M</dt>
640<dd>
641<p>tracked file that is unmerged</p>
642</dd>
643<dt class="hdlist1">R</dt>
644<dd>
645<p>tracked file with unstaged removal/deletion</p>
646</dd>
647<dt class="hdlist1">C</dt>
648<dd>
649<p>tracked file with unstaged modification/change</p>
650</dd>
651<dt class="hdlist1">K</dt>
652<dd>
653<p>untracked paths which are part of file/directory conflicts
654which prevent checking out tracked files</p>
655</dd>
656<dt class="hdlist1">?</dt>
657<dd>
658<p>untracked file</p>
659</dd>
660<dt class="hdlist1">U</dt>
661<dd>
662<p>file with resolve-undo information</p>
663</dd>
664</dl>
665</div>
666</div>
667</div>
668</dd>
669<dt class="hdlist1">-v</dt>
670<dd>
671<p>Similar to <code>-t</code>, but use lowercase letters for files
672that are marked as <em>assume unchanged</em> (see
673<a href="git-update-index.html">git-update-index(1)</a>).</p>
674</dd>
675<dt class="hdlist1">-f</dt>
676<dd>
677<p>Similar to <code>-t</code>, but use lowercase letters for files
678that are marked as <em>fsmonitor valid</em> (see
679<a href="git-update-index.html">git-update-index(1)</a>).</p>
680</dd>
681<dt class="hdlist1">--full-name</dt>
682<dd>
683<p>When run from a subdirectory, the command usually
684outputs paths relative to the current directory. This
685option forces paths to be output relative to the project
686top directory.</p>
687</dd>
688<dt class="hdlist1">--recurse-submodules</dt>
689<dd>
690<p>Recursively calls ls-files on each active submodule in the repository.
691Currently there is only support for the --cached and --stage modes.</p>
692</dd>
693<dt class="hdlist1">--abbrev[=&lt;n&gt;]</dt>
694<dd>
695<p>Instead of showing the full 40-byte hexadecimal object
696lines, show the shortest prefix that is at least <em>&lt;n&gt;</em>
697hexdigits long that uniquely refers the object.
698Non default number of digits can be specified with --abbrev=&lt;n&gt;.</p>
699</dd>
700<dt class="hdlist1">--debug</dt>
701<dd>
702<p>After each line that describes a file, add more data about its
703cache entry. This is intended to show as much information as
704possible for manual inspection; the exact format may change at
705any time.</p>
706</dd>
707<dt class="hdlist1">--eol</dt>
708<dd>
709<p>Show &lt;eolinfo&gt; and &lt;eolattr&gt; of files.
710&lt;eolinfo&gt; is the file content identification used by Git when
711the "text" attribute is "auto" (or not set and core.autocrlf is not false).
712&lt;eolinfo&gt; is either "-text", "none", "lf", "crlf", "mixed" or "".</p>
713<div class="paragraph">
714<p>"" means the file is not a regular file, it is not in the index or
715not accessible in the working tree.</p>
716</div>
717<div class="paragraph">
718<p>&lt;eolattr&gt; is the attribute that is used when checking out or committing,
719it is either "", "-text", "text", "text=auto", "text eol=lf", "text eol=crlf".
720Since Git 2.10 "text=auto eol=lf" and "text=auto eol=crlf" are supported.</p>
721</div>
722<div class="paragraph">
723<p>Both the &lt;eolinfo&gt; in the index ("i/&lt;eolinfo&gt;")
724and in the working tree ("w/&lt;eolinfo&gt;") are shown for regular files,
725followed by the ("attr/&lt;eolattr&gt;").</p>
726</div>
727</dd>
728<dt class="hdlist1">--sparse</dt>
729<dd>
730<p>If the index is sparse, show the sparse directories without expanding
731to the contained files. Sparse directories will be shown with a
732trailing slash, such as "x/" for a sparse directory "x".</p>
733</dd>
734<dt class="hdlist1">--format=&lt;format&gt;</dt>
735<dd>
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]736<p>A string that interpolates %(<code>fieldname</code>) from the result being shown.
737It also interpolates %% to %, and %xXX where <code>XX</code> are hex digits
738interpolates to character with hex code <code>XX</code>; for example %x00
739interpolates to \0 (NUL), %x09 to \t (TAB) and %x0a to \n (LF).
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]740--format cannot be combined with <code>-s</code>, <code>-o</code>, <code>-k</code>, <code>-t</code>, <code>--resolve-undo</code>
741and <code>--eol</code>.</p>
742</dd>
743<dt class="hdlist1">--</dt>
744<dd>
745<p>Do not interpret any more arguments as options.</p>
746</dd>
747<dt class="hdlist1">&lt;file&gt;</dt>
748<dd>
749<p>Files to show. If no files are given all files which match the other
750specified criteria are shown.</p>
751</dd>
752</dl>
753</div>
754</div>
755</div>
756<div class="sect1">
757<h2 id="_output">OUTPUT</h2>
758<div class="sectionbody">
759<div class="paragraph">
760<p><em>git ls-files</em> just outputs the filenames unless <code>--stage</code> is specified in
761which case it outputs:</p>
762</div>
763<div class="literalblock">
764<div class="content">
765<pre>[&lt;tag&gt; ]&lt;mode&gt; &lt;object&gt; &lt;stage&gt; &lt;file&gt;</pre>
766</div>
767</div>
768<div class="paragraph">
769<p><em>git ls-files --eol</em> will show
770i/&lt;eolinfo&gt;&lt;SPACES&gt;w/&lt;eolinfo&gt;&lt;SPACES&gt;attr/&lt;eolattr&gt;&lt;SPACE*&gt;&lt;TAB&gt;&lt;file&gt;</p>
771</div>
772<div class="paragraph">
773<p><em>git ls-files --unmerged</em> and <em>git ls-files --stage</em> can be used to examine
774detailed information on unmerged paths.</p>
775</div>
776<div class="paragraph">
777<p>For an unmerged path, instead of recording a single mode/SHA-1 pair,
778the index records up to three such pairs; one from tree O in stage
7791, A in stage 2, and B in stage 3. This information can be used by
780the user (or the porcelain) to see what should eventually be recorded at the
781path. (see <a href="git-read-tree.html">git-read-tree(1)</a> for more information on state)</p>
782</div>
783<div class="paragraph">
784<p>Without the <code>-z</code> option, pathnames with "unusual" characters are
785quoted as explained for the configuration variable <code>core.quotePath</code>
786(see <a href="git-config.html">git-config(1)</a>). Using <code>-z</code> the filename is output
787verbatim and the line is terminated by a NUL byte.</p>
788</div>
789<div class="paragraph">
790<p>It is possible to print in a custom format by using the <code>--format</code>
791option, which is able to interpolate different fields using
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]792a %(<code>fieldname</code>) notation. For example, if you only care about the
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]793"objectname" and "path" fields, you can execute with a specific
794"--format" like</p>
795</div>
796<div class="literalblock">
797<div class="content">
798<pre>git ls-files --format='%(objectname) %(path)'</pre>
799</div>
800</div>
801</div>
802</div>
803<div class="sect1">
804<h2 id="_field_names">FIELD NAMES</h2>
805<div class="sectionbody">
806<div class="paragraph">
807<p>The way each path is shown can be customized by using the
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]808<code>--format=</code><em>&lt;format&gt;</em> option, where the %(fieldname) in the
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]809&lt;format&gt; string for various aspects of the index entry are
810interpolated. The following "fieldname" are understood:</p>
811</div>
812<div class="dlist">
813<dl>
814<dt class="hdlist1">objectmode</dt>
815<dd>
816<p>The mode of the file which is recorded in the index.</p>
817</dd>
818<dt class="hdlist1">objecttype</dt>
819<dd>
820<p>The object type of the file which is recorded in the index.</p>
821</dd>
822<dt class="hdlist1">objectname</dt>
823<dd>
824<p>The name of the file which is recorded in the index.</p>
825</dd>
826<dt class="hdlist1">objectsize[:padded]</dt>
827<dd>
828<p>The object size of the file which is recorded in the index
829("-" if the object is a <code>commit</code> or <code>tree</code>).
830It also supports a padded format of size with "%(objectsize:padded)".</p>
831</dd>
832<dt class="hdlist1">stage</dt>
833<dd>
834<p>The stage of the file which is recorded in the index.</p>
835</dd>
836<dt class="hdlist1">eolinfo:index</dt>
837<dt class="hdlist1">eolinfo:worktree</dt>
838<dd>
839<p>The &lt;eolinfo&gt; (see the description of the <code>--eol</code> option) of
840the contents in the index or in the worktree for the path.</p>
841</dd>
842<dt class="hdlist1">eolattr</dt>
843<dd>
844<p>The &lt;eolattr&gt; (see the description of the <code>--eol</code> option)
845that applies to the path.</p>
846</dd>
847<dt class="hdlist1">path</dt>
848<dd>
849<p>The pathname of the file which is recorded in the index.</p>
850</dd>
851</dl>
852</div>
853</div>
854</div>
855<div class="sect1">
856<h2 id="_exclude_patterns">EXCLUDE PATTERNS</h2>
857<div class="sectionbody">
858<div class="paragraph">
859<p><em>git ls-files</em> can use a list of "exclude patterns" when
860traversing the directory tree and finding files to show when the
861flags --others or --ignored are specified. <a href="gitignore.html">gitignore(5)</a>
862specifies the format of exclude patterns.</p>
863</div>
864<div class="paragraph">
865<p>These exclude patterns can be specified from the following places,
866in order:</p>
867</div>
868<div class="olist arabic">
869<ol class="arabic">
870<li>
871<p>The command-line flag --exclude=&lt;pattern&gt; specifies a
872single pattern. Patterns are ordered in the same order
873they appear in the command line.</p>
874</li>
875<li>
876<p>The command-line flag --exclude-from=&lt;file&gt; specifies a
877file containing a list of patterns. Patterns are ordered
878in the same order they appear in the file.</p>
879</li>
880<li>
881<p>The command-line flag --exclude-per-directory=&lt;name&gt; specifies
882a name of the file in each directory <em>git ls-files</em>
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]883examines, normally .<code>gitignore</code>. Files in deeper
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]884directories take precedence. Patterns are ordered in the
885same order they appear in the files.</p>
886</li>
887</ol>
888</div>
889<div class="paragraph">
890<p>A pattern specified on the command line with --exclude or read
891from the file specified with --exclude-from is relative to the
892top of the directory tree. A pattern read from a file specified
893by --exclude-per-directory is relative to the directory that the
894pattern file appears in.</p>
895</div>
896<div class="paragraph">
897<p>Generally, you should be able to use <code>--exclude-standard</code> when you
898want the exclude rules applied the same way as what Porcelain
899commands do. To emulate what <code>--exclude-standard</code> specifies, you
900can give <code>--exclude-per-directory=.gitignore</code>, and then specify:</p>
901</div>
902<div class="olist arabic">
903<ol class="arabic">
904<li>
905<p>The file specified by the <code>core.excludesfile</code> configuration
906variable, if exists, or the <code>$XDG_CONFIG_HOME/git/ignore</code> file.</p>
907</li>
908<li>
909<p>The <code>$GIT_DIR/info/exclude</code> file.</p>
910</li>
911</ol>
912</div>
913<div class="paragraph">
914<p>via the <code>--exclude-from=</code> option.</p>
915</div>
916</div>
917</div>
918<div class="sect1">
919<h2 id="_see_also">SEE ALSO</h2>
920<div class="sectionbody">
921<div class="paragraph">
922<p><a href="git-read-tree.html">git-read-tree(1)</a>, <a href="gitignore.html">gitignore(5)</a></p>
923</div>
924</div>
925</div>
926<div class="sect1">
927<h2 id="_git">GIT</h2>
928<div class="sectionbody">
929<div class="paragraph">
930<p>Part of the <a href="git.html">git(1)</a> suite</p>
931</div>
932</div>
933</div>
934</div>
935<div id="footer">
936<div id="footer-text">
Junio C Hamanod6a33e42025-02-18 23:45:11[diff] [blame]937Last updated 2025-02-14 21:38:14 -0800
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]938</div>
939</div>
940</body>
941</html>