Documentation/git-tar-tree.txt

   1 git-tar-tree(1)
   2 ===============
   3
   4 NAME
   5 ----
   6 git-tar-tree - Create a tar archive of the files in the named tree object
   7
   8
   9 SYNOPSIS
  10 --------
  11 'git tar-tree' [--remote=<repo>] <tree-ish> [ <base> ]
  12
  13 DESCRIPTION
  14 -----------
  15 THIS COMMAND IS DEPRECATED.  Use 'git archive' with `--format=tar`
  16 option instead (and move the <base> argument to `--prefix=base/`).
  17
  18 Creates a tar archive containing the tree structure for the named tree.
  19 When <base> is specified it is added as a leading path to the files in the
  20 generated tar archive.
  21
  22 'git tar-tree' behaves differently when given a tree ID versus when given
  23 a commit ID or tag ID.  In the first case the current time is used as
  24 modification time of each file in the archive.  In the latter case the
  25 commit time as recorded in the referenced commit object is used instead.
  26 Additionally the commit ID is stored in a global extended pax header.
  27 It can be extracted using 'git get-tar-commit-id'.
  28
  29 OPTIONS
  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
  43 CONFIGURATION
  44 -------------
  45
  46 tar.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
  53 EXAMPLES
  54 --------
  55 git 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
  61 git 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
  65 git 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
  70 git 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
  74 git 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
  79 Author
  80 ------
  81 Written by Rene Scharfe.
  82
  83 Documentation
  84 --------------
  85 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
  86
  87 GIT
  88 ---
  89 Part of the linkgit:git[1] suite