Documentation: add missing docs make check-docs found.
[git.git] / Documentation / git-tar-tree.txt
1 git-tar-tree(1)
2 ===============
3
4 NAME
5 ----
6 git-tar-tree - Creates a tar archive of the files in the named tree
7
8
9 SYNOPSIS
10 --------
11 'git-tar-tree' [--remote=<repo>] <tree-ish> [ <base> ]
12
13 DESCRIPTION
14 -----------
15 Creates a tar archive containing the tree structure for the named tree.
16 When <base> is specified it is added as a leading path to the files in the
17 generated tar archive.
18
19 git-tar-tree behaves differently when given a tree ID versus when given
20 a commit ID or tag ID.  In the first case the current time is used as
21 modification time of each file in the archive.  In the latter case the
22 commit time as recorded in the referenced commit object is used instead.
23 Additionally the commit ID is stored in a global extended pax header.
24 It can be extracted using git-get-tar-commit-id.
25
26 OPTIONS
27 -------
28
29 <tree-ish>::
30         The tree or commit to produce tar archive for.  If it is
31         the object name of a commit object.
32
33 <base>::
34         Leading path to the files in the resulting tar archive.
35
36 --remote=<repo>::
37         Instead of making a tar archive from local repository,
38         retrieve a tar archive from a remote repository.
39
40 Examples
41 --------
42 git tar-tree HEAD | (cd /var/tmp/ && mkdir junk && tar Cxf junk -)::
43
44         Create a tar archive that contains the contents of the
45         latest commit on the current branch, and extracts it in
46         `/var/tmp/junk` directory.
47
48 git tar-tree v2.6.17 linux-2.6.17 | gzip >linux-2.6.17.tar.gz
49
50         Create a tarball for v2.6.17 release.
51
52 git tar-tree --remote=example.com:git.git v0.99 >git-0.99.tar
53
54         Get a tarball v0.99 from example.com.
55
56 Author
57 ------
58 Written by Rene Scharfe.
59
60 Documentation
61 --------------
62 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
63
64 GIT
65 ---
66 Part of the gitlink:git[7] suite
67