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