Documentation/git-tar-tree.txt

   1 git-tar-tree(1)
   2 ===============
   3
   4 NAME
   5 ----
   6 git-tar-tree - Creates a tar archive of the files in the named tree
   7
   8
   9 SYNOPSIS
  10 --------
  11 'git-tar-tree' [--remote=<repo>] <tree-ish> [ <base> ]
  12
  13 DESCRIPTION
  14 -----------
  15 Creates a tar archive containing the tree structure for the named tree.
  16 When <base> is specified it is added as a leading path to the files in the
  17 generated tar archive.
  18
  19 git-tar-tree behaves differently when given a tree ID versus when given
  20 a commit ID or tag ID.  In the first case the current time is used as
  21 modification time of each file in the archive.  In the latter case the
  22 commit time as recorded in the referenced commit object is used instead.
  23 Additionally the commit ID is stored in a global extended pax header.
  24 It can be extracted using git-get-tar-commit-id.
  25
  26 OPTIONS
  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
  40 CONFIGURATION
  41 -------------
  42 By default, file and directories modes are set to 0666 or 0777. It is
  43 possible to change this by setting the "umask" variable in the
  44 repository configuration as follows :
  45
  46 [tar]
  47         umask = 002     ;# group friendly
  48
  49 The special umask value "user" indicates that the user's current umask
  50 will be used instead. The default value remains 0, which means world
  51 readable/writable files and directories.
  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 Author
  75 ------
  76 Written by Rene Scharfe.
  77
  78 Documentation
  79 --------------
  80 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
  81
  82 GIT
  83 ---
  84 Part of the gitlink:git[7] suite
  85