| blob | c691c533a0bff973a93ad63f40314b088a54ace9 |
1 '\" t
2 .\" Title: git-cat-file
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 2023-08-04
6 .\" Manual: Git Manual
7 .\" Source: Git 2.42.0.rc0
8 .\" Language: English
9 .\"
10 .TH "GIT\-CAT\-FILE" "1" "2023\-08\-04" "Git 2\&.42\&.0\&.rc0" "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-cat-file \- Provide content or type and size information for repository objects
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit cat\-file\fR <type> <object>
36 \fIgit cat\-file\fR (\-e | \-p) <object>
37 \fIgit cat\-file\fR (\-t | \-s) [\-\-allow\-unknown\-type] <object>
38 \fIgit cat\-file\fR (\-\-batch | \-\-batch\-check | \-\-batch\-command) [\-\-batch\-all\-objects]
39 [\-\-buffer] [\-\-follow\-symlinks] [\-\-unordered]
40 [\-\-textconv | \-\-filters] [\-Z]
41 \fIgit cat\-file\fR (\-\-textconv | \-\-filters)
42 [<rev>:<path|tree\-ish> | \-\-path=<path|tree\-ish> <rev>]
43 .fi
44 .sp
45 .SH "DESCRIPTION"
46 .sp
47 In its first form, the command provides the content or the type of an object in the repository\&. The type is required unless \fB\-t\fR or \fB\-p\fR is used to find the object type, or \fB\-s\fR is used to find the object size, or \fB\-\-textconv\fR or \fB\-\-filters\fR is used (which imply type "blob")\&.
48 .sp
49 In the second form, a list of objects (separated by linefeeds) is provided on stdin, and the SHA\-1, type, and size of each object is printed on stdout\&. The output format can be overridden using the optional \fB<format>\fR argument\&. If either \fB\-\-textconv\fR or \fB\-\-filters\fR was specified, the input is expected to list the object names followed by the path name, separated by a single whitespace, so that the appropriate drivers can be determined\&.
50 .SH "OPTIONS"
51 .PP
52 <object>
53 .RS 4
54 The name of the object to show\&. For a more complete list of ways to spell object names, see the "SPECIFYING REVISIONS" section in
55 \fBgitrevisions\fR(7)\&.
56 .RE
57 .PP
58 \-t
59 .RS 4
60 Instead of the content, show the object type identified by
61 \fB<object>\fR\&.
62 .RE
63 .PP
64 \-s
65 .RS 4
66 Instead of the content, show the object size identified by
67 \fB<object>\fR\&. If used with
68 \fB\-\-use\-mailmap\fR
69 option, will show the size of updated object after replacing idents using the mailmap mechanism\&.
70 .RE
71 .PP
72 \-e
73 .RS 4
74 Exit with zero status if
75 \fB<object>\fR
76 exists and is a valid object\&. If
77 \fB<object>\fR
78 is of an invalid format exit with non\-zero and emits an error on stderr\&.
79 .RE
80 .PP
81 \-p
82 .RS 4
83 Pretty\-print the contents of
84 \fB<object>\fR
85 based on its type\&.
86 .RE
87 .PP
88 <type>
89 .RS 4
90 Typically this matches the real type of
91 \fB<object>\fR
92 but asking for a type that can trivially be dereferenced from the given
93 \fB<object>\fR
94 is also permitted\&. An example is to ask for a "tree" with
95 \fB<object>\fR
96 being a commit object that contains it, or to ask for a "blob" with
97 \fB<object>\fR
98 being a tag object that points at it\&.
99 .RE
100 .PP
101 \-\-[no\-]mailmap, \-\-[no\-]use\-mailmap
102 .RS 4
103 Use mailmap file to map author, committer and tagger names and email addresses to canonical real names and email addresses\&. See
104 \fBgit-shortlog\fR(1)\&.
105 .RE
106 .PP
107 \-\-textconv
108 .RS 4
109 Show the content as transformed by a textconv filter\&. In this case,
110 \fB<object>\fR
111 has to be of the form
112 \fB<tree\-ish>:<path>\fR, or
113 \fB:<path>\fR
114 in order to apply the filter to the content recorded in the index at
115 \fB<path>\fR\&.
116 .RE
117 .PP
118 \-\-filters
119 .RS 4
120 Show the content as converted by the filters configured in the current working tree for the given
121 \fB<path>\fR
122 (i\&.e\&. smudge filters, end\-of\-line conversion, etc)\&. In this case,
123 \fB<object>\fR
124 has to be of the form
125 \fB<tree\-ish>:<path>\fR, or
126 \fB:<path>\fR\&.
127 .RE
128 .PP
129 \-\-path=<path>
130 .RS 4
131 For use with
132 \fB\-\-textconv\fR
133 or
134 \fB\-\-filters\fR, to allow specifying an object name and a path separately, e\&.g\&. when it is difficult to figure out the revision from which the blob came\&.
135 .RE
136 .PP
137 \-\-batch, \-\-batch=<format>
138 .RS 4
139 Print object information and contents for each object provided on stdin\&. May not be combined with any other options or arguments except
140 \fB\-\-textconv\fR,
141 \fB\-\-filters\fR, or
142 \fB\-\-use\-mailmap\fR\&.
143 .sp
144 .RS 4
145 .ie n \{\
146 \h'-04'\(bu\h'+03'\c
147 .\}
148 .el \{\
149 .sp -1
150 .IP \(bu 2.3
151 .\}
152 When used with
153 \fB\-\-textconv\fR
154 or
155 \fB\-\-filters\fR, the input lines must specify the path, separated by whitespace\&. See the section
156 \fBBATCH OUTPUT\fR
157 below for details\&.
158 .RE
159 .sp
160 .RS 4
161 .ie n \{\
162 \h'-04'\(bu\h'+03'\c
163 .\}
164 .el \{\
165 .sp -1
166 .IP \(bu 2.3
167 .\}
168 When used with
169 \fB\-\-use\-mailmap\fR, for commit and tag objects, the contents part of the output shows the identities replaced using the mailmap mechanism, while the information part of the output shows the size of the object as if it actually recorded the replacement identities\&.
170 .RE
171 .RE
172 .PP
173 \-\-batch\-check, \-\-batch\-check=<format>
174 .RS 4
175 Print object information for each object provided on stdin\&. May not be combined with any other options or arguments except
176 \fB\-\-textconv\fR,
177 \fB\-\-filters\fR
178 or
179 \fB\-\-use\-mailmap\fR\&.
180 .sp
181 .RS 4
182 .ie n \{\
183 \h'-04'\(bu\h'+03'\c
184 .\}
185 .el \{\
186 .sp -1
187 .IP \(bu 2.3
188 .\}
189 When used with
190 \fB\-\-textconv\fR
191 or
192 \fB\-\-filters\fR, the input lines must specify the path, separated by whitespace\&. See the section
193 \fBBATCH OUTPUT\fR
194 below for details\&.
195 .RE
196 .sp
197 .RS 4
198 .ie n \{\
199 \h'-04'\(bu\h'+03'\c
200 .\}
201 .el \{\
202 .sp -1
203 .IP \(bu 2.3
204 .\}
205 When used with
206 \fB\-\-use\-mailmap\fR, for commit and tag objects, the printed object information shows the size of the object as if the identities recorded in it were replaced by the mailmap mechanism\&.
207 .RE
208 .RE
209 .PP
210 \-\-batch\-command, \-\-batch\-command=<format>
211 .RS 4
212 Enter a command mode that reads commands and arguments from stdin\&. May only be combined with
213 \fB\-\-buffer\fR,
214 \fB\-\-textconv\fR,
215 \fB\-\-use\-mailmap\fR
216 or
217 \fB\-\-filters\fR\&.
218 .sp
219 .RS 4
220 .ie n \{\
221 \h'-04'\(bu\h'+03'\c
222 .\}
223 .el \{\
224 .sp -1
225 .IP \(bu 2.3
226 .\}
227 When used with
228 \fB\-\-textconv\fR
229 or
230 \fB\-\-filters\fR, the input lines must specify the path, separated by whitespace\&. See the section
231 \fBBATCH OUTPUT\fR
232 below for details\&.
233 .RE
234 .sp
235 .RS 4
236 .ie n \{\
237 \h'-04'\(bu\h'+03'\c
238 .\}
239 .el \{\
240 .sp -1
241 .IP \(bu 2.3
242 .\}
243 When used with
244 \fB\-\-use\-mailmap\fR, for commit and tag objects, the
245 \fBcontents\fR
246 command shows the identities replaced using the mailmap mechanism, while the
247 \fBinfo\fR
248 command shows the size of the object as if it actually recorded the replacement identities\&.
249 .RE
250 .sp
251 \fB\-\-batch\-command\fR
252 recognizes the following commands:
253 .PP
254 contents <object>
255 .RS 4
256 Print object contents for object reference
257 \fB<object>\fR\&. This corresponds to the output of
258 \fB\-\-batch\fR\&.
259 .RE
260 .PP
261 info <object>
262 .RS 4
263 Print object info for object reference
264 \fB<object>\fR\&. This corresponds to the output of
265 \fB\-\-batch\-check\fR\&.
266 .RE
267 .PP
268 flush
269 .RS 4
270 Used with
271 \fB\-\-buffer\fR
272 to execute all preceding commands that were issued since the beginning or since the last flush was issued\&. When
273 \fB\-\-buffer\fR
274 is used, no output will come until a
275 \fBflush\fR
276 is issued\&. When
277 \fB\-\-buffer\fR
278 is not used, commands are flushed each time without issuing
279 \fBflush\fR\&.
280 .RE
281 .RE
282 .PP
283 \-\-batch\-all\-objects
284 .RS 4
285 Instead of reading a list of objects on stdin, perform the requested batch operation on all objects in the repository and any alternate object stores (not just reachable objects)\&. Requires
286 \fB\-\-batch\fR
287 or
288 \fB\-\-batch\-check\fR
289 be specified\&. By default, the objects are visited in order sorted by their hashes; see also
290 \fB\-\-unordered\fR
291 below\&. Objects are presented as\-is, without respecting the "replace" mechanism of
292 \fBgit-replace\fR(1)\&.
293 .RE
294 .PP
295 \-\-buffer
296 .RS 4
297 Normally batch output is flushed after each object is output, so that a process can interactively read and write from
298 \fBcat\-file\fR\&. With this option, the output uses normal stdio buffering; this is much more efficient when invoking
299 \fB\-\-batch\-check\fR
300 or
301 \fB\-\-batch\-command\fR
302 on a large number of objects\&.
303 .RE
304 .PP
305 \-\-unordered
306 .RS 4
307 When
308 \fB\-\-batch\-all\-objects\fR
309 is in use, visit objects in an order which may be more efficient for accessing the object contents than hash order\&. The exact details of the order are unspecified, but if you do not require a specific order, this should generally result in faster output, especially with
310 \fB\-\-batch\fR\&. Note that
311 \fBcat\-file\fR
312 will still show each object only once, even if it is stored multiple times in the repository\&.
313 .RE
314 .PP
315 \-\-allow\-unknown\-type
316 .RS 4
317 Allow
318 \fB\-s\fR
319 or
320 \fB\-t\fR
321 to query broken/corrupt objects of unknown type\&.
322 .RE
323 .PP
324 \-\-follow\-symlinks
325 .RS 4
326 With
327 \fB\-\-batch\fR
328 or
329 \fB\-\-batch\-check\fR, follow symlinks inside the repository when requesting objects with extended SHA\-1 expressions of the form tree\-ish:path\-in\-tree\&. Instead of providing output about the link itself, provide output about the linked\-to object\&. If a symlink points outside the tree\-ish (e\&.g\&. a link to
330 \fB/foo\fR
331 or a root\-level link to
332 \fB\&.\&./foo\fR), the portion of the link which is outside the tree will be printed\&.
333 .sp
334 This option does not (currently) work correctly when an object in the index is specified (e\&.g\&.
335 \fB:link\fR
336 instead of
337 \fBHEAD:link\fR) rather than one in the tree\&.
338 .sp
339 This option cannot (currently) be used unless
340 \fB\-\-batch\fR
341 or
342 \fB\-\-batch\-check\fR
343 is used\&.
344 .sp
345 For example, consider a git repository containing:
346 .sp
347 .if n \{\
348 .RS 4
349 .\}
350 .nf
351 f: a file containing "hello\en"
352 link: a symlink to f
353 dir/link: a symlink to \&.\&./f
354 plink: a symlink to \&.\&./f
355 alink: a symlink to /etc/passwd
356 .fi
357 .if n \{\
358 .RE
359 .\}
360 .sp
361 For a regular file
362 \fBf\fR,
363 \fBecho HEAD:f | git cat\-file \-\-batch\fR
364 would print
365 .sp
366 .if n \{\
367 .RS 4
368 .\}
369 .nf
370 ce013625030ba8dba906f756967f9e9ca394464a blob 6
371 .fi
372 .if n \{\
373 .RE
374 .\}
375 .sp
376 And
377 \fBecho HEAD:link | git cat\-file \-\-batch \-\-follow\-symlinks\fR
378 would print the same thing, as would
379 \fBHEAD:dir/link\fR, as they both point at
380 \fBHEAD:f\fR\&.
381 .sp
382 Without
383 \fB\-\-follow\-symlinks\fR, these would print data about the symlink itself\&. In the case of
384 \fBHEAD:link\fR, you would see
385 .sp
386 .if n \{\
387 .RS 4
388 .\}
389 .nf
390 4d1ae35ba2c8ec712fa2a379db44ad639ca277bd blob 1
391 .fi
392 .if n \{\
393 .RE
394 .\}
395 .sp
396 Both
397 \fBplink\fR
398 and
399 \fBalink\fR
400 point outside the tree, so they would respectively print:
401 .sp
402 .if n \{\
403 .RS 4
404 .\}
405 .nf
406 symlink 4
407 \&.\&./f
408 .fi
409 .if n \{\
410 .RE
411 .\}
412 .sp
413 .if n \{\
414 .RS 4
415 .\}
416 .nf
417 symlink 11
418 /etc/passwd
419 .fi
420 .if n \{\
421 .RE
422 .\}
423 .RE
424 .PP
425 \-Z
426 .RS 4
427 Only meaningful with
428 \fB\-\-batch\fR,
429 \fB\-\-batch\-check\fR, or
430 \fB\-\-batch\-command\fR; input and output is NUL\-delimited instead of newline\-delimited\&.
431 .RE
432 .PP
433 \-z
434 .RS 4
435 Only meaningful with
436 \fB\-\-batch\fR,
437 \fB\-\-batch\-check\fR, or
438 \fB\-\-batch\-command\fR; input is NUL\-delimited instead of newline\-delimited\&. This option is deprecated in favor of
439 \fB\-Z\fR
440 as the output can otherwise be ambiguous\&.
441 .RE
442 .SH "OUTPUT"
443 .sp
444 If \fB\-t\fR is specified, one of the \fB<type>\fR\&.
445 .sp
446 If \fB\-s\fR is specified, the size of the \fB<object>\fR in bytes\&.
447 .sp
448 If \fB\-e\fR is specified, no output, unless the \fB<object>\fR is malformed\&.
449 .sp
450 If \fB\-p\fR is specified, the contents of \fB<object>\fR are pretty\-printed\&.
451 .sp
452 If \fB<type>\fR is specified, the raw (though uncompressed) contents of the \fB<object>\fR will be returned\&.
453 .SH "BATCH OUTPUT"
454 .sp
455 If \fB\-\-batch\fR or \fB\-\-batch\-check\fR is given, \fBcat\-file\fR will read objects from stdin, one per line, and print information about them\&. By default, the whole line is considered as an object, as if it were fed to \fBgit-rev-parse\fR(1)\&.
456 .sp
457 When \fB\-\-batch\-command\fR is given, \fBcat\-file\fR will read commands from stdin, one per line, and print information based on the command given\&. With \fB\-\-batch\-command\fR, the \fBinfo\fR command followed by an object will print information about the object the same way \fB\-\-batch\-check\fR would, and the \fBcontents\fR command followed by an object prints contents in the same way \fB\-\-batch\fR would\&.
458 .sp
459 You can specify the information shown for each object by using a custom \fB<format>\fR\&. The \fB<format>\fR is copied literally to stdout for each object, with placeholders of the form \fB%(atom)\fR expanded, followed by a newline\&. The available atoms are:
460 .PP
461 \fBobjectname\fR
462 .RS 4
463 The full hex representation of the object name\&.
464 .RE
465 .PP
466 \fBobjecttype\fR
467 .RS 4
468 The type of the object (the same as
469 \fBcat\-file \-t\fR
470 reports)\&.
471 .RE
472 .PP
473 \fBobjectsize\fR
474 .RS 4
475 The size, in bytes, of the object (the same as
476 \fBcat\-file \-s\fR
477 reports)\&.
478 .RE
479 .PP
480 \fBobjectsize:disk\fR
481 .RS 4
482 The size, in bytes, that the object takes up on disk\&. See the note about on\-disk sizes in the
483 \fBCAVEATS\fR
484 section below\&.
485 .RE
486 .PP
487 \fBdeltabase\fR
488 .RS 4
489 If the object is stored as a delta on\-disk, this expands to the full hex representation of the delta base object name\&. Otherwise, expands to the null OID (all zeroes)\&. See
490 \fBCAVEATS\fR
491 below\&.
492 .RE
493 .PP
494 \fBrest\fR
495 .RS 4
496 If this atom is used in the output string, input lines are split at the first whitespace boundary\&. All characters before that whitespace are considered to be the object name; characters after that first run of whitespace (i\&.e\&., the "rest" of the line) are output in place of the
497 \fB%(rest)\fR
498 atom\&.
499 .RE
500 .sp
501 If no format is specified, the default format is \fB%(objectname) %(objecttype) %(objectsize)\fR\&.
502 .sp
503 If \fB\-\-batch\fR is specified, or if \fB\-\-batch\-command\fR is used with the \fBcontents\fR command, the object information is followed by the object contents (consisting of \fB%(objectsize)\fR bytes), followed by a newline\&.
504 .sp
505 For example, \fB\-\-batch\fR without a custom format would produce:
506 .sp
507 .if n \{\
508 .RS 4
509 .\}
510 .nf
511 <oid> SP <type> SP <size> LF
512 <contents> LF
513 .fi
514 .if n \{\
515 .RE
516 .\}
517 .sp
518 .sp
519 Whereas \fB\-\-batch\-check=\*(Aq%(objectname) %(objecttype)\*(Aq\fR would produce:
520 .sp
521 .if n \{\
522 .RS 4
523 .\}
524 .nf
525 <oid> SP <type> LF
526 .fi
527 .if n \{\
528 .RE
529 .\}
530 .sp
531 .sp
532 If a name is specified on stdin that cannot be resolved to an object in the repository, then \fBcat\-file\fR will ignore any custom format and print:
533 .sp
534 .if n \{\
535 .RS 4
536 .\}
537 .nf
538 <object> SP missing LF
539 .fi
540 .if n \{\
541 .RE
542 .\}
543 .sp
544 .sp
545 If a name is specified that might refer to more than one object (an ambiguous short sha), then \fBcat\-file\fR will ignore any custom format and print:
546 .sp
547 .if n \{\
548 .RS 4
549 .\}
550 .nf
551 <object> SP ambiguous LF
552 .fi
553 .if n \{\
554 .RE
555 .\}
556 .sp
557 .sp
558 If \fB\-\-follow\-symlinks\fR is used, and a symlink in the repository points outside the repository, then \fBcat\-file\fR will ignore any custom format and print:
559 .sp
560 .if n \{\
561 .RS 4
562 .\}
563 .nf
564 symlink SP <size> LF
565 <symlink> LF
566 .fi
567 .if n \{\
568 .RE
569 .\}
570 .sp
571 .sp
572 The symlink will either be absolute (beginning with a \fB/\fR), or relative to the tree root\&. For instance, if dir/link points to \fB\&.\&./\&.\&./foo\fR, then \fB<symlink>\fR will be \fB\&.\&./foo\fR\&. \fB<size>\fR is the size of the symlink in bytes\&.
573 .sp
574 If \fB\-\-follow\-symlinks\fR is used, the following error messages will be displayed:
575 .sp
576 .if n \{\
577 .RS 4
578 .\}
579 .nf
580 <object> SP missing LF
581 .fi
582 .if n \{\
583 .RE
584 .\}
585 .sp
586 .sp
587 is printed when the initial symlink requested does not exist\&.
588 .sp
589 .if n \{\
590 .RS 4
591 .\}
592 .nf
593 dangling SP <size> LF
594 <object> LF
595 .fi
596 .if n \{\
597 .RE
598 .\}
599 .sp
600 .sp
601 is printed when the initial symlink exists, but something that it (transitive\-of) points to does not\&.
602 .sp
603 .if n \{\
604 .RS 4
605 .\}
606 .nf
607 loop SP <size> LF
608 <object> LF
609 .fi
610 .if n \{\
611 .RE
612 .\}
613 .sp
614 .sp
615 is printed for symlink loops (or any symlinks that require more than 40 link resolutions to resolve)\&.
616 .sp
617 .if n \{\
618 .RS 4
619 .\}
620 .nf
621 notdir SP <size> LF
622 <object> LF
623 .fi
624 .if n \{\
625 .RE
626 .\}
627 .sp
628 .sp
629 is printed when, during symlink resolution, a file is used as a directory name\&.
630 .sp
631 Alternatively, when \fB\-Z\fR is passed, the line feeds in any of the above examples are replaced with NUL terminators\&. This ensures that output will be parsable if the output itself would contain a linefeed and is thus recommended for scripting purposes\&.
632 .SH "CAVEATS"
633 .sp
634 Note that the sizes of objects on disk are reported accurately, but care should be taken in drawing conclusions about which refs or objects are responsible for disk usage\&. The size of a packed non\-delta object may be much larger than the size of objects which delta against it, but the choice of which object is the base and which is the delta is arbitrary and is subject to change during a repack\&.
635 .sp
636 Note also that multiple copies of an object may be present in the object database; in this case, it is undefined which copy\(cqs size or delta base will be reported\&.
637 .SH "GIT"
638 .sp
639 Part of the \fBgit\fR(1) suite