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