Git.pm: fix return value of config method
[git/dscho.git] / Documentation / git-ls-files.txt
blob4be45b001a0794b7955b9a4c1848c41dbea26e27
1 git-ls-files(1)
2 ===============
4 NAME
5 ----
6 git-ls-files - Show information about files in the index and the working tree
9 SYNOPSIS
10 --------
11 [verse]
12 'git-ls-files' [-z] [-t] [-v]
13                 (--[cached|deleted|others|ignored|stage|unmerged|killed|modified])\*
14                 (-[c|d|o|i|s|u|k|m])\*
15                 [-x <pattern>|--exclude=<pattern>]
16                 [-X <file>|--exclude-from=<file>]
17                 [--exclude-per-directory=<file>]
18                 [--exclude-standard]
19                 [--error-unmatch] [--with-tree=<tree-ish>]
20                 [--full-name] [--abbrev] [--] [<file>]\*
22 DESCRIPTION
23 -----------
24 This merges the file listing in the directory cache index with the
25 actual working directory list, and shows different combinations of the
26 two.
28 One or more of the options below may be used to determine the files
29 shown:
31 OPTIONS
32 -------
33 -c|--cached::
34         Show cached files in the output (default)
36 -d|--deleted::
37         Show deleted files in the output
39 -m|--modified::
40         Show modified files in the output
42 -o|--others::
43         Show other files in the output
45 -i|--ignored::
46         Show ignored files in the output.
47         Note that this also reverses any exclude list present.
49 -s|--stage::
50         Show stage files in the output
52 --directory::
53         If a whole directory is classified as "other", show just its
54         name (with a trailing slash) and not its whole contents.
56 --no-empty-directory::
57         Do not list empty directories. Has no effect without --directory.
59 -u|--unmerged::
60         Show unmerged files in the output (forces --stage)
62 -k|--killed::
63         Show files on the filesystem that need to be removed due
64         to file/directory conflicts for checkout-index to
65         succeed.
67 -z::
68         \0 line termination on output.
70 -x|--exclude=<pattern>::
71         Skips files matching pattern.
72         Note that pattern is a shell wildcard pattern.
74 -X|--exclude-from=<file>::
75         exclude patterns are read from <file>; 1 per line.
77 --exclude-per-directory=<file>::
78         read additional exclude patterns that apply only to the
79         directory and its subdirectories in <file>.
81 --exclude-standard::
82         Add the standard git exclusions: .git/info/exclude, .gitignore
83         in each directory, and the user's global exclusion file.
85 --error-unmatch::
86         If any <file> does not appear in the index, treat this as an
87         error (return 1).
89 --with-tree=<tree-ish>::
90         When using --error-unmatch to expand the user supplied
91         <file> (i.e. path pattern) arguments to paths, pretend
92         that paths which were removed in the index since the
93         named <tree-ish> are still present.  Using this option
94         with `-s` or `-u` options does not make any sense.
96 -t::
97         Identify the file status with the following tags (followed by
98         a space) at the start of each line:
99         H::     cached
100         M::     unmerged
101         R::     removed/deleted
102         C::     modified/changed
103         K::     to be killed
104         ?::     other
106 -v::
107         Similar to `-t`, but use lowercase letters for files
108         that are marked as 'assume unchanged' (see
109         linkgit:git-update-index[1]).
111 --full-name::
112         When run from a subdirectory, the command usually
113         outputs paths relative to the current directory.  This
114         option forces paths to be output relative to the project
115         top directory.
117 --abbrev[=<n>]::
118         Instead of showing the full 40-byte hexadecimal object
119         lines, show only handful hexdigits prefix.
120         Non default number of digits can be specified with --abbrev=<n>.
122 \--::
123         Do not interpret any more arguments as options.
125 <file>::
126         Files to show. If no files are given all files which match the other
127         specified criteria are shown.
129 Output
130 ------
131 show files just outputs the filename unless '--stage' is specified in
132 which case it outputs:
134         [<tag> ]<mode> <object> <stage> <file>
136 "git-ls-files --unmerged" and "git-ls-files --stage" can be used to examine
137 detailed information on unmerged paths.
139 For an unmerged path, instead of recording a single mode/SHA1 pair,
140 the index records up to three such pairs; one from tree O in stage
141 1, A in stage 2, and B in stage 3.  This information can be used by
142 the user (or the porcelain) to see what should eventually be recorded at the
143 path. (see git-read-tree for more information on state)
145 When `-z` option is not used, TAB, LF, and backslash characters
146 in pathnames are represented as `\t`, `\n`, and `\\`,
147 respectively.
150 Exclude Patterns
151 ----------------
153 'git-ls-files' can use a list of "exclude patterns" when
154 traversing the directory tree and finding files to show when the
155 flags --others or --ignored are specified.  linkgit:gitignore[5]
156 specifies the format of exclude patterns.
158 These exclude patterns come from these places, in order:
160   1. The command line flag --exclude=<pattern> specifies a
161      single pattern.  Patterns are ordered in the same order
162      they appear in the command line.
164   2. The command line flag --exclude-from=<file> specifies a
165      file containing a list of patterns.  Patterns are ordered
166      in the same order they appear in the file.
168   3. command line flag --exclude-per-directory=<name> specifies
169      a name of the file in each directory 'git-ls-files'
170      examines, normally `.gitignore`.  Files in deeper
171      directories take precedence.  Patterns are ordered in the
172      same order they appear in the files.
174 A pattern specified on the command line with --exclude or read
175 from the file specified with --exclude-from is relative to the
176 top of the directory tree.  A pattern read from a file specified
177 by --exclude-per-directory is relative to the directory that the
178 pattern file appears in.
180 SEE ALSO
181 --------
182 linkgit:git-read-tree[1], linkgit:gitignore[5]
185 Author
186 ------
187 Written by Linus Torvalds <torvalds@osdl.org>
189 Documentation
190 --------------
191 Documentation by David Greaves, Junio C Hamano, Josh Triplett, and the git-list <git@vger.kernel.org>.
195 Part of the linkgit:git[7] suite