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