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 [--remote=<repo>] <tree-ish> [path...] 14 15DESCRIPTION 16----------- 17Creates an archive of the specified format containing the tree 18structure for the named tree, and writes it out to the standard 19output. If <prefix> is specified it is 20prepended to the filenames in the archive. 21 22'git-archive' behaves differently when given a tree ID versus when 23given a commit ID or tag ID. In the first case the current time is 24used as modification time of each file in the archive. In the latter 25case the commit time as recorded in the referenced commit object is 26used instead. Additionally the commit ID is stored in a global 27extended pax header if the tar format is used; it can be extracted 28using 'git-get-tar-commit-id'. In ZIP files it is stored as a file 29comment. 30 31OPTIONS 32------- 33 34--format=<fmt>:: 35 Format of the resulting archive: 'tar' or 'zip'. The default 36 is 'tar'. 37 38--list, -l:: 39 Show all available formats. 40 41--verbose, -v:: 42 Report progress to stderr. 43 44--prefix=<prefix>/:: 45 Prepend <prefix>/ to each filename in the archive. 46 47<extra>:: 48 This can be any options that the archiver backend understand. 49 See next section. 50 51--remote=<repo>:: 52 Instead of making a tar archive from local repository, 53 retrieve a tar archive from a remote repository. 54 55<tree-ish>:: 56 The tree or commit to produce an archive for. 57 58path:: 59 If one or more paths are specified, include only these in the 60 archive, otherwise include all files and subdirectories. 61 62BACKEND EXTRA OPTIONS 63--------------------- 64 65zip 66~~~ 67-0:: 68 Store the files instead of deflating them. 69-9:: 70 Highest and slowest compression level. You can specify any 71 number from 1 to 9 to adjust compression speed and ratio. 72 73 74CONFIGURATION 75------------- 76 77tar.umask:: 78 This variable can be used to restrict the permission bits of 79 tar archive entries. The default is 0002, which turns off the 80 world write bit. The special value "user" indicates that the 81 archiving user's umask will be used instead. See umask(2) for 82 details. 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