updated git doc
[TortoiseGit.git] / doc / source / en / TortoiseGit / git_doc / git-tar-tree.xml
blob42397ac5812469c852b1f380a21724f29ca6bf87
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
3 \r
4 <article lang="en" id="git-tar-tree(1)">\r
5 <articleinfo>\r
6     <title>git-tar-tree(1)</title>\r
7 <indexterm>\r
8 <primary>git-tar-tree(1)</primary>\r
9 </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-tar-tree - Create a tar archive of the files in the named tree object</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <blockquote>\r
18 <literallayout><emphasis>git tar-tree</emphasis> [--remote=&lt;repo&gt;] &lt;tree-ish&gt; [ &lt;base&gt; ]</literallayout>\r
19 </blockquote>\r
20 </simplesect>\r
21 <simplesect id="_description">\r
22 <title>DESCRIPTION</title>\r
23 <simpara>THIS COMMAND IS DEPRECATED.  Use <emphasis>git archive</emphasis> with <emphasis>--format=tar</emphasis>\r
24 option instead (and move the &lt;base&gt; argument to <emphasis>--prefix=base/</emphasis>).</simpara>\r
25 <simpara>Creates a tar archive containing the tree structure for the named tree.\r
26 When &lt;base&gt; is specified it is added as a leading path to the files in the\r
27 generated tar archive.</simpara>\r
28 <simpara><emphasis>git tar-tree</emphasis> behaves differently when given a tree ID versus when given\r
29 a commit ID or tag ID.  In the first case the current time is used as\r
30 modification time of each file in the archive.  In the latter case the\r
31 commit time as recorded in the referenced commit object is used instead.\r
32 Additionally the commit ID is stored in a global extended pax header.\r
33 It can be extracted using <emphasis>git get-tar-commit-id</emphasis>.</simpara>\r
34 </simplesect>\r
35 <simplesect id="_options">\r
36 <title>OPTIONS</title>\r
37 <variablelist>\r
38 <varlistentry>\r
39 <term>\r
40 &lt;tree-ish&gt;\r
41 </term>\r
42 <listitem>\r
43 <simpara>\r
44         The tree or commit to produce tar archive for.  If it is\r
45         the object name of a commit object.\r
46 </simpara>\r
47 </listitem>\r
48 </varlistentry>\r
49 <varlistentry>\r
50 <term>\r
51 &lt;base&gt;\r
52 </term>\r
53 <listitem>\r
54 <simpara>\r
55         Leading path to the files in the resulting tar archive.\r
56 </simpara>\r
57 </listitem>\r
58 </varlistentry>\r
59 <varlistentry>\r
60 <term>\r
61 --remote=&lt;repo&gt;\r
62 </term>\r
63 <listitem>\r
64 <simpara>\r
65         Instead of making a tar archive from local repository,\r
66         retrieve a tar archive from a remote repository.\r
67 </simpara>\r
68 </listitem>\r
69 </varlistentry>\r
70 </variablelist>\r
71 </simplesect>\r
72 <simplesect id="_configuration">\r
73 <title>CONFIGURATION</title>\r
74 <variablelist>\r
75 <varlistentry>\r
76 <term>\r
77 tar.umask\r
78 </term>\r
79 <listitem>\r
80 <simpara>\r
81         This variable can be used to restrict the permission bits of\r
82         tar archive entries.  The default is 0002, which turns off the\r
83         world write bit.  The special value "user" indicates that the\r
84         archiving user's umask will be used instead.  See umask(2) for\r
85         details.\r
86 </simpara>\r
87 </listitem>\r
88 </varlistentry>\r
89 </variablelist>\r
90 </simplesect>\r
91 <simplesect id="_examples">\r
92 <title>EXAMPLES</title>\r
93 <variablelist>\r
94 <varlistentry>\r
95 <term>\r
96 <emphasis>git tar-tree HEAD junk | (cd /var/tmp/ &amp;&amp; tar xf -)</emphasis>\r
97 </term>\r
98 <listitem>\r
99 <simpara>\r
100         Create a tar archive that contains the contents of the\r
101         latest commit on the current branch, and extracts it in\r
102         <emphasis>/var/tmp/junk</emphasis> directory.\r
103 </simpara>\r
104 </listitem>\r
105 </varlistentry>\r
106 <varlistentry>\r
107 <term>\r
108 <emphasis>git tar-tree v1.4.0 git-1.4.0 | gzip &gt;git-1.4.0.tar.gz</emphasis>\r
109 </term>\r
110 <listitem>\r
111 <simpara>\r
112         Create a tarball for v1.4.0 release.\r
113 </simpara>\r
114 </listitem>\r
115 </varlistentry>\r
116 <varlistentry>\r
117 <term>\r
118 <emphasis>git tar-tree v1.4.0^{tree} git-1.4.0 | gzip &gt;git-1.4.0.tar.gz</emphasis>\r
119 </term>\r
120 <listitem>\r
121 <simpara>\r
122         Create a tarball for v1.4.0 release, but without a\r
123         global extended pax header.\r
124 </simpara>\r
125 </listitem>\r
126 </varlistentry>\r
127 <varlistentry>\r
128 <term>\r
129 <emphasis>git tar-tree --remote=example.com:git.git v1.4.0 &gt;git-1.4.0.tar</emphasis>\r
130 </term>\r
131 <listitem>\r
132 <simpara>\r
133         Get a tarball v1.4.0 from example.com.\r
134 </simpara>\r
135 </listitem>\r
136 </varlistentry>\r
137 <varlistentry>\r
138 <term>\r
139 <emphasis>git tar-tree HEAD:Documentation/ git-docs &gt; git-1.4.0-docs.tar</emphasis>\r
140 </term>\r
141 <listitem>\r
142 <simpara>\r
143         Put everything in the current head's Documentation/ directory\r
144         into <emphasis>git-1.4.0-docs.tar</emphasis>, with the prefix <emphasis>git-docs/</emphasis>.\r
145 </simpara>\r
146 </listitem>\r
147 </varlistentry>\r
148 </variablelist>\r
149 </simplesect>\r
150 <simplesect id="_git">\r
151 <title>GIT</title>\r
152 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
153 </simplesect>\r
154 </article>\r