Merge branch 'jc/for-each-ref' into jc/ref-locking
[git/git.git] / Documentation / git-zip-tree.txt
1 git-zip-tree(1)
2 ===============
3
4 NAME
5 ----
6 git-zip-tree - Creates a ZIP archive of the files in the named tree
7
8
9 SYNOPSIS
10 --------
11 'git-zip-tree' [-0|...|-9] <tree-ish> [ <base> ]
12
13 DESCRIPTION
14 -----------
15 Creates a ZIP archive containing the tree structure for the named tree.
16 When <base> is specified it is added as a leading path to the files in the
17 generated ZIP archive.
18
19 git-zip-tree behaves differently when given a tree ID versus when given
20 a commit ID or tag ID. In the first case the current time is used as
21 modification time of each file in the archive. In the latter case the
22 commit time as recorded in the referenced commit object is used instead.
23 Additionally the commit ID is stored as an archive comment.
24
25 Currently git-zip-tree can handle only files and directories, symbolic
26 links are not supported.
27
28 OPTIONS
29 -------
30
31 -0::
32 Store the files instead of deflating them.
33
34 -9::
35 Highest and slowest compression level. You can specify any
36 number from 1 to 9 to adjust compression speed and ratio.
37
38 <tree-ish>::
39 The tree or commit to produce ZIP archive for. If it is
40 the object name of a commit object.
41
42 <base>::
43 Leading path to the files in the resulting ZIP archive.
44
45 EXAMPLES
46 --------
47 git zip-tree v1.4.0 git-1.4.0 >git-1.4.0.zip::
48
49 Create a ZIP file for v1.4.0 release.
50
51 git zip-tree HEAD:Documentation/ git-docs >docs.zip::
52
53 Put everything in the current head's Documentation/ directory
54 into 'docs.zip', with the prefix 'git-docs/'.
55
56 Author
57 ------
58 Written by Rene Scharfe.
59
60 Documentation
61 --------------
62 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
63
64 GIT
65 ---
66 Part of the gitlink:git[7] suite
67