documentation: clarify read-tree --reset
[git/jrn.git] / Documentation / git-cat-file.txt
blobab4dcae21caa190a41c19ec24b4dc2d71a5a73fb
1 git-cat-file(1)
2 ===============
4 NAME
5 ----
6 git-cat-file - Provide content or type information for repository objects
9 SYNOPSIS
10 --------
11 'git-cat-file' (-t | -s | <type>) <object>
13 DESCRIPTION
14 -----------
15 Provides content or type of objects in the repository. The type
16 is required unless '-t' is used to find the object type,
17 or '-s' is used to find the object size.
19 OPTIONS
20 -------
21 <object>::
22         The sha1 identifier of the object.
24 -t::
25         Instead of the content, show the object type identified by
26         <object>.
28 -s::
29         Instead of the content, show the object size identified by
30         <object>.
32 <type>::
33         Typically this matches the real type of <object> but asking
34         for a type that can trivially be dereferenced from the given
35         <object> is also permitted.  An example is to ask for a
36         "tree" with <object> being a commit object that contains it,
37         or to ask for a "blob" with <object> being a tag object that
38         points at it.
40 OUTPUT
41 ------
42 If '-t' is specified, one of the <type>.  If '-s' is specified,
43 the size of the <object> in bytes.
45 Otherwise the raw (though uncompressed) contents of the <object> will
46 be returned.
49 Author
50 ------
51 Written by Linus Torvalds <torvalds@osdl.org>
53 Documentation
54 --------------
55 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
57 GIT
58 ---
59 Part of the gitlink:git[7] suite