blob: 7b7859967326acaff157eab01da16b83c1342fcc [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:231git-ls-tree(1)
2==============
3
4NAME
5----
Junio C Hamano7c73c662007-01-19 00:37:506git-ls-tree - List the contents of a tree object
Junio C Hamano1a4e8412005-12-27 08:17:237
8
9SYNOPSIS
10--------
Junio C Hamano33db4372006-06-07 19:51:4511[verse]
Junio C Hamano7fd84172007-05-24 07:00:3212'git-ls-tree' [-d] [-r] [-t] [-l] [-z]
Junio C Hamano33db4372006-06-07 19:51:4513 [--name-only] [--name-status] [--full-name] [--abbrev=[<n>]]
14 <tree-ish> [paths...]
Junio C Hamano1a4e8412005-12-27 08:17:2315
16DESCRIPTION
17-----------
18Lists the contents of a given tree object, like what "/bin/ls -a" does
19in the current working directory. Note that the usage is subtly different,
20though - 'paths' denote just a list of patterns to match, e.g. so specifying
21directory name (without '-r') will behave differently, and order of the
22arguments does not matter.
23
24OPTIONS
25-------
26<tree-ish>::
27Id of a tree-ish.
28
29-d::
30Show only the named tree entry itself, not its children.
31
32-r::
33Recurse into sub-trees.
34
35-t::
36Show tree entries even when going to recurse them. Has no effect
37if '-r' was not passed. '-d' implies '-t'.
38
Junio C Hamano7fd84172007-05-24 07:00:3239-l::
40--long::
41Show object size of blob (file) entries.
42
Junio C Hamano1a4e8412005-12-27 08:17:2343-z::
44\0 line termination on output.
45
46--name-only::
47--name-status::
48List only filenames (instead of the "long" output), one per line.
49
Junio C Hamano5c3957e2006-03-28 00:28:0150--abbrev[=<n>]::
51Instead of showing the full 40-byte hexadecimal object
52lines, show only handful hexdigits prefix.
53Non default number of digits can be specified with --abbrev=<n>.
54
Junio C Hamano33db4372006-06-07 19:51:4555--full-name::
Junio C Hamanof1d14802006-06-08 00:48:1756Instead of showing the path names relative to the current working
Junio C Hamano33db4372006-06-07 19:51:4557directory, show the full path names.
58
Junio C Hamano1a4e8412005-12-27 08:17:2359paths::
60When paths are given, show them (note that this isn't really raw
61pathnames, but rather a list of patterns to match). Otherwise
62implicitly uses the root level of the tree as the sole path argument.
63
64
65Output Format
66-------------
67 <mode> SP <type> SP <object> TAB <file>
68
69When the `-z` option is not used, TAB, LF, and backslash characters
70in pathnames are represented as `\t`, `\n`, and `\\`, respectively.
71
Junio C Hamano7fd84172007-05-24 07:00:3272When the `-l` option is used, format changes to
73
74 <mode> SP <type> SP <object> SP <object size> TAB <file>
75
76Object size identified by <object> is given in bytes, and right-justified
77with minimum width of 7 characters. Object size is given only for blobs
78(file) entries; for other entries `-` character is used in place of size.
79
Junio C Hamano1a4e8412005-12-27 08:17:2380
81Author
82------
83Written by Petr Baudis <pasky@suse.cz>
84Completely rewritten from scratch by Junio C Hamano <junkio@cox.net>,
85another major rewrite by Linus Torvalds <torvalds@osdl.org>
86
87Documentation
88--------------
89Documentation by David Greaves, Junio C Hamano and the git-list
90<git@vger.kernel.org>.
91
Junio C Hamano1a4e8412005-12-27 08:17:2392GIT
93---
94Part of the gitlink:git[7] suite