man1/git-ls-tree.1

   1 '\" t
   2 .\"     Title: git-ls-tree
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-09-30
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.47.0.rc0.18.ge9356ba3ea
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-LS\-TREE" "1" "2024-09-30" "Git 2\&.47\&.0\&.rc0\&.18\&.ge" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-ls-tree \- List the contents of a tree object
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit ls\-tree\fR [\-d] [\-r] [\-t] [\-l] [\-z]
  36             [\-\-name\-only] [\-\-name\-status] [\-\-object\-only] [\-\-full\-name] [\-\-full\-tree] [\-\-abbrev[=<n>]] [\-\-format=<format>]
  37             <tree\-ish> [<path>\&...\:]
  38 .fi
  39 .SH "DESCRIPTION"
  40 .sp
  41 Lists the contents of a given tree object, like what "/bin/ls \-a" does in the current working directory\&. Note that:
  42 .sp
  43 .RS 4
  44 .ie n \{\
  45 \h'-04'\(bu\h'+03'\c
  46 .\}
  47 .el \{\
  48 .sp -1
  49 .IP \(bu 2.3
  50 .\}
  51 the behaviour is slightly different from that of "/bin/ls" in that the
  52 \fI<path>\fR
  53 denotes just a list of patterns to match, e\&.g\&. so specifying directory name (without
  54 \fB\-r\fR) will behave differently, and order of the arguments does not matter\&.
  55 .RE
  56 .sp
  57 .RS 4
  58 .ie n \{\
  59 \h'-04'\(bu\h'+03'\c
  60 .\}
  61 .el \{\
  62 .sp -1
  63 .IP \(bu 2.3
  64 .\}
  65 the behaviour is similar to that of "/bin/ls" in that the
  66 \fI<path>\fR
  67 is taken as relative to the current working directory\&. E\&.g\&. when you are in a directory
  68 \fIsub\fR
  69 that has a directory
  70 \fIdir\fR, you can run
  71 \fIgit ls\-tree \-r HEAD dir\fR
  72 to list the contents of the tree (that is
  73 \fBsub/dir\fR
  74 in
  75 \fBHEAD\fR)\&. You don\(cqt want to give a tree that is not at the root level (e\&.g\&.
  76 \fBgit ls\-tree \-r HEAD:sub dir\fR) in this case, as that would result in asking for
  77 \fBsub/sub/dir\fR
  78 in the
  79 \fBHEAD\fR
  80 commit\&. However, the current working directory can be ignored by passing \-\-full\-tree option\&.
  81 .RE
  82 .SH "OPTIONS"
  83 .PP
  84 <tree\-ish>
  85 .RS 4
  86 Id of a tree\-ish\&.
  87 .RE
  88 .PP
  89 \-d
  90 .RS 4
  91 Show only the named tree entry itself, not its children\&.
  92 .RE
  93 .PP
  94 \-r
  95 .RS 4
  96 Recurse into sub\-trees\&.
  97 .RE
  98 .PP
  99 \-t
 100 .RS 4
 101 Show tree entries even when going to recurse them\&. Has no effect if
 102 \fB\-r\fR
 103 was not passed\&.
 104 \fB\-d\fR
 105 implies
 106 \fB\-t\fR\&.
 107 .RE
 108 .PP
 109 \-l, \-\-long
 110 .RS 4
 111 Show object size of blob (file) entries\&.
 112 .RE
 113 .PP
 114 \-z
 115 .RS 4
 116 \e0 line termination on output and do not quote filenames\&. See OUTPUT FORMAT below for more information\&.
 117 .RE
 118 .PP
 119 \-\-name\-only, \-\-name\-status
 120 .RS 4
 121 List only filenames (instead of the "long" output), one per line\&. Cannot be combined with
 122 \fB\-\-object\-only\fR\&.
 123 .RE
 124 .PP
 125 \-\-object\-only
 126 .RS 4
 127 List only names of the objects, one per line\&. Cannot be combined with
 128 \fB\-\-name\-only\fR
 129 or
 130 \fB\-\-name\-status\fR\&. This is equivalent to specifying
 131 \fB\-\-format=\*(Aq%(objectname)\*(Aq\fR, but for both this option and that exact format the command takes a hand\-optimized codepath instead of going through the generic formatting mechanism\&.
 132 .RE
 133 .PP
 134 \-\-abbrev[=<n>]
 135 .RS 4
 136 Instead of showing the full 40\-byte hexadecimal object lines, show the shortest prefix that is at least
 137 \fI<n>\fR
 138 hexdigits long that uniquely refers the object\&. Non default number of digits can be specified with \-\-abbrev=<n>\&.
 139 .RE
 140 .PP
 141 \-\-full\-name
 142 .RS 4
 143 Instead of showing the path names relative to the current working directory, show the full path names\&.
 144 .RE
 145 .PP
 146 \-\-full\-tree
 147 .RS 4
 148 Do not limit the listing to the current working directory\&. Implies \-\-full\-name\&.
 149 .RE
 150 .PP
 151 \-\-format=<format>
 152 .RS 4
 153 A string that interpolates
 154 \fB%(fieldname)\fR
 155 from the result being shown\&. It also interpolates
 156 \fB%%\fR
 157 to
 158 \fB%\fR, and
 159 \fB%xNN\fR
 160 where
 161 \fBNN\fR
 162 are hex digits interpolates to character with hex code
 163 \fBNN\fR; for example
 164 \fB%x00\fR
 165 interpolates to
 166 \fB\e0\fR
 167 (NUL),
 168 \fB%x09\fR
 169 to
 170 \fB\et\fR
 171 (TAB) and
 172 \fB%x0a\fR
 173 to
 174 \fB\en\fR
 175 (LF)\&. When specified,
 176 \fB\-\-format\fR
 177 cannot be combined with other format\-altering options, including
 178 \fB\-\-long\fR,
 179 \fB\-\-name\-only\fR
 180 and
 181 \fB\-\-object\-only\fR\&.
 182 .RE
 183 .PP
 184 [<path>\&...\:]
 185 .RS 4
 186 When paths are given, show them (note that this isn\(cqt 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\&.
 187 .RE
 188 .SH "OUTPUT FORMAT"
 189 .sp
 190 The output format of \fBls\-tree\fR is determined by either the \fB\-\-format\fR option, or other format\-altering options such as \fB\-\-name\-only\fR etc\&. (see \fB\-\-format\fR above)\&.
 191 .sp
 192 The use of certain \fB\-\-format\fR directives is equivalent to using those options, but invoking the full formatting machinery can be slower than using an appropriate formatting option\&.
 193 .sp
 194 In cases where the \fB\-\-format\fR would exactly map to an existing option \fBls\-tree\fR will use the appropriate faster path\&. Thus the default format is equivalent to:
 195 .sp
 196 .if n \{\
 197 .RS 4
 198 .\}
 199 .nf
 200 %(objectmode) %(objecttype) %(objectname)%x09%(path)
 201 .fi
 202 .if n \{\
 203 .RE
 204 .\}
 205 .sp
 206 This output format is compatible with what \fB\-\-index\-info \-\-stdin\fR of \fIgit update\-index\fR expects\&.
 207 .sp
 208 When the \fB\-l\fR option is used, format changes to
 209 .sp
 210 .if n \{\
 211 .RS 4
 212 .\}
 213 .nf
 214 %(objectmode) %(objecttype) %(objectname) %(objectsize:padded)%x09%(path)
 215 .fi
 216 .if n \{\
 217 .RE
 218 .\}
 219 .sp
 220 Object size identified by <objectname> 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 \fB\-\fR character is used in place of size\&.
 221 .sp
 222 Without the \fB\-z\fR option, pathnames with "unusual" characters are quoted as explained for the configuration variable \fBcore\&.quotePath\fR (see \fBgit-config\fR(1))\&. Using \fB\-z\fR the filename is output verbatim and the line is terminated by a NUL byte\&.
 223 .sp
 224 Customized format:
 225 .sp
 226 It is possible to print in a custom format by using the \fB\-\-format\fR option, which is able to interpolate different fields using a \fB%(fieldname)\fR notation\&. For example, if you only care about the "objectname" and "path" fields, you can execute with a specific "\-\-format" like
 227 .sp
 228 .if n \{\
 229 .RS 4
 230 .\}
 231 .nf
 232 git ls\-tree \-\-format=\*(Aq%(objectname) %(path)\*(Aq <tree\-ish>
 233 .fi
 234 .if n \{\
 235 .RE
 236 .\}
 237 .SH "FIELD NAMES"
 238 .sp
 239 Various values from structured fields can be used to interpolate into the resulting output\&. For each outputting line, the following names can be used:
 240 .PP
 241 objectmode
 242 .RS 4
 243 The mode of the object\&.
 244 .RE
 245 .PP
 246 objecttype
 247 .RS 4
 248 The type of the object (\fBcommit\fR,
 249 \fBblob\fR
 250 or
 251 \fBtree\fR)\&.
 252 .RE
 253 .PP
 254 objectname
 255 .RS 4
 256 The name of the object\&.
 257 .RE
 258 .PP
 259 objectsize[:padded]
 260 .RS 4
 261 The size of a
 262 \fBblob\fR
 263 object ("\-" if it\(cqs a
 264 \fBcommit\fR
 265 or
 266 \fBtree\fR)\&. It also supports a padded format of size with "%(objectsize:padded)"\&.
 267 .RE
 268 .PP
 269 path
 270 .RS 4
 271 The pathname of the object\&.
 272 .RE
 273 .SH "GIT"
 274 .sp
 275 Part of the \fBgit\fR(1) suite