tests: fix cleanup after tests in t1509-root-worktree
[git/git-svn.git] / Documentation / git.txt
blobf4cb5cb200cf69461d5af39d4c29b51138e4d3ec
1 git(1)
2 ======
4 NAME
5 ----
6 git - the stupid content tracker
9 SYNOPSIS
10 --------
11 [verse]
12 'git' [--version] [--help] [-C <path>] [-c <name>=<value>]
13     [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
14     [-p|--paginate|--no-pager] [--no-replace-objects] [--bare]
15     [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
16     <command> [<args>]
18 DESCRIPTION
19 -----------
20 Git is a fast, scalable, distributed revision control system with an
21 unusually rich command set that provides both high-level operations
22 and full access to internals.
24 See linkgit:gittutorial[7] to get started, then see
25 linkgit:giteveryday[7] for a useful minimum set of
26 commands.  The link:user-manual.html[Git User's Manual] has a more
27 in-depth introduction.
29 After you mastered the basic concepts, you can come back to this
30 page to learn what commands Git offers.  You can learn more about
31 individual Git commands with "git help command".  linkgit:gitcli[7]
32 manual page gives you an overview of the command-line command syntax.
34 Formatted and hyperlinked version of the latest Git documentation
35 can be viewed at `http://git-htmldocs.googlecode.com/git/git.html`.
37 ifdef::stalenotes[]
38 [NOTE]
39 ============
41 You are reading the documentation for the latest (possibly
42 unreleased) version of Git, that is available from the 'master'
43 branch of the `git.git` repository.
44 Documentation for older releases are available here:
46 * link:v2.5.0/git.html[documentation for release 2.5]
48 * release notes for
49   link:RelNotes/2.5.0.txt[2.5],
51 * link:v2.4.7/git.html[documentation for release 2.4.7]
53 * release notes for
54   link:RelNotes/2.4.7.txt[2.4.7],
55   link:RelNotes/2.4.6.txt[2.4.6],
56   link:RelNotes/2.4.5.txt[2.4.5],
57   link:RelNotes/2.4.4.txt[2.4.4],
58   link:RelNotes/2.4.3.txt[2.4.3],
59   link:RelNotes/2.4.2.txt[2.4.2],
60   link:RelNotes/2.4.1.txt[2.4.1],
61   link:RelNotes/2.4.0.txt[2.4].
63 * link:v2.3.8/git.html[documentation for release 2.3.8]
65 * release notes for
66   link:RelNotes/2.3.8.txt[2.3.8],
67   link:RelNotes/2.3.7.txt[2.3.7],
68   link:RelNotes/2.3.6.txt[2.3.6],
69   link:RelNotes/2.3.5.txt[2.3.5],
70   link:RelNotes/2.3.4.txt[2.3.4],
71   link:RelNotes/2.3.3.txt[2.3.3],
72   link:RelNotes/2.3.2.txt[2.3.2],
73   link:RelNotes/2.3.1.txt[2.3.1],
74   link:RelNotes/2.3.0.txt[2.3].
76 * link:v2.2.2/git.html[documentation for release 2.2.2]
78 * release notes for
79   link:RelNotes/2.2.2.txt[2.2.2],
80   link:RelNotes/2.2.1.txt[2.2.1],
81   link:RelNotes/2.2.0.txt[2.2].
83 * link:v2.1.4/git.html[documentation for release 2.1.4]
85 * release notes for
86   link:RelNotes/2.1.4.txt[2.1.4],
87   link:RelNotes/2.1.3.txt[2.1.3],
88   link:RelNotes/2.1.2.txt[2.1.2],
89   link:RelNotes/2.1.1.txt[2.1.1],
90   link:RelNotes/2.1.0.txt[2.1].
92 * link:v2.0.5/git.html[documentation for release 2.0.5]
94 * release notes for
95   link:RelNotes/2.0.5.txt[2.0.5],
96   link:RelNotes/2.0.4.txt[2.0.4],
97   link:RelNotes/2.0.3.txt[2.0.3],
98   link:RelNotes/2.0.2.txt[2.0.2],
99   link:RelNotes/2.0.1.txt[2.0.1],
100   link:RelNotes/2.0.0.txt[2.0.0].
102 * link:v1.9.5/git.html[documentation for release 1.9.5]
104 * release notes for
105   link:RelNotes/1.9.5.txt[1.9.5],
106   link:RelNotes/1.9.4.txt[1.9.4],
107   link:RelNotes/1.9.3.txt[1.9.3],
108   link:RelNotes/1.9.2.txt[1.9.2],
109   link:RelNotes/1.9.1.txt[1.9.1],
110   link:RelNotes/1.9.0.txt[1.9.0].
112 * link:v1.8.5.6/git.html[documentation for release 1.8.5.6]
114 * release notes for
115   link:RelNotes/1.8.5.6.txt[1.8.5.6],
116   link:RelNotes/1.8.5.5.txt[1.8.5.5],
117   link:RelNotes/1.8.5.4.txt[1.8.5.4],
118   link:RelNotes/1.8.5.3.txt[1.8.5.3],
119   link:RelNotes/1.8.5.2.txt[1.8.5.2],
120   link:RelNotes/1.8.5.1.txt[1.8.5.1],
121   link:RelNotes/1.8.5.txt[1.8.5].
123 * link:v1.8.4.5/git.html[documentation for release 1.8.4.5]
125 * release notes for
126   link:RelNotes/1.8.4.5.txt[1.8.4.5],
127   link:RelNotes/1.8.4.4.txt[1.8.4.4],
128   link:RelNotes/1.8.4.3.txt[1.8.4.3],
129   link:RelNotes/1.8.4.2.txt[1.8.4.2],
130   link:RelNotes/1.8.4.1.txt[1.8.4.1],
131   link:RelNotes/1.8.4.txt[1.8.4].
133 * link:v1.8.3.4/git.html[documentation for release 1.8.3.4]
135 * release notes for
136   link:RelNotes/1.8.3.4.txt[1.8.3.4],
137   link:RelNotes/1.8.3.3.txt[1.8.3.3],
138   link:RelNotes/1.8.3.2.txt[1.8.3.2],
139   link:RelNotes/1.8.3.1.txt[1.8.3.1],
140   link:RelNotes/1.8.3.txt[1.8.3].
142 * link:v1.8.2.3/git.html[documentation for release 1.8.2.3]
144 * release notes for
145   link:RelNotes/1.8.2.3.txt[1.8.2.3],
146   link:RelNotes/1.8.2.2.txt[1.8.2.2],
147   link:RelNotes/1.8.2.1.txt[1.8.2.1],
148   link:RelNotes/1.8.2.txt[1.8.2].
150 * link:v1.8.1.6/git.html[documentation for release 1.8.1.6]
152 * release notes for
153   link:RelNotes/1.8.1.6.txt[1.8.1.6],
154   link:RelNotes/1.8.1.5.txt[1.8.1.5],
155   link:RelNotes/1.8.1.4.txt[1.8.1.4],
156   link:RelNotes/1.8.1.3.txt[1.8.1.3],
157   link:RelNotes/1.8.1.2.txt[1.8.1.2],
158   link:RelNotes/1.8.1.1.txt[1.8.1.1],
159   link:RelNotes/1.8.1.txt[1.8.1].
161 * link:v1.8.0.3/git.html[documentation for release 1.8.0.3]
163 * release notes for
164   link:RelNotes/1.8.0.3.txt[1.8.0.3],
165   link:RelNotes/1.8.0.2.txt[1.8.0.2],
166   link:RelNotes/1.8.0.1.txt[1.8.0.1],
167   link:RelNotes/1.8.0.txt[1.8.0].
169 * link:v1.7.12.4/git.html[documentation for release 1.7.12.4]
171 * release notes for
172   link:RelNotes/1.7.12.4.txt[1.7.12.4],
173   link:RelNotes/1.7.12.3.txt[1.7.12.3],
174   link:RelNotes/1.7.12.2.txt[1.7.12.2],
175   link:RelNotes/1.7.12.1.txt[1.7.12.1],
176   link:RelNotes/1.7.12.txt[1.7.12].
178 * link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
180 * release notes for
181   link:RelNotes/1.7.11.7.txt[1.7.11.7],
182   link:RelNotes/1.7.11.6.txt[1.7.11.6],
183   link:RelNotes/1.7.11.5.txt[1.7.11.5],
184   link:RelNotes/1.7.11.4.txt[1.7.11.4],
185   link:RelNotes/1.7.11.3.txt[1.7.11.3],
186   link:RelNotes/1.7.11.2.txt[1.7.11.2],
187   link:RelNotes/1.7.11.1.txt[1.7.11.1],
188   link:RelNotes/1.7.11.txt[1.7.11].
190 * link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
192 * release notes for
193   link:RelNotes/1.7.10.5.txt[1.7.10.5],
194   link:RelNotes/1.7.10.4.txt[1.7.10.4],
195   link:RelNotes/1.7.10.3.txt[1.7.10.3],
196   link:RelNotes/1.7.10.2.txt[1.7.10.2],
197   link:RelNotes/1.7.10.1.txt[1.7.10.1],
198   link:RelNotes/1.7.10.txt[1.7.10].
200 * link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
202 * release notes for
203   link:RelNotes/1.7.9.7.txt[1.7.9.7],
204   link:RelNotes/1.7.9.6.txt[1.7.9.6],
205   link:RelNotes/1.7.9.5.txt[1.7.9.5],
206   link:RelNotes/1.7.9.4.txt[1.7.9.4],
207   link:RelNotes/1.7.9.3.txt[1.7.9.3],
208   link:RelNotes/1.7.9.2.txt[1.7.9.2],
209   link:RelNotes/1.7.9.1.txt[1.7.9.1],
210   link:RelNotes/1.7.9.txt[1.7.9].
212 * link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
214 * release notes for
215   link:RelNotes/1.7.8.6.txt[1.7.8.6],
216   link:RelNotes/1.7.8.5.txt[1.7.8.5],
217   link:RelNotes/1.7.8.4.txt[1.7.8.4],
218   link:RelNotes/1.7.8.3.txt[1.7.8.3],
219   link:RelNotes/1.7.8.2.txt[1.7.8.2],
220   link:RelNotes/1.7.8.1.txt[1.7.8.1],
221   link:RelNotes/1.7.8.txt[1.7.8].
223 * link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
225 * release notes for
226   link:RelNotes/1.7.7.7.txt[1.7.7.7],
227   link:RelNotes/1.7.7.6.txt[1.7.7.6],
228   link:RelNotes/1.7.7.5.txt[1.7.7.5],
229   link:RelNotes/1.7.7.4.txt[1.7.7.4],
230   link:RelNotes/1.7.7.3.txt[1.7.7.3],
231   link:RelNotes/1.7.7.2.txt[1.7.7.2],
232   link:RelNotes/1.7.7.1.txt[1.7.7.1],
233   link:RelNotes/1.7.7.txt[1.7.7].
235 * link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
237 * release notes for
238   link:RelNotes/1.7.6.6.txt[1.7.6.6],
239   link:RelNotes/1.7.6.5.txt[1.7.6.5],
240   link:RelNotes/1.7.6.4.txt[1.7.6.4],
241   link:RelNotes/1.7.6.3.txt[1.7.6.3],
242   link:RelNotes/1.7.6.2.txt[1.7.6.2],
243   link:RelNotes/1.7.6.1.txt[1.7.6.1],
244   link:RelNotes/1.7.6.txt[1.7.6].
246 * link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
248 * release notes for
249   link:RelNotes/1.7.5.4.txt[1.7.5.4],
250   link:RelNotes/1.7.5.3.txt[1.7.5.3],
251   link:RelNotes/1.7.5.2.txt[1.7.5.2],
252   link:RelNotes/1.7.5.1.txt[1.7.5.1],
253   link:RelNotes/1.7.5.txt[1.7.5].
255 * link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
257 * release notes for
258   link:RelNotes/1.7.4.5.txt[1.7.4.5],
259   link:RelNotes/1.7.4.4.txt[1.7.4.4],
260   link:RelNotes/1.7.4.3.txt[1.7.4.3],
261   link:RelNotes/1.7.4.2.txt[1.7.4.2],
262   link:RelNotes/1.7.4.1.txt[1.7.4.1],
263   link:RelNotes/1.7.4.txt[1.7.4].
265 * link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
267 * release notes for
268   link:RelNotes/1.7.3.5.txt[1.7.3.5],
269   link:RelNotes/1.7.3.4.txt[1.7.3.4],
270   link:RelNotes/1.7.3.3.txt[1.7.3.3],
271   link:RelNotes/1.7.3.2.txt[1.7.3.2],
272   link:RelNotes/1.7.3.1.txt[1.7.3.1],
273   link:RelNotes/1.7.3.txt[1.7.3].
275 * link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
277 * release notes for
278   link:RelNotes/1.7.2.5.txt[1.7.2.5],
279   link:RelNotes/1.7.2.4.txt[1.7.2.4],
280   link:RelNotes/1.7.2.3.txt[1.7.2.3],
281   link:RelNotes/1.7.2.2.txt[1.7.2.2],
282   link:RelNotes/1.7.2.1.txt[1.7.2.1],
283   link:RelNotes/1.7.2.txt[1.7.2].
285 * link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
287 * release notes for
288   link:RelNotes/1.7.1.4.txt[1.7.1.4],
289   link:RelNotes/1.7.1.3.txt[1.7.1.3],
290   link:RelNotes/1.7.1.2.txt[1.7.1.2],
291   link:RelNotes/1.7.1.1.txt[1.7.1.1],
292   link:RelNotes/1.7.1.txt[1.7.1].
294 * link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
296 * release notes for
297   link:RelNotes/1.7.0.9.txt[1.7.0.9],
298   link:RelNotes/1.7.0.8.txt[1.7.0.8],
299   link:RelNotes/1.7.0.7.txt[1.7.0.7],
300   link:RelNotes/1.7.0.6.txt[1.7.0.6],
301   link:RelNotes/1.7.0.5.txt[1.7.0.5],
302   link:RelNotes/1.7.0.4.txt[1.7.0.4],
303   link:RelNotes/1.7.0.3.txt[1.7.0.3],
304   link:RelNotes/1.7.0.2.txt[1.7.0.2],
305   link:RelNotes/1.7.0.1.txt[1.7.0.1],
306   link:RelNotes/1.7.0.txt[1.7.0].
308 * link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
310 * release notes for
311   link:RelNotes/1.6.6.3.txt[1.6.6.3],
312   link:RelNotes/1.6.6.2.txt[1.6.6.2],
313   link:RelNotes/1.6.6.1.txt[1.6.6.1],
314   link:RelNotes/1.6.6.txt[1.6.6].
316 * link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
318 * release notes for
319   link:RelNotes/1.6.5.9.txt[1.6.5.9],
320   link:RelNotes/1.6.5.8.txt[1.6.5.8],
321   link:RelNotes/1.6.5.7.txt[1.6.5.7],
322   link:RelNotes/1.6.5.6.txt[1.6.5.6],
323   link:RelNotes/1.6.5.5.txt[1.6.5.5],
324   link:RelNotes/1.6.5.4.txt[1.6.5.4],
325   link:RelNotes/1.6.5.3.txt[1.6.5.3],
326   link:RelNotes/1.6.5.2.txt[1.6.5.2],
327   link:RelNotes/1.6.5.1.txt[1.6.5.1],
328   link:RelNotes/1.6.5.txt[1.6.5].
330 * link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
332 * release notes for
333   link:RelNotes/1.6.4.5.txt[1.6.4.5],
334   link:RelNotes/1.6.4.4.txt[1.6.4.4],
335   link:RelNotes/1.6.4.3.txt[1.6.4.3],
336   link:RelNotes/1.6.4.2.txt[1.6.4.2],
337   link:RelNotes/1.6.4.1.txt[1.6.4.1],
338   link:RelNotes/1.6.4.txt[1.6.4].
340 * link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
342 * release notes for
343   link:RelNotes/1.6.3.4.txt[1.6.3.4],
344   link:RelNotes/1.6.3.3.txt[1.6.3.3],
345   link:RelNotes/1.6.3.2.txt[1.6.3.2],
346   link:RelNotes/1.6.3.1.txt[1.6.3.1],
347   link:RelNotes/1.6.3.txt[1.6.3].
349 * release notes for
350   link:RelNotes/1.6.2.5.txt[1.6.2.5],
351   link:RelNotes/1.6.2.4.txt[1.6.2.4],
352   link:RelNotes/1.6.2.3.txt[1.6.2.3],
353   link:RelNotes/1.6.2.2.txt[1.6.2.2],
354   link:RelNotes/1.6.2.1.txt[1.6.2.1],
355   link:RelNotes/1.6.2.txt[1.6.2].
357 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
359 * release notes for
360   link:RelNotes/1.6.1.3.txt[1.6.1.3],
361   link:RelNotes/1.6.1.2.txt[1.6.1.2],
362   link:RelNotes/1.6.1.1.txt[1.6.1.1],
363   link:RelNotes/1.6.1.txt[1.6.1].
365 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
367 * release notes for
368   link:RelNotes/1.6.0.6.txt[1.6.0.6],
369   link:RelNotes/1.6.0.5.txt[1.6.0.5],
370   link:RelNotes/1.6.0.4.txt[1.6.0.4],
371   link:RelNotes/1.6.0.3.txt[1.6.0.3],
372   link:RelNotes/1.6.0.2.txt[1.6.0.2],
373   link:RelNotes/1.6.0.1.txt[1.6.0.1],
374   link:RelNotes/1.6.0.txt[1.6.0].
376 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
378 * release notes for
379   link:RelNotes/1.5.6.6.txt[1.5.6.6],
380   link:RelNotes/1.5.6.5.txt[1.5.6.5],
381   link:RelNotes/1.5.6.4.txt[1.5.6.4],
382   link:RelNotes/1.5.6.3.txt[1.5.6.3],
383   link:RelNotes/1.5.6.2.txt[1.5.6.2],
384   link:RelNotes/1.5.6.1.txt[1.5.6.1],
385   link:RelNotes/1.5.6.txt[1.5.6].
387 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
389 * release notes for
390   link:RelNotes/1.5.5.6.txt[1.5.5.6],
391   link:RelNotes/1.5.5.5.txt[1.5.5.5],
392   link:RelNotes/1.5.5.4.txt[1.5.5.4],
393   link:RelNotes/1.5.5.3.txt[1.5.5.3],
394   link:RelNotes/1.5.5.2.txt[1.5.5.2],
395   link:RelNotes/1.5.5.1.txt[1.5.5.1],
396   link:RelNotes/1.5.5.txt[1.5.5].
398 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
400 * release notes for
401   link:RelNotes/1.5.4.7.txt[1.5.4.7],
402   link:RelNotes/1.5.4.6.txt[1.5.4.6],
403   link:RelNotes/1.5.4.5.txt[1.5.4.5],
404   link:RelNotes/1.5.4.4.txt[1.5.4.4],
405   link:RelNotes/1.5.4.3.txt[1.5.4.3],
406   link:RelNotes/1.5.4.2.txt[1.5.4.2],
407   link:RelNotes/1.5.4.1.txt[1.5.4.1],
408   link:RelNotes/1.5.4.txt[1.5.4].
410 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
412 * release notes for
413   link:RelNotes/1.5.3.8.txt[1.5.3.8],
414   link:RelNotes/1.5.3.7.txt[1.5.3.7],
415   link:RelNotes/1.5.3.6.txt[1.5.3.6],
416   link:RelNotes/1.5.3.5.txt[1.5.3.5],
417   link:RelNotes/1.5.3.4.txt[1.5.3.4],
418   link:RelNotes/1.5.3.3.txt[1.5.3.3],
419   link:RelNotes/1.5.3.2.txt[1.5.3.2],
420   link:RelNotes/1.5.3.1.txt[1.5.3.1],
421   link:RelNotes/1.5.3.txt[1.5.3].
423 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
425 * release notes for
426   link:RelNotes/1.5.2.5.txt[1.5.2.5],
427   link:RelNotes/1.5.2.4.txt[1.5.2.4],
428   link:RelNotes/1.5.2.3.txt[1.5.2.3],
429   link:RelNotes/1.5.2.2.txt[1.5.2.2],
430   link:RelNotes/1.5.2.1.txt[1.5.2.1],
431   link:RelNotes/1.5.2.txt[1.5.2].
433 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
435 * release notes for
436   link:RelNotes/1.5.1.6.txt[1.5.1.6],
437   link:RelNotes/1.5.1.5.txt[1.5.1.5],
438   link:RelNotes/1.5.1.4.txt[1.5.1.4],
439   link:RelNotes/1.5.1.3.txt[1.5.1.3],
440   link:RelNotes/1.5.1.2.txt[1.5.1.2],
441   link:RelNotes/1.5.1.1.txt[1.5.1.1],
442   link:RelNotes/1.5.1.txt[1.5.1].
444 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
446 * release notes for
447   link:RelNotes/1.5.0.7.txt[1.5.0.7],
448   link:RelNotes/1.5.0.6.txt[1.5.0.6],
449   link:RelNotes/1.5.0.5.txt[1.5.0.5],
450   link:RelNotes/1.5.0.3.txt[1.5.0.3],
451   link:RelNotes/1.5.0.2.txt[1.5.0.2],
452   link:RelNotes/1.5.0.1.txt[1.5.0.1],
453   link:RelNotes/1.5.0.txt[1.5.0].
455 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
456   link:v1.3.3/git.html[1.3.3],
457   link:v1.2.6/git.html[1.2.6],
458   link:v1.0.13/git.html[1.0.13].
460 ============
462 endif::stalenotes[]
464 OPTIONS
465 -------
466 --version::
467         Prints the Git suite version that the 'git' program came from.
469 --help::
470         Prints the synopsis and a list of the most commonly used
471         commands. If the option '--all' or '-a' is given then all
472         available commands are printed. If a Git command is named this
473         option will bring up the manual page for that command.
475 Other options are available to control how the manual page is
476 displayed. See linkgit:git-help[1] for more information,
477 because `git --help ...` is converted internally into `git
478 help ...`.
480 -C <path>::
481         Run as if git was started in '<path>' instead of the current working
482         directory.  When multiple `-C` options are given, each subsequent
483         non-absolute `-C <path>` is interpreted relative to the preceding `-C
484         <path>`.
486 This option affects options that expect path name like `--git-dir` and
487 `--work-tree` in that their interpretations of the path names would be
488 made relative to the working directory caused by the `-C` option. For
489 example the following invocations are equivalent:
491     git --git-dir=a.git --work-tree=b -C c status
492     git --git-dir=c/a.git --work-tree=c/b status
494 -c <name>=<value>::
495         Pass a configuration parameter to the command. The value
496         given will override values from configuration files.
497         The <name> is expected in the same format as listed by
498         'git config' (subkeys separated by dots).
500 Note that omitting the `=` in `git -c foo.bar ...` is allowed and sets
501 `foo.bar` to the boolean true value (just like `[foo]bar` would in a
502 config file). Including the equals but with an empty value (like `git -c
503 foo.bar= ...`) sets `foo.bar` to the empty string.
505 --exec-path[=<path>]::
506         Path to wherever your core Git programs are installed.
507         This can also be controlled by setting the GIT_EXEC_PATH
508         environment variable. If no path is given, 'git' will print
509         the current setting and then exit.
511 --html-path::
512         Print the path, without trailing slash, where Git's HTML
513         documentation is installed and exit.
515 --man-path::
516         Print the manpath (see `man(1)`) for the man pages for
517         this version of Git and exit.
519 --info-path::
520         Print the path where the Info files documenting this
521         version of Git are installed and exit.
523 -p::
524 --paginate::
525         Pipe all output into 'less' (or if set, $PAGER) if standard
526         output is a terminal.  This overrides the `pager.<cmd>`
527         configuration options (see the "Configuration Mechanism" section
528         below).
530 --no-pager::
531         Do not pipe Git output into a pager.
533 --git-dir=<path>::
534         Set the path to the repository. This can also be controlled by
535         setting the GIT_DIR environment variable. It can be an absolute
536         path or relative path to current working directory.
538 --work-tree=<path>::
539         Set the path to the working tree. It can be an absolute path
540         or a path relative to the current working directory.
541         This can also be controlled by setting the GIT_WORK_TREE
542         environment variable and the core.worktree configuration
543         variable (see core.worktree in linkgit:git-config[1] for a
544         more detailed discussion).
546 --namespace=<path>::
547         Set the Git namespace.  See linkgit:gitnamespaces[7] for more
548         details.  Equivalent to setting the `GIT_NAMESPACE` environment
549         variable.
551 --bare::
552         Treat the repository as a bare repository.  If GIT_DIR
553         environment is not set, it is set to the current working
554         directory.
556 --no-replace-objects::
557         Do not use replacement refs to replace Git objects. See
558         linkgit:git-replace[1] for more information.
560 --literal-pathspecs::
561         Treat pathspecs literally (i.e. no globbing, no pathspec magic).
562         This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
563         variable to `1`.
565 --glob-pathspecs::
566         Add "glob" magic to all pathspec. This is equivalent to setting
567         the `GIT_GLOB_PATHSPECS` environment variable to `1`. Disabling
568         globbing on individual pathspecs can be done using pathspec
569         magic ":(literal)"
571 --noglob-pathspecs::
572         Add "literal" magic to all pathspec. This is equivalent to setting
573         the `GIT_NOGLOB_PATHSPECS` environment variable to `1`. Enabling
574         globbing on individual pathspecs can be done using pathspec
575         magic ":(glob)"
577 --icase-pathspecs::
578         Add "icase" magic to all pathspec. This is equivalent to setting
579         the `GIT_ICASE_PATHSPECS` environment variable to `1`.
581 GIT COMMANDS
582 ------------
584 We divide Git into high level ("porcelain") commands and low level
585 ("plumbing") commands.
587 High-level commands (porcelain)
588 -------------------------------
590 We separate the porcelain commands into the main commands and some
591 ancillary user utilities.
593 Main porcelain commands
594 ~~~~~~~~~~~~~~~~~~~~~~~
596 include::cmds-mainporcelain.txt[]
598 Ancillary Commands
599 ~~~~~~~~~~~~~~~~~~
600 Manipulators:
602 include::cmds-ancillarymanipulators.txt[]
604 Interrogators:
606 include::cmds-ancillaryinterrogators.txt[]
609 Interacting with Others
610 ~~~~~~~~~~~~~~~~~~~~~~~
612 These commands are to interact with foreign SCM and with other
613 people via patch over e-mail.
615 include::cmds-foreignscminterface.txt[]
618 Low-level commands (plumbing)
619 -----------------------------
621 Although Git includes its
622 own porcelain layer, its low-level commands are sufficient to support
623 development of alternative porcelains.  Developers of such porcelains
624 might start by reading about linkgit:git-update-index[1] and
625 linkgit:git-read-tree[1].
627 The interface (input, output, set of options and the semantics)
628 to these low-level commands are meant to be a lot more stable
629 than Porcelain level commands, because these commands are
630 primarily for scripted use.  The interface to Porcelain commands
631 on the other hand are subject to change in order to improve the
632 end user experience.
634 The following description divides
635 the low-level commands into commands that manipulate objects (in
636 the repository, index, and working tree), commands that interrogate and
637 compare objects, and commands that move objects and references between
638 repositories.
641 Manipulation commands
642 ~~~~~~~~~~~~~~~~~~~~~
644 include::cmds-plumbingmanipulators.txt[]
647 Interrogation commands
648 ~~~~~~~~~~~~~~~~~~~~~~
650 include::cmds-plumbinginterrogators.txt[]
652 In general, the interrogate commands do not touch the files in
653 the working tree.
656 Synching repositories
657 ~~~~~~~~~~~~~~~~~~~~~
659 include::cmds-synchingrepositories.txt[]
661 The following are helper commands used by the above; end users
662 typically do not use them directly.
664 include::cmds-synchelpers.txt[]
667 Internal helper commands
668 ~~~~~~~~~~~~~~~~~~~~~~~~
670 These are internal helper commands used by other commands; end
671 users typically do not use them directly.
673 include::cmds-purehelpers.txt[]
676 Configuration Mechanism
677 -----------------------
679 Git uses a simple text format to store customizations that are per
680 repository and are per user.  Such a configuration file may look
681 like this:
683 ------------
685 # A '#' or ';' character indicates a comment.
688 ; core variables
689 [core]
690         ; Don't trust file modes
691         filemode = false
693 ; user identity
694 [user]
695         name = "Junio C Hamano"
696         email = "gitster@pobox.com"
698 ------------
700 Various commands read from the configuration file and adjust
701 their operation accordingly.  See linkgit:git-config[1] for a
702 list and more details about the configuration mechanism.
705 Identifier Terminology
706 ----------------------
707 <object>::
708         Indicates the object name for any type of object.
710 <blob>::
711         Indicates a blob object name.
713 <tree>::
714         Indicates a tree object name.
716 <commit>::
717         Indicates a commit object name.
719 <tree-ish>::
720         Indicates a tree, commit or tag object name.  A
721         command that takes a <tree-ish> argument ultimately wants to
722         operate on a <tree> object but automatically dereferences
723         <commit> and <tag> objects that point at a <tree>.
725 <commit-ish>::
726         Indicates a commit or tag object name.  A
727         command that takes a <commit-ish> argument ultimately wants to
728         operate on a <commit> object but automatically dereferences
729         <tag> objects that point at a <commit>.
731 <type>::
732         Indicates that an object type is required.
733         Currently one of: `blob`, `tree`, `commit`, or `tag`.
735 <file>::
736         Indicates a filename - almost always relative to the
737         root of the tree structure `GIT_INDEX_FILE` describes.
739 Symbolic Identifiers
740 --------------------
741 Any Git command accepting any <object> can also use the following
742 symbolic notation:
744 HEAD::
745         indicates the head of the current branch.
747 <tag>::
748         a valid tag 'name'
749         (i.e. a `refs/tags/<tag>` reference).
751 <head>::
752         a valid head 'name'
753         (i.e. a `refs/heads/<head>` reference).
755 For a more complete list of ways to spell object names, see
756 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
759 File/Directory Structure
760 ------------------------
762 Please see the linkgit:gitrepository-layout[5] document.
764 Read linkgit:githooks[5] for more details about each hook.
766 Higher level SCMs may provide and manage additional information in the
767 `$GIT_DIR`.
770 Terminology
771 -----------
772 Please see linkgit:gitglossary[7].
775 Environment Variables
776 ---------------------
777 Various Git commands use the following environment variables:
779 The Git Repository
780 ~~~~~~~~~~~~~~~~~~
781 These environment variables apply to 'all' core Git commands. Nb: it
782 is worth noting that they may be used/overridden by SCMS sitting above
783 Git so take care if using Cogito etc.
785 'GIT_INDEX_FILE'::
786         This environment allows the specification of an alternate
787         index file. If not specified, the default of `$GIT_DIR/index`
788         is used.
790 'GIT_INDEX_VERSION'::
791         This environment variable allows the specification of an index
792         version for new repositories.  It won't affect existing index
793         files.  By default index file version 2 or 3 is used. See
794         linkgit:git-update-index[1] for more information.
796 'GIT_OBJECT_DIRECTORY'::
797         If the object storage directory is specified via this
798         environment variable then the sha1 directories are created
799         underneath - otherwise the default `$GIT_DIR/objects`
800         directory is used.
802 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
803         Due to the immutable nature of Git objects, old objects can be
804         archived into shared, read-only directories. This variable
805         specifies a ":" separated (on Windows ";" separated) list
806         of Git object directories which can be used to search for Git
807         objects. New objects will not be written to these directories.
809 'GIT_DIR'::
810         If the 'GIT_DIR' environment variable is set then it
811         specifies a path to use instead of the default `.git`
812         for the base of the repository.
813         The '--git-dir' command-line option also sets this value.
815 'GIT_WORK_TREE'::
816         Set the path to the root of the working tree.
817         This can also be controlled by the '--work-tree' command-line
818         option and the core.worktree configuration variable.
820 'GIT_NAMESPACE'::
821         Set the Git namespace; see linkgit:gitnamespaces[7] for details.
822         The '--namespace' command-line option also sets this value.
824 'GIT_CEILING_DIRECTORIES'::
825         This should be a colon-separated list of absolute paths.  If
826         set, it is a list of directories that Git should not chdir up
827         into while looking for a repository directory (useful for
828         excluding slow-loading network directories).  It will not
829         exclude the current working directory or a GIT_DIR set on the
830         command line or in the environment.  Normally, Git has to read
831         the entries in this list and resolve any symlink that
832         might be present in order to compare them with the current
833         directory.  However, if even this access is slow, you
834         can add an empty entry to the list to tell Git that the
835         subsequent entries are not symlinks and needn't be resolved;
836         e.g.,
837         'GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink'.
839 'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
840         When run in a directory that does not have ".git" repository
841         directory, Git tries to find such a directory in the parent
842         directories to find the top of the working tree, but by default it
843         does not cross filesystem boundaries.  This environment variable
844         can be set to true to tell Git not to stop at filesystem
845         boundaries.  Like 'GIT_CEILING_DIRECTORIES', this will not affect
846         an explicit repository directory set via 'GIT_DIR' or on the
847         command line.
849 'GIT_COMMON_DIR'::
850         If this variable is set to a path, non-worktree files that are
851         normally in $GIT_DIR will be taken from this path
852         instead. Worktree-specific files such as HEAD or index are
853         taken from $GIT_DIR. See linkgit:gitrepository-layout[5] and
854         linkgit:git-worktree[1] for
855         details. This variable has lower precedence than other path
856         variables such as GIT_INDEX_FILE, GIT_OBJECT_DIRECTORY...
858 Git Commits
859 ~~~~~~~~~~~
860 'GIT_AUTHOR_NAME'::
861 'GIT_AUTHOR_EMAIL'::
862 'GIT_AUTHOR_DATE'::
863 'GIT_COMMITTER_NAME'::
864 'GIT_COMMITTER_EMAIL'::
865 'GIT_COMMITTER_DATE'::
866 'EMAIL'::
867         see linkgit:git-commit-tree[1]
869 Git Diffs
870 ~~~~~~~~~
871 'GIT_DIFF_OPTS'::
872         Only valid setting is "--unified=??" or "-u??" to set the
873         number of context lines shown when a unified diff is created.
874         This takes precedence over any "-U" or "--unified" option
875         value passed on the Git diff command line.
877 'GIT_EXTERNAL_DIFF'::
878         When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
879         program named by it is called, instead of the diff invocation
880         described above.  For a path that is added, removed, or modified,
881         'GIT_EXTERNAL_DIFF' is called with 7 parameters:
883         path old-file old-hex old-mode new-file new-hex new-mode
885 where:
887         <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
888                          contents of <old|new>,
889         <old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
890         <old|new>-mode:: are the octal representation of the file modes.
892 The file parameters can point at the user's working file
893 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
894 when a new file is added), or a temporary file (e.g. `old-file` in the
895 index).  'GIT_EXTERNAL_DIFF' should not worry about unlinking the
896 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
898 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
899 parameter, <path>.
901 For each path 'GIT_EXTERNAL_DIFF' is called, two environment variables,
902 'GIT_DIFF_PATH_COUNTER' and 'GIT_DIFF_PATH_TOTAL' are set.
904 'GIT_DIFF_PATH_COUNTER'::
905         A 1-based counter incremented by one for every path.
907 'GIT_DIFF_PATH_TOTAL'::
908         The total number of paths.
910 other
911 ~~~~~
912 'GIT_MERGE_VERBOSITY'::
913         A number controlling the amount of output shown by
914         the recursive merge strategy.  Overrides merge.verbosity.
915         See linkgit:git-merge[1]
917 'GIT_PAGER'::
918         This environment variable overrides `$PAGER`. If it is set
919         to an empty string or to the value "cat", Git will not launch
920         a pager.  See also the `core.pager` option in
921         linkgit:git-config[1].
923 'GIT_EDITOR'::
924         This environment variable overrides `$EDITOR` and `$VISUAL`.
925         It is used by several Git commands when, on interactive mode,
926         an editor is to be launched. See also linkgit:git-var[1]
927         and the `core.editor` option in linkgit:git-config[1].
929 'GIT_SSH'::
930 'GIT_SSH_COMMAND'::
931         If either of these environment variables is set then 'git fetch'
932         and 'git push' will use the specified command instead of 'ssh'
933         when they need to connect to a remote system.
934         The command will be given exactly two or four arguments: the
935         'username@host' (or just 'host') from the URL and the shell
936         command to execute on that remote system, optionally preceded by
937         '-p' (literally) and the 'port' from the URL when it specifies
938         something other than the default SSH port.
940 `$GIT_SSH_COMMAND` takes precedence over `$GIT_SSH`, and is interpreted
941 by the shell, which allows additional arguments to be included.
942 `$GIT_SSH` on the other hand must be just the path to a program
943 (which can be a wrapper shell script, if additional arguments are
944 needed).
946 Usually it is easier to configure any desired options through your
947 personal `.ssh/config` file.  Please consult your ssh documentation
948 for further details.
950 'GIT_ASKPASS'::
951         If this environment variable is set, then Git commands which need to
952         acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
953         will call this program with a suitable prompt as command-line argument
954         and read the password from its STDOUT. See also the 'core.askPass'
955         option in linkgit:git-config[1].
957 'GIT_TERMINAL_PROMPT'::
958         If this environment variable is set to `0`, git will not prompt
959         on the terminal (e.g., when asking for HTTP authentication).
961 'GIT_CONFIG_NOSYSTEM'::
962         Whether to skip reading settings from the system-wide
963         `$(prefix)/etc/gitconfig` file.  This environment variable can
964         be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
965         predictable environment for a picky script, or you can set it
966         temporarily to avoid using a buggy `/etc/gitconfig` file while
967         waiting for someone with sufficient permissions to fix it.
969 'GIT_FLUSH'::
970         If this environment variable is set to "1", then commands such
971         as 'git blame' (in incremental mode), 'git rev-list', 'git log',
972         'git check-attr' and 'git check-ignore' will
973         force a flush of the output stream after each record have been
974         flushed. If this
975         variable is set to "0", the output of these commands will be done
976         using completely buffered I/O.   If this environment variable is
977         not set, Git will choose buffered or record-oriented flushing
978         based on whether stdout appears to be redirected to a file or not.
980 'GIT_TRACE'::
981         Enables general trace messages, e.g. alias expansion, built-in
982         command execution and external command execution.
984 If this variable is set to "1", "2" or "true" (comparison
985 is case insensitive), trace messages will be printed to
986 stderr.
988 If the variable is set to an integer value greater than 2
989 and lower than 10 (strictly) then Git will interpret this
990 value as an open file descriptor and will try to write the
991 trace messages into this file descriptor.
993 Alternatively, if the variable is set to an absolute path
994 (starting with a '/' character), Git will interpret this
995 as a file path and will try to write the trace messages
996 into it.
998 Unsetting the variable, or setting it to empty, "0" or
999 "false" (case insensitive) disables trace messages.
1001 'GIT_TRACE_PACK_ACCESS'::
1002         Enables trace messages for all accesses to any packs. For each
1003         access, the pack file name and an offset in the pack is
1004         recorded. This may be helpful for troubleshooting some
1005         pack-related performance problems.
1006         See 'GIT_TRACE' for available trace output options.
1008 'GIT_TRACE_PACKET'::
1009         Enables trace messages for all packets coming in or out of a
1010         given program. This can help with debugging object negotiation
1011         or other protocol issues. Tracing is turned off at a packet
1012         starting with "PACK".
1013         See 'GIT_TRACE' for available trace output options.
1015 'GIT_TRACE_PERFORMANCE'::
1016         Enables performance related trace messages, e.g. total execution
1017         time of each Git command.
1018         See 'GIT_TRACE' for available trace output options.
1020 'GIT_TRACE_SETUP'::
1021         Enables trace messages printing the .git, working tree and current
1022         working directory after Git has completed its setup phase.
1023         See 'GIT_TRACE' for available trace output options.
1025 'GIT_TRACE_SHALLOW'::
1026         Enables trace messages that can help debugging fetching /
1027         cloning of shallow repositories.
1028         See 'GIT_TRACE' for available trace output options.
1030 GIT_LITERAL_PATHSPECS::
1031         Setting this variable to `1` will cause Git to treat all
1032         pathspecs literally, rather than as glob patterns. For example,
1033         running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
1034         for commits that touch the path `*.c`, not any paths that the
1035         glob `*.c` matches. You might want this if you are feeding
1036         literal paths to Git (e.g., paths previously given to you by
1037         `git ls-tree`, `--raw` diff output, etc).
1039 GIT_GLOB_PATHSPECS::
1040         Setting this variable to `1` will cause Git to treat all
1041         pathspecs as glob patterns (aka "glob" magic).
1043 GIT_NOGLOB_PATHSPECS::
1044         Setting this variable to `1` will cause Git to treat all
1045         pathspecs as literal (aka "literal" magic).
1047 GIT_ICASE_PATHSPECS::
1048         Setting this variable to `1` will cause Git to treat all
1049         pathspecs as case-insensitive.
1051 'GIT_REFLOG_ACTION'::
1052         When a ref is updated, reflog entries are created to keep
1053         track of the reason why the ref was updated (which is
1054         typically the name of the high-level command that updated
1055         the ref), in addition to the old and new values of the ref.
1056         A scripted Porcelain command can use set_reflog_action
1057         helper function in `git-sh-setup` to set its name to this
1058         variable when it is invoked as the top level command by the
1059         end user, to be recorded in the body of the reflog.
1061 `GIT_REF_PARANOIA`::
1062         If set to `1`, include broken or badly named refs when iterating
1063         over lists of refs. In a normal, non-corrupted repository, this
1064         does nothing. However, enabling it may help git to detect and
1065         abort some operations in the presence of broken refs. Git sets
1066         this variable automatically when performing destructive
1067         operations like linkgit:git-prune[1]. You should not need to set
1068         it yourself unless you want to be paranoid about making sure
1069         an operation has touched every ref (e.g., because you are
1070         cloning a repository to make a backup).
1073 Discussion[[Discussion]]
1074 ------------------------
1076 More detail on the following is available from the
1077 link:user-manual.html#git-concepts[Git concepts chapter of the
1078 user-manual] and linkgit:gitcore-tutorial[7].
1080 A Git project normally consists of a working directory with a ".git"
1081 subdirectory at the top level.  The .git directory contains, among other
1082 things, a compressed object database representing the complete history
1083 of the project, an "index" file which links that history to the current
1084 contents of the working tree, and named pointers into that history such
1085 as tags and branch heads.
1087 The object database contains objects of three main types: blobs, which
1088 hold file data; trees, which point to blobs and other trees to build up
1089 directory hierarchies; and commits, which each reference a single tree
1090 and some number of parent commits.
1092 The commit, equivalent to what other systems call a "changeset" or
1093 "version", represents a step in the project's history, and each parent
1094 represents an immediately preceding step.  Commits with more than one
1095 parent represent merges of independent lines of development.
1097 All objects are named by the SHA-1 hash of their contents, normally
1098 written as a string of 40 hex digits.  Such names are globally unique.
1099 The entire history leading up to a commit can be vouched for by signing
1100 just that commit.  A fourth object type, the tag, is provided for this
1101 purpose.
1103 When first created, objects are stored in individual files, but for
1104 efficiency may later be compressed together into "pack files".
1106 Named pointers called refs mark interesting points in history.  A ref
1107 may contain the SHA-1 name of an object or the name of another ref.  Refs
1108 with names beginning `ref/head/` contain the SHA-1 name of the most
1109 recent commit (or "head") of a branch under development.  SHA-1 names of
1110 tags of interest are stored under `ref/tags/`.  A special ref named
1111 `HEAD` contains the name of the currently checked-out branch.
1113 The index file is initialized with a list of all paths and, for each
1114 path, a blob object and a set of attributes.  The blob object represents
1115 the contents of the file as of the head of the current branch.  The
1116 attributes (last modified time, size, etc.) are taken from the
1117 corresponding file in the working tree.  Subsequent changes to the
1118 working tree can be found by comparing these attributes.  The index may
1119 be updated with new content, and new commits may be created from the
1120 content stored in the index.
1122 The index is also capable of storing multiple entries (called "stages")
1123 for a given pathname.  These stages are used to hold the various
1124 unmerged version of a file when a merge is in progress.
1126 FURTHER DOCUMENTATION
1127 ---------------------
1129 See the references in the "description" section to get started
1130 using Git.  The following is probably more detail than necessary
1131 for a first-time user.
1133 The link:user-manual.html#git-concepts[Git concepts chapter of the
1134 user-manual] and linkgit:gitcore-tutorial[7] both provide
1135 introductions to the underlying Git architecture.
1137 See linkgit:gitworkflows[7] for an overview of recommended workflows.
1139 See also the link:howto-index.html[howto] documents for some useful
1140 examples.
1142 The internals are documented in the
1143 link:technical/api-index.html[Git API documentation].
1145 Users migrating from CVS may also want to
1146 read linkgit:gitcvs-migration[7].
1149 Authors
1150 -------
1151 Git was started by Linus Torvalds, and is currently maintained by Junio
1152 C Hamano. Numerous contributions have come from the Git mailing list
1153 <git@vger.kernel.org>.  http://www.openhub.net/p/git/contributors/summary
1154 gives you a more complete list of contributors.
1156 If you have a clone of git.git itself, the
1157 output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
1158 the authors for specific parts of the project.
1160 Reporting Bugs
1161 --------------
1163 Report bugs to the Git mailing list <git@vger.kernel.org> where the
1164 development and maintenance is primarily done.  You do not have to be
1165 subscribed to the list to send a message there.
1167 SEE ALSO
1168 --------
1169 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
1170 linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
1171 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
1172 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
1173 linkgit:gitworkflows[7]
1177 Part of the linkgit:git[1] suite