add special "matching refs" refspec
[gitweb.git] / Documentation / git-ls-tree.txt
index 5bf6d8b613e4916fb4e98d1f873aa220ab76bb92..360c0a1b98698a8532ceb4969831d1038fde9acc 100644 (file)
@@ -3,12 +3,15 @@ git-ls-tree(1)
 
 NAME
 ----
-git-ls-tree - Lists the contents of a tree object
+git-ls-tree - List the contents of a tree object
 
 
 SYNOPSIS
 --------
-'git-ls-tree' [-d] [-r] [-t] [-z] [--name-only] [--name-status] <tree-ish> [paths...]
+[verse]
+'git-ls-tree' [-d] [-r] [-t] [-l] [-z]
+           [--name-only] [--name-status] [--full-name] [--abbrev=[<n>]]
+           <tree-ish> [paths...]
 
 DESCRIPTION
 -----------
@@ -33,6 +36,10 @@ OPTIONS
        Show tree entries even when going to recurse them. Has no effect
        if '-r' was not passed. '-d' implies '-t'.
 
+-l::
+--long::
+       Show object size of blob (file) entries.
+
 -z::
        \0 line termination on output.
 
@@ -40,6 +47,15 @@ OPTIONS
 --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 to the current working
+       directory, show the full path names.
+
 paths::
        When paths are given, show them (note that this isn't really raw
        pathnames, but rather a list of patterns to match).  Otherwise
@@ -53,6 +69,14 @@ Output Format
 When the `-z` option is not used, TAB, LF, and backslash characters
 in pathnames are represented as `\t`, `\n`, and `\\`, respectively.
 
+When the `-l` option is used, format changes to
+
+        <mode> SP <type> SP <object> SP <object size> TAB <file>
+
+Object size identified by <object> is given in bytes, and right-justified
+with minimum width of 7 characters.  Object size is given only for blobs
+(file) entries; for other entries `-` character is used in place of size.
+
 
 Author
 ------
@@ -65,9 +89,6 @@ 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
-
+Part of the linkgit:git[7] suite