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 [--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 versus when 25given a commit ID or tag ID. In the first case the current time is 26used as the modification time of each file in the archive. In the latter 27case the commit time as recorded in the referenced commit object is 28used instead. Additionally the commit ID is stored in a global 29extended pax header if the tar format is used; it can be extracted 30using 'git-get-tar-commit-id'. In ZIP files it is stored as a file 31comment. 32 33OPTIONS 34------- 35 36--format=<fmt>:: 37 Format of the resulting archive: 'tar' or 'zip'. The default 38 is 'tar'. 39 40-l:: 41--list:: 42 Show all available formats. 43 44-v:: 45--verbose:: 46 Report progress to stderr. 47 48--prefix=<prefix>/:: 49 Prepend <prefix>/ to each filename in the archive. 50 51--output=<file>:: 52 Write the archive to <file> instead of stdout. 53 54--worktree-attributes:: 55 Look for attributes in .gitattributes in working directory too. 56 57<extra>:: 58 This can be any options that the archiver backend understands. 59 See next section. 60 61--remote=<repo>:: 62 Instead of making a tar archive from the local repository, 63 retrieve a tar archive from a remote repository. 64 65--exec=<git-upload-archive>:: 66 Used with --remote to specify the path to the 67 'git-upload-archive' on the remote side. 68 69<tree-ish>:: 70 The tree or commit to produce an archive for. 71 72path:: 73 If one or more paths are specified, include only these in the 74 archive, otherwise include all files and subdirectories. 75 76BACKEND EXTRA OPTIONS 77--------------------- 78 79zip 80~~~ 81-0:: 82 Store the files instead of deflating them. 83-9:: 84 Highest and slowest compression level. You can specify any 85 number from 1 to 9 to adjust compression speed and ratio. 86 87 88CONFIGURATION 89------------- 90 91tar.umask:: 92 This variable can be used to restrict the permission bits of 93 tar archive entries. The default is 0002, which turns off the 94 world write bit. The special value "user" indicates that the 95 archiving user's umask will be used instead. See umask(2) for 96 details. 97 98ATTRIBUTES 99---------- 100 101export-ignore:: 102 Files and directories with the attribute export-ignore won't be 103 added to archive files. See linkgit:gitattributes[5] for details. 104 105export-subst:: 106 If the attribute export-subst is set for a file then git will 107 expand several placeholders when adding this file to an archive. 108 See linkgit:gitattributes[5] for details. 109 110EXAMPLES 111-------- 112git archive --format=tar --prefix=junk/ HEAD | (cd /var/tmp/ && tar xf -):: 113 114 Create a tar archive that contains the contents of the 115 latest commit on the current branch, and extract it in the 116 `/var/tmp/junk` directory. 117 118git archive --format=tar --prefix=git-1.4.0/ v1.4.0 | gzip >git-1.4.0.tar.gz:: 119 120 Create a compressed tarball for v1.4.0 release. 121 122git archive --format=tar --prefix=git-1.4.0/ v1.4.0{caret}\{tree\} | gzip >git-1.4.0.tar.gz:: 123 124 Create a compressed tarball for v1.4.0 release, but without a 125 global extended pax header. 126 127git archive --format=zip --prefix=git-docs/ HEAD:Documentation/ > git-1.4.0-docs.zip:: 128 129 Put everything in the current head's Documentation/ directory 130 into 'git-1.4.0-docs.zip', with the prefix 'git-docs/'. 131 132 133SEE ALSO 134-------- 135linkgit:gitattributes[5] 136 137Author 138------ 139Written by Franck Bui-Huu and Rene Scharfe. 140 141Documentation 142-------------- 143Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>. 144 145GIT 146--- 147Part of the linkgit:git[1] suite