git-ls-tree(1)
==============
-v0.1, May 2005
NAME
----
-git-ls-tree - Displays a tree object in human readable form
+git-ls-tree - Lists the contents of a tree object
SYNOPSIS
--------
-'git-ls-tree' [-r] [-z] <tree-ish>
+'git-ls-tree' [-d] [-r] [-t] [-z] [--name-only] [--name-status] <tree-ish> [paths...]
DESCRIPTION
-----------
-Converts the tree object to a human readable (and script processable)
-form.
+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.
+ Id of a tree-ish.
+
+-d::
+ Show only the named tree entry itself, not its children.
-r::
- recurse into sub-trees
+ 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
+ \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>\t <type>\t <object>\t <file>
+ <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 Linus Torvalds <torvalds@osdl.org>
+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>.
+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 link:git.html[git] suite
+Part of the gitlink:git[7] suite