Documentation / git-tar-tree.txton commit Merge branch 'np/malloc-threading' (ea5f75a)
   1git-tar-tree(1)
   2===============
   3
   4NAME
   5----
   6git-tar-tree - Create a tar archive of the files in the named tree object
   7
   8
   9SYNOPSIS
  10--------
  11'git tar-tree' [--remote=<repo>] <tree-ish> [ <base> ]
  12
  13DESCRIPTION
  14-----------
  15THIS COMMAND IS DEPRECATED.  Use 'git archive' with `--format=tar`
  16option instead (and move the <base> argument to `--prefix=base/`).
  17
  18Creates a tar archive containing the tree structure for the named tree.
  19When <base> is specified it is added as a leading path to the files in the
  20generated tar archive.
  21
  22'git tar-tree' behaves differently when given a tree ID versus when given
  23a 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.
  27It can be extracted using 'git get-tar-commit-id'.
  28
  29OPTIONS
  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
  43CONFIGURATION
  44-------------
  45
  46tar.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.
  52
  53EXAMPLES
  54--------
  55git tar-tree HEAD junk | (cd /var/tmp/ && tar xf -)::
  56
  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
  61git tar-tree v1.4.0 git-1.4.0 | gzip >git-1.4.0.tar.gz::
  62
  63        Create a tarball for v1.4.0 release.
  64
  65git tar-tree v1.4.0{caret}\{tree\} git-1.4.0 | gzip >git-1.4.0.tar.gz::
  66
  67        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.
  73
  74git 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
  79Author
  80------
  81Written by Rene Scharfe.
  82
  83Documentation
  84--------------
  85Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
  86
  87GIT
  88---
  89Part of the linkgit:git[1] suite