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               [-o | --output=<file>] [--worktree-attributes]
  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 the 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'. If this option
  38         is not given, and the output file is specified, the format is
  39         inferred from the filename if possible (e.g. writing to "foo.zip"
  40         makes the output to be in the zip format). Otherwise the output
  41         format is `tar`.
  42
  43 -l::
  44 --list::
  45         Show all available formats.
  46
  47 -v::
  48 --verbose::
  49         Report progress to stderr.
  50
  51 --prefix=<prefix>/::
  52         Prepend <prefix>/ to each filename in the archive.
  53
  54 -o <file>::
  55 --output=<file>::
  56         Write the archive to <file> instead of stdout.
  57
  58 --worktree-attributes::
  59         Look for attributes in .gitattributes in working directory too.
  60
  61 <extra>::
  62         This can be any options that the archiver backend understands.
  63         See next section.
  64
  65 --remote=<repo>::
  66         Instead of making a tar archive from the local repository,
  67         retrieve a tar archive from a remote repository.
  68
  69 --exec=<git-upload-archive>::
  70         Used with --remote to specify the path to the
  71         'git-upload-archive' on the remote side.
  72
  73 <tree-ish>::
  74         The tree or commit to produce an archive for.
  75
  76 <path>::
  77         Without an optional path parameter, all files and subdirectories
  78         of the current working directory are included in the archive.
  79         If one or more paths are specified, only these are included.
  80
  81 BACKEND EXTRA OPTIONS
  82 ---------------------
  83
  84 zip
  85 ~~~
  86 -0::
  87         Store the files instead of deflating them.
  88 -9::
  89         Highest and slowest compression level.  You can specify any
  90         number from 1 to 9 to adjust compression speed and ratio.
  91
  92
  93 CONFIGURATION
  94 -------------
  95
  96 tar.umask::
  97         This variable can be used to restrict the permission bits of
  98         tar archive entries.  The default is 0002, which turns off the
  99         world write bit.  The special value "user" indicates that the
 100         archiving user's umask will be used instead.  See umask(2) for
 101         details.  If `--remote` is used then only the configuration of
 102         the remote repository takes effect.
 103
 104 tar.<format>.command::
 105         This variable specifies a shell command through which the tar
 106         output generated by `git archive` should be piped. The command
 107         is executed using the shell with the generated tar file on its
 108         standard input, and should produce the final output on its
 109         standard output. Any compression-level options will be passed
 110         to the command (e.g., "-9"). An output file with the same
 111         extension as `<format>` will be use this format if no other
 112         format is given.
 113 +
 114 The "tar.gz" and "tgz" formats are defined automatically and default to
 115 `gzip -cn`. You may override them with custom commands.
 116
 117 tar.<format>.remote::
 118         If true, enable `<format>` for use by remote clients via
 119         linkgit:git-upload-archive[1]. Defaults to false for
 120         user-defined formats, but true for the "tar.gz" and "tgz"
 121         formats.
 122
 123 ATTRIBUTES
 124 ----------
 125
 126 export-ignore::
 127         Files and directories with the attribute export-ignore won't be
 128         added to archive files.  See linkgit:gitattributes[5] for details.
 129
 130 export-subst::
 131         If the attribute export-subst is set for a file then git will
 132         expand several placeholders when adding this file to an archive.
 133         See linkgit:gitattributes[5] for details.
 134
 135 Note that attributes are by default taken from the `.gitattributes` files
 136 in the tree that is being archived.  If you want to tweak the way the
 137 output is generated after the fact (e.g. you committed without adding an
 138 appropriate export-ignore in its `.gitattributes`), adjust the checked out
 139 `.gitattributes` file as necessary and use `--worktree-attributes`
 140 option.  Alternatively you can keep necessary attributes that should apply
 141 while archiving any tree in your `$GIT_DIR/info/attributes` file.
 142
 143 EXAMPLES
 144 --------
 145 `git archive --format=tar --prefix=junk/ HEAD | (cd /var/tmp/ && tar xf -)`::
 146
 147         Create a tar archive that contains the contents of the
 148         latest commit on the current branch, and extract it in the
 149         `/var/tmp/junk` directory.
 150
 151 `git archive --format=tar --prefix=git-1.4.0/ v1.4.0 | gzip >git-1.4.0.tar.gz`::
 152
 153         Create a compressed tarball for v1.4.0 release.
 154
 155 `git archive --format=tar.gz --prefix=git-1.4.0/ v1.4.0 >git-1.4.0.tar.gz`::
 156
 157         Same as above, but using the builtin tar.gz handling.
 158
 159 `git archive --prefix=git-1.4.0/ -o git-1.4.0.tar.gz v1.4.0`::
 160
 161         Same as above, but the format is inferred from the output file.
 162
 163 `git archive --format=tar --prefix=git-1.4.0/ v1.4.0{caret}\{tree\} | gzip >git-1.4.0.tar.gz`::
 164
 165         Create a compressed tarball for v1.4.0 release, but without a
 166         global extended pax header.
 167
 168 `git archive --format=zip --prefix=git-docs/ HEAD:Documentation/ > git-1.4.0-docs.zip`::
 169
 170         Put everything in the current head's Documentation/ directory
 171         into 'git-1.4.0-docs.zip', with the prefix 'git-docs/'.
 172
 173 `git archive -o latest.zip HEAD`::
 174
 175         Create a Zip archive that contains the contents of the latest
 176         commit on the current branch. Note that the output format is
 177         inferred by the extension of the output file.
 178
 179 `git config tar.tar.xz.command "xz -c"`::
 180
 181         Configure a "tar.xz" format for making LZMA-compressed tarfiles.
 182         You can use it specifying `--format=tar.xz`, or by creating an
 183         output file like `-o foo.tar.xz`.
 184
 185
 186 SEE ALSO
 187 --------
 188 linkgit:gitattributes[5]
 189
 190 GIT
 191 ---
 192 Part of the linkgit:git[1] suite