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