Documentation/git-archive.txt

   1 git-archive(1)
   2 ==============
   3
   4 NAME
   5 ----
   6 git-archive - Create an archive of files from a named tree
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git archive' --format=<fmt> [--list] [--prefix=<prefix>/] [<extra>]
  13               [--output=<file>]
  14               [--remote=<repo> [--exec=<git-upload-archive>]] <tree-ish>
  15               [path...]
  16
  17 DESCRIPTION
  18 -----------
  19 Creates an archive of the specified format containing the tree
  20 structure for the named tree, and writes it out to the standard
  21 output.  If <prefix> is specified it is
  22 prepended to the filenames in the archive.
  23
  24 'git-archive' behaves differently when given a tree ID versus when
  25 given a commit ID or tag ID.  In the first case the current time is
  26 used as modification time of each file in the archive.  In the latter
  27 case the commit time as recorded in the referenced commit object is
  28 used instead.  Additionally the commit ID is stored in a global
  29 extended pax header if the tar format is used; it can be extracted
  30 using 'git-get-tar-commit-id'. In ZIP files it is stored as a file
  31 comment.
  32
  33 OPTIONS
  34 -------
  35
  36 --format=<fmt>::
  37         Format of the resulting archive: 'tar' or 'zip'.  The default
  38         is 'tar'.
  39
  40 -l::
  41 --list::
  42         Show all available formats.
  43
  44 -v::
  45 --verbose::
  46         Report progress to stderr.
  47
  48 --prefix=<prefix>/::
  49         Prepend <prefix>/ to each filename in the archive.
  50
  51 --output=<file>::
  52         Write the archive to <file> instead of stdout.
  53
  54 <extra>::
  55         This can be any options that the archiver backend understand.
  56         See next section.
  57
  58 --remote=<repo>::
  59         Instead of making a tar archive from local repository,
  60         retrieve a tar archive from a remote repository.
  61
  62 --exec=<git-upload-archive>::
  63         Used with --remote to specify the path to the
  64         'git-upload-archive' on the remote side.
  65
  66 <tree-ish>::
  67         The tree or commit to produce an archive for.
  68
  69 path::
  70         If one or more paths are specified, include only these in the
  71         archive, otherwise include all files and subdirectories.
  72
  73 BACKEND EXTRA OPTIONS
  74 ---------------------
  75
  76 zip
  77 ~~~
  78 -0::
  79         Store the files instead of deflating them.
  80 -9::
  81         Highest and slowest compression level.  You can specify any
  82         number from 1 to 9 to adjust compression speed and ratio.
  83
  84
  85 CONFIGURATION
  86 -------------
  87
  88 tar.umask::
  89         This variable can be used to restrict the permission bits of
  90         tar archive entries.  The default is 0002, which turns off the
  91         world write bit.  The special value "user" indicates that the
  92         archiving user's umask will be used instead.  See umask(2) for
  93         details.
  94
  95 ATTRIBUTES
  96 ----------
  97
  98 export-ignore::
  99         Files and directories with the attribute export-ignore won't be
 100         added to archive files.  See linkgit:gitattributes[5] for details.
 101
 102 export-subst::
 103         If the attribute export-subst is set for a file then git will
 104         expand several placeholders when adding this file to an archive.
 105         See linkgit:gitattributes[5] for details.
 106
 107 EXAMPLES
 108 --------
 109 git archive --format=tar --prefix=junk/ HEAD | (cd /var/tmp/ && tar xf -)::
 110
 111         Create a tar archive that contains the contents of the
 112         latest commit on the current branch, and extracts it in
 113         `/var/tmp/junk` directory.
 114
 115 git archive --format=tar --prefix=git-1.4.0/ v1.4.0 | gzip >git-1.4.0.tar.gz::
 116
 117         Create a compressed tarball for v1.4.0 release.
 118
 119 git archive --format=tar --prefix=git-1.4.0/ v1.4.0{caret}\{tree\} | gzip >git-1.4.0.tar.gz::
 120
 121         Create a compressed tarball for v1.4.0 release, but without a
 122         global extended pax header.
 123
 124 git archive --format=zip --prefix=git-docs/ HEAD:Documentation/ > git-1.4.0-docs.zip::
 125
 126         Put everything in the current head's Documentation/ directory
 127         into 'git-1.4.0-docs.zip', with the prefix 'git-docs/'.
 128
 129
 130 SEE ALSO
 131 --------
 132 linkgit:gitattributes[5]
 133
 134 Author
 135 ------
 136 Written by Franck Bui-Huu and Rene Scharfe.
 137
 138 Documentation
 139 --------------
 140 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
 141
 142 GIT
 143 ---
 144 Part of the linkgit:git[1] suite