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