clone: factor out dir_exists() helper
[git/debian.git] / Documentation / git-ls-tree.txt
blob9dee7bef35fb1df1afa2fcabebe22043c66b6fba
1 git-ls-tree(1)
2 ==============
4 NAME
5 ----
6 git-ls-tree - List the contents of a tree object
9 SYNOPSIS
10 --------
11 [verse]
12 'git ls-tree' [-d] [-r] [-t] [-l] [-z]
13             [--name-only] [--name-status] [--full-name] [--full-tree] [--abbrev[=<n>]]
14             <tree-ish> [<path>...]
16 DESCRIPTION
17 -----------
18 Lists the contents of a given tree object, like what "/bin/ls -a" does
19 in the current working directory.  Note that:
21  - the behaviour is slightly different from that of "/bin/ls" in that the
22    '<path>' denotes just a list of patterns to match, e.g. so specifying
23    directory name (without `-r`) will behave differently, and order of the
24    arguments does not matter.
26  - the behaviour is similar to that of "/bin/ls" in that the '<path>' is
27    taken as relative to the current working directory.  E.g. when you are
28    in a directory 'sub' that has a directory 'dir', you can run 'git
29    ls-tree -r HEAD dir' to list the contents of the tree (that is
30    'sub/dir' in `HEAD`).  You don't want to give a tree that is not at the
31    root level (e.g. `git ls-tree -r HEAD:sub dir`) in this case, as that
32    would result in asking for 'sub/sub/dir' in the `HEAD` commit.
33    However, the current working directory can be ignored by passing
34    --full-tree option.
36 OPTIONS
37 -------
38 <tree-ish>::
39         Id of a tree-ish.
41 -d::
42         Show only the named tree entry itself, not its children.
44 -r::
45         Recurse into sub-trees.
47 -t::
48         Show tree entries even when going to recurse them. Has no effect
49         if `-r` was not passed. `-d` implies `-t`.
51 -l::
52 --long::
53         Show object size of blob (file) entries.
55 -z::
56         \0 line termination on output and do not quote filenames.
57         See OUTPUT FORMAT below for more information.
59 --name-only::
60 --name-status::
61         List only filenames (instead of the "long" output), one per line.
63 --abbrev[=<n>]::
64         Instead of showing the full 40-byte hexadecimal object
65         lines, show only a partial prefix.
66         Non default number of digits can be specified with --abbrev=<n>.
68 --full-name::
69         Instead of showing the path names relative to the current working
70         directory, show the full path names.
72 --full-tree::
73         Do not limit the listing to the current working directory.
74         Implies --full-name.
76 [<path>...]::
77         When paths are given, show them (note that this isn't really raw
78         pathnames, but rather a list of patterns to match).  Otherwise
79         implicitly uses the root level of the tree as the sole path argument.
82 Output Format
83 -------------
84         <mode> SP <type> SP <object> TAB <file>
86 This output format is compatible with what `--index-info --stdin` of
87 'git update-index' expects.
89 When the `-l` option is used, format changes to
91         <mode> SP <type> SP <object> SP <object size> TAB <file>
93 Object size identified by <object> is given in bytes, and right-justified
94 with minimum width of 7 characters.  Object size is given only for blobs
95 (file) entries; for other entries `-` character is used in place of size.
97 Without the `-z` option, pathnames with "unusual" characters are
98 quoted as explained for the configuration variable `core.quotePath`
99 (see linkgit:git-config[1]).  Using `-z` the filename is output
100 verbatim and the line is terminated by a NUL byte.
104 Part of the linkgit:git[1] suite