Autogenerated HTML docs for v1.4.0-rc2-g5e3a6
[git.git] / git-ls-tree.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
4 <head>\r
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
6 <meta name="generator" content="AsciiDoc 7.0.2" />\r
7 <style type="text/css">\r
8 /* Debug borders */\r
9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
10 /*\r
11   border: 1px solid red;\r
12 */\r
13 }\r
14 \r
15 body {\r
16   margin: 1em 5% 1em 5%;\r
17 }\r
18 \r
19 a { color: blue; }\r
20 a:visited { color: fuchsia; }\r
21 \r
22 em {\r
23   font-style: italic;\r
24 }\r
25 \r
26 strong {\r
27   font-weight: bold;\r
28 }\r
29 \r
30 tt {\r
31   color: navy;\r
32 }\r
33 \r
34 h1, h2, h3, h4, h5, h6 {\r
35   color: #527bbd;\r
36   font-family: sans-serif;\r
37   margin-top: 1.2em;\r
38   margin-bottom: 0.5em;\r
39   line-height: 1.3;\r
40 }\r
41 \r
42 h1 {\r
43   border-bottom: 2px solid silver;\r
44 }\r
45 h2 {\r
46   border-bottom: 2px solid silver;\r
47   padding-top: 0.5em;\r
48 }\r
49 \r
50 div.sectionbody {\r
51   font-family: serif;\r
52   margin-left: 0;\r
53 }\r
54 \r
55 hr {\r
56   border: 1px solid silver;\r
57 }\r
58 \r
59 p {\r
60   margin-top: 0.5em;\r
61   margin-bottom: 0.5em;\r
62 }\r
63 \r
64 pre {\r
65   padding: 0;\r
66   margin: 0;\r
67 }\r
68 \r
69 span#author {\r
70   color: #527bbd;\r
71   font-family: sans-serif;\r
72   font-weight: bold;\r
73   font-size: 1.2em;\r
74 }\r
75 span#email {\r
76 }\r
77 span#revision {\r
78   font-family: sans-serif;\r
79 }\r
80 \r
81 div#footer {\r
82   font-family: sans-serif;\r
83   font-size: small;\r
84   border-top: 2px solid silver;\r
85   padding-top: 0.5em;\r
86   margin-top: 4.0em;\r
87 }\r
88 div#footer-text {\r
89   float: left;\r
90   padding-bottom: 0.5em;\r
91 }\r
92 div#footer-badges {\r
93   float: right;\r
94   padding-bottom: 0.5em;\r
95 }\r
96 \r
97 div#preamble,\r
98 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
99 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
100 div.admonitionblock {\r
101   margin-right: 10%;\r
102   margin-top: 1.5em;\r
103   margin-bottom: 1.5em;\r
104 }\r
105 div.admonitionblock {\r
106   margin-top: 2.5em;\r
107   margin-bottom: 2.5em;\r
108 }\r
109 \r
110 div.content { /* Block element content. */\r
111   padding: 0;\r
112 }\r
113 \r
114 /* Block element titles. */\r
115 div.title, caption.title {\r
116   font-family: sans-serif;\r
117   font-weight: bold;\r
118   text-align: left;\r
119   margin-top: 1.0em;\r
120   margin-bottom: 0.5em;\r
121 }\r
122 div.title + * {\r
123   margin-top: 0;\r
124 }\r
125 \r
126 td div.title:first-child {\r
127   margin-top: 0.0em;\r
128 }\r
129 div.content div.title:first-child {\r
130   margin-top: 0.0em;\r
131 }\r
132 div.content + div.title {\r
133   margin-top: 0.0em;\r
134 }\r
135 \r
136 div.sidebarblock > div.content {\r
137   background: #ffffee;\r
138   border: 1px solid silver;\r
139   padding: 0.5em;\r
140 }\r
141 \r
142 div.listingblock > div.content {\r
143   border: 1px solid silver;\r
144   background: #f4f4f4;\r
145   padding: 0.5em;\r
146 }\r
147 \r
148 div.quoteblock > div.content {\r
149   padding-left: 2.0em;\r
150 }\r
151 div.quoteblock .attribution {\r
152   text-align: right;\r
153 }\r
154 \r
155 div.admonitionblock .icon {\r
156   vertical-align: top;\r
157   font-size: 1.1em;\r
158   font-weight: bold;\r
159   text-decoration: underline;\r
160   color: #527bbd;\r
161   padding-right: 0.5em;\r
162 }\r
163 div.admonitionblock td.content {\r
164   padding-left: 0.5em;\r
165   border-left: 2px solid silver;\r
166 }\r
167 \r
168 div.exampleblock > div.content {\r
169   border-left: 2px solid silver;\r
170   padding: 0.5em;\r
171 }\r
172 \r
173 div.verseblock div.content {\r
174   white-space: pre;\r
175 }\r
176 \r
177 div.imageblock div.content { padding-left: 0; }\r
178 div.imageblock img { border: 1px solid silver; }\r
179 span.image img { border-style: none; }\r
180 \r
181 dl {\r
182   margin-top: 0.8em;\r
183   margin-bottom: 0.8em;\r
184 }\r
185 dt {\r
186   margin-top: 0.5em;\r
187   margin-bottom: 0;\r
188   font-style: italic;\r
189 }\r
190 dd > *:first-child {\r
191   margin-top: 0;\r
192 }\r
193 \r
194 ul, ol {\r
195     list-style-position: outside;\r
196 }\r
197 ol.olist2 {\r
198   list-style-type: lower-alpha;\r
199 }\r
200 \r
201 div.tableblock > table {\r
202   border-color: #527bbd;\r
203   border-width: 3px;\r
204 }\r
205 thead {\r
206   font-family: sans-serif;\r
207   font-weight: bold;\r
208 }\r
209 tfoot {\r
210   font-weight: bold;\r
211 }\r
212 \r
213 div.hlist {\r
214   margin-top: 0.8em;\r
215   margin-bottom: 0.8em;\r
216 }\r
217 td.hlist1 {\r
218   vertical-align: top;\r
219   font-style: italic;\r
220   padding-right: 0.8em;\r
221 }\r
222 td.hlist2 {\r
223   vertical-align: top;\r
224 }\r
225 \r
226 @media print {\r
227   div#footer-badges { display: none; }\r
228 }\r
229 include::./stylesheets/xhtml11-manpage.css[]\r
230 /* Workarounds for IE6's broken and incomplete CSS2. */\r
231 \r
232 div.sidebar-content {\r
233   background: #ffffee;\r
234   border: 1px solid silver;\r
235   padding: 0.5em;\r
236 }\r
237 div.sidebar-title, div.image-title {\r
238   font-family: sans-serif;\r
239   font-weight: bold;\r
240   margin-top: 0.0em;\r
241   margin-bottom: 0.5em;\r
242 }\r
243 \r
244 div.listingblock div.content {\r
245   border: 1px solid silver;\r
246   background: #f4f4f4;\r
247   padding: 0.5em;\r
248 }\r
249 \r
250 div.quoteblock-content {\r
251   padding-left: 2.0em;\r
252 }\r
253 \r
254 div.exampleblock-content {\r
255   border-left: 2px solid silver;\r
256   padding-left: 0.5em;\r
257 }\r
258 </style>\r
259 <title>git-ls-tree(1)</title>\r
260 </head>\r
261 <body>\r
262 <div id="header">\r
263 <h1>\r
264 git-ls-tree(1) Manual Page\r
265 </h1>\r
266 <h2>NAME</h2>\r
267 <div class="sectionbody">\r
268 <p>git-ls-tree -\r
269    Lists the contents of a tree object\r
270 </p>\r
271 </div>\r
272 </div>\r
273 <h2>SYNOPSIS</h2>\r
274 <div class="sectionbody">\r
275 <div class="verseblock">\r
276 <div class="content"><em>git-ls-tree</em> [-d] [-r] [-t] [-z]\r
277             [--name-only] [--name-status] [--full-name] [--abbrev=[&lt;n&gt;]]\r
278             &lt;tree-ish&gt; [paths&#8230;]</div></div>\r
279 </div>\r
280 <h2>DESCRIPTION</h2>\r
281 <div class="sectionbody">\r
282 <p>Lists the contents of a given tree object, like what "/bin/ls -a" does\r
283 in the current working directory. Note that the usage is subtly different,\r
284 though - <em>paths</em> denote just a list of patterns to match, e.g. so specifying\r
285 directory name (without <em>-r</em>) will behave differently, and order of the\r
286 arguments does not matter.</p>\r
287 </div>\r
288 <h2>OPTIONS</h2>\r
289 <div class="sectionbody">\r
290 <dl>\r
291 <dt>\r
292 &lt;tree-ish&gt;\r
293 </dt>\r
294 <dd>\r
295 <p>\r
296         Id of a tree-ish.\r
297 </p>\r
298 </dd>\r
299 <dt>\r
300 -d\r
301 </dt>\r
302 <dd>\r
303 <p>\r
304         Show only the named tree entry itself, not its children.\r
305 </p>\r
306 </dd>\r
307 <dt>\r
308 -r\r
309 </dt>\r
310 <dd>\r
311 <p>\r
312         Recurse into sub-trees.\r
313 </p>\r
314 </dd>\r
315 <dt>\r
316 -t\r
317 </dt>\r
318 <dd>\r
319 <p>\r
320         Show tree entries even when going to recurse them. Has no effect\r
321         if <em>-r</em> was not passed. <em>-d</em> implies <em>-t</em>.\r
322 </p>\r
323 </dd>\r
324 <dt>\r
325 -z\r
326 </dt>\r
327 <dd>\r
328 <p>\r
329         \0 line termination on output.\r
330 </p>\r
331 </dd>\r
332 <dt>\r
333 --name-only\r
334 </dt>\r
335 <dt>\r
336 --name-status\r
337 </dt>\r
338 <dd>\r
339 <p>\r
340         List only filenames (instead of the "long" output), one per line.\r
341 </p>\r
342 </dd>\r
343 <dt>\r
344 --abbrev[=&lt;n&gt;]\r
345 </dt>\r
346 <dd>\r
347 <p>\r
348         Instead of showing the full 40-byte hexadecimal object\r
349         lines, show only handful hexdigits prefix.\r
350         Non default number of digits can be specified with --abbrev=&lt;n&gt;.\r
351 </p>\r
352 </dd>\r
353 <dt>\r
354 --full-name\r
355 </dt>\r
356 <dd>\r
357 <p>\r
358         Instead of showing the path names relative to the current working\r
359         directory, show the full path names.\r
360 </p>\r
361 </dd>\r
362 <dt>\r
363 paths\r
364 </dt>\r
365 <dd>\r
366 <p>\r
367         When paths are given, show them (note that this isn't really raw\r
368         pathnames, but rather a list of patterns to match).  Otherwise\r
369         implicitly uses the root level of the tree as the sole path argument.\r
370 </p>\r
371 </dd>\r
372 </dl>\r
373 </div>\r
374 <h2>Output Format</h2>\r
375 <div class="sectionbody">\r
376 <div class="literalblock">\r
377 <div class="content">\r
378 <pre><tt>&lt;mode&gt; SP &lt;type&gt; SP &lt;object&gt; TAB &lt;file&gt;</tt></pre>\r
379 </div></div>\r
380 <p>When the <tt>-z</tt> option is not used, TAB, LF, and backslash characters\r
381 in pathnames are represented as <tt>\t</tt>, <tt>\n</tt>, and <tt>\\</tt>, respectively.</p>\r
382 </div>\r
383 <h2>Author</h2>\r
384 <div class="sectionbody">\r
385 <p>Written by Petr Baudis &lt;pasky@suse.cz&gt;\r
386 Completely rewritten from scratch by Junio C Hamano &lt;junkio@cox.net&gt;,\r
387 another major rewrite by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>\r
388 </div>\r
389 <h2>Documentation</h2>\r
390 <div class="sectionbody">\r
391 <p>Documentation by David Greaves, Junio C Hamano and the git-list\r
392 &lt;git@vger.kernel.org&gt;.</p>\r
393 </div>\r
394 <h2>GIT</h2>\r
395 <div class="sectionbody">\r
396 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
397 </div>\r
398 <div id="footer">\r
399 <div id="footer-text">\r
400 Last updated 08-Jun-2006 00:48:14 UTC\r
401 </div>\r
402 </div>\r
403 </body>\r
404 </html>\r