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