1 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns=
"http://www.w3.org/1999/xhtml" xml:
lang=
"en">
5 <meta http-equiv=
"Content-Type" content=
"text/html; charset=UTF-8" />
6 <meta name=
"generator" content=
"AsciiDoc 8.5.2" />
7 <title>git-ls-files(
1)
</title>
8 <style type=
"text/css">
10 p
, li
, dt
, dd
, div
, pre
, h1
, h2
, h3
, h4
, h5
, h6
{
12 border: 1px solid red;
17 margin: 1em 5% 1em 5%;
22 text-decoration: underline
;
42 h1
, h2
, h3
, h4
, h5
, h6
{
44 font-family: sans-serif
;
51 border-bottom: 2px solid silver
;
69 border: 1px solid silver
;
88 font-family: sans-serif
;
94 span#revnumber
, span#revdate
, span#revremark
{
95 font-family: sans-serif
;
99 font-family: sans-serif
;
101 border-top: 2px solid silver
;
107 padding-bottom: 0.5em;
111 padding-bottom: 0.5em;
116 margin-bottom: 1.5em;
118 div
.tableblock
, div
.imageblock
, div
.exampleblock
, div
.verseblock
,
119 div
.quoteblock
, div
.literalblock
, div
.listingblock
, div
.sidebarblock
,
120 div
.admonitionblock
{
122 margin-bottom: 1.5em;
124 div
.admonitionblock
{
126 margin-bottom: 2.0em;
131 div
.content
{ /* Block element content. */
135 /* Block element titles. */
136 div
.title
, caption
.title
{
138 font-family: sans-serif
;
142 margin-bottom: 0.5em;
148 td div
.title:first-child
{
151 div
.content div
.title:first-child
{
154 div
.content
+ div
.title
{
158 div
.sidebarblock
> div
.content
{
160 border: 1px solid silver
;
164 div
.listingblock
> div
.content
{
165 border: 1px solid silver
;
170 div
.quoteblock
, div
.verseblock
{
174 border-left: 5px solid
#dddddd;
178 div
.quoteblock
> div
.attribution
{
183 div
.verseblock
> div
.content
{
186 div
.verseblock
> div
.attribution
{
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 div
.verseblock
+ div
.attribution
{
195 div
.admonitionblock
.icon
{
199 text-decoration: underline
;
201 padding-right: 0.5em;
203 div
.admonitionblock td
.content
{
205 border-left: 3px solid
#dddddd;
208 div
.exampleblock
> div
.content
{
209 border-left: 3px solid
#dddddd;
213 div
.imageblock div
.content
{ padding-left: 0; }
214 span
.image img
{ border-style: none
; }
215 a
.image:visited
{ color: white
; }
219 margin-bottom: 0.8em;
232 list-style-position: outside
;
235 list-style-type: decimal
;
238 list-style-type: lower-alpha
;
241 list-style-type: upper-alpha
;
244 list-style-type: lower-roman
;
247 list-style-type: upper-roman
;
250 div
.compact ul
, div
.compact ol
,
251 div
.compact p
, div
.compact p
,
252 div
.compact div
, div
.compact div
{
254 margin-bottom: 0.1em;
257 div
.tableblock
> table
{
258 border: 3px solid
#527bbd;
260 thead
, p
.table
.header
{
261 font-family: sans-serif
;
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 div
.tableblock
> table
[frame
="void"] {
277 div
.tableblock
> table
[frame
="hsides"] {
278 border-left-style: none
;
279 border-right-style: none
;
281 div
.tableblock
> table
[frame
="vsides"] {
282 border-top-style: none
;
283 border-bottom-style: none
;
289 margin-bottom: 0.8em;
292 padding-bottom: 15px;
294 dt
.hdlist1
.strong
, td
.hdlist1
.strong
{
300 padding-right: 0.8em;
306 div
.hdlist
.compact tr
{
315 .footnote, .footnoteref {
319 span
.footnote
, span
.footnoteref
{
320 vertical-align: super
;
324 margin: 20px 0 20px 0;
328 #footnotes div
.footnote
{
334 border-top: 1px solid silver
;
344 div#footer-badges
{ display: none
; }
348 margin-bottom: 2.5em;
353 font-family: sans-serif
;
357 margin-bottom: 0.1em;
360 div
.toclevel1
, div
.toclevel2
, div
.toclevel3
, div
.toclevel4
{
376 /* Overrides for manpage documents */
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver
;
381 border-bottom: 2px solid silver
;
391 div#toc
{ display: none
; }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
396 div
.sidebar-content
{
398 border: 1px solid silver
;
401 div
.sidebar-title
, div
.image-title
{
403 font-family: sans-serif
;
406 margin-bottom: 0.5em;
409 div
.listingblock div
.content
{
410 border: 1px solid silver
;
415 div
.quoteblock-attribution
{
420 div
.verseblock-content
{
423 div
.verseblock-attribution
{
428 div
.exampleblock-content
{
429 border-left: 3px solid
#dddddd;
433 /* IE6 sets dynamically generated links as visited. */
434 div#toc
a:visited
{ color: blue
; }
436 <script type=
"text/javascript">
438 window
.onload = function(){asciidoc
.footnotes();}
439 var asciidoc
= { // Namespace.
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
448 * Table Of Content generator
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
459 toc: function (toclevels
) {
461 function getText(el
) {
463 for (var i
= el
.firstChild
; i
!= null; i
= i
.nextSibling
) {
464 if (i
.nodeType
== 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
466 else if (i
.firstChild
!= null)
472 function TocEntry(el
, text
, toclevel
) {
475 this.toclevel
= toclevel
;
478 function tocEntries(el
, toclevels
) {
479 var result
= new Array
;
480 var re
= new RegExp('[hH]([2-'+(toclevels
+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
484 var iterate = function (el
) {
485 for (var i
= el
.firstChild
; i
!= null; i
= i
.nextSibling
) {
486 if (i
.nodeType
== 1 /* Node.ELEMENT_NODE */) {
487 var mo
= re
.exec(i
.tagName
);
488 if (mo
&& (i
.getAttribute("class") || i
.getAttribute("className")) != "float") {
489 result
[result
.length
] = new TocEntry(i
, getText(i
), mo
[1]-1);
499 var toc
= document
.getElementById("toc");
500 var entries
= tocEntries(document
.getElementById("content"), toclevels
);
501 for (var i
= 0; i
< entries
.length
; ++i
) {
502 var entry
= entries
[i
];
503 if (entry
.element
.id
== "")
504 entry
.element
.id
= "_toc_" + i
;
505 var a
= document
.createElement("a");
506 a
.href
= "#" + entry
.element
.id
;
507 a
.appendChild(document
.createTextNode(entry
.text
));
508 var div
= document
.createElement("div");
510 div
.className
= "toclevel" + entry
.toclevel
;
511 toc
.appendChild(div
);
513 if (entries
.length
== 0)
514 toc
.parentNode
.removeChild(toc
);
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
526 footnotes: function () {
527 var cont
= document
.getElementById("content");
528 var noteholder
= document
.getElementById("footnotes");
529 var spans
= cont
.getElementsByTagName("span");
532 for (i
=0; i
<spans
.length
; i
++) {
533 if (spans
[i
].className
== "footnote") {
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note
= spans
[i
].innerHTML
.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder
.innerHTML
+=
539 "<div class='footnote' id='_footnote_" + n
+ "'>" +
540 "<a href='#_footnoteref_" + n
+ "' title='Return to text'>" +
541 n
+ "</a>. " + note
+ "</div>";
543 "[<a id='_footnoteref_" + n
+ "' href='#_footnote_" + n
+
544 "' title='View footnote' class='footnote'>" + n
+ "</a>]";
545 var id
=spans
[i
].getAttribute("id");
546 if (id
!= null) refs
["#"+id
] = n
;
550 noteholder
.parentNode
.removeChild(noteholder
);
552 // Process footnoterefs.
553 for (i
=0; i
<spans
.length
; i
++) {
554 if (spans
[i
].className
== "footnoteref") {
555 var href
= spans
[i
].getElementsByTagName("a")[0].getAttribute("href");
556 href
= href
.match(/#.*/)[0]; // Because IE return full URL.
559 "[<a href='#_footnote_" + n
+
560 "' title='View footnote' class='footnote'>" + n
+ "</a>]";
573 git-ls-files(
1) Manual Page
576 <div class=
"sectionbody">
578 Show information about files in the index and the working tree
583 <h2 id=
"_synopsis">SYNOPSIS
</h2>
584 <div class=
"sectionbody">
585 <div class=
"verseblock">
586 <div class=
"verseblock-content"><em>git ls-files
</em> [-z] [-t] [-v]
587 (--[cached|deleted|others|ignored|stage|unmerged|killed|modified])*
588 (-[c|d|o|i|s|u|k|m])*
589 [-x
<pattern
>|--exclude=
<pattern
>]
590 [-X
<file
>|--exclude-from=
<file
>]
591 [--exclude-per-directory=
<file
>]
593 [--error-unmatch] [--with-tree=
<tree-ish
>]
594 [--full-name] [--abbrev] [--] [
<file
>…]
</div>
595 <div class=
"verseblock-attribution">
598 <h2 id=
"_description">DESCRIPTION
</h2>
599 <div class=
"sectionbody">
600 <div class=
"paragraph"><p>This merges the file listing in the directory cache index with the
601 actual working directory list, and shows different combinations of the
603 <div class=
"paragraph"><p>One or more of the options below may be used to determine the files
606 <h2 id=
"_options">OPTIONS
</h2>
607 <div class=
"sectionbody">
608 <div class=
"dlist"><dl>
617 Show cached files in the output (default)
628 Show deleted files in the output
639 Show modified files in the output
650 Show other (i.e. untracked) files in the output
661 Show only ignored files in the output. When showing files in the
662 index, print only those matched by an exclude pattern. When
663 showing
"other" files, show only those matched by an exclude
675 Show staged contents' object name, mode bits and stage number in the output.
683 If a whole directory is classified as
"other", show just its
684 name (with a trailing slash) and not its whole contents.
692 Do not list empty directories. Has no effect without --directory.
703 Show unmerged files in the output (forces --stage)
714 Show files on the filesystem that need to be removed due
715 to file/directory conflicts for checkout-index to
724 \
0 line termination on output.
731 --exclude=
<pattern
>
735 Skip untracked files matching pattern.
736 Note that pattern is a shell wildcard pattern. See EXCLUDE PATTERNS
737 below for more information.
744 --exclude-from=
<file
>
748 Read exclude patterns from
<file
>;
1 per line.
752 --exclude-per-directory=
<file
>
756 Read additional exclude patterns that apply only to the
757 directory and its subdirectories in
<file
>.
765 Add the standard git exclusions: .git/info/exclude, .gitignore
766 in each directory, and the user
’s global exclusion file.
774 If any
<file
> does not appear in the index, treat this as an
779 --with-tree=
<tree-ish
>
783 When using --error-unmatch to expand the user supplied
784 <file
> (i.e. path pattern) arguments to paths, pretend
785 that paths which were removed in the index since the
786 named
<tree-ish
> are still present. Using this option
787 with
<tt>-s
</tt> or
<tt>-u
</tt> options does not make any sense.
795 This feature is semi-deprecated. For scripting purpose,
796 <a href=
"git-status.html">git-status(
1)
</a> <tt>--porcelain
</tt> and
797 <a href=
"git-diff-files.html">git-diff-files(
1)
</a> <tt>--name-status
</tt> are almost always
798 superior alternatives, and users should look at
799 <a href=
"git-status.html">git-status(
1)
</a> <tt>--short
</tt> or
<a href=
"git-diff.html">git-diff(
1)
</a>
800 <tt>--name-status
</tt> for more user-friendly alternatives.
802 <div class=
"paragraph"><p>This option identifies the file status with the following tags (followed by
803 a space) at the start of each line:
</p></div>
866 Similar to
<tt>-t
</tt>, but use lowercase letters for files
867 that are marked as
<em>assume unchanged
</em> (see
868 <a href=
"git-update-index.html">git-update-index(
1)
</a>).
876 When run from a subdirectory, the command usually
877 outputs paths relative to the current directory. This
878 option forces paths to be output relative to the project
887 Instead of showing the full
40-byte hexadecimal object
888 lines, show only a partial prefix.
889 Non default number of digits can be specified with --abbrev=
<n
>.
897 After each line that describes a file, add more data about its
898 cache entry. This is intended to show as much information as
899 possible for manual inspection; the exact format may change at
908 Do not interpret any more arguments as options.
916 Files to show. If no files are given all files which match the other
917 specified criteria are shown.
922 <h2 id=
"_output">Output
</h2>
923 <div class=
"sectionbody">
924 <div class=
"paragraph"><p><em>git ls-files
</em> just outputs the filenames unless
<em>--stage
</em> is specified in
925 which case it outputs:
</p></div>
926 <div class=
"literalblock">
927 <div class=
"content">
928 <pre><tt>[
<tag
> ]
<mode
> <object
> <stage
> <file
></tt></pre>
930 <div class=
"paragraph"><p><em>git ls-files --unmerged
</em> and
<em>git ls-files --stage
</em> can be used to examine
931 detailed information on unmerged paths.
</p></div>
932 <div class=
"paragraph"><p>For an unmerged path, instead of recording a single mode/SHA1 pair,
933 the index records up to three such pairs; one from tree O in stage
934 1, A in stage
2, and B in stage
3. This information can be used by
935 the user (or the porcelain) to see what should eventually be recorded at the
936 path. (see
<a href=
"git-read-tree.html">git-read-tree(
1)
</a> for more information on state)
</p></div>
937 <div class=
"paragraph"><p>When
<tt>-z
</tt> option is not used, TAB, LF, and backslash characters
938 in pathnames are represented as
<tt>\t
</tt>,
<tt>\n
</tt>, and
<tt>\\
</tt>,
939 respectively.
</p></div>
941 <h2 id=
"_exclude_patterns">Exclude Patterns
</h2>
942 <div class=
"sectionbody">
943 <div class=
"paragraph"><p><em>git ls-files
</em> can use a list of
"exclude patterns" when
944 traversing the directory tree and finding files to show when the
945 flags --others or --ignored are specified.
<a href=
"gitignore.html">gitignore(
5)
</a>
946 specifies the format of exclude patterns.
</p></div>
947 <div class=
"paragraph"><p>These exclude patterns come from these places, in order:
</p></div>
948 <div class=
"olist arabic"><ol class=
"arabic">
951 The command line flag --exclude=
<pattern
> specifies a
952 single pattern. Patterns are ordered in the same order
953 they appear in the command line.
958 The command line flag --exclude-from=
<file
> specifies a
959 file containing a list of patterns. Patterns are ordered
960 in the same order they appear in the file.
965 The command line flag --exclude-per-directory=
<name
> specifies
966 a name of the file in each directory
<em>git ls-files
</em>
967 examines, normally
<tt>.gitignore
</tt>. Files in deeper
968 directories take precedence. Patterns are ordered in the
969 same order they appear in the files.
973 <div class=
"paragraph"><p>A pattern specified on the command line with --exclude or read
974 from the file specified with --exclude-from is relative to the
975 top of the directory tree. A pattern read from a file specified
976 by --exclude-per-directory is relative to the directory that the
977 pattern file appears in.
</p></div>
979 <h2 id=
"_see_also">SEE ALSO
</h2>
980 <div class=
"sectionbody">
981 <div class=
"paragraph"><p><a href=
"git-read-tree.html">git-read-tree(
1)
</a>,
<a href=
"gitignore.html">gitignore(
5)
</a></p></div>
983 <h2 id=
"_git">GIT
</h2>
984 <div class=
"sectionbody">
985 <div class=
"paragraph"><p>Part of the
<a href=
"git.html">git(
1)
</a> suite
</p></div>
988 <div id=
"footnotes"><hr /></div>
990 <div id=
"footer-text">
991 Last updated
2011-
09-
21 23:
01:
14 PDT