gitweb: Add git_merge sub
[git/gsoc2010-gitweb.git] / Documentation / git-ls-files.txt
blob3521637b582687978c088dc463e8784817a92217
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::
34 --cached::
35         Show cached files in the output (default)
37 -d::
38 --deleted::
39         Show deleted files in the output
41 -m::
42 --modified::
43         Show modified files in the output
45 -o::
46 --others::
47         Show other (i.e. untracked) files in the output
49 -i::
50 --ignored::
51         Show only ignored files in the output. When showing files in the
52         index, print only those matched by an exclude pattern. When
53         showing "other" files, show only those matched by an exclude
54         pattern.
56 -s::
57 --stage::
58         Show staged contents' object name, mode bits and stage number in the output.
60 --directory::
61         If a whole directory is classified as "other", show just its
62         name (with a trailing slash) and not its whole contents.
64 --no-empty-directory::
65         Do not list empty directories. Has no effect without --directory.
67 -u::
68 --unmerged::
69         Show unmerged files in the output (forces --stage)
71 -k::
72 --killed::
73         Show files on the filesystem that need to be removed due
74         to file/directory conflicts for checkout-index to
75         succeed.
77 -z::
78         \0 line termination on output.
80 -x <pattern>::
81 --exclude=<pattern>::
82         Skips files matching pattern.
83         Note that pattern is a shell wildcard pattern.
85 -X <file>::
86 --exclude-from=<file>::
87         exclude patterns are read from <file>; 1 per line.
89 --exclude-per-directory=<file>::
90         read additional exclude patterns that apply only to the
91         directory and its subdirectories in <file>.
93 --exclude-standard::
94         Add the standard git exclusions: .git/info/exclude, .gitignore
95         in each directory, and the user's global exclusion file.
97 --error-unmatch::
98         If any <file> does not appear in the index, treat this as an
99         error (return 1).
101 --with-tree=<tree-ish>::
102         When using --error-unmatch to expand the user supplied
103         <file> (i.e. path pattern) arguments to paths, pretend
104         that paths which were removed in the index since the
105         named <tree-ish> are still present.  Using this option
106         with `-s` or `-u` options does not make any sense.
108 -t::
109         Identify the file status with the following tags (followed by
110         a space) at the start of each line:
111         H::     cached
112         S::     skip-worktree
113         M::     unmerged
114         R::     removed/deleted
115         C::     modified/changed
116         K::     to be killed
117         ?::     other
119 -v::
120         Similar to `-t`, but use lowercase letters for files
121         that are marked as 'assume unchanged' (see
122         linkgit:git-update-index[1]).
124 --full-name::
125         When run from a subdirectory, the command usually
126         outputs paths relative to the current directory.  This
127         option forces paths to be output relative to the project
128         top directory.
130 --abbrev[=<n>]::
131         Instead of showing the full 40-byte hexadecimal object
132         lines, show only a partial prefix.
133         Non default number of digits can be specified with --abbrev=<n>.
135 \--::
136         Do not interpret any more arguments as options.
138 <file>::
139         Files to show. If no files are given all files which match the other
140         specified criteria are shown.
142 Output
143 ------
144 'git ls-files' just outputs the filenames unless '--stage' is specified in
145 which case it outputs:
147         [<tag> ]<mode> <object> <stage> <file>
149 'git ls-files --unmerged' and 'git ls-files --stage' can be used to examine
150 detailed information on unmerged paths.
152 For an unmerged path, instead of recording a single mode/SHA1 pair,
153 the index records up to three such pairs; one from tree O in stage
154 1, A in stage 2, and B in stage 3.  This information can be used by
155 the user (or the porcelain) to see what should eventually be recorded at the
156 path. (see linkgit:git-read-tree[1] for more information on state)
158 When `-z` option is not used, TAB, LF, and backslash characters
159 in pathnames are represented as `\t`, `\n`, and `\\`,
160 respectively.
163 Exclude Patterns
164 ----------------
166 'git ls-files' can use a list of "exclude patterns" when
167 traversing the directory tree and finding files to show when the
168 flags --others or --ignored are specified.  linkgit:gitignore[5]
169 specifies the format of exclude patterns.
171 These exclude patterns come from these places, in order:
173   1. The command line flag --exclude=<pattern> specifies a
174      single pattern.  Patterns are ordered in the same order
175      they appear in the command line.
177   2. The command line flag --exclude-from=<file> specifies a
178      file containing a list of patterns.  Patterns are ordered
179      in the same order they appear in the file.
181   3. command line flag --exclude-per-directory=<name> specifies
182      a name of the file in each directory 'git ls-files'
183      examines, normally `.gitignore`.  Files in deeper
184      directories take precedence.  Patterns are ordered in the
185      same order they appear in the files.
187 A pattern specified on the command line with --exclude or read
188 from the file specified with --exclude-from is relative to the
189 top of the directory tree.  A pattern read from a file specified
190 by --exclude-per-directory is relative to the directory that the
191 pattern file appears in.
193 SEE ALSO
194 --------
195 linkgit:git-read-tree[1], linkgit:gitignore[5]
198 Author
199 ------
200 Written by Linus Torvalds <torvalds@osdl.org>
202 Documentation
203 --------------
204 Documentation by David Greaves, Junio C Hamano, Josh Triplett, and the git-list <git@vger.kernel.org>.
208 Part of the linkgit:git[1] suite