Documentation / git-tar-tree.txton commit Merge branch 'jn/web' into next (8ec7e19)
   1git-tar-tree(1)
   2===============
   3
   4NAME
   5----
   6git-tar-tree - Creates a tar archive of the files in the named tree
   7
   8
   9SYNOPSIS
  10--------
  11'git-tar-tree' [--remote=<repo>] <tree-ish> [ <base> ]
  12
  13DESCRIPTION
  14-----------
  15Creates a tar archive containing the tree structure for the named tree.
  16When <base> is specified it is added as a leading path to the files in the
  17generated tar archive.
  18
  19git-tar-tree behaves differently when given a tree ID versus when given
  20a commit ID or tag ID.  In the first case the current time is used as
  21modification time of each file in the archive.  In the latter case the
  22commit time as recorded in the referenced commit object is used instead.
  23Additionally the commit ID is stored in a global extended pax header.
  24It can be extracted using git-get-tar-commit-id.
  25
  26OPTIONS
  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
  40Examples
  41--------
  42git tar-tree HEAD junk | (cd /var/tmp/ && tar xf -)::
  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
  48git tar-tree v1.4.0 git-1.4.0 | gzip >git-1.4.0.tar.gz::
  49
  50        Create a tarball for v1.4.0 release.
  51
  52git tar-tree v1.4.0{caret}\{tree\} git-1.4.0 | gzip >git-1.4.0.tar.gz::
  53
  54        Create a tarball for v1.4.0 release, but without a
  55        global extended pax header.
  56
  57git tar-tree --remote=example.com:git.git v1.4.0 >git-1.4.0.tar::
  58
  59        Get a tarball v1.4.0 from example.com.
  60
  61Author
  62------
  63Written by Rene Scharfe.
  64
  65Documentation
  66--------------
  67Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
  68
  69GIT
  70---
  71Part of the gitlink:git[7] suite
  72