1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
\r
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
\r
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
\r
6 <meta name="generator" content="AsciiDoc 7.0.1" />
\r
7 <style type="text/css">
\r
9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
\r
11 border: 1px solid red;
\r
16 margin: 1em 5% 1em 5%;
\r
20 a:visited { color: fuchsia; }
\r
34 h1, h2, h3, h4, h5, h6 {
\r
36 font-family: sans-serif;
\r
38 margin-bottom: 0.5em;
\r
43 border-bottom: 2px solid silver;
\r
46 border-bottom: 2px solid silver;
\r
56 border: 1px solid silver;
\r
61 margin-bottom: 0.5em;
\r
71 font-family: sans-serif;
\r
78 font-family: sans-serif;
\r
82 font-family: sans-serif;
\r
84 border-top: 2px solid silver;
\r
90 padding-bottom: 0.5em;
\r
94 padding-bottom: 0.5em;
\r
98 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
\r
99 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
\r
100 div.admonitionblock {
\r
103 margin-bottom: 1.5em;
\r
105 div.admonitionblock {
\r
107 margin-bottom: 2.5em;
\r
110 div.content { /* Block element content. */
\r
114 /* Block element titles. */
\r
115 div.title, caption.title {
\r
116 font-family: sans-serif;
\r
120 margin-bottom: 0.5em;
\r
126 td div.title:first-child {
\r
129 div.content div.title:first-child {
\r
132 div.content + div.title {
\r
136 div.sidebarblock > div.content {
\r
137 background: #ffffee;
\r
138 border: 1px solid silver;
\r
142 div.listingblock > div.content {
\r
143 border: 1px solid silver;
\r
144 background: #f4f4f4;
\r
148 div.quoteblock > div.content {
\r
149 padding-left: 2.0em;
\r
151 div.quoteblock .attribution {
\r
155 div.admonitionblock .icon {
\r
156 vertical-align: top;
\r
159 text-decoration: underline;
\r
161 padding-right: 0.5em;
\r
163 div.admonitionblock td.content {
\r
164 padding-left: 0.5em;
\r
165 border-left: 2px solid silver;
\r
168 div.exampleblock > div.content {
\r
169 border-left: 2px solid silver;
\r
173 div.verseblock div.content {
\r
177 div.imageblock div.content { padding-left: 0; }
\r
178 div.imageblock img { border: 1px solid silver; }
\r
179 span.image img { border-style: none; }
\r
183 margin-bottom: 0.8em;
\r
188 font-style: italic;
\r
190 dd > *:first-child {
\r
195 list-style-position: outside;
\r
198 list-style-type: lower-alpha;
\r
201 div.tableblock > table {
\r
202 border-color: #527bbd;
\r
206 font-family: sans-serif;
\r
215 margin-bottom: 0.8em;
\r
218 vertical-align: top;
\r
219 font-style: italic;
\r
220 padding-right: 0.8em;
\r
223 vertical-align: top;
\r
227 div#footer-badges { display: none; }
\r
229 include::./stylesheets/xhtml11-manpage.css[]
\r
230 /* Workarounds for IE6's broken and incomplete CSS2. */
\r
232 div.sidebar-content {
\r
233 background: #ffffee;
\r
234 border: 1px solid silver;
\r
237 div.sidebar-title, div.image-title {
\r
238 font-family: sans-serif;
\r
241 margin-bottom: 0.5em;
\r
244 div.listingblock div.content {
\r
245 border: 1px solid silver;
\r
246 background: #f4f4f4;
\r
250 div.quoteblock-content {
\r
251 padding-left: 2.0em;
\r
254 div.exampleblock-content {
\r
255 border-left: 2px solid silver;
\r
256 padding-left: 0.5em;
\r
259 <title>git-ls-files(1)</title>
\r
264 git-ls-files(1) Manual Page
\r
267 <div class="sectionbody">
\r
269 Information about files in the index/working directory
\r
274 <div class="sectionbody">
\r
275 <p><em>git-ls-files</em> [-z] [-t]
\r
276 (--[cached|deleted|others|ignored|stage|unmerged|killed|modified])*
\r
277 (-[c|d|o|i|s|u|k|m])*
\r
278 [-x <pattern>|--exclude=<pattern>]
\r
279 [-X <file>|--exclude-from=<file>]
\r
280 [--exclude-per-directory=<file>]
\r
281 [--full-name] [--] [<file>]*</p>
\r
283 <h2>DESCRIPTION</h2>
\r
284 <div class="sectionbody">
\r
285 <p>This merges the file listing in the directory cache index with the
\r
286 actual working directory list, and shows different combinations of the
\r
288 <p>One or more of the options below may be used to determine the files
\r
292 <div class="sectionbody">
\r
299 Show cached files in the output (default)
\r
307 Show deleted files in the output
\r
315 Show modified files in the output
\r
323 Show other files in the output
\r
331 Show ignored files in the output
\r
332 Note the this also reverses any exclude list present.
\r
340 Show stage files in the output
\r
348 If a whole directory is classified as "other", show just its
\r
349 name (with a trailing slash) and not its whole contents.
\r
357 Show unmerged files in the output (forces --stage)
\r
365 Show files on the filesystem that need to be removed due
\r
366 to file/directory conflicts for checkout-index to
\r
375 \0 line termination on output.
\r
379 -x|--exclude=<pattern>
\r
383 Skips files matching pattern.
\r
384 Note that pattern is a shell wildcard pattern.
\r
388 -X|--exclude-from=<file>
\r
392 exclude patterns are read from <file>; 1 per line.
\r
396 --exclude-per-directory=<file>
\r
400 read additional exclude patterns that apply only to the
\r
401 directory and its subdirectories in <file>.
\r
409 Identify the file status with the following tags (followed by
\r
410 a space) at the start of each line:
\r
412 <div class="hlist"><table>
\r
414 <td class="hlist1">
\r
417 <td class="hlist2">
\r
422 <td class="hlist1">
\r
425 <td class="hlist2">
\r
430 <td class="hlist1">
\r
433 <td class="hlist2">
\r
438 <td class="hlist1">
\r
441 <td class="hlist2">
\r
446 <td class="hlist1">
\r
449 <td class="hlist2">
\r
461 When run from a subdirectory, the command usually
\r
462 outputs paths relative to the current directory. This
\r
463 option forces paths to be output relative to the project
\r
472 Do not interpret any more arguments as options.
\r
480 Files to show. If no files are given all files which match the other
\r
481 specified criteria are shown.
\r
487 <div class="sectionbody">
\r
488 <p>show files just outputs the filename unless <em>--stage</em> is specified in
\r
489 which case it outputs:</p>
\r
490 <div class="literalblock">
\r
491 <div class="content">
\r
492 <pre><tt>[<tag> ]<mode> <object> <stage> <file></tt></pre>
\r
494 <p>"git-ls-files --unmerged" and "git-ls-files --stage" can be used to examine
\r
495 detailed information on unmerged paths.</p>
\r
496 <p>For an unmerged path, instead of recording a single mode/SHA1 pair,
\r
497 the dircache records up to three such pairs; one from tree O in stage
\r
498 1, A in stage 2, and B in stage 3. This information can be used by
\r
499 the user (or the porcelain) to see what should eventually be recorded at the
\r
500 path. (see git-read-tree for more information on state)</p>
\r
501 <p>When <tt>-z</tt> option is not used, TAB, LF, and backslash characters
\r
502 in pathnames are represented as <tt>\t</tt>, <tt>\n</tt>, and <tt>\\</tt>,
\r
505 <h2>Exclude Patterns</h2>
\r
506 <div class="sectionbody">
\r
507 <p><em>git-ls-files</em> can use a list of "exclude patterns" when
\r
508 traversing the directory tree and finding files to show when the
\r
509 flags --others or --ignored are specified.</p>
\r
510 <p>These exclude patterns come from these places:</p>
\r
514 command line flag --exclude=<pattern> specifies a single
\r
520 command line flag --exclude-from=<file> specifies a list of
\r
521 patterns stored in a file.
\r
526 command line flag --exclude-per-directory=<name> specifies
\r
527 a name of the file in each directory <em>git-ls-files</em>
\r
528 examines, and if exists, its contents are used as an
\r
529 additional list of patterns.
\r
533 <p>An exclude pattern file used by (2) and (3) contains one pattern
\r
534 per line. A line that starts with a <em>#</em> can be used as comment
\r
535 for readability.</p>
\r
536 <p>There are three lists of patterns that are in effect at a given
\r
537 time. They are built and ordered in the following way:</p>
\r
541 --exclude=<pattern> from the command line; patterns are
\r
542 ordered in the same order as they appear on the command line.
\r
547 lines read from --exclude-from=<file>; patterns are ordered
\r
548 in the same order as they appear in the file.
\r
553 When --exclude-per-directory=<name> is specified, upon
\r
554 entering a directory that has such a file, its contents are
\r
555 appended at the end of the current "list of patterns". They
\r
556 are popped off when leaving the directory.
\r
560 <p>Each pattern in the pattern list specifies "a match pattern" and
\r
561 optionally the fate; either a file that matches the pattern is
\r
562 considered excluded or included. A filename is matched against
\r
563 the patterns in the three lists; the --exclude-from list is
\r
564 checked first, then the --exclude-per-directory list, and then
\r
565 finally the --exclude list. The last match determines its fate.
\r
566 If there is no match in the three lists, the fate is "included".</p>
\r
567 <p>A pattern specified on the command line with --exclude or read
\r
568 from the file specified with --exclude-from is relative to the
\r
569 top of the directory tree. A pattern read from a file specified
\r
570 by --exclude-per-directory is relative to the directory that the
\r
571 pattern file appears in.</p>
\r
572 <p>An exclude pattern is of the following format:</p>
\r
576 an optional prefix <em>!</em> which means that the fate this pattern
\r
577 specifies is "include", not the usual "exclude"; the
\r
578 remainder of the pattern string is interpreted according to
\r
579 the following rules.
\r
584 if it does not contain a slash <em>/</em>, it is a shell glob
\r
585 pattern and used to match against the filename without
\r
586 leading directories (i.e. the same way as the current
\r
592 otherwise, it is a shell glob pattern, suitable for
\r
593 consumption by fnmatch(3) with FNM_PATHNAME flag. I.e. a
\r
594 slash in the pattern must match a slash in the pathname.
\r
595 "Documentation/*.html" matches "Documentation/git.html" but
\r
596 not "ppc/ppc.html". As a natural exception, "/*.c" matches
\r
597 "cat-file.c" but not "mozilla-sha1/sha1.c".
\r
602 <div class="listingblock">
\r
603 <div class="content">
\r
604 <pre><tt> $ cat .git/ignore
\r
605 # ignore objects and archives, anywhere in the tree.
\r
607 $ cat Documentation/.gitignore
\r
608 # ignore generated html files,
\r
610 # except foo.html which is maintained by hand
\r
612 $ git-ls-files --ignored \
\r
613 --exclude='Documentation/*.[0-9]' \
\r
614 --exclude-from=.git/ignore \
\r
615 --exclude-per-directory=.gitignore</tt></pre>
\r
619 <div class="sectionbody">
\r
620 <p><a href="git-read-tree.html">git-read-tree(1)</a></p>
\r
623 <div class="sectionbody">
\r
624 <p>Written by Linus Torvalds <torvalds@osdl.org></p>
\r
626 <h2>Documentation</h2>
\r
627 <div class="sectionbody">
\r
628 <p>Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.</p>
\r
631 <div class="sectionbody">
\r
632 <p>Part of the <a href="git.html">git(7)</a> suite</p>
\r
635 <div id="footer-text">
\r
636 Last updated 21-Jan-2006 23:50:18 PDT
\r