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