Documentation / git-archive.txton commit Add the --submodule option to the diff option family (752c0c2)
   1git-archive(1)
   2==============
   3
   4NAME
   5----
   6git-archive - Create an archive of files from a named tree
   7
   8
   9SYNOPSIS
  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
  17DESCRIPTION
  18-----------
  19Creates an archive of the specified format containing the tree
  20structure for the named tree, and writes it out to the standard
  21output.  If <prefix> is specified it is
  22prepended to the filenames in the archive.
  23
  24'git-archive' behaves differently when given a tree ID versus when
  25given a commit ID or tag ID.  In the first case the current time is
  26used as the modification time of each file in the archive.  In the latter
  27case the commit time as recorded in the referenced commit object is
  28used instead.  Additionally the commit ID is stored in a global
  29extended pax header if the tar format is used; it can be extracted
  30using 'git-get-tar-commit-id'. In ZIP files it is stored as a file
  31comment.
  32
  33OPTIONS
  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
  76path::
  77        If one or more paths are specified, include only these in the
  78        archive, otherwise include all files and subdirectories.
  79
  80BACKEND EXTRA OPTIONS
  81---------------------
  82
  83zip
  84~~~
  85-0::
  86        Store the files instead of deflating them.
  87-9::
  88        Highest and slowest compression level.  You can specify any
  89        number from 1 to 9 to adjust compression speed and ratio.
  90
  91
  92CONFIGURATION
  93-------------
  94
  95tar.umask::
  96        This variable can be used to restrict the permission bits of
  97        tar archive entries.  The default is 0002, which turns off the
  98        world write bit.  The special value "user" indicates that the
  99        archiving user's umask will be used instead.  See umask(2) for
 100        details.
 101
 102ATTRIBUTES
 103----------
 104
 105export-ignore::
 106        Files and directories with the attribute export-ignore won't be
 107        added to archive files.  See linkgit:gitattributes[5] for details.
 108
 109export-subst::
 110        If the attribute export-subst is set for a file then git will
 111        expand several placeholders when adding this file to an archive.
 112        See linkgit:gitattributes[5] for details.
 113
 114EXAMPLES
 115--------
 116git archive --format=tar --prefix=junk/ HEAD | (cd /var/tmp/ && tar xf -)::
 117
 118        Create a tar archive that contains the contents of the
 119        latest commit on the current branch, and extract it in the
 120        `/var/tmp/junk` directory.
 121
 122git archive --format=tar --prefix=git-1.4.0/ v1.4.0 | gzip >git-1.4.0.tar.gz::
 123
 124        Create a compressed tarball for v1.4.0 release.
 125
 126git archive --format=tar --prefix=git-1.4.0/ v1.4.0{caret}\{tree\} | gzip >git-1.4.0.tar.gz::
 127
 128        Create a compressed tarball for v1.4.0 release, but without a
 129        global extended pax header.
 130
 131git archive --format=zip --prefix=git-docs/ HEAD:Documentation/ > git-1.4.0-docs.zip::
 132
 133        Put everything in the current head's Documentation/ directory
 134        into 'git-1.4.0-docs.zip', with the prefix 'git-docs/'.
 135
 136git archive -o latest.zip HEAD::
 137
 138        Create a Zip archive that contains the contents of the latest
 139        commit on the current branch. Note that the output format is
 140        inferred by the extension of the output file.
 141
 142
 143SEE ALSO
 144--------
 145linkgit:gitattributes[5]
 146
 147Author
 148------
 149Written by Franck Bui-Huu and Rene Scharfe.
 150
 151Documentation
 152--------------
 153Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
 154
 155GIT
 156---
 157Part of the linkgit:git[1] suite