X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=Documentation%2Fgit-tar-tree.txt;h=831537b6ffe5c53b8b1955fe7b4f8bac9a3df60d;hb=4514ad4fb77b3c68f69133c22b9c0d3b88ff058f;hp=7870e92ae9b394b80a0a0dfcfc888971eb00c356;hpb=f1a7eb36b017c62d9a007b6b8660bdeec3f94f97;p=git.git

diff --git a/Documentation/git-tar-tree.txt b/Documentation/git-tar-tree.txt
index 7870e92a..831537b6 100644
--- a/Documentation/git-tar-tree.txt
+++ b/Documentation/git-tar-tree.txt
@@ -1,6 +1,5 @@
 git-tar-tree(1)
 ===============
-v0.1, May 2005
 
 NAME
 ----
@@ -9,18 +8,54 @@ git-tar-tree - Creates a tar archive of the files in the named tree
 
 SYNOPSIS
 --------
-'git-tar-tree' <tree-ish> [ <base> ]
+'git-tar-tree' [--remote=<repo>] <tree-ish> [ <base> ]
 
 DESCRIPTION
 -----------
 Creates a tar archive containing the tree structure for the named tree.
-When <base> is specified it is added as a leading path as the files in the
+When <base> is specified it is added as a leading path to the files in the
 generated tar archive.
 
+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.
+
+OPTIONS
+-------
+
+<tree-ish>::
+	The tree or commit to produce tar archive for.  If it is
+	the object name of a commit object.
+
+<base>::
+	Leading path to the files in the resulting tar archive.
+
+--remote=<repo>::
+	Instead of making a tar archive from local repository,
+	retrieve a tar archive from a remote repository.
+
+Examples
+--------
+git tar-tree HEAD | (cd /var/tmp/ && mkdir junk && tar Cxf junk -)::
+
+	Create a tar archive that contains the contents of the
+	latest commit on the current branch, and extracts it in
+	`/var/tmp/junk` directory.
+
+git tar-tree v2.6.17 linux-2.6.17 | gzip >linux-2.6.17.tar.gz
+
+	Create a tarball for v2.6.17 release.
+
+git tar-tree --remote=example.com:git.git v0.99 >git-0.99.tar
+
+	Get a tarball v0.99 from example.com.
 
 Author
 ------
-Written by Linus Torvalds <torvalds@osdl.org>
+Written by Rene Scharfe.
 
 Documentation
 --------------
@@ -28,5 +63,5 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel
 
 GIT
 ---
-Part of the link:git.html[git] suite
+Part of the gitlink:git[7] suite