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'... 34 35--list, -l:: 36 Show all available formats. 37 38--verbose, -v:: 39 Report progress to stderr. 40 41--prefix=<prefix>/:: 42 Prepend <prefix>/ to each filename in the archive. 43 44<extra>:: 45 This can be any options that the archiver backend understand. 46 See next section. 47 48--remote=<repo>:: 49 Instead of making a tar archive from local repository, 50 retrieve a tar archive from a remote repository. 51 52<tree-ish>:: 53 The tree or commit to produce an archive for. 54 55path:: 56 If one or more paths are specified, include only these in the 57 archive, otherwise include all files and subdirectories. 58 59BACKEND EXTRA OPTIONS 60--------------------- 61 62zip 63~~~ 64-0:: 65 Store the files instead of deflating them. 66-9:: 67 Highest and slowest compression level. You can specify any 68 number from 1 to 9 to adjust compression speed and ratio. 69 70 71CONFIGURATION 72------------- 73By default, file and directories modes are set to 0666 or 0777 in tar 74archives. It is possible to change this by setting the "umask" variable 75in the repository configuration as follows : 76 77[tar] 78 umask = 002 ;# group friendly 79 80The special umask value "user" indicates that the user's current umask 81will be used instead. The default value remains 0, which means world 82readable/writable files and directories. 83 84EXAMPLES 85-------- 86git 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 92git 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 96git 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 101git 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 106Author 107------ 108Written by Franck Bui-Huu and Rene Scharfe. 109 110Documentation 111-------------- 112Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>. 113 114GIT 115--- 116Part of the gitlink:git[7] suite