7cc011a762ef7add96e3f568d1aa4b690d6d985c
[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
26 git\-ls\-tree [\-d] [\-r] [\-t] [\-z] [\-\-name\-only] [\-\-name\-status] <tree\-ish> [paths...]
27
28 .SH "DESCRIPTION"
29
30
31 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\&.
32
33 .SH "OPTIONS"
34
35 .TP
36 <tree\-ish>
37 Id of a tree\-ish\&.
38
39 .TP
40 \-d
41 Show only the named tree entry itself, not its children\&.
42
43 .TP
44 \-r
45 Recurse into sub\-trees\&.
46
47 .TP
48 \-t
49 Show tree entries even when going to recurse them\&. Has no effect if \-r was not passed\&. \-d implies \-t\&.
50
51 .TP
52 \-z
53 \\0 line termination on output\&.
54
55 .TP
56 \-\-name\-only, \-\-name\-status, 
57 List only filenames (instead of the "long" output), one per line\&.
58
59 .TP
60 paths
61 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\&.
62
63 .SH "OUTPUT FORMAT"
64
65 .nf
66 <mode> SP <type> SP <object> TAB <file>
67 .fi
68
69
70 When the \-z option is not used, TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and \\\\, respectively\&.
71
72 .SH "AUTHOR"
73
74
75 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>
76
77 .SH "DOCUMENTATION"
78
79
80 Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
81
82
83 This manual page is a stub\&. You can help the git documentation by expanding it\&.
84
85 .SH "GIT"
86
87
88 Part of the \fBgit\fR(7) suite
89