Autogenerated man pages for v1.4.0-rc1-gfd7e
[git.git] / man1 / git-tar-tree.1
index 8e9f629..4c17895 100755 (executable)
@@ -23,7 +23,7 @@ git-tar-tree \- Creates a tar archive of the files in the named tree
 .SH "SYNOPSIS"
 
 
-git\-tar\-tree <tree\-ish> [ <base> ]
+\fIgit\-tar\-tree\fR [\-\-remote=<repo>] <tree\-ish> [ <base> ]
 
 .SH "DESCRIPTION"
 
@@ -33,6 +33,40 @@ Creates a tar archive containing the tree structure for the named tree\&. When <
 
 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\&.
 
+.SH "OPTIONS"
+
+.TP
+<tree\-ish>
+The tree or commit to produce tar archive for\&. If it is the object name of a commit object\&.
+
+.TP
+<base>
+Leading path to the files in the resulting tar archive\&.
+
+.TP
+\-\-remote=<repo>
+Instead of making a tar archive from local repository, retrieve a tar archive from a remote repository\&.
+
+.SH "EXAMPLES"
+
+.TP
+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
+
+.nf
+Create a tarball for v2\&.6\&.17 release\&.
+.fi
+
+
+git tar\-tree \-\-remote=example\&.com:git\&.git v0\&.99 >git\-0\&.99\&.tar
+
+.nf
+Get a tarball v0\&.99 from example\&.com\&.
+.fi
+
 .SH "AUTHOR"