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