Autogenerated HTML docs for v2.47.0-229-g8f8d6
[git-htmldocs.git] / git-cat-file.html
blob824f73c487b3b25d11b5ad8920a0a83842df2f53
1 <!DOCTYPE html>
2 <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
3 <head>
4 <meta charset="UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=edge"/>
6 <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
7 <meta name="generator" content="Asciidoctor 2.0.20"/>
8 <title>git-cat-file(1)</title>
9 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"/>
10 <style>
11 /*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
12 /* Uncomment the following line when using as a custom stylesheet */
13 /* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
14 html{font-family:sans-serif;-webkit-text-size-adjust:100%}
15 a{background:none}
16 a:focus{outline:thin dotted}
17 a:active,a:hover{outline:0}
18 h1{font-size:2em;margin:.67em 0}
19 b,strong{font-weight:bold}
20 abbr{font-size:.9em}
21 abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
22 dfn{font-style:italic}
23 hr{height:0}
24 mark{background:#ff0;color:#000}
25 code,kbd,pre,samp{font-family:monospace;font-size:1em}
26 pre{white-space:pre-wrap}
27 q{quotes:"\201C" "\201D" "\2018" "\2019"}
28 small{font-size:80%}
29 sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
30 sup{top:-.5em}
31 sub{bottom:-.25em}
32 img{border:0}
33 svg:not(:root){overflow:hidden}
34 figure{margin:0}
35 audio,video{display:inline-block}
36 audio:not([controls]){display:none;height:0}
37 fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
38 legend{border:0;padding:0}
39 button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
40 button,input{line-height:normal}
41 button,select{text-transform:none}
42 button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
43 button[disabled],html input[disabled]{cursor:default}
44 input[type=checkbox],input[type=radio]{padding:0}
45 button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
46 textarea{overflow:auto;vertical-align:top}
47 table{border-collapse:collapse;border-spacing:0}
48 *,::before,::after{box-sizing:border-box}
49 html,body{font-size:100%}
50 body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
51 a:hover{cursor:pointer}
52 img,object,embed{max-width:100%;height:auto}
53 object,embed{height:100%}
54 img{-ms-interpolation-mode:bicubic}
55 .left{float:left!important}
56 .right{float:right!important}
57 .text-left{text-align:left!important}
58 .text-right{text-align:right!important}
59 .text-center{text-align:center!important}
60 .text-justify{text-align:justify!important}
61 .hide{display:none}
62 img,object,svg{display:inline-block;vertical-align:middle}
63 textarea{height:auto;min-height:50px}
64 select{width:100%}
65 .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
66 div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
67 a{color:#2156a5;text-decoration:underline;line-height:inherit}
68 a:hover,a:focus{color:#1d4b8f}
69 a img{border:0}
70 p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
71 p aside{font-size:.875em;line-height:1.35;font-style:italic}
72 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
73 h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
74 h1{font-size:2.125em}
75 h2{font-size:1.6875em}
76 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
77 h4,h5{font-size:1.125em}
78 h6{font-size:1em}
79 hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
80 em,i{font-style:italic;line-height:inherit}
81 strong,b{font-weight:bold;line-height:inherit}
82 small{font-size:60%;line-height:inherit}
83 code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
84 ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
85 ul,ol{margin-left:1.5em}
86 ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
87 ul.circle{list-style-type:circle}
88 ul.disc{list-style-type:disc}
89 ul.square{list-style-type:square}
90 ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
91 ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
92 dl dt{margin-bottom:.3125em;font-weight:bold}
93 dl dd{margin-bottom:1.25em}
94 blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
95 blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
96 @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
97 h1{font-size:2.75em}
98 h2{font-size:2.3125em}
99 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
100 h4{font-size:1.4375em}}
101 table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
102 table thead,table tfoot{background:#f7f8f7}
103 table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
104 table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
105 table tr.even,table tr.alt{background:#f8f8f7}
106 table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
107 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
108 h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
109 .center{margin-left:auto;margin-right:auto}
110 .stretch{width:100%}
111 .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
112 .clearfix::after,.float-group::after{clear:both}
113 :not(pre).nobreak{word-wrap:normal}
114 :not(pre).nowrap{white-space:nowrap}
115 :not(pre).pre-wrap{white-space:pre-wrap}
116 :not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
117 pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
118 pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
119 pre>code{display:block}
120 pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
121 em em{font-style:normal}
122 strong strong{font-weight:400}
123 .keyseq{color:rgba(51,51,51,.8)}
124 kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
125 .keyseq kbd:first-child{margin-left:0}
126 .keyseq kbd:last-child{margin-right:0}
127 .menuseq,.menuref{color:#000}
128 .menuseq b:not(.caret),.menuref{font-weight:inherit}
129 .menuseq{word-spacing:-.02em}
130 .menuseq b.caret{font-size:1.25em;line-height:.8}
131 .menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
132 b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
133 b.button::before{content:"[";padding:0 3px 0 2px}
134 b.button::after{content:"]";padding:0 2px 0 3px}
135 p a>code:hover{color:rgba(0,0,0,.9)}
136 #header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
137 #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
138 #header::after,#content::after,#footnotes::after,#footer::after{clear:both}
139 #content{margin-top:1.25em}
140 #content::before{content:none}
141 #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
142 #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
143 #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
144 #header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
145 #header .details span:first-child{margin-left:-.125em}
146 #header .details span.email a{color:rgba(0,0,0,.85)}
147 #header .details br{display:none}
148 #header .details br+span::before{content:"\00a0\2013\00a0"}
149 #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
150 #header .details br+span#revremark::before{content:"\00a0|\00a0"}
151 #header #revnumber{text-transform:capitalize}
152 #header #revnumber::after{content:"\00a0"}
153 #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
154 #toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
155 #toc>ul{margin-left:.125em}
156 #toc ul.sectlevel0>li>a{font-style:italic}
157 #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
158 #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
159 #toc li{line-height:1.3334;margin-top:.3334em}
160 #toc a{text-decoration:none}
161 #toc a:active{text-decoration:underline}
162 #toctitle{color:#7a2518;font-size:1.2em}
163 @media screen and (min-width:768px){#toctitle{font-size:1.375em}
164 body.toc2{padding-left:15em;padding-right:0}
165 #toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
166 #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
167 #toc.toc2>ul{font-size:.9em;margin-bottom:0}
168 #toc.toc2 ul ul{margin-left:0;padding-left:1em}
169 #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
170 body.toc2.toc-right{padding-left:0;padding-right:15em}
171 body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
172 @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
173 #toc.toc2{width:20em}
174 #toc.toc2 #toctitle{font-size:1.375em}
175 #toc.toc2>ul{font-size:.95em}
176 #toc.toc2 ul ul{padding-left:1.25em}
177 body.toc2.toc-right{padding-left:0;padding-right:20em}}
178 #content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
179 #content #toc>:first-child{margin-top:0}
180 #content #toc>:last-child{margin-bottom:0}
181 #footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
182 #footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
183 #content{margin-bottom:.625em}
184 .sect1{padding-bottom:.625em}
185 @media screen and (min-width:768px){#content{margin-bottom:1.25em}
186 .sect1{padding-bottom:1.25em}}
187 .sect1:last-child{padding-bottom:0}
188 .sect1+.sect1{border-top:1px solid #e7e7e9}
189 #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
190 #content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
191 #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
192 #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
193 #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
194 details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
195 details{margin-left:1.25rem}
196 details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
197 details>summary::-webkit-details-marker{display:none}
198 details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
199 details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
200 details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
201 .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
202 table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
203 .paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
204 .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
205 .admonitionblock>table td.icon{text-align:center;width:80px}
206 .admonitionblock>table td.icon img{max-width:none}
207 .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
208 .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
209 .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
210 .exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
211 .sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
212 .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
213 .exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
214 .exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
215 .literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
216 @media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
217 @media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
218 .literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
219 .literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
220 .listingblock>.content{position:relative}
221 .listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
222 .listingblock:hover code[data-lang]::before{display:block}
223 .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
224 .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
225 .listingblock pre.highlightjs{padding:0}
226 .listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
227 .listingblock pre.prettyprint{border-width:0}
228 .prettyprint{background:#f7f7f8}
229 pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
230 pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
231 pre.prettyprint li code[data-lang]::before{opacity:1}
232 pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
233 table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
234 table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
235 table.linenotable td.code{padding-left:.75em}
236 table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
237 pre.pygments span.linenos{display:inline-block;margin-right:.75em}
238 .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
239 .quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
240 .quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
241 .quoteblock blockquote{margin:0;padding:0;border:0}
242 .quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
243 .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
244 .quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
245 .verseblock{margin:0 1em 1.25em}
246 .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
247 .verseblock pre strong{font-weight:400}
248 .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
249 .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
250 .quoteblock .attribution br,.verseblock .attribution br{display:none}
251 .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
252 .quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
253 .quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
254 .quoteblock.abstract{margin:0 1em 1.25em;display:block}
255 .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
256 .quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
257 .quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
258 .quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
259 .quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
260 p.tableblock:last-child{margin-bottom:0}
261 td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
262 td.tableblock>.content>:last-child{margin-bottom:-1.25em}
263 table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
264 table.grid-all>*>tr>*{border-width:1px}
265 table.grid-cols>*>tr>*{border-width:0 1px}
266 table.grid-rows>*>tr>*{border-width:1px 0}
267 table.frame-all{border-width:1px}
268 table.frame-ends{border-width:1px 0}
269 table.frame-sides{border-width:0 1px}
270 table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
271 table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
272 table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
273 table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
274 table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
275 th.halign-left,td.halign-left{text-align:left}
276 th.halign-right,td.halign-right{text-align:right}
277 th.halign-center,td.halign-center{text-align:center}
278 th.valign-top,td.valign-top{vertical-align:top}
279 th.valign-bottom,td.valign-bottom{vertical-align:bottom}
280 th.valign-middle,td.valign-middle{vertical-align:middle}
281 table thead th,table tfoot th{font-weight:bold}
282 tbody tr th{background:#f7f8f7}
283 tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
284 p.tableblock>code:only-child{background:none;padding:0}
285 p.tableblock{font-size:1em}
286 ol{margin-left:1.75em}
287 ul li ol{margin-left:1.5em}
288 dl dd{margin-left:1.125em}
289 dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
290 li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
291 ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
292 ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
293 ul.unstyled,ol.unstyled{margin-left:0}
294 li>p:empty:only-child::before{content:"";display:inline-block}
295 ul.checklist>li>p:first-child{margin-left:-1em}
296 ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
297 ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
298 ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
299 ul.inline>li{margin-left:1.25em}
300 .unstyled dl dt{font-weight:400;font-style:normal}
301 ol.arabic{list-style-type:decimal}
302 ol.decimal{list-style-type:decimal-leading-zero}
303 ol.loweralpha{list-style-type:lower-alpha}
304 ol.upperalpha{list-style-type:upper-alpha}
305 ol.lowerroman{list-style-type:lower-roman}
306 ol.upperroman{list-style-type:upper-roman}
307 ol.lowergreek{list-style-type:lower-greek}
308 .hdlist>table,.colist>table{border:0;background:none}
309 .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
310 td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
311 td.hdlist1{font-weight:bold;padding-bottom:1.25em}
312 td.hdlist2{word-wrap:anywhere}
313 .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
314 .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
315 .colist td:not([class]):first-child img{max-width:none}
316 .colist td:not([class]):last-child{padding:.25em 0}
317 .thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
318 .imageblock.left{margin:.25em .625em 1.25em 0}
319 .imageblock.right{margin:.25em 0 1.25em .625em}
320 .imageblock>.title{margin-bottom:0}
321 .imageblock.thumb,.imageblock.th{border-width:6px}
322 .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
323 .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
324 .image.left{margin-right:.625em}
325 .image.right{margin-left:.625em}
326 a.image{text-decoration:none;display:inline-block}
327 a.image object{pointer-events:none}
328 sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
329 sup.footnote a,sup.footnoteref a{text-decoration:none}
330 sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
331 #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
332 #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
333 #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
334 #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
335 #footnotes .footnote:last-of-type{margin-bottom:0}
336 #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
337 div.unbreakable{page-break-inside:avoid}
338 .big{font-size:larger}
339 .small{font-size:smaller}
340 .underline{text-decoration:underline}
341 .overline{text-decoration:overline}
342 .line-through{text-decoration:line-through}
343 .aqua{color:#00bfbf}
344 .aqua-background{background:#00fafa}
345 .black{color:#000}
346 .black-background{background:#000}
347 .blue{color:#0000bf}
348 .blue-background{background:#0000fa}
349 .fuchsia{color:#bf00bf}
350 .fuchsia-background{background:#fa00fa}
351 .gray{color:#606060}
352 .gray-background{background:#7d7d7d}
353 .green{color:#006000}
354 .green-background{background:#007d00}
355 .lime{color:#00bf00}
356 .lime-background{background:#00fa00}
357 .maroon{color:#600000}
358 .maroon-background{background:#7d0000}
359 .navy{color:#000060}
360 .navy-background{background:#00007d}
361 .olive{color:#606000}
362 .olive-background{background:#7d7d00}
363 .purple{color:#600060}
364 .purple-background{background:#7d007d}
365 .red{color:#bf0000}
366 .red-background{background:#fa0000}
367 .silver{color:#909090}
368 .silver-background{background:#bcbcbc}
369 .teal{color:#006060}
370 .teal-background{background:#007d7d}
371 .white{color:#bfbfbf}
372 .white-background{background:#fafafa}
373 .yellow{color:#bfbf00}
374 .yellow-background{background:#fafa00}
375 span.icon>.fa{cursor:default}
376 a span.icon>.fa{cursor:inherit}
377 .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
378 .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
379 .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
380 .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
381 .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
382 .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
383 .conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
384 .conum[data-value] *{color:#fff!important}
385 .conum[data-value]+b{display:none}
386 .conum[data-value]::after{content:attr(data-value)}
387 pre .conum[data-value]{position:relative;top:-.125em}
388 b.conum *{color:inherit!important}
389 .conum:not([data-value]):empty{display:none}
390 dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
391 h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
392 p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
393 p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
394 p{margin-bottom:1.25rem}
395 .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
396 .exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
397 .print-only{display:none!important}
398 @page{margin:1.25cm .75cm}
399 @media print{*{box-shadow:none!important;text-shadow:none!important}
400 html{font-size:80%}
401 a{color:inherit!important;text-decoration:underline!important}
402 a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
403 a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
404 abbr[title]{border-bottom:1px dotted}
405 abbr[title]::after{content:" (" attr(title) ")"}
406 pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
407 thead{display:table-header-group}
408 svg{max-width:100%}
409 p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
410 h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
411 #header,#content,#footnotes,#footer{max-width:none}
412 #toc,.sidebarblock,.exampleblock>.content{background:none!important}
413 #toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
414 body.book #header{text-align:center}
415 body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
416 body.book #header .details{border:0!important;display:block;padding:0!important}
417 body.book #header .details span:first-child{margin-left:0!important}
418 body.book #header .details br{display:block}
419 body.book #header .details br+span::before{content:none!important}
420 body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
421 body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
422 .listingblock code[data-lang]::before{display:block}
423 #footer{padding:0 .9375em}
424 .hide-on-print{display:none!important}
425 .print-only{display:block!important}
426 .hide-for-print{display:none!important}
427 .show-for-print{display:inherit!important}}
428 @media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
429 .sect1{padding:0!important}
430 .sect1+.sect1{border:0}
431 #footer{background:none}
432 #footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
433 @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
434 </style>
435 <style>
436 pre>code {
437 display: inline;
439 </style>
440 </head>
441 <body class="manpage">
442 <div id="header">
443 <h1>git-cat-file(1) Manual Page</h1>
444 <h2 id="_name">NAME</h2>
445 <div class="sectionbody">
446 <p>git-cat-file - Provide contents or details of repository objects</p>
447 </div>
448 </div>
449 <div id="content">
450 <div class="sect1">
451 <h2 id="_synopsis">SYNOPSIS</h2>
452 <div class="sectionbody">
453 <div class="verseblock">
454 <pre class="content"><em>git cat-file</em> &lt;type&gt; &lt;object&gt;
455 <em>git cat-file</em> (-e | -p) &lt;object&gt;
456 <em>git cat-file</em> (-t | -s) [--allow-unknown-type] &lt;object&gt;
457 <em>git cat-file</em> (--textconv | --filters)
458 [&lt;rev&gt;:&lt;path|tree-ish&gt; | --path=&lt;path|tree-ish&gt; &lt;rev&gt;]
459 <em>git cat-file</em> (--batch | --batch-check | --batch-command) [--batch-all-objects]
460 [--buffer] [--follow-symlinks] [--unordered]
461 [--textconv | --filters] [-Z]</pre>
462 </div>
463 </div>
464 </div>
465 <div class="sect1">
466 <h2 id="_description">DESCRIPTION</h2>
467 <div class="sectionbody">
468 <div class="paragraph">
469 <p>Output the contents or other properties such as size, type or delta
470 information of one or more objects.</p>
471 </div>
472 <div class="paragraph">
473 <p>This command can operate in two modes, depending on whether an option
474 from the <code>--batch</code> family is specified.</p>
475 </div>
476 <div class="paragraph">
477 <p>In non-batch mode, the command provides information on an object
478 named on the command line.</p>
479 </div>
480 <div class="paragraph">
481 <p>In batch mode, arguments are read from standard input.</p>
482 </div>
483 </div>
484 </div>
485 <div class="sect1">
486 <h2 id="_options">OPTIONS</h2>
487 <div class="sectionbody">
488 <div class="dlist">
489 <dl>
490 <dt class="hdlist1">&lt;object&gt;</dt>
491 <dd>
492 <p>The name of the object to show.
493 For a more complete list of ways to spell object names, see
494 the "SPECIFYING REVISIONS" section in <a href="gitrevisions.html">gitrevisions(7)</a>.</p>
495 </dd>
496 <dt class="hdlist1">-t</dt>
497 <dd>
498 <p>Instead of the content, show the object type identified by
499 <em>&lt;object&gt;</em>.</p>
500 </dd>
501 <dt class="hdlist1">-s</dt>
502 <dd>
503 <p>Instead of the content, show the object size identified by
504 <em>&lt;object&gt;</em>. If used with <code>--use-mailmap</code> option, will show
505 the size of updated object after replacing idents using the
506 mailmap mechanism.</p>
507 </dd>
508 <dt class="hdlist1">-e</dt>
509 <dd>
510 <p>Exit with zero status if <em>&lt;object&gt;</em> exists and is a valid
511 object. If <em>&lt;object&gt;</em> is of an invalid format, exit with non-zero
512 status and emit an error on stderr.</p>
513 </dd>
514 <dt class="hdlist1">-p</dt>
515 <dd>
516 <p>Pretty-print the contents of <em>&lt;object&gt;</em> based on its type.</p>
517 </dd>
518 <dt class="hdlist1">&lt;type&gt;</dt>
519 <dd>
520 <p>Typically this matches the real type of <em>&lt;object&gt;</em> but asking
521 for a type that can trivially be dereferenced from the given
522 <em>&lt;object&gt;</em> is also permitted. An example is to ask for a
523 "tree" with <em>&lt;object&gt;</em> being a commit object that contains it,
524 or to ask for a "blob" with <em>&lt;object&gt;</em> being a tag object that
525 points at it.</p>
526 </dd>
527 <dt class="hdlist1">--[no-]mailmap</dt>
528 <dt class="hdlist1">--[no-]use-mailmap</dt>
529 <dd>
530 <p>Use mailmap file to map author, committer and tagger names
531 and email addresses to canonical real names and email addresses.
532 See <a href="git-shortlog.html">git-shortlog(1)</a>.</p>
533 </dd>
534 <dt class="hdlist1">--textconv</dt>
535 <dd>
536 <p>Show the content as transformed by a textconv filter. In this case,
537 <em>&lt;object&gt;</em> has to be of the form <em>&lt;tree-ish&gt;</em><code>:</code><em>&lt;path&gt;</em>, or <code>:</code><em>&lt;path&gt;</em> in
538 order to apply the filter to the content recorded in the index at
539 <em>&lt;path&gt;</em>.</p>
540 </dd>
541 <dt class="hdlist1">--filters</dt>
542 <dd>
543 <p>Show the content as converted by the filters configured in
544 the current working tree for the given <em>&lt;path&gt;</em> (i.e. smudge filters,
545 end-of-line conversion, etc). In this case, <em>&lt;object&gt;</em> has to be of
546 the form <em>&lt;tree-ish&gt;</em><code>:</code><em>&lt;path&gt;</em>, or <code>:</code><em>&lt;path&gt;</em>.</p>
547 </dd>
548 <dt class="hdlist1">--path=&lt;path&gt;</dt>
549 <dd>
550 <p>For use with <code>--textconv</code> or <code>--filters</code>, to allow specifying an object
551 name and a path separately, e.g. when it is difficult to figure out
552 the revision from which the blob came.</p>
553 </dd>
554 <dt class="hdlist1">--batch</dt>
555 <dt class="hdlist1">--batch=&lt;format&gt;</dt>
556 <dd>
557 <p>Print object information and contents for each object provided
558 on stdin. May not be combined with any other options or arguments
559 except <code>--textconv</code>, <code>--filters</code>, or <code>--use-mailmap</code>.</p>
560 <div class="openblock">
561 <div class="content">
562 <div class="ulist">
563 <ul>
564 <li>
565 <p>When used with <code>--textconv</code> or <code>--filters</code>, the input lines
566 must specify the path, separated by whitespace. See the section
567 <code>BATCH</code> <code>OUTPUT</code> below for details.</p>
568 </li>
569 <li>
570 <p>When used with <code>--use-mailmap</code>, for commit and tag objects, the
571 contents part of the output shows the identities replaced using the
572 mailmap mechanism, while the information part of the output shows
573 the size of the object as if it actually recorded the replacement
574 identities.</p>
575 </li>
576 </ul>
577 </div>
578 </div>
579 </div>
580 </dd>
581 <dt class="hdlist1">--batch-check</dt>
582 <dt class="hdlist1">--batch-check=&lt;format&gt;</dt>
583 <dd>
584 <p>Print object information for each object provided on stdin. May not be
585 combined with any other options or arguments except <code>--textconv</code>, <code>--filters</code>
586 or <code>--use-mailmap</code>.</p>
587 <div class="openblock">
588 <div class="content">
589 <div class="ulist">
590 <ul>
591 <li>
592 <p>When used with <code>--textconv</code> or <code>--filters</code>, the input lines must
593 specify the path, separated by whitespace. See the section
594 <code>BATCH</code> <code>OUTPUT</code> below for details.</p>
595 </li>
596 <li>
597 <p>When used with <code>--use-mailmap</code>, for commit and tag objects, the
598 printed object information shows the size of the object as if the
599 identities recorded in it were replaced by the mailmap mechanism.</p>
600 </li>
601 </ul>
602 </div>
603 </div>
604 </div>
605 </dd>
606 <dt class="hdlist1">--batch-command</dt>
607 <dt class="hdlist1">--batch-command=&lt;format&gt;</dt>
608 <dd>
609 <p>Enter a command mode that reads commands and arguments from stdin. May
610 only be combined with <code>--buffer</code>, <code>--textconv</code>, <code>--use-mailmap</code> or
611 <code>--filters</code>.</p>
612 <div class="openblock">
613 <div class="content">
614 <div class="ulist">
615 <ul>
616 <li>
617 <p>When used with <code>--textconv</code> or <code>--filters</code>, the input lines must
618 specify the path, separated by whitespace. See the section
619 <code>BATCH</code> <code>OUTPUT</code> below for details.</p>
620 </li>
621 <li>
622 <p>When used with <code>--use-mailmap</code>, for commit and tag objects, the
623 <code>contents</code> command shows the identities replaced using the
624 mailmap mechanism, while the <code>info</code> command shows the size
625 of the object as if it actually recorded the replacement
626 identities.</p>
627 </li>
628 </ul>
629 </div>
630 </div>
631 </div>
632 <div class="paragraph">
633 <p><code>--batch-command</code> recognizes the following commands:</p>
634 </div>
635 <div class="openblock">
636 <div class="content">
637 <div class="dlist">
638 <dl>
639 <dt class="hdlist1">contents &lt;object&gt;</dt>
640 <dd>
641 <p>Print object contents for object reference <em>&lt;object&gt;</em>. This corresponds to
642 the output of <code>--batch</code>.</p>
643 </dd>
644 <dt class="hdlist1">info &lt;object&gt;</dt>
645 <dd>
646 <p>Print object info for object reference <em>&lt;object&gt;</em>. This corresponds to the
647 output of <code>--batch-check</code>.</p>
648 </dd>
649 <dt class="hdlist1">flush</dt>
650 <dd>
651 <p>Used with <code>--buffer</code> to execute all preceding commands that were issued
652 since the beginning or since the last flush was issued. When <code>--buffer</code>
653 is used, no output will come until a <code>flush</code> is issued. When <code>--buffer</code>
654 is not used, commands are flushed each time without issuing <code>flush</code>.</p>
655 </dd>
656 </dl>
657 </div>
658 </div>
659 </div>
660 </dd>
661 <dt class="hdlist1">--batch-all-objects</dt>
662 <dd>
663 <p>Instead of reading a list of objects on stdin, perform the
664 requested batch operation on all objects in the repository and
665 any alternate object stores (not just reachable objects).
666 Requires <code>--batch</code> or <code>--batch-check</code> be specified. By default,
667 the objects are visited in order sorted by their hashes; see
668 also <code>--unordered</code> below. Objects are presented as-is, without
669 respecting the "replace" mechanism of <a href="git-replace.html">git-replace(1)</a>.</p>
670 </dd>
671 <dt class="hdlist1">--buffer</dt>
672 <dd>
673 <p>Normally batch output is flushed after each object is output, so
674 that a process can interactively read and write from
675 <code>cat-file</code>. With this option, the output uses normal stdio
676 buffering; this is much more efficient when invoking
677 <code>--batch-check</code> or <code>--batch-command</code> on a large number of objects.</p>
678 </dd>
679 <dt class="hdlist1">--unordered</dt>
680 <dd>
681 <p>When <code>--batch-all-objects</code> is in use, visit objects in an
682 order which may be more efficient for accessing the object
683 contents than hash order. The exact details of the order are
684 unspecified, but if you do not require a specific order, this
685 should generally result in faster output, especially with
686 <code>--batch</code>. Note that <code>cat-file</code> will still show each object
687 only once, even if it is stored multiple times in the
688 repository.</p>
689 </dd>
690 <dt class="hdlist1">--allow-unknown-type</dt>
691 <dd>
692 <p>Allow <code>-s</code> or <code>-t</code> to query broken/corrupt objects of unknown type.</p>
693 </dd>
694 <dt class="hdlist1">--follow-symlinks</dt>
695 <dd>
696 <p>With <code>--batch</code> or <code>--batch-check</code>, follow symlinks inside the
697 repository when requesting objects with extended SHA-1
698 expressions of the form tree-ish:path-in-tree. Instead of
699 providing output about the link itself, provide output about
700 the linked-to object. If a symlink points outside the
701 tree-ish (e.g. a link to <code>/foo</code> or a root-level link to <code>..</code><code>/foo</code>),
702 the portion of the link which is outside the tree will be
703 printed.</p>
704 <div class="paragraph">
705 <p>This option does not (currently) work correctly when an object in the
706 index is specified (e.g. <code>:link</code> instead of <code>HEAD:link</code>) rather than
707 one in the tree.</p>
708 </div>
709 <div class="paragraph">
710 <p>This option cannot (currently) be used unless <code>--batch</code> or
711 <code>--batch-check</code> is used.</p>
712 </div>
713 <div class="paragraph">
714 <p>For example, consider a git repository containing:</p>
715 </div>
716 <div class="openblock">
717 <div class="content">
718 <div class="literalblock">
719 <div class="content">
720 <pre>f: a file containing "hello\n"
721 link: a symlink to f
722 dir/link: a symlink to ../f
723 plink: a symlink to ../f
724 alink: a symlink to /etc/passwd</pre>
725 </div>
726 </div>
727 </div>
728 </div>
729 <div class="paragraph">
730 <p>For a regular file <code>f</code>, <code>echo</code> <code>HEAD:f</code> | <code>git</code> <code>cat-file</code> <code>--batch</code> would print</p>
731 </div>
732 <div class="openblock">
733 <div class="content">
734 <div class="literalblock">
735 <div class="content">
736 <pre>ce013625030ba8dba906f756967f9e9ca394464a blob 6</pre>
737 </div>
738 </div>
739 </div>
740 </div>
741 <div class="paragraph">
742 <p>And <code>echo</code> <code>HEAD:link</code> | <code>git</code> <code>cat-file</code> <code>--batch</code> <code>--follow-symlinks</code> would
743 print the same thing, as would <code>HEAD:dir/link</code>, as they both point at
744 <code>HEAD:f</code>.</p>
745 </div>
746 <div class="paragraph">
747 <p>Without <code>--follow-symlinks</code>, these would print data about the symlink
748 itself. In the case of <code>HEAD:link</code>, you would see</p>
749 </div>
750 <div class="openblock">
751 <div class="content">
752 <div class="literalblock">
753 <div class="content">
754 <pre>4d1ae35ba2c8ec712fa2a379db44ad639ca277bd blob 1</pre>
755 </div>
756 </div>
757 </div>
758 </div>
759 <div class="paragraph">
760 <p>Both <code>plink</code> and <code>alink</code> point outside the tree, so they would
761 respectively print:</p>
762 </div>
763 <div class="openblock">
764 <div class="content">
765 <div class="literalblock">
766 <div class="content">
767 <pre>symlink 4
768 ../f</pre>
769 </div>
770 </div>
771 <div class="literalblock">
772 <div class="content">
773 <pre>symlink 11
774 /etc/passwd</pre>
775 </div>
776 </div>
777 </div>
778 </div>
779 </dd>
780 <dt class="hdlist1">-Z</dt>
781 <dd>
782 <p>Only meaningful with <code>--batch</code>, <code>--batch-check</code>, or
783 <code>--batch-command</code>; input and output is NUL-delimited instead of
784 newline-delimited.</p>
785 </dd>
786 <dt class="hdlist1">-z</dt>
787 <dd>
788 <p>Only meaningful with <code>--batch</code>, <code>--batch-check</code>, or
789 <code>--batch-command</code>; input is NUL-delimited instead of
790 newline-delimited. This option is deprecated in favor of
791 <code>-Z</code> as the output can otherwise be ambiguous.</p>
792 </dd>
793 </dl>
794 </div>
795 </div>
796 </div>
797 <div class="sect1">
798 <h2 id="_output">OUTPUT</h2>
799 <div class="sectionbody">
800 <div class="paragraph">
801 <p>If <code>-t</code> is specified, one of the <em>&lt;type&gt;</em>.</p>
802 </div>
803 <div class="paragraph">
804 <p>If <code>-s</code> is specified, the size of the <em>&lt;object&gt;</em> in bytes.</p>
805 </div>
806 <div class="paragraph">
807 <p>If <code>-e</code> is specified, no output, unless the <em>&lt;object&gt;</em> is malformed.</p>
808 </div>
809 <div class="paragraph">
810 <p>If <code>-p</code> is specified, the contents of <em>&lt;object&gt;</em> are pretty-printed.</p>
811 </div>
812 <div class="paragraph">
813 <p>If <em>&lt;type&gt;</em> is specified, the raw (though uncompressed) contents of the <em>&lt;object&gt;</em>
814 will be returned.</p>
815 </div>
816 </div>
817 </div>
818 <div class="sect1">
819 <h2 id="_batch_output">BATCH OUTPUT</h2>
820 <div class="sectionbody">
821 <div class="paragraph">
822 <p>If <code>--batch</code> or <code>--batch-check</code> is given, <code>cat-file</code> will read objects
823 from stdin, one per line, and print information about them in the same
824 order as they have been read. By default, the whole line is
825 considered as an object, as if it were fed to <a href="git-rev-parse.html">git-rev-parse(1)</a>.</p>
826 </div>
827 <div class="paragraph">
828 <p>When <code>--batch-command</code> is given, <code>cat-file</code> will read commands from stdin,
829 one per line, and print information based on the command given. With
830 <code>--batch-command</code>, the <code>info</code> command followed by an object will print
831 information about the object the same way <code>--batch-check</code> would, and the
832 <code>contents</code> command followed by an object prints contents in the same way
833 <code>--batch</code> would.</p>
834 </div>
835 <div class="paragraph">
836 <p>You can specify the information shown for each object by using a custom
837 <em>&lt;format&gt;</em>. The <em>&lt;format&gt;</em> is copied literally to stdout for each
838 object, with placeholders of the form %(<code>atom</code>) expanded, followed by a
839 newline. The available atoms are:</p>
840 </div>
841 <div class="dlist">
842 <dl>
843 <dt class="hdlist1"><code>objectname</code></dt>
844 <dd>
845 <p>The full hex representation of the object name.</p>
846 </dd>
847 <dt class="hdlist1"><code>objecttype</code></dt>
848 <dd>
849 <p>The type of the object (the same as <code>cat-file</code> <code>-t</code> reports).</p>
850 </dd>
851 <dt class="hdlist1"><code>objectsize</code></dt>
852 <dd>
853 <p>The size, in bytes, of the object (the same as <code>cat-file</code> <code>-s</code>
854 reports).</p>
855 </dd>
856 <dt class="hdlist1"><code>objectsize:disk</code></dt>
857 <dd>
858 <p>The size, in bytes, that the object takes up on disk. See the
859 note about on-disk sizes in the <code>CAVEATS</code> section below.</p>
860 </dd>
861 <dt class="hdlist1"><code>deltabase</code></dt>
862 <dd>
863 <p>If the object is stored as a delta on-disk, this expands to the
864 full hex representation of the delta base object name.
865 Otherwise, expands to the null OID (all zeroes). See <code>CAVEATS</code>
866 below.</p>
867 </dd>
868 <dt class="hdlist1"><code>rest</code></dt>
869 <dd>
870 <p>If this atom is used in the output string, input lines are split
871 at the first whitespace boundary. All characters before that
872 whitespace are considered to be the object name; characters
873 after that first run of whitespace (i.e., the "rest" of the
874 line) are output in place of the %(<code>rest</code>) atom.</p>
875 </dd>
876 </dl>
877 </div>
878 <div class="paragraph">
879 <p>If no format is specified, the default format is %(<code>objectname</code>)
880 %(<code>objecttype</code>) %(<code>objectsize</code>).</p>
881 </div>
882 <div class="paragraph">
883 <p>If <code>--batch</code> is specified, or if <code>--batch-command</code> is used with the <code>contents</code>
884 command, the object information is followed by the object contents (consisting
885 of %(<code>objectsize</code>) bytes), followed by a newline.</p>
886 </div>
887 <div class="paragraph">
888 <p>For example, <code>--batch</code> without a custom format would produce:</p>
889 </div>
890 <div class="listingblock">
891 <div class="content">
892 <pre>&lt;oid&gt; SP &lt;type&gt; SP &lt;size&gt; LF
893 &lt;contents&gt; LF</pre>
894 </div>
895 </div>
896 <div class="paragraph">
897 <p>Whereas <code>--batch-check=</code>'%(<code>objectname</code>) %(<code>objecttype</code>)' would produce:</p>
898 </div>
899 <div class="listingblock">
900 <div class="content">
901 <pre>&lt;oid&gt; SP &lt;type&gt; LF</pre>
902 </div>
903 </div>
904 <div class="paragraph">
905 <p>If a name is specified on stdin that cannot be resolved to an object in
906 the repository, then <code>cat-file</code> will ignore any custom format and print:</p>
907 </div>
908 <div class="listingblock">
909 <div class="content">
910 <pre>&lt;object&gt; SP missing LF</pre>
911 </div>
912 </div>
913 <div class="paragraph">
914 <p>If a name is specified that might refer to more than one object (an ambiguous short sha), then <code>cat-file</code> will ignore any custom format and print:</p>
915 </div>
916 <div class="listingblock">
917 <div class="content">
918 <pre>&lt;object&gt; SP ambiguous LF</pre>
919 </div>
920 </div>
921 <div class="paragraph">
922 <p>If <code>--follow-symlinks</code> is used, and a symlink in the repository points
923 outside the repository, then <code>cat-file</code> will ignore any custom format
924 and print:</p>
925 </div>
926 <div class="listingblock">
927 <div class="content">
928 <pre>symlink SP &lt;size&gt; LF
929 &lt;symlink&gt; LF</pre>
930 </div>
931 </div>
932 <div class="paragraph">
933 <p>The symlink will either be absolute (beginning with a <code>/</code>), or relative
934 to the tree root. For instance, if dir/link points to <code>..</code><code>/</code><code>..</code><code>/foo</code>, then
935 <em>&lt;symlink&gt;</em> will be <code>..</code><code>/foo</code>. <em>&lt;size&gt;</em> is the size of the symlink in bytes.</p>
936 </div>
937 <div class="paragraph">
938 <p>If <code>--follow-symlinks</code> is used, the following error messages will be
939 displayed:</p>
940 </div>
941 <div class="listingblock">
942 <div class="content">
943 <pre>&lt;object&gt; SP missing LF</pre>
944 </div>
945 </div>
946 <div class="paragraph">
947 <p>is printed when the initial symlink requested does not exist.</p>
948 </div>
949 <div class="listingblock">
950 <div class="content">
951 <pre>dangling SP &lt;size&gt; LF
952 &lt;object&gt; LF</pre>
953 </div>
954 </div>
955 <div class="paragraph">
956 <p>is printed when the initial symlink exists, but something that
957 it (transitive-of) points to does not.</p>
958 </div>
959 <div class="listingblock">
960 <div class="content">
961 <pre>loop SP &lt;size&gt; LF
962 &lt;object&gt; LF</pre>
963 </div>
964 </div>
965 <div class="paragraph">
966 <p>is printed for symlink loops (or any symlinks that
967 require more than 40 link resolutions to resolve).</p>
968 </div>
969 <div class="listingblock">
970 <div class="content">
971 <pre>notdir SP &lt;size&gt; LF
972 &lt;object&gt; LF</pre>
973 </div>
974 </div>
975 <div class="paragraph">
976 <p>is printed when, during symlink resolution, a file is used as a
977 directory name.</p>
978 </div>
979 <div class="paragraph">
980 <p>Alternatively, when <code>-Z</code> is passed, the line feeds in any of the above examples
981 are replaced with NUL terminators. This ensures that output will be parsable if
982 the output itself would contain a linefeed and is thus recommended for
983 scripting purposes.</p>
984 </div>
985 </div>
986 </div>
987 <div class="sect1">
988 <h2 id="_caveats">CAVEATS</h2>
989 <div class="sectionbody">
990 <div class="paragraph">
991 <p>Note that the sizes of objects on disk are reported accurately, but care
992 should be taken in drawing conclusions about which refs or objects are
993 responsible for disk usage. The size of a packed non-delta object may be
994 much larger than the size of objects which delta against it, but the
995 choice of which object is the base and which is the delta is arbitrary
996 and is subject to change during a repack.</p>
997 </div>
998 <div class="paragraph">
999 <p>Note also that multiple copies of an object may be present in the object
1000 database; in this case, it is undefined which copy&#8217;s size or delta base
1001 will be reported.</p>
1002 </div>
1003 </div>
1004 </div>
1005 <div class="sect1">
1006 <h2 id="_git">GIT</h2>
1007 <div class="sectionbody">
1008 <div class="paragraph">
1009 <p>Part of the <a href="git.html">git(1)</a> suite</p>
1010 </div>
1011 </div>
1012 </div>
1013 </div>
1014 <div id="footer">
1015 <div id="footer-text">
1016 Last updated 2024-09-03 13:52:44 -0700
1017 </div>
1018 </div>
1019 </body>
1020 </html>