Documentation/git-archive.txt

   1 git-archive(1)
   2 ==============
   3
   4 NAME
   5 ----
   6 git-archive - Creates an archive of files from a named tree
   7
   8
   9 SYNOPSIS
  10 --------
  11 'git-archive' --format=<fmt> [--list] [--prefix=<prefix>/] [<extra>]
  12               [--remote=<repo>] <tree-ish> [path...]
  13
  14 DESCRIPTION
  15 -----------
  16 Creates an archive of the specified format containing the tree
  17 structure for the named tree.  If <prefix> is specified it is
  18 prepended to the filenames in the archive.
  19
  20 'git-archive' behaves differently when given a tree ID versus when
  21 given a commit ID or tag ID.  In the first case the current time is
  22 used as modification time of each file in the archive.  In the latter
  23 case the commit time as recorded in the referenced commit object is
  24 used instead.  Additionally the commit ID is stored in a global
  25 extended pax header if the tar format is used; it can be extracted
  26 using 'git-get-tar-commit-id'. In ZIP files it is stored as a file
  27 comment.
  28
  29 OPTIONS
  30 -------
  31
  32 --format=<fmt>::
  33         Format of the resulting archive: 'tar', 'zip'...  The default
  34         is 'tar'.
  35
  36 --list, -l::
  37         Show all available formats.
  38
  39 --verbose, -v::
  40         Report progress to stderr.
  41
  42 --prefix=<prefix>/::
  43         Prepend <prefix>/ to each filename in the archive.
  44
  45 <extra>::
  46         This can be any options that the archiver backend understand.
  47         See next section.
  48
  49 --remote=<repo>::
  50         Instead of making a tar archive from local repository,
  51         retrieve a tar archive from a remote repository.
  52
  53 <tree-ish>::
  54         The tree or commit to produce an archive for.
  55
  56 path::
  57         If one or more paths are specified, include only these in the
  58         archive, otherwise include all files and subdirectories.
  59
  60 BACKEND EXTRA OPTIONS
  61 ---------------------
  62
  63 zip
  64 ~~~
  65 -0::
  66         Store the files instead of deflating them.
  67 -9::
  68         Highest and slowest compression level.  You can specify any
  69         number from 1 to 9 to adjust compression speed and ratio.
  70
  71
  72 CONFIGURATION
  73 -------------
  74 By default, file and directories modes are set to 0666 or 0777 in tar
  75 archives.  It is possible to change this by setting the "umask" variable
  76 in the repository configuration as follows :
  77
  78 [tar]
  79         umask = 002     ;# group friendly
  80
  81 The special umask value "user" indicates that the user's current umask
  82 will be used instead. The default value remains 0, which means world
  83 readable/writable files and directories.
  84
  85 EXAMPLES
  86 --------
  87 git archive --format=tar --prefix=junk/ HEAD | (cd /var/tmp/ && tar xf -)::
  88
  89         Create a tar archive that contains the contents of the
  90         latest commit on the current branch, and extracts it in
  91         `/var/tmp/junk` directory.
  92
  93 git archive --format=tar --prefix=git-1.4.0/ v1.4.0 | gzip >git-1.4.0.tar.gz::
  94
  95         Create a compressed tarball for v1.4.0 release.
  96
  97 git archive --format=tar --prefix=git-1.4.0/ v1.4.0{caret}\{tree\} | gzip >git-1.4.0.tar.gz::
  98
  99         Create a compressed tarball for v1.4.0 release, but without a
 100         global extended pax header.
 101
 102 git archive --format=zip --prefix=git-docs/ HEAD:Documentation/ > git-1.4.0-docs.zip::
 103
 104         Put everything in the current head's Documentation/ directory
 105         into 'git-1.4.0-docs.zip', with the prefix 'git-docs/'.
 106
 107 Author
 108 ------
 109 Written by Franck Bui-Huu and Rene Scharfe.
 110
 111 Documentation
 112 --------------
 113 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
 114
 115 GIT
 116 ---
 117 Part of the gitlink:git[7] suite