Documentation / git-tar-tree.txton commit documentation: trivial whitespace cleanups (240ae2b)
   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[verse]
  12'git tar-tree' [--remote=<repo>] <tree-ish> [ <base> ]
  13
  14DESCRIPTION
  15-----------
  16THIS COMMAND IS DEPRECATED.  Use 'git archive' with `--format=tar`
  17option instead (and move the <base> argument to `--prefix=base/`).
  18
  19Creates a tar archive containing the tree structure for the named tree.
  20When <base> is specified it is added as a leading path to the files in the
  21generated tar archive.
  22
  23'git tar-tree' behaves differently when given a tree ID versus when given
  24a commit ID or tag ID.  In the first case the current time is used as
  25modification time of each file in the archive.  In the latter case the
  26commit time as recorded in the referenced commit object is used instead.
  27Additionally the commit ID is stored in a global extended pax header.
  28It can be extracted using 'git get-tar-commit-id'.
  29
  30OPTIONS
  31-------
  32
  33<tree-ish>::
  34        The tree or commit to produce tar archive for.  If it is
  35        the object name of a commit object.
  36
  37<base>::
  38        Leading path to the files in the resulting tar archive.
  39
  40--remote=<repo>::
  41        Instead of making a tar archive from local repository,
  42        retrieve a tar archive from a remote repository.
  43
  44CONFIGURATION
  45-------------
  46
  47tar.umask::
  48        This variable can be used to restrict the permission bits of
  49        tar archive entries.  The default is 0002, which turns off the
  50        world write bit.  The special value "user" indicates that the
  51        archiving user's umask will be used instead.  See umask(2) for
  52        details.
  53
  54EXAMPLES
  55--------
  56`git tar-tree HEAD junk | (cd /var/tmp/ && tar xf -)`::
  57
  58        Create a tar archive that contains the contents of the
  59        latest commit on the current branch, and extracts it in
  60        `/var/tmp/junk` directory.
  61
  62`git tar-tree v1.4.0 git-1.4.0 | gzip >git-1.4.0.tar.gz`::
  63
  64        Create a tarball for v1.4.0 release.
  65
  66`git tar-tree v1.4.0^{tree} git-1.4.0 | gzip >git-1.4.0.tar.gz`::
  67
  68        Create a tarball for v1.4.0 release, but without a
  69        global extended pax header.
  70
  71`git tar-tree --remote=example.com:git.git v1.4.0 >git-1.4.0.tar`::
  72
  73        Get a tarball v1.4.0 from example.com.
  74
  75`git tar-tree HEAD:Documentation/ git-docs > git-1.4.0-docs.tar`::
  76
  77        Put everything in the current head's Documentation/ directory
  78        into 'git-1.4.0-docs.tar', with the prefix 'git-docs/'.
  79
  80GIT
  81---
  82Part of the linkgit:git[1] suite