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