Autogenerated HTML docs for v1.1.1-g0f76f
[git.git] / git-checkout.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.1" />\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-checkout(1)</title>\r
260 </head>\r
261 <body>\r
262 <div id="header">\r
263 <h1>\r
264 git-checkout(1) Manual Page\r
265 </h1>\r
266 <h2>NAME</h2>\r
267 <div class="sectionbody">\r
268 <p>git-checkout -\r
269    Checkout and switch to a branch.\r
270 </p>\r
271 </div>\r
272 </div>\r
273 <h2>SYNOPSIS</h2>\r
274 <div class="sectionbody">\r
275 <p><em>git-checkout</em> [-f] [-b &lt;new_branch&gt;] [&lt;branch&gt;] [&lt;paths&gt;&#8230;]</p>\r
276 </div>\r
277 <h2>DESCRIPTION</h2>\r
278 <div class="sectionbody">\r
279 <p>When &lt;paths&gt; are not given, this command switches branches, by\r
280 updating the index and working tree to reflect the specified\r
281 branch, &lt;branch&gt;, and updating HEAD to be &lt;branch&gt; or, if\r
282 specified, &lt;new_branch&gt;.</p>\r
283 <p>When &lt;paths&gt; are given, this command does <strong>not</strong> switch\r
284 branches.  It updates the named paths in the working tree from\r
285 the index file (i.e. it runs <tt>git-checkout-index -f -u</tt>).  In\r
286 this case, <tt>-f</tt> and <tt>-b</tt> options are meaningless and giving\r
287 either of them results in an error.  &lt;branch&gt; argument can be\r
288 used to specify a specific tree-ish to update the index for the\r
289 given paths before updating the working tree.</p>\r
290 </div>\r
291 <h2>OPTIONS</h2>\r
292 <div class="sectionbody">\r
293 <dl>\r
294 <dt>\r
295 -f\r
296 </dt>\r
297 <dd>\r
298 <p>\r
299         Force an re-read of everything.\r
300 </p>\r
301 </dd>\r
302 <dt>\r
303 -b\r
304 </dt>\r
305 <dd>\r
306 <p>\r
307         Create a new branch and start it at &lt;branch&gt;.\r
308 </p>\r
309 </dd>\r
310 <dt>\r
311 &lt;new_branch&gt;\r
312 </dt>\r
313 <dd>\r
314 <p>\r
315         Name for the new branch.\r
316 </p>\r
317 </dd>\r
318 <dt>\r
319 &lt;branch&gt;\r
320 </dt>\r
321 <dd>\r
322 <p>\r
323         Branch to checkout; may be any object ID that resolves to a\r
324         commit. Defaults to HEAD.\r
325 </p>\r
326 </dd>\r
327 </dl>\r
328 </div>\r
329 <h2>EXAMPLE</h2>\r
330 <div class="sectionbody">\r
331 <p>The following sequence checks out the <tt>master</tt> branch, reverts\r
332 the <tt>Makefile</tt> to two revisions back, deletes hello.c by\r
333 mistake, and gets it back from the index.</p>\r
334 <div class="listingblock">\r
335 <div class="content">\r
336 <pre><tt>$ git checkout master <b>(1)</b>\r
337 $ git checkout master~2 Makefile <b>(2)</b>\r
338 $ rm -f hello.c\r
339 $ git checkout hello.c <b>(3)</b>\r
340 \r
341 <b>(1)</b> switch branch\r
342 <b>(2)</b> take out a file out of other commit\r
343 <b>(3)</b> or "git checkout -- hello.c", as in the next example.</tt></pre>\r
344 </div></div>\r
345 <p>If you have an unfortunate branch that is named <tt>hello.c</tt>, the\r
346 last step above would be confused as an instruction to switch to\r
347 that branch.  You should instead write:</p>\r
348 <div class="listingblock">\r
349 <div class="content">\r
350 <pre><tt>$ git checkout -- hello.c</tt></pre>\r
351 </div></div>\r
352 </div>\r
353 <h2>Author</h2>\r
354 <div class="sectionbody">\r
355 <p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>\r
356 </div>\r
357 <h2>Documentation</h2>\r
358 <div class="sectionbody">\r
359 <p>Documentation by Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>\r
360 </div>\r
361 <h2>GIT</h2>\r
362 <div class="sectionbody">\r
363 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
364 </div>\r
365 <div id="footer">\r
366 <div id="footer-text">\r
367 Last updated 27-Dec-2005 00:15:51 PDT\r
368 </div>\r
369 </div>\r
370 </body>\r
371 </html>\r