X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=Documentation%2Fgit-ls-files.txt;h=2f308ecda9d039224d2714e4cfd209422605430f;hb=ee34518d629331dadd58b1a75294369d679eda8b;hp=9c5ef8e7a41425a02eeda8b28fafa26907aa7f47;hpb=f5f2c52bb08a7fc5bde6a7eb6552235df9daca71;p=git.git diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt index 9c5ef8e7..2f308ecd 100644 --- a/Documentation/git-ls-files.txt +++ b/Documentation/git-ls-files.txt @@ -1,20 +1,19 @@ git-ls-files(1) =============== -v0.1, May 2005 NAME ---- -git-ls-files - Information about files in the cache/working directory +git-ls-files - Information about files in the index/working directory SYNOPSIS -------- 'git-ls-files' [-z] [-t] - (--[cached|deleted|others|ignored|stage|unmerged|killed])\* - (-[c|d|o|i|s|u|k])\* + (--[cached|deleted|others|ignored|stage|unmerged|killed|modified])\* + (-[c|d|o|i|s|u|k|m])\* [-x |--exclude=] [-X |--exclude-from=] - [--exclude-per-directory=] + [--exclude-per-directory=] [--] []\* DESCRIPTION ----------- @@ -33,6 +32,9 @@ OPTIONS -d|--deleted:: Show deleted files in the output +-m|--modified:: + Show modified files in the output + -o|--others:: Show other files in the output @@ -48,11 +50,11 @@ OPTIONS -k|--killed:: Show files on the filesystem that need to be removed due - to file/directory conflicts for checkout-cache to + to file/directory conflicts for checkout-index to succeed. -z:: - \0 line termination on output + \0 line termination on output. -x|--exclude=:: Skips files matching pattern. @@ -68,12 +70,20 @@ OPTIONS -t:: Identify the file status with the following tags (followed by a space) at the start of each line: - H cached - M unmerged - R removed/deleted - K to be killed + H:: cached + M:: unmerged + R:: removed/deleted + C:: modifed/changed + K:: to be killed ? other +--:: + Do not interpret any more arguments as options. + +:: + Files to show. If no files are given all files which match the other + specified criteria are shown. + Output ------ show files just outputs the filename unless '--stage' is specified in @@ -90,6 +100,10 @@ the dircache records up to three such pairs; one from tree O in stage the user (or the porcelain) to see what should eventually be recorded at the path. (see git-read-tree for more information on state) +When `-z` option is not used, TAB, LF, and backslash characters +in pathnames are represented as `\t`, `\n`, and `\\`, +respectively. + Exclude Patterns ---------------- @@ -100,13 +114,13 @@ flags --others or --ignored are specified. These exclude patterns come from these places: - (1) command line flag --exclude= specifies a single + 1. command line flag --exclude= specifies a single pattern. - (2) command line flag --exclude-from= specifies a list of + 2. command line flag --exclude-from= specifies a list of patterns stored in a file. - (3) command line flag --exclude-per-directory= specifies + 3. command line flag --exclude-per-directory= specifies a name of the file in each directory 'git-ls-files' examines, and if exists, its contents are used as an additional list of patterns. @@ -158,12 +172,13 @@ An exclude pattern is of the following format: - otherwise, it is a shell glob pattern, suitable for consumption by fnmatch(3) with FNM_PATHNAME flag. I.e. a slash in the pattern must match a slash in the pathname. - "Documentation/*.html" matches "Documentation/git.html" but + "Documentation/\*.html" matches "Documentation/git.html" but not "ppc/ppc.html". As a natural exception, "/*.c" matches "cat-file.c" but not "mozilla-sha1/sha1.c". An example: +-------------------------------------------------------------- $ cat .git/ignore # ignore objects and archives, anywhere in the tree. *.[oa] @@ -176,11 +191,12 @@ An example: --exclude='Documentation/*.[0-9]' \ --exclude-from=.git/ignore \ --exclude-per-directory=.gitignore +-------------------------------------------------------------- See Also -------- -link:git-read-tree.html[git-read-tree] +gitlink:git-read-tree[1] Author @@ -193,5 +209,5 @@ Documentation by David Greaves, Junio C Hamano and the git-list