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