Documentation/git-ls-files.txt

   1 git-ls-files(1)
   2 ===============
   3
   4 NAME
   5 ----
   6 git-ls-files - Information about files in the index/working directory
   7
   8
   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                 [--error-unmatch]
  19                 [--full-name] [--] [<file>]\*
  20
  21 DESCRIPTION
  22 -----------
  23 This merges the file listing in the directory cache index with the
  24 actual working directory list, and shows different combinations of the
  25 two.
  26
  27 One or more of the options below may be used to determine the files
  28 shown:
  29
  30 OPTIONS
  31 -------
  32 -c|--cached::
  33         Show cached files in the output (default)
  34
  35 -d|--deleted::
  36         Show deleted files in the output
  37
  38 -m|--modified::
  39         Show modified files in the output
  40
  41 -o|--others::
  42         Show other files in the output
  43
  44 -i|--ignored::
  45         Show ignored files in the output
  46         Note the this also reverses any exclude list present.
  47
  48 -s|--stage::
  49         Show stage files in the output
  50
  51 --directory::
  52         If a whole directory is classified as "other", show just its
  53         name (with a trailing slash) and not its whole contents.
  54
  55 -u|--unmerged::
  56         Show unmerged files in the output (forces --stage)
  57
  58 -k|--killed::
  59         Show files on the filesystem that need to be removed due
  60         to file/directory conflicts for checkout-index to
  61         succeed.
  62
  63 -z::
  64         \0 line termination on output.
  65
  66 -x|--exclude=<pattern>::
  67         Skips files matching pattern.
  68         Note that pattern is a shell wildcard pattern.
  69
  70 -X|--exclude-from=<file>::
  71         exclude patterns are read from <file>; 1 per line.
  72
  73 --exclude-per-directory=<file>::
  74         read additional exclude patterns that apply only to the
  75         directory and its subdirectories in <file>.
  76
  77 --error-unmatch::
  78         If any <file> does not appear in the index, treat this as an
  79         error (return 1).
  80
  81 -t::
  82         Identify the file status with the following tags (followed by
  83         a space) at the start of each line:
  84         H::     cached
  85         M::     unmerged
  86         R::     removed/deleted
  87         C::     modified/changed
  88         K::     to be killed
  89         ?::     other
  90
  91 -v::
  92         Similar to `-t`, but use lowercase letters for files
  93         that are marked as 'always matching index'.
  94
  95 --full-name::
  96         When run from a subdirectory, the command usually
  97         outputs paths relative to the current directory.  This
  98         option forces paths to be output relative to the project
  99         top directory.
 100
 101 --::
 102         Do not interpret any more arguments as options.
 103
 104 <file>::
 105         Files to show. If no files are given all files which match the other
 106         specified criteria are shown.
 107
 108 Output
 109 ------
 110 show files just outputs the filename unless '--stage' is specified in
 111 which case it outputs:
 112
 113         [<tag> ]<mode> <object> <stage> <file>
 114
 115 "git-ls-files --unmerged" and "git-ls-files --stage" can be used to examine
 116 detailed information on unmerged paths.
 117
 118 For an unmerged path, instead of recording a single mode/SHA1 pair,
 119 the dircache records up to three such pairs; one from tree O in stage
 120 1, A in stage 2, and B in stage 3.  This information can be used by
 121 the user (or the porcelain) to see what should eventually be recorded at the
 122 path. (see git-read-tree for more information on state)
 123
 124 When `-z` option is not used, TAB, LF, and backslash characters
 125 in pathnames are represented as `\t`, `\n`, and `\\`,
 126 respectively.
 127
 128
 129 Exclude Patterns
 130 ----------------
 131
 132 'git-ls-files' can use a list of "exclude patterns" when
 133 traversing the directory tree and finding files to show when the
 134 flags --others or --ignored are specified.
 135
 136 These exclude patterns come from these places:
 137
 138   1. command line flag --exclude=<pattern> specifies a single
 139      pattern.
 140
 141   2. command line flag --exclude-from=<file> specifies a list of
 142      patterns stored in a file.
 143
 144   3. command line flag --exclude-per-directory=<name> specifies
 145      a name of the file in each directory 'git-ls-files'
 146      examines, and if exists, its contents are used as an
 147      additional list of patterns.
 148
 149 An exclude pattern file used by (2) and (3) contains one pattern
 150 per line.  A line that starts with a '#' can be used as comment
 151 for readability.
 152
 153 There are three lists of patterns that are in effect at a given
 154 time.  They are built and ordered in the following way:
 155
 156  * --exclude=<pattern> from the command line; patterns are
 157    ordered in the same order as they appear on the command line.
 158
 159  * lines read from --exclude-from=<file>; patterns are ordered
 160    in the same order as they appear in the file.
 161
 162  * When --exclude-per-directory=<name> is specified, upon
 163    entering a directory that has such a file, its contents are
 164    appended at the end of the current "list of patterns".  They
 165    are popped off when leaving the directory.
 166
 167 Each pattern in the pattern list specifies "a match pattern" and
 168 optionally the fate; either a file that matches the pattern is
 169 considered excluded or included.  A filename is matched against
 170 the patterns in the three lists; the --exclude-from list is
 171 checked first, then the --exclude-per-directory list, and then
 172 finally the --exclude list. The last match determines its fate.
 173 If there is no match in the three lists, the fate is "included".
 174
 175 A pattern specified on the command line with --exclude or read
 176 from the file specified with --exclude-from is relative to the
 177 top of the directory tree.  A pattern read from a file specified
 178 by --exclude-per-directory is relative to the directory that the
 179 pattern file appears in.
 180
 181 An exclude pattern is of the following format:
 182
 183  - an optional prefix '!' which means that the fate this pattern
 184    specifies is "include", not the usual "exclude"; the
 185    remainder of the pattern string is interpreted according to
 186    the following rules.
 187
 188  - if it does not contain a slash '/', it is a shell glob
 189    pattern and used to match against the filename without
 190    leading directories (i.e. the same way as the current
 191    implementation).
 192
 193  - otherwise, it is a shell glob pattern, suitable for
 194    consumption by fnmatch(3) with FNM_PATHNAME flag.  I.e. a
 195    slash in the pattern must match a slash in the pathname.
 196    "Documentation/\*.html" matches "Documentation/git.html" but
 197    not "ppc/ppc.html".  As a natural exception, "/*.c" matches
 198    "cat-file.c" but not "mozilla-sha1/sha1.c".
 199
 200 An example:
 201
 202 --------------------------------------------------------------
 203     $ cat .git/ignore
 204     # ignore objects and archives, anywhere in the tree.
 205     *.[oa]
 206     $ cat Documentation/.gitignore
 207     # ignore generated html files,
 208     *.html
 209     # except foo.html which is maintained by hand
 210     !foo.html
 211     $ git-ls-files --ignored \
 212         --exclude='Documentation/*.[0-9]' \
 213         --exclude-from=.git/ignore \
 214         --exclude-per-directory=.gitignore
 215 --------------------------------------------------------------
 216
 217
 218 See Also
 219 --------
 220 gitlink:git-read-tree[1]
 221
 222
 223 Author
 224 ------
 225 Written by Linus Torvalds <torvalds@osdl.org>
 226
 227 Documentation
 228 --------------
 229 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
 230
 231 GIT
 232 ---
 233 Part of the gitlink:git[7] suite
 234