blob: 3c786bd283ce839ca9339f0a8ac7412a1f985d3a [file] [log] [blame]
David Greaves2cf565c2005-05-10 22:32:30 +01001git-tar-tree(1)
2===============
David Greaves2cf565c2005-05-10 22:32:30 +01003
4NAME
5----
Junio C Hamanoc3f0baa2007-01-18 15:53:37 -08006git-tar-tree - Create a tar archive of the files in the named tree object
David Greaves2cf565c2005-05-10 22:32:30 +01007
8
9SYNOPSIS
10--------
Jonathan Niederb1889c32008-06-30 01:09:04 -050011'git tar-tree' [--remote=<repo>] <tree-ish> [ <base> ]
David Greaves2cf565c2005-05-10 22:32:30 +010012
13DESCRIPTION
14-----------
Thomas Rast0b444cd2010-01-10 00:33:00 +010015THIS COMMAND IS DEPRECATED. Use 'git archive' with `--format=tar`
Sam Vilain9f1beb72007-04-19 11:51:21 +120016option instead (and move the <base> argument to `--prefix=base/`).
Junio C Hamanofd88d9c2006-09-24 14:42:01 -070017
David Greaves2cf565c2005-05-10 22:32:30 +010018Creates a tar archive containing the tree structure for the named tree.
Johannes Schindelin2c6e4772005-08-05 17:05:02 +020019When <base> is specified it is added as a leading path to the files in the
David Greaves2cf565c2005-05-10 22:32:30 +010020generated tar archive.
21
Thomas Rast0b444cd2010-01-10 00:33:00 +010022'git tar-tree' behaves differently when given a tree ID versus when given
Rene Scharfed3a15c42005-06-02 20:50:42 +020023a commit ID or tag ID. In the first case the current time is used as
24modification time of each file in the archive. In the latter case the
25commit time as recorded in the referenced commit object is used instead.
26Additionally the commit ID is stored in a global extended pax header.
Thomas Rast0b444cd2010-01-10 00:33:00 +010027It can be extracted using 'git get-tar-commit-id'.
Rene Scharfed3a15c42005-06-02 20:50:42 +020028
Junio C Hamano34925d32006-06-07 11:15:10 -070029OPTIONS
30-------
31
32<tree-ish>::
33 The tree or commit to produce tar archive for. If it is
34 the object name of a commit object.
35
36<base>::
37 Leading path to the files in the resulting tar archive.
38
39--remote=<repo>::
40 Instead of making a tar archive from local repository,
41 retrieve a tar archive from a remote repository.
42
Willy Tarreauce1a79b2006-07-20 11:30:44 +020043CONFIGURATION
44-------------
Willy Tarreauce1a79b2006-07-20 11:30:44 +020045
René Scharfe687157c2007-08-21 20:01:16 +020046tar.umask::
47 This variable can be used to restrict the permission bits of
48 tar archive entries. The default is 0002, which turns off the
49 world write bit. The special value "user" indicates that the
50 archiving user's umask will be used instead. See umask(2) for
51 details.
Willy Tarreauce1a79b2006-07-20 11:30:44 +020052
53EXAMPLES
Junio C Hamano34925d32006-06-07 11:15:10 -070054--------
Rene Scharfe9236cdd2006-06-18 12:57:59 +020055git tar-tree HEAD junk | (cd /var/tmp/ && tar xf -)::
Junio C Hamano34925d32006-06-07 11:15:10 -070056
57 Create a tar archive that contains the contents of the
58 latest commit on the current branch, and extracts it in
59 `/var/tmp/junk` directory.
60
Rene Scharfe9236cdd2006-06-18 12:57:59 +020061git tar-tree v1.4.0 git-1.4.0 | gzip >git-1.4.0.tar.gz::
Junio C Hamano34925d32006-06-07 11:15:10 -070062
Rene Scharfe9236cdd2006-06-18 12:57:59 +020063 Create a tarball for v1.4.0 release.
Junio C Hamano34925d32006-06-07 11:15:10 -070064
Rene Scharfe9236cdd2006-06-18 12:57:59 +020065git tar-tree v1.4.0{caret}\{tree\} git-1.4.0 | gzip >git-1.4.0.tar.gz::
Junio C Hamano34925d32006-06-07 11:15:10 -070066
Rene Scharfe9236cdd2006-06-18 12:57:59 +020067 Create a tarball for v1.4.0 release, but without a
68 global extended pax header.
69
70git tar-tree --remote=example.com:git.git v1.4.0 >git-1.4.0.tar::
71
72 Get a tarball v1.4.0 from example.com.
David Greaves2cf565c2005-05-10 22:32:30 +010073
Johannes Schindelinb63fafd2006-07-31 02:26:27 +020074git tar-tree HEAD:Documentation/ git-docs > git-1.4.0-docs.tar::
75
76 Put everything in the current head's Documentation/ directory
77 into 'git-1.4.0-docs.tar', with the prefix 'git-docs/'.
78
David Greaves2cf565c2005-05-10 22:32:30 +010079Author
80------
Rene Scharfed3a15c42005-06-02 20:50:42 +020081Written by Rene Scharfe.
David Greaves2cf565c2005-05-10 22:32:30 +010082
83Documentation
84--------------
85Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
86
87GIT
88---
Christian Couder9e1f0a82008-06-06 09:07:32 +020089Part of the linkgit:git[1] suite