Document git-ls-tree --fullname

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

diff --git a/Documentation/git-ls-tree.txt b/Documentation/git-ls-tree.txt
index 958b56d..7e072b5 100644 (file)
--- a/Documentation/git-ls-tree.txt
+++ b/Documentation/git-ls-tree.txt
@@ -1,55 +1,83 @@
 git-ls-tree(1)
 ==============
-v0.1, May 2005
 
 NAME
 ----
-git-ls-tree - Lists the contents of a tree object.
+git-ls-tree - Lists the contents of a tree object
 
 
 SYNOPSIS
 --------
-'git-ls-tree' [-d] [-r] [-z] <tree-ish> [paths...]
+[verse]
+'git-ls-tree' [-d] [-r] [-t] [-z]
+           [--name-only] [--name-status] [--full-name] [--abbrev=[<n>]]
+           <tree-ish> [paths...]
 
 DESCRIPTION
 -----------
-Lists the contents of a tree object, like what "/bin/ls -a" does
-in the current working directory.
+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
+       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.
+
+--abbrev[=<n>]::
+       Instead of showing the full 40-byte hexadecimal object
+       lines, show only handful hexdigits prefix.
+       Non default number of digits can be specified with --abbrev=<n>.
+
+--full-name::
+       Instead of showing the path names relative the current working
+       directory, show the full path names.
 
 paths::
-       When paths are given, shows them.  Otherwise implicitly
-       uses the root level of the tree as the sole path argument.
+       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 Linus Torvalds <torvalds@osdl.org>
-Completely rewritten from scratch by Junio C Hamano <junkio@cox.net>
+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>.
 
 GIT
 ---
-Part of the link:git.html[git] suite
+Part of the gitlink:git[7] suite