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