doc/source/en/TortoiseGit/git_doc/git-cat-file.html.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
   3 \r
   4 <article lang="en" id="git-cat-file(1)">\r
   5 <articleinfo>\r
   6     <title>git-cat-file(1)</title>\r
   7         <indexterm>\r
   8                 <primary>git-cat-file(1)</primary>\r
   9         </indexterm>\r
  10 </articleinfo>\r
  11 <simplesect id="_name">\r
  12 <title>NAME</title>\r
  13 <simpara>git-cat-file - Provide content or type/size information for repository objects</simpara>\r
  14 </simplesect>\r
  15 <simplesect id="_synopsis">\r
  16 <title>SYNOPSIS</title>\r
  17 <blockquote>\r
  18 <literallayout><emphasis>git cat-file</emphasis> [-t | -s | -e | -p | &lt;type&gt;] &lt;object&gt;\r
  19 <emphasis>git cat-file</emphasis> [--batch | --batch-check] &lt; &lt;list-of-objects&gt;</literallayout>\r
  20 </blockquote>\r
  21 </simplesect>\r
  22 <simplesect id="_description">\r
  23 <title>DESCRIPTION</title>\r
  24 <simpara>In the first form, provides content or type of objects in the repository. The\r
  25 type is required unless <emphasis>-t</emphasis> or <emphasis>-p</emphasis> is used to find the object type, or <emphasis>-s</emphasis>\r
  26 is used to find the object size.</simpara>\r
  27 <simpara>In the second form, a list of object (separated by LFs) is provided on stdin,\r
  28 and the SHA1, type, and size of each object is printed on stdout.</simpara>\r
  29 </simplesect>\r
  30 <simplesect id="_options">\r
  31 <title>OPTIONS</title>\r
  32 <variablelist>\r
  33 <varlistentry>\r
  34 <term>\r
  35 &lt;object&gt;\r
  36 </term>\r
  37 <listitem>\r
  38 <simpara>\r
  39         The name of the object to show.\r
  40         For a more complete list of ways to spell object names, see\r
  41         "SPECIFYING REVISIONS" section in <xref linkend="git-rev-parse(1)"/>.\r
  42 </simpara>\r
  43 </listitem>\r
  44 </varlistentry>\r
  45 <varlistentry>\r
  46 <term>\r
  47 -t\r
  48 </term>\r
  49 <listitem>\r
  50 <simpara>\r
  51         Instead of the content, show the object type identified by\r
  52         &lt;object&gt;.\r
  53 </simpara>\r
  54 </listitem>\r
  55 </varlistentry>\r
  56 <varlistentry>\r
  57 <term>\r
  58 -s\r
  59 </term>\r
  60 <listitem>\r
  61 <simpara>\r
  62         Instead of the content, show the object size identified by\r
  63         &lt;object&gt;.\r
  64 </simpara>\r
  65 </listitem>\r
  66 </varlistentry>\r
  67 <varlistentry>\r
  68 <term>\r
  69 -e\r
  70 </term>\r
  71 <listitem>\r
  72 <simpara>\r
  73         Suppress all output; instead exit with zero status if &lt;object&gt;\r
  74         exists and is a valid object.\r
  75 </simpara>\r
  76 </listitem>\r
  77 </varlistentry>\r
  78 <varlistentry>\r
  79 <term>\r
  80 -p\r
  81 </term>\r
  82 <listitem>\r
  83 <simpara>\r
  84         Pretty-print the contents of &lt;object&gt; based on its type.\r
  85 </simpara>\r
  86 </listitem>\r
  87 </varlistentry>\r
  88 <varlistentry>\r
  89 <term>\r
  90 &lt;type&gt;\r
  91 </term>\r
  92 <listitem>\r
  93 <simpara>\r
  94         Typically this matches the real type of &lt;object&gt; but asking\r
  95         for a type that can trivially be dereferenced from the given\r
  96         &lt;object&gt; is also permitted.  An example is to ask for a\r
  97         "tree" with &lt;object&gt; being a commit object that contains it,\r
  98         or to ask for a "blob" with &lt;object&gt; being a tag object that\r
  99         points at it.\r
 100 </simpara>\r
 101 </listitem>\r
 102 </varlistentry>\r
 103 <varlistentry>\r
 104 <term>\r
 105 --batch\r
 106 </term>\r
 107 <listitem>\r
 108 <simpara>\r
 109         Print the SHA1, type, size, and contents of each object provided on\r
 110         stdin. May not be combined with any other options or arguments.\r
 111 </simpara>\r
 112 </listitem>\r
 113 </varlistentry>\r
 114 <varlistentry>\r
 115 <term>\r
 116 --batch-check\r
 117 </term>\r
 118 <listitem>\r
 119 <simpara>\r
 120         Print the SHA1, type, and size of each object provided on stdin. May not be\r
 121         combined with any other options or arguments.\r
 122 </simpara>\r
 123 </listitem>\r
 124 </varlistentry>\r
 125 </variablelist>\r
 126 </simplesect>\r
 127 <simplesect id="_output">\r
 128 <title>OUTPUT</title>\r
 129 <simpara>If <emphasis>-t</emphasis> is specified, one of the &lt;type&gt;.</simpara>\r
 130 <simpara>If <emphasis>-s</emphasis> is specified, the size of the &lt;object&gt; in bytes.</simpara>\r
 131 <simpara>If <emphasis>-e</emphasis> is specified, no output.</simpara>\r
 132 <simpara>If <emphasis>-p</emphasis> is specified, the contents of &lt;object&gt; are pretty-printed.</simpara>\r
 133 <simpara>If &lt;type&gt; is specified, the raw (though uncompressed) contents of the &lt;object&gt;\r
 134 will be returned.</simpara>\r
 135 <simpara>If <emphasis>--batch</emphasis> is specified, output of the following form is printed for each\r
 136 object specified on stdin:</simpara>\r
 137 <literallayout>&lt;sha1&gt; SP &lt;type&gt; SP &lt;size&gt; LF\r
 138 &lt;contents&gt; LF</literallayout>\r
 139 <simpara>If <emphasis>--batch-check</emphasis> is specified, output of the following form is printed for\r
 140 each object specified on stdin:</simpara>\r
 141 <literallayout>&lt;sha1&gt; SP &lt;type&gt; SP &lt;size&gt; LF</literallayout>\r
 142 <simpara>For both <emphasis>--batch</emphasis> and <emphasis>--batch-check</emphasis>, output of the following form is printed\r
 143 for each object specified on stdin that does not exist in the repository:</simpara>\r
 144 <literallayout>&lt;object&gt; SP missing LF</literallayout>\r
 145 </simplesect>\r
 146 <simplesect id="_author">\r
 147 <title>Author</title>\r
 148 <simpara>Written by Linus Torvalds &lt;<ulink url="mailto:torvalds@osdl.org">torvalds@osdl.org</ulink>&gt;</simpara>\r
 149 </simplesect>\r
 150 <simplesect id="_documentation">\r
 151 <title>Documentation</title>\r
 152 <simpara>Documentation by David Greaves, Junio C Hamano and the git-list &lt;<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>&gt;.</simpara>\r
 153 </simplesect>\r
 154 <simplesect id="_git">\r
 155 <title>GIT</title>\r
 156 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
 157 </simplesect>\r
 158 </article>\r