freshlybakedca.ke
Git fork
1git-archive(1)
2==============
3
4NAME
5----
6git-archive - Create an archive of files from a named tree
7
8
9SYNOPSIS
10--------
11[verse]
12'git archive' [--format=<fmt>] [--list] [--prefix=<prefix>/] [<extra>]
13 [-o <file> | --output=<file>] [--worktree-attributes]
14 [--remote=<repo> [--exec=<git-upload-archive>]] <tree-ish>
15 [<path>...]
16
17DESCRIPTION
18-----------
19Creates an archive of the specified format containing the tree
20structure for the named tree, and writes it out to the standard
21output. If <prefix> is specified it is
22prepended to the filenames in the archive.
23
24'git archive' behaves differently when given a tree ID as opposed to a
25commit ID or tag ID. When a tree ID is provided, the current time is
26used as the modification time of each file in the archive. On the
27other hand, when a commit ID or tag ID is provided, the commit time as
28recorded in the referenced commit object is used instead.
29Additionally the commit ID is stored in a global extended pax header
30if the tar format is used; it can be extracted using 'git
31get-tar-commit-id'. In ZIP files it is stored as a file comment.
32
33OPTIONS
34-------
35
36--format=<fmt>::
37 Format of the resulting archive. Possible values are `tar`,
38 `zip`, `tar.gz`, `tgz`, and any format defined using the
39 configuration option `tar.<format>.command`. If `--format`
40 is not given, and the output file is specified, the format is
41 inferred from the filename if possible (e.g. writing to `foo.zip`
42 makes the output to be in the `zip` format). Otherwise the output
43 format is `tar`.
44
45-l::
46--list::
47 Show all available formats.
48
49-v::
50--verbose::
51 Report progress to stderr.
52
53--prefix=<prefix>/::
54 Prepend <prefix>/ to paths in the archive. Can be repeated; its
55 rightmost value is used for all tracked files. See below which
56 value gets used by `--add-file`.
57
58-o <file>::
59--output=<file>::
60 Write the archive to <file> instead of stdout.
61
62--add-file=<file>::
63 Add a non-tracked file to the archive. Can be repeated to add
64 multiple files. The path of the file in the archive is built by
65 concatenating the value of the last `--prefix` option (if any)
66 before this `--add-file` and the basename of <file>.
67
68--add-virtual-file=<path>:<content>::
69 Add the specified contents to the archive. Can be repeated to add
70 multiple files.
71+
72The `<path>` argument can start and end with a literal double-quote
73character; the contained file name is interpreted as a C-style string,
74i.e. the backslash is interpreted as escape character. The path must
75be quoted if it contains a colon, to avoid the colon from being
76misinterpreted as the separator between the path and the contents, or
77if the path begins or ends with a double-quote character.
78+
79The file mode is limited to a regular file, and the option may be
80subject to platform-dependent command-line limits. For non-trivial
81cases, write an untracked file and use `--add-file` instead.
82+
83Note that unlike `--add-file` the path created in the archive is not
84affected by the `--prefix` option, as a full `<path>` can be given as
85the value of the option.
86
87--worktree-attributes::
88 Look for attributes in .gitattributes files in the working tree
89 as well (see <<ATTRIBUTES>>).
90
91--mtime=<time>::
92 Set modification time of archive entries. Without this option
93 the committer time is used if `<tree-ish>` is a commit or tag,
94 and the current time if it is a tree.
95
96<extra>::
97 This can be any options that the archiver backend understands.
98 See next section.
99
100--remote=<repo>::
101 Instead of making a tar archive from the local repository,
102 retrieve a tar archive from a remote repository. Note that the
103 remote repository may place restrictions on which sha1
104 expressions may be allowed in `<tree-ish>`. See
105 linkgit:git-upload-archive[1] for details.
106
107--exec=<git-upload-archive>::
108 Used with --remote to specify the path to the
109 'git-upload-archive' on the remote side.
110
111<tree-ish>::
112 The tree or commit to produce an archive for.
113
114<path>::
115 Without an optional path parameter, all files and subdirectories
116 of the current working directory are included in the archive.
117 If one or more paths are specified, only these are included.
118
119BACKEND EXTRA OPTIONS
120---------------------
121
122zip
123~~~
124-<digit>::
125 Specify compression level. Larger values allow the command
126 to spend more time to compress to smaller size. Supported
127 values are from `-0` (store-only) to `-9` (best ratio).
128 Default is `-6` if not given.
129
130tar
131~~~
132-<number>::
133 Specify compression level. The value will be passed to the
134 compression command configured in `tar.<format>.command`. See
135 manual page of the configured command for the list of supported
136 levels and the default level if this option isn't specified.
137
138CONFIGURATION
139-------------
140
141tar.umask::
142 This variable can be used to restrict the permission bits of
143 tar archive entries. The default is 0002, which turns off the
144 world write bit. The special value "user" indicates that the
145 archiving user's umask will be used instead. See umask(2) for
146 details. If `--remote` is used then only the configuration of
147 the remote repository takes effect.
148
149tar.<format>.command::
150 This variable specifies a shell command through which the tar
151 output generated by `git archive` should be piped. The command
152 is executed using the shell with the generated tar file on its
153 standard input, and should produce the final output on its
154 standard output. Any compression-level options will be passed
155 to the command (e.g., `-9`).
156+
157The `tar.gz` and `tgz` formats are defined automatically and use the
158magic command `git archive gzip` by default, which invokes an internal
159implementation of gzip.
160
161tar.<format>.remote::
162 If true, enable the format for use by remote clients via
163 linkgit:git-upload-archive[1]. Defaults to false for
164 user-defined formats, but true for the `tar.gz` and `tgz`
165 formats.
166
167[[ATTRIBUTES]]
168ATTRIBUTES
169----------
170
171export-ignore::
172 Files and directories with the attribute export-ignore won't be
173 added to archive files. See linkgit:gitattributes[5] for details.
174
175export-subst::
176 If the attribute export-subst is set for a file then Git will
177 expand several placeholders when adding this file to an archive.
178 See linkgit:gitattributes[5] for details.
179
180Note that attributes are by default taken from the `.gitattributes` files
181in the tree that is being archived. If you want to tweak the way the
182output is generated after the fact (e.g. you committed without adding an
183appropriate export-ignore in its `.gitattributes`), adjust the checked out
184`.gitattributes` file as necessary and use `--worktree-attributes`
185option. Alternatively you can keep necessary attributes that should apply
186while archiving any tree in your `$GIT_DIR/info/attributes` file.
187
188EXAMPLES
189--------
190`git archive --format=tar --prefix=junk/ HEAD | (cd /var/tmp/ && tar xf -)`::
191
192 Create a tar archive that contains the contents of the
193 latest commit on the current branch, and extract it in the
194 `/var/tmp/junk` directory.
195
196`git archive --format=tar --prefix=git-1.4.0/ v1.4.0 | gzip >git-1.4.0.tar.gz`::
197
198 Create a compressed tarball for v1.4.0 release.
199
200`git archive --format=tar.gz --prefix=git-1.4.0/ v1.4.0 >git-1.4.0.tar.gz`::
201
202 Same as above, but using the builtin tar.gz handling.
203
204`git archive --prefix=git-1.4.0/ -o git-1.4.0.tar.gz v1.4.0`::
205
206 Same as above, but the format is inferred from the output file.
207
208`git archive --format=tar --prefix=git-1.4.0/ v1.4.0^{tree} | gzip >git-1.4.0.tar.gz`::
209
210 Create a compressed tarball for v1.4.0 release, but without a
211 global extended pax header.
212
213`git archive --format=zip --prefix=git-docs/ HEAD:Documentation/ > git-1.4.0-docs.zip`::
214
215 Put everything in the current head's Documentation/ directory
216 into 'git-1.4.0-docs.zip', with the prefix 'git-docs/'.
217
218`git archive -o latest.zip HEAD`::
219
220 Create a Zip archive that contains the contents of the latest
221 commit on the current branch. Note that the output format is
222 inferred by the extension of the output file.
223
224`git archive -o latest.tar --prefix=build/ --add-file=configure --prefix= HEAD`::
225
226 Creates a tar archive that contains the contents of the latest
227 commit on the current branch with no prefix and the untracked
228 file 'configure' with the prefix 'build/'.
229
230`git config tar.tar.xz.command "xz -c"`::
231
232 Configure a "tar.xz" format for making LZMA-compressed tarfiles.
233 You can use it specifying `--format=tar.xz`, or by creating an
234 output file like `-o foo.tar.xz`.
235
236
237SEE ALSO
238--------
239linkgit:gitattributes[5]
240
241GIT
242---
243Part of the linkgit:git[1] suite