3ba2293c502f033d8a4783359b760e528a6e36fb
[git.git] / man1 / git-ls-tree.1
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "GIT-LS-TREE" 1 "" "" ""
21 .SH NAME
22 git-ls-tree \- Lists the contents of a tree object
23 .SH "SYNOPSIS"
24
25 .nf
26 \fIgit\-ls\-tree\fR [\-d] [\-r] [\-t] [\-z]
27             [\-\-name\-only] [\-\-name\-status] [\-\-full\-name] [\-\-abbrev=[<n>]]
28             <tree\-ish> [paths...]
29 .fi
30
31 .SH "DESCRIPTION"
32
33
34 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 \- \fIpaths\fR denote just a list of patterns to match, e\&.g\&. so specifying directory name (without \fI\-r\fR) will behave differently, and order of the arguments does not matter\&.
35
36 .SH "OPTIONS"
37
38 .TP
39 <tree\-ish>
40 Id of a tree\-ish\&.
41
42 .TP
43 \-d
44 Show only the named tree entry itself, not its children\&.
45
46 .TP
47 \-r
48 Recurse into sub\-trees\&.
49
50 .TP
51 \-t
52 Show tree entries even when going to recurse them\&. Has no effect if \fI\-r\fR was not passed\&. \fI\-d\fR implies \fI\-t\fR\&.
53
54 .TP
55 \-z
56 \\0 line termination on output\&.
57
58 .TP
59 \-\-name\-only, \-\-name\-status
60 List only filenames (instead of the "long" output), one per line\&.
61
62 .TP
63 \-\-abbrev[=<n>]
64 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>\&.
65
66 .TP
67 \-\-full\-name
68 Instead of showing the path names relative the current working directory, show the full path names\&.
69
70 .TP
71 paths
72 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\&.
73
74 .SH "OUTPUT FORMAT"
75
76 .nf
77 <mode> SP <type> SP <object> TAB <file>
78 .fi
79
80
81 When the \-z option is not used, TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and \\\\, respectively\&.
82
83 .SH "AUTHOR"
84
85
86 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>
87
88 .SH "DOCUMENTATION"
89
90
91 Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
92
93 .SH "GIT"
94
95
96 Part of the \fBgit\fR(7) suite
97