[thirdparty/git.git] / Documentation / git-ls-tree.txt

git-ls-tree(1)
==============

NAME
----
git-ls-tree - Lists the contents of a tree object.


SYNOPSIS
--------
'git-ls-tree' [-d] [-r] [-t] [-z] [--name-only] [--name-status] <tree-ish> [paths...]

DESCRIPTION
-----------
Lists the contents of a given tree object, like what "/bin/ls -a" does
in the current working directory. Note that the usage is subtly different,
though - 'paths' denote just a list of patterns to match, e.g. so specifying
directory name (without '-r') will behave differently, and order of the
arguments does not matter.

OPTIONS
-------
<tree-ish>::
	Id of a tree-ish.

-d::
	Show only the named tree entry itself, not its children.

-r::
	Recurse into sub-trees.

-t::
	Show tree entries even when going to recurse them. Has no effect
	if '-r' was not passed. '-d' implies '-t'.

-z::
	\0 line termination on output.

--name-only::
--name-status::
	List only filenames (instead of the "long" output), one per line.

paths::
	When paths are given, show them (note that this isn't really raw
	pathnames, but rather a list of patterns to match).  Otherwise
	implicitly uses the root level of the tree as the sole path argument.


Output Format
-------------
        <mode> SP <type> SP <object> TAB <file>

When the `-z` option is not used, TAB, LF, and backslash characters
in pathnames are represented as `\t`, `\n`, and `\\`, respectively.


Author
------
Written by Petr Baudis <pasky@suse.cz>
Completely rewritten from scratch by Junio C Hamano <junkio@cox.net>,
another major rewrite by Linus Torvalds <torvalds@osdl.org>

Documentation
--------------
Documentation by David Greaves, Junio C Hamano and the git-list
<git@vger.kernel.org>.

This manual page is a stub. You can help the git documentation by expanding it.

GIT
---
Part of the gitlink:git[7] suite
Commit	Line	Data
	1	git-ls-tree(1)
	2	==============
	3
	4	NAME
	5	----
	6	git-ls-tree - Lists the contents of a tree object.
	7
	8
	9	SYNOPSIS
	10	--------
	11	'git-ls-tree' [-d] [-r] [-t] [-z] [--name-only] [--name-status] <tree-ish> [paths...]
	12
	13	DESCRIPTION
	14	-----------
	15	Lists the contents of a given tree object, like what "/bin/ls -a" does
	16	in the current working directory. Note that the usage is subtly different,
	17	though - 'paths' denote just a list of patterns to match, e.g. so specifying
	18	directory name (without '-r') will behave differently, and order of the
	19	arguments does not matter.
	20
	21	OPTIONS
	22	-------
	23	<tree-ish>::
	24	Id of a tree-ish.
	25
	26	-d::
	27	Show only the named tree entry itself, not its children.
	28
	29	-r::
	30	Recurse into sub-trees.
	31
	32	-t::
	33	Show tree entries even when going to recurse them. Has no effect
	34	if '-r' was not passed. '-d' implies '-t'.
	35
	36	-z::
	37	\0 line termination on output.
	38
	39	--name-only::
	40	--name-status::
	41	List only filenames (instead of the "long" output), one per line.
	42
	43	paths::
	44	When paths are given, show them (note that this isn't really raw
	45	pathnames, but rather a list of patterns to match). Otherwise
	46	implicitly uses the root level of the tree as the sole path argument.
	47
	48
	49	Output Format
	50	-------------
	51	<mode> SP <type> SP <object> TAB <file>
	52
	53	When the `-z` option is not used, TAB, LF, and backslash characters
	54	in pathnames are represented as `\t`, `\n`, and `\\`, respectively.
	55
	56
	57	Author
	58	------
	59	Written by Petr Baudis <pasky@suse.cz>
	60	Completely rewritten from scratch by Junio C Hamano <junkio@cox.net>,
	61	another major rewrite by Linus Torvalds <torvalds@osdl.org>
	62
	63	Documentation
	64	--------------
	65	Documentation by David Greaves, Junio C Hamano and the git-list
	66	<git@vger.kernel.org>.
	67
	68	This manual page is a stub. You can help the git documentation by expanding it.
	69
	70	GIT
	71	---
	72	Part of the gitlink:git[7] suite
	73