Autogenerated man pages for v1.4.0-rc1-gfd7e
[git.git] / man1 / git-tar-tree.1
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "GIT-TAR-TREE" 1 "" "" ""
21 .SH NAME
22 git-tar-tree \- Creates a tar archive of the files in the named tree
23 .SH "SYNOPSIS"
24
25
26 \fIgit\-tar\-tree\fR [\-\-remote=<repo>] <tree\-ish> [ <base> ]
27
28 .SH "DESCRIPTION"
29
30
31 Creates a tar archive containing the tree structure for the named tree\&. When <base> is specified it is added as a leading path to the files in the generated tar archive\&.
32
33
34 git\-tar\-tree behaves differently when given a tree ID versus when given a commit ID or tag ID\&. In the first case the current time is used as modification time of each file in the archive\&. In the latter case the commit time as recorded in the referenced commit object is used instead\&. Additionally the commit ID is stored in a global extended pax header\&. It can be extracted using git\-get\-tar\-commit\-id\&.
35
36 .SH "OPTIONS"
37
38 .TP
39 <tree\-ish>
40 The tree or commit to produce tar archive for\&. If it is the object name of a commit object\&.
41
42 .TP
43 <base>
44 Leading path to the files in the resulting tar archive\&.
45
46 .TP
47 \-\-remote=<repo>
48 Instead of making a tar archive from local repository, retrieve a tar archive from a remote repository\&.
49
50 .SH "EXAMPLES"
51
52 .TP
53 git tar\-tree HEAD | (cd /var/tmp/ && mkdir junk && tar Cxf junk \-)
54 Create a tar archive that contains the contents of the latest commit on the current branch, and extracts it in /var/tmp/junk directory\&.
55
56
57 git tar\-tree v2\&.6\&.17 linux\-2\&.6\&.17 | gzip >linux\-2\&.6\&.17\&.tar\&.gz
58
59 .nf
60 Create a tarball for v2\&.6\&.17 release\&.
61 .fi
62
63
64 git tar\-tree \-\-remote=example\&.com:git\&.git v0\&.99 >git\-0\&.99\&.tar
65
66 .nf
67 Get a tarball v0\&.99 from example\&.com\&.
68 .fi
69
70 .SH "AUTHOR"
71
72
73 Written by Rene Scharfe\&.
74
75 .SH "DOCUMENTATION"
76
77
78 Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
79
80 .SH "GIT"
81
82
83 Part of the \fBgit\fR(7) suite
84