submodule: decouple url and submodule interest
[git/raj.git] / Documentation / git.txt
blobdf0941d456b0fa1ab3be4f459f73edd3145ffb32
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     [--super-prefix=<path>]
17     <command> [<args>]
19 DESCRIPTION
20 -----------
21 Git is a fast, scalable, distributed revision control system with an
22 unusually rich command set that provides both high-level operations
23 and full access to internals.
25 See linkgit:gittutorial[7] to get started, then see
26 linkgit:giteveryday[7] for a useful minimum set of
27 commands.  The link:user-manual.html[Git User's Manual] has a more
28 in-depth introduction.
30 After you mastered the basic concepts, you can come back to this
31 page to learn what commands Git offers.  You can learn more about
32 individual Git commands with "git help command".  linkgit:gitcli[7]
33 manual page gives you an overview of the command-line command syntax.
35 A formatted and hyperlinked copy of the latest Git documentation
36 can be viewed at `https://git.github.io/htmldocs/git.html`.
38 ifdef::stalenotes[]
39 [NOTE]
40 ============
42 You are reading the documentation for the latest (possibly
43 unreleased) version of Git, that is available from the 'master'
44 branch of the `git.git` repository.
45 Documentation for older releases are available here:
47 * link:v2.12.0/git.html[documentation for release 2.12.0]
49 * release notes for
50   link:RelNotes/2.12.0.txt[2.12].
52 * link:v2.11.1/git.html[documentation for release 2.11.1]
54 * release notes for
55   link:RelNotes/2.11.1.txt[2.11.1],
56   link:RelNotes/2.11.0.txt[2.11].
58 * link:v2.10.2/git.html[documentation for release 2.10.2]
60 * release notes for
61   link:RelNotes/2.10.2.txt[2.10.2],
62   link:RelNotes/2.10.1.txt[2.10.1],
63   link:RelNotes/2.10.0.txt[2.10].
65 * link:v2.9.3/git.html[documentation for release 2.9.3]
67 * release notes for
68   link:RelNotes/2.9.3.txt[2.9.3],
69   link:RelNotes/2.9.2.txt[2.9.2],
70   link:RelNotes/2.9.1.txt[2.9.1],
71   link:RelNotes/2.9.0.txt[2.9].
73 * link:v2.8.4/git.html[documentation for release 2.8.4]
75 * release notes for
76   link:RelNotes/2.8.4.txt[2.8.4],
77   link:RelNotes/2.8.3.txt[2.8.3],
78   link:RelNotes/2.8.2.txt[2.8.2],
79   link:RelNotes/2.8.1.txt[2.8.1],
80   link:RelNotes/2.8.0.txt[2.8].
82 * link:v2.7.3/git.html[documentation for release 2.7.3]
84 * release notes for
85   link:RelNotes/2.7.3.txt[2.7.3],
86   link:RelNotes/2.7.2.txt[2.7.2],
87   link:RelNotes/2.7.1.txt[2.7.1],
88   link:RelNotes/2.7.0.txt[2.7].
90 * link:v2.6.6/git.html[documentation for release 2.6.6]
92 * release notes for
93   link:RelNotes/2.6.6.txt[2.6.6],
94   link:RelNotes/2.6.5.txt[2.6.5],
95   link:RelNotes/2.6.4.txt[2.6.4],
96   link:RelNotes/2.6.3.txt[2.6.3],
97   link:RelNotes/2.6.2.txt[2.6.2],
98   link:RelNotes/2.6.1.txt[2.6.1],
99   link:RelNotes/2.6.0.txt[2.6].
101 * link:v2.5.5/git.html[documentation for release 2.5.5]
103 * release notes for
104   link:RelNotes/2.5.5.txt[2.5.5],
105   link:RelNotes/2.5.4.txt[2.5.4],
106   link:RelNotes/2.5.3.txt[2.5.3],
107   link:RelNotes/2.5.2.txt[2.5.2],
108   link:RelNotes/2.5.1.txt[2.5.1],
109   link:RelNotes/2.5.0.txt[2.5].
111 * link:v2.4.11/git.html[documentation for release 2.4.11]
113 * release notes for
114   link:RelNotes/2.4.11.txt[2.4.11],
115   link:RelNotes/2.4.10.txt[2.4.10],
116   link:RelNotes/2.4.9.txt[2.4.9],
117   link:RelNotes/2.4.8.txt[2.4.8],
118   link:RelNotes/2.4.7.txt[2.4.7],
119   link:RelNotes/2.4.6.txt[2.4.6],
120   link:RelNotes/2.4.5.txt[2.4.5],
121   link:RelNotes/2.4.4.txt[2.4.4],
122   link:RelNotes/2.4.3.txt[2.4.3],
123   link:RelNotes/2.4.2.txt[2.4.2],
124   link:RelNotes/2.4.1.txt[2.4.1],
125   link:RelNotes/2.4.0.txt[2.4].
127 * link:v2.3.10/git.html[documentation for release 2.3.10]
129 * release notes for
130   link:RelNotes/2.3.10.txt[2.3.10],
131   link:RelNotes/2.3.9.txt[2.3.9],
132   link:RelNotes/2.3.8.txt[2.3.8],
133   link:RelNotes/2.3.7.txt[2.3.7],
134   link:RelNotes/2.3.6.txt[2.3.6],
135   link:RelNotes/2.3.5.txt[2.3.5],
136   link:RelNotes/2.3.4.txt[2.3.4],
137   link:RelNotes/2.3.3.txt[2.3.3],
138   link:RelNotes/2.3.2.txt[2.3.2],
139   link:RelNotes/2.3.1.txt[2.3.1],
140   link:RelNotes/2.3.0.txt[2.3].
142 * link:v2.2.3/git.html[documentation for release 2.2.3]
144 * release notes for
145   link:RelNotes/2.2.3.txt[2.2.3],
146   link:RelNotes/2.2.2.txt[2.2.2],
147   link:RelNotes/2.2.1.txt[2.2.1],
148   link:RelNotes/2.2.0.txt[2.2].
150 * link:v2.1.4/git.html[documentation for release 2.1.4]
152 * release notes for
153   link:RelNotes/2.1.4.txt[2.1.4],
154   link:RelNotes/2.1.3.txt[2.1.3],
155   link:RelNotes/2.1.2.txt[2.1.2],
156   link:RelNotes/2.1.1.txt[2.1.1],
157   link:RelNotes/2.1.0.txt[2.1].
159 * link:v2.0.5/git.html[documentation for release 2.0.5]
161 * release notes for
162   link:RelNotes/2.0.5.txt[2.0.5],
163   link:RelNotes/2.0.4.txt[2.0.4],
164   link:RelNotes/2.0.3.txt[2.0.3],
165   link:RelNotes/2.0.2.txt[2.0.2],
166   link:RelNotes/2.0.1.txt[2.0.1],
167   link:RelNotes/2.0.0.txt[2.0.0].
169 * link:v1.9.5/git.html[documentation for release 1.9.5]
171 * release notes for
172   link:RelNotes/1.9.5.txt[1.9.5],
173   link:RelNotes/1.9.4.txt[1.9.4],
174   link:RelNotes/1.9.3.txt[1.9.3],
175   link:RelNotes/1.9.2.txt[1.9.2],
176   link:RelNotes/1.9.1.txt[1.9.1],
177   link:RelNotes/1.9.0.txt[1.9.0].
179 * link:v1.8.5.6/git.html[documentation for release 1.8.5.6]
181 * release notes for
182   link:RelNotes/1.8.5.6.txt[1.8.5.6],
183   link:RelNotes/1.8.5.5.txt[1.8.5.5],
184   link:RelNotes/1.8.5.4.txt[1.8.5.4],
185   link:RelNotes/1.8.5.3.txt[1.8.5.3],
186   link:RelNotes/1.8.5.2.txt[1.8.5.2],
187   link:RelNotes/1.8.5.1.txt[1.8.5.1],
188   link:RelNotes/1.8.5.txt[1.8.5].
190 * link:v1.8.4.5/git.html[documentation for release 1.8.4.5]
192 * release notes for
193   link:RelNotes/1.8.4.5.txt[1.8.4.5],
194   link:RelNotes/1.8.4.4.txt[1.8.4.4],
195   link:RelNotes/1.8.4.3.txt[1.8.4.3],
196   link:RelNotes/1.8.4.2.txt[1.8.4.2],
197   link:RelNotes/1.8.4.1.txt[1.8.4.1],
198   link:RelNotes/1.8.4.txt[1.8.4].
200 * link:v1.8.3.4/git.html[documentation for release 1.8.3.4]
202 * release notes for
203   link:RelNotes/1.8.3.4.txt[1.8.3.4],
204   link:RelNotes/1.8.3.3.txt[1.8.3.3],
205   link:RelNotes/1.8.3.2.txt[1.8.3.2],
206   link:RelNotes/1.8.3.1.txt[1.8.3.1],
207   link:RelNotes/1.8.3.txt[1.8.3].
209 * link:v1.8.2.3/git.html[documentation for release 1.8.2.3]
211 * release notes for
212   link:RelNotes/1.8.2.3.txt[1.8.2.3],
213   link:RelNotes/1.8.2.2.txt[1.8.2.2],
214   link:RelNotes/1.8.2.1.txt[1.8.2.1],
215   link:RelNotes/1.8.2.txt[1.8.2].
217 * link:v1.8.1.6/git.html[documentation for release 1.8.1.6]
219 * release notes for
220   link:RelNotes/1.8.1.6.txt[1.8.1.6],
221   link:RelNotes/1.8.1.5.txt[1.8.1.5],
222   link:RelNotes/1.8.1.4.txt[1.8.1.4],
223   link:RelNotes/1.8.1.3.txt[1.8.1.3],
224   link:RelNotes/1.8.1.2.txt[1.8.1.2],
225   link:RelNotes/1.8.1.1.txt[1.8.1.1],
226   link:RelNotes/1.8.1.txt[1.8.1].
228 * link:v1.8.0.3/git.html[documentation for release 1.8.0.3]
230 * release notes for
231   link:RelNotes/1.8.0.3.txt[1.8.0.3],
232   link:RelNotes/1.8.0.2.txt[1.8.0.2],
233   link:RelNotes/1.8.0.1.txt[1.8.0.1],
234   link:RelNotes/1.8.0.txt[1.8.0].
236 * link:v1.7.12.4/git.html[documentation for release 1.7.12.4]
238 * release notes for
239   link:RelNotes/1.7.12.4.txt[1.7.12.4],
240   link:RelNotes/1.7.12.3.txt[1.7.12.3],
241   link:RelNotes/1.7.12.2.txt[1.7.12.2],
242   link:RelNotes/1.7.12.1.txt[1.7.12.1],
243   link:RelNotes/1.7.12.txt[1.7.12].
245 * link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
247 * release notes for
248   link:RelNotes/1.7.11.7.txt[1.7.11.7],
249   link:RelNotes/1.7.11.6.txt[1.7.11.6],
250   link:RelNotes/1.7.11.5.txt[1.7.11.5],
251   link:RelNotes/1.7.11.4.txt[1.7.11.4],
252   link:RelNotes/1.7.11.3.txt[1.7.11.3],
253   link:RelNotes/1.7.11.2.txt[1.7.11.2],
254   link:RelNotes/1.7.11.1.txt[1.7.11.1],
255   link:RelNotes/1.7.11.txt[1.7.11].
257 * link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
259 * release notes for
260   link:RelNotes/1.7.10.5.txt[1.7.10.5],
261   link:RelNotes/1.7.10.4.txt[1.7.10.4],
262   link:RelNotes/1.7.10.3.txt[1.7.10.3],
263   link:RelNotes/1.7.10.2.txt[1.7.10.2],
264   link:RelNotes/1.7.10.1.txt[1.7.10.1],
265   link:RelNotes/1.7.10.txt[1.7.10].
267 * link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
269 * release notes for
270   link:RelNotes/1.7.9.7.txt[1.7.9.7],
271   link:RelNotes/1.7.9.6.txt[1.7.9.6],
272   link:RelNotes/1.7.9.5.txt[1.7.9.5],
273   link:RelNotes/1.7.9.4.txt[1.7.9.4],
274   link:RelNotes/1.7.9.3.txt[1.7.9.3],
275   link:RelNotes/1.7.9.2.txt[1.7.9.2],
276   link:RelNotes/1.7.9.1.txt[1.7.9.1],
277   link:RelNotes/1.7.9.txt[1.7.9].
279 * link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
281 * release notes for
282   link:RelNotes/1.7.8.6.txt[1.7.8.6],
283   link:RelNotes/1.7.8.5.txt[1.7.8.5],
284   link:RelNotes/1.7.8.4.txt[1.7.8.4],
285   link:RelNotes/1.7.8.3.txt[1.7.8.3],
286   link:RelNotes/1.7.8.2.txt[1.7.8.2],
287   link:RelNotes/1.7.8.1.txt[1.7.8.1],
288   link:RelNotes/1.7.8.txt[1.7.8].
290 * link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
292 * release notes for
293   link:RelNotes/1.7.7.7.txt[1.7.7.7],
294   link:RelNotes/1.7.7.6.txt[1.7.7.6],
295   link:RelNotes/1.7.7.5.txt[1.7.7.5],
296   link:RelNotes/1.7.7.4.txt[1.7.7.4],
297   link:RelNotes/1.7.7.3.txt[1.7.7.3],
298   link:RelNotes/1.7.7.2.txt[1.7.7.2],
299   link:RelNotes/1.7.7.1.txt[1.7.7.1],
300   link:RelNotes/1.7.7.txt[1.7.7].
302 * link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
304 * release notes for
305   link:RelNotes/1.7.6.6.txt[1.7.6.6],
306   link:RelNotes/1.7.6.5.txt[1.7.6.5],
307   link:RelNotes/1.7.6.4.txt[1.7.6.4],
308   link:RelNotes/1.7.6.3.txt[1.7.6.3],
309   link:RelNotes/1.7.6.2.txt[1.7.6.2],
310   link:RelNotes/1.7.6.1.txt[1.7.6.1],
311   link:RelNotes/1.7.6.txt[1.7.6].
313 * link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
315 * release notes for
316   link:RelNotes/1.7.5.4.txt[1.7.5.4],
317   link:RelNotes/1.7.5.3.txt[1.7.5.3],
318   link:RelNotes/1.7.5.2.txt[1.7.5.2],
319   link:RelNotes/1.7.5.1.txt[1.7.5.1],
320   link:RelNotes/1.7.5.txt[1.7.5].
322 * link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
324 * release notes for
325   link:RelNotes/1.7.4.5.txt[1.7.4.5],
326   link:RelNotes/1.7.4.4.txt[1.7.4.4],
327   link:RelNotes/1.7.4.3.txt[1.7.4.3],
328   link:RelNotes/1.7.4.2.txt[1.7.4.2],
329   link:RelNotes/1.7.4.1.txt[1.7.4.1],
330   link:RelNotes/1.7.4.txt[1.7.4].
332 * link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
334 * release notes for
335   link:RelNotes/1.7.3.5.txt[1.7.3.5],
336   link:RelNotes/1.7.3.4.txt[1.7.3.4],
337   link:RelNotes/1.7.3.3.txt[1.7.3.3],
338   link:RelNotes/1.7.3.2.txt[1.7.3.2],
339   link:RelNotes/1.7.3.1.txt[1.7.3.1],
340   link:RelNotes/1.7.3.txt[1.7.3].
342 * link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
344 * release notes for
345   link:RelNotes/1.7.2.5.txt[1.7.2.5],
346   link:RelNotes/1.7.2.4.txt[1.7.2.4],
347   link:RelNotes/1.7.2.3.txt[1.7.2.3],
348   link:RelNotes/1.7.2.2.txt[1.7.2.2],
349   link:RelNotes/1.7.2.1.txt[1.7.2.1],
350   link:RelNotes/1.7.2.txt[1.7.2].
352 * link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
354 * release notes for
355   link:RelNotes/1.7.1.4.txt[1.7.1.4],
356   link:RelNotes/1.7.1.3.txt[1.7.1.3],
357   link:RelNotes/1.7.1.2.txt[1.7.1.2],
358   link:RelNotes/1.7.1.1.txt[1.7.1.1],
359   link:RelNotes/1.7.1.txt[1.7.1].
361 * link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
363 * release notes for
364   link:RelNotes/1.7.0.9.txt[1.7.0.9],
365   link:RelNotes/1.7.0.8.txt[1.7.0.8],
366   link:RelNotes/1.7.0.7.txt[1.7.0.7],
367   link:RelNotes/1.7.0.6.txt[1.7.0.6],
368   link:RelNotes/1.7.0.5.txt[1.7.0.5],
369   link:RelNotes/1.7.0.4.txt[1.7.0.4],
370   link:RelNotes/1.7.0.3.txt[1.7.0.3],
371   link:RelNotes/1.7.0.2.txt[1.7.0.2],
372   link:RelNotes/1.7.0.1.txt[1.7.0.1],
373   link:RelNotes/1.7.0.txt[1.7.0].
375 * link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
377 * release notes for
378   link:RelNotes/1.6.6.3.txt[1.6.6.3],
379   link:RelNotes/1.6.6.2.txt[1.6.6.2],
380   link:RelNotes/1.6.6.1.txt[1.6.6.1],
381   link:RelNotes/1.6.6.txt[1.6.6].
383 * link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
385 * release notes for
386   link:RelNotes/1.6.5.9.txt[1.6.5.9],
387   link:RelNotes/1.6.5.8.txt[1.6.5.8],
388   link:RelNotes/1.6.5.7.txt[1.6.5.7],
389   link:RelNotes/1.6.5.6.txt[1.6.5.6],
390   link:RelNotes/1.6.5.5.txt[1.6.5.5],
391   link:RelNotes/1.6.5.4.txt[1.6.5.4],
392   link:RelNotes/1.6.5.3.txt[1.6.5.3],
393   link:RelNotes/1.6.5.2.txt[1.6.5.2],
394   link:RelNotes/1.6.5.1.txt[1.6.5.1],
395   link:RelNotes/1.6.5.txt[1.6.5].
397 * link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
399 * release notes for
400   link:RelNotes/1.6.4.5.txt[1.6.4.5],
401   link:RelNotes/1.6.4.4.txt[1.6.4.4],
402   link:RelNotes/1.6.4.3.txt[1.6.4.3],
403   link:RelNotes/1.6.4.2.txt[1.6.4.2],
404   link:RelNotes/1.6.4.1.txt[1.6.4.1],
405   link:RelNotes/1.6.4.txt[1.6.4].
407 * link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
409 * release notes for
410   link:RelNotes/1.6.3.4.txt[1.6.3.4],
411   link:RelNotes/1.6.3.3.txt[1.6.3.3],
412   link:RelNotes/1.6.3.2.txt[1.6.3.2],
413   link:RelNotes/1.6.3.1.txt[1.6.3.1],
414   link:RelNotes/1.6.3.txt[1.6.3].
416 * release notes for
417   link:RelNotes/1.6.2.5.txt[1.6.2.5],
418   link:RelNotes/1.6.2.4.txt[1.6.2.4],
419   link:RelNotes/1.6.2.3.txt[1.6.2.3],
420   link:RelNotes/1.6.2.2.txt[1.6.2.2],
421   link:RelNotes/1.6.2.1.txt[1.6.2.1],
422   link:RelNotes/1.6.2.txt[1.6.2].
424 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
426 * release notes for
427   link:RelNotes/1.6.1.3.txt[1.6.1.3],
428   link:RelNotes/1.6.1.2.txt[1.6.1.2],
429   link:RelNotes/1.6.1.1.txt[1.6.1.1],
430   link:RelNotes/1.6.1.txt[1.6.1].
432 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
434 * release notes for
435   link:RelNotes/1.6.0.6.txt[1.6.0.6],
436   link:RelNotes/1.6.0.5.txt[1.6.0.5],
437   link:RelNotes/1.6.0.4.txt[1.6.0.4],
438   link:RelNotes/1.6.0.3.txt[1.6.0.3],
439   link:RelNotes/1.6.0.2.txt[1.6.0.2],
440   link:RelNotes/1.6.0.1.txt[1.6.0.1],
441   link:RelNotes/1.6.0.txt[1.6.0].
443 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
445 * release notes for
446   link:RelNotes/1.5.6.6.txt[1.5.6.6],
447   link:RelNotes/1.5.6.5.txt[1.5.6.5],
448   link:RelNotes/1.5.6.4.txt[1.5.6.4],
449   link:RelNotes/1.5.6.3.txt[1.5.6.3],
450   link:RelNotes/1.5.6.2.txt[1.5.6.2],
451   link:RelNotes/1.5.6.1.txt[1.5.6.1],
452   link:RelNotes/1.5.6.txt[1.5.6].
454 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
456 * release notes for
457   link:RelNotes/1.5.5.6.txt[1.5.5.6],
458   link:RelNotes/1.5.5.5.txt[1.5.5.5],
459   link:RelNotes/1.5.5.4.txt[1.5.5.4],
460   link:RelNotes/1.5.5.3.txt[1.5.5.3],
461   link:RelNotes/1.5.5.2.txt[1.5.5.2],
462   link:RelNotes/1.5.5.1.txt[1.5.5.1],
463   link:RelNotes/1.5.5.txt[1.5.5].
465 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
467 * release notes for
468   link:RelNotes/1.5.4.7.txt[1.5.4.7],
469   link:RelNotes/1.5.4.6.txt[1.5.4.6],
470   link:RelNotes/1.5.4.5.txt[1.5.4.5],
471   link:RelNotes/1.5.4.4.txt[1.5.4.4],
472   link:RelNotes/1.5.4.3.txt[1.5.4.3],
473   link:RelNotes/1.5.4.2.txt[1.5.4.2],
474   link:RelNotes/1.5.4.1.txt[1.5.4.1],
475   link:RelNotes/1.5.4.txt[1.5.4].
477 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
479 * release notes for
480   link:RelNotes/1.5.3.8.txt[1.5.3.8],
481   link:RelNotes/1.5.3.7.txt[1.5.3.7],
482   link:RelNotes/1.5.3.6.txt[1.5.3.6],
483   link:RelNotes/1.5.3.5.txt[1.5.3.5],
484   link:RelNotes/1.5.3.4.txt[1.5.3.4],
485   link:RelNotes/1.5.3.3.txt[1.5.3.3],
486   link:RelNotes/1.5.3.2.txt[1.5.3.2],
487   link:RelNotes/1.5.3.1.txt[1.5.3.1],
488   link:RelNotes/1.5.3.txt[1.5.3].
490 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
492 * release notes for
493   link:RelNotes/1.5.2.5.txt[1.5.2.5],
494   link:RelNotes/1.5.2.4.txt[1.5.2.4],
495   link:RelNotes/1.5.2.3.txt[1.5.2.3],
496   link:RelNotes/1.5.2.2.txt[1.5.2.2],
497   link:RelNotes/1.5.2.1.txt[1.5.2.1],
498   link:RelNotes/1.5.2.txt[1.5.2].
500 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
502 * release notes for
503   link:RelNotes/1.5.1.6.txt[1.5.1.6],
504   link:RelNotes/1.5.1.5.txt[1.5.1.5],
505   link:RelNotes/1.5.1.4.txt[1.5.1.4],
506   link:RelNotes/1.5.1.3.txt[1.5.1.3],
507   link:RelNotes/1.5.1.2.txt[1.5.1.2],
508   link:RelNotes/1.5.1.1.txt[1.5.1.1],
509   link:RelNotes/1.5.1.txt[1.5.1].
511 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
513 * release notes for
514   link:RelNotes/1.5.0.7.txt[1.5.0.7],
515   link:RelNotes/1.5.0.6.txt[1.5.0.6],
516   link:RelNotes/1.5.0.5.txt[1.5.0.5],
517   link:RelNotes/1.5.0.3.txt[1.5.0.3],
518   link:RelNotes/1.5.0.2.txt[1.5.0.2],
519   link:RelNotes/1.5.0.1.txt[1.5.0.1],
520   link:RelNotes/1.5.0.txt[1.5.0].
522 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
523   link:v1.3.3/git.html[1.3.3],
524   link:v1.2.6/git.html[1.2.6],
525   link:v1.0.13/git.html[1.0.13].
527 ============
529 endif::stalenotes[]
531 OPTIONS
532 -------
533 --version::
534         Prints the Git suite version that the 'git' program came from.
536 --help::
537         Prints the synopsis and a list of the most commonly used
538         commands. If the option `--all` or `-a` is given then all
539         available commands are printed. If a Git command is named this
540         option will bring up the manual page for that command.
542 Other options are available to control how the manual page is
543 displayed. See linkgit:git-help[1] for more information,
544 because `git --help ...` is converted internally into `git
545 help ...`.
547 -C <path>::
548         Run as if git was started in '<path>' instead of the current working
549         directory.  When multiple `-C` options are given, each subsequent
550         non-absolute `-C <path>` is interpreted relative to the preceding `-C
551         <path>`.
553 This option affects options that expect path name like `--git-dir` and
554 `--work-tree` in that their interpretations of the path names would be
555 made relative to the working directory caused by the `-C` option. For
556 example the following invocations are equivalent:
558     git --git-dir=a.git --work-tree=b -C c status
559     git --git-dir=c/a.git --work-tree=c/b status
561 -c <name>=<value>::
562         Pass a configuration parameter to the command. The value
563         given will override values from configuration files.
564         The <name> is expected in the same format as listed by
565         'git config' (subkeys separated by dots).
567 Note that omitting the `=` in `git -c foo.bar ...` is allowed and sets
568 `foo.bar` to the boolean true value (just like `[foo]bar` would in a
569 config file). Including the equals but with an empty value (like `git -c
570 foo.bar= ...`) sets `foo.bar` to the empty string.
572 --exec-path[=<path>]::
573         Path to wherever your core Git programs are installed.
574         This can also be controlled by setting the GIT_EXEC_PATH
575         environment variable. If no path is given, 'git' will print
576         the current setting and then exit.
578 --html-path::
579         Print the path, without trailing slash, where Git's HTML
580         documentation is installed and exit.
582 --man-path::
583         Print the manpath (see `man(1)`) for the man pages for
584         this version of Git and exit.
586 --info-path::
587         Print the path where the Info files documenting this
588         version of Git are installed and exit.
590 -p::
591 --paginate::
592         Pipe all output into 'less' (or if set, $PAGER) if standard
593         output is a terminal.  This overrides the `pager.<cmd>`
594         configuration options (see the "Configuration Mechanism" section
595         below).
597 --no-pager::
598         Do not pipe Git output into a pager.
600 --git-dir=<path>::
601         Set the path to the repository. This can also be controlled by
602         setting the `GIT_DIR` environment variable. It can be an absolute
603         path or relative path to current working directory.
605 --work-tree=<path>::
606         Set the path to the working tree. It can be an absolute path
607         or a path relative to the current working directory.
608         This can also be controlled by setting the GIT_WORK_TREE
609         environment variable and the core.worktree configuration
610         variable (see core.worktree in linkgit:git-config[1] for a
611         more detailed discussion).
613 --namespace=<path>::
614         Set the Git namespace.  See linkgit:gitnamespaces[7] for more
615         details.  Equivalent to setting the `GIT_NAMESPACE` environment
616         variable.
618 --super-prefix=<path>::
619         Currently for internal use only.  Set a prefix which gives a path from
620         above a repository down to its root.  One use is to give submodules
621         context about the superproject that invoked it.
623 --bare::
624         Treat the repository as a bare repository.  If GIT_DIR
625         environment is not set, it is set to the current working
626         directory.
628 --no-replace-objects::
629         Do not use replacement refs to replace Git objects. See
630         linkgit:git-replace[1] for more information.
632 --literal-pathspecs::
633         Treat pathspecs literally (i.e. no globbing, no pathspec magic).
634         This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
635         variable to `1`.
637 --glob-pathspecs::
638         Add "glob" magic to all pathspec. This is equivalent to setting
639         the `GIT_GLOB_PATHSPECS` environment variable to `1`. Disabling
640         globbing on individual pathspecs can be done using pathspec
641         magic ":(literal)"
643 --noglob-pathspecs::
644         Add "literal" magic to all pathspec. This is equivalent to setting
645         the `GIT_NOGLOB_PATHSPECS` environment variable to `1`. Enabling
646         globbing on individual pathspecs can be done using pathspec
647         magic ":(glob)"
649 --icase-pathspecs::
650         Add "icase" magic to all pathspec. This is equivalent to setting
651         the `GIT_ICASE_PATHSPECS` environment variable to `1`.
653 GIT COMMANDS
654 ------------
656 We divide Git into high level ("porcelain") commands and low level
657 ("plumbing") commands.
659 High-level commands (porcelain)
660 -------------------------------
662 We separate the porcelain commands into the main commands and some
663 ancillary user utilities.
665 Main porcelain commands
666 ~~~~~~~~~~~~~~~~~~~~~~~
668 include::cmds-mainporcelain.txt[]
670 Ancillary Commands
671 ~~~~~~~~~~~~~~~~~~
672 Manipulators:
674 include::cmds-ancillarymanipulators.txt[]
676 Interrogators:
678 include::cmds-ancillaryinterrogators.txt[]
681 Interacting with Others
682 ~~~~~~~~~~~~~~~~~~~~~~~
684 These commands are to interact with foreign SCM and with other
685 people via patch over e-mail.
687 include::cmds-foreignscminterface.txt[]
690 Low-level commands (plumbing)
691 -----------------------------
693 Although Git includes its
694 own porcelain layer, its low-level commands are sufficient to support
695 development of alternative porcelains.  Developers of such porcelains
696 might start by reading about linkgit:git-update-index[1] and
697 linkgit:git-read-tree[1].
699 The interface (input, output, set of options and the semantics)
700 to these low-level commands are meant to be a lot more stable
701 than Porcelain level commands, because these commands are
702 primarily for scripted use.  The interface to Porcelain commands
703 on the other hand are subject to change in order to improve the
704 end user experience.
706 The following description divides
707 the low-level commands into commands that manipulate objects (in
708 the repository, index, and working tree), commands that interrogate and
709 compare objects, and commands that move objects and references between
710 repositories.
713 Manipulation commands
714 ~~~~~~~~~~~~~~~~~~~~~
716 include::cmds-plumbingmanipulators.txt[]
719 Interrogation commands
720 ~~~~~~~~~~~~~~~~~~~~~~
722 include::cmds-plumbinginterrogators.txt[]
724 In general, the interrogate commands do not touch the files in
725 the working tree.
728 Synching repositories
729 ~~~~~~~~~~~~~~~~~~~~~
731 include::cmds-synchingrepositories.txt[]
733 The following are helper commands used by the above; end users
734 typically do not use them directly.
736 include::cmds-synchelpers.txt[]
739 Internal helper commands
740 ~~~~~~~~~~~~~~~~~~~~~~~~
742 These are internal helper commands used by other commands; end
743 users typically do not use them directly.
745 include::cmds-purehelpers.txt[]
748 Configuration Mechanism
749 -----------------------
751 Git uses a simple text format to store customizations that are per
752 repository and are per user.  Such a configuration file may look
753 like this:
755 ------------
757 # A '#' or ';' character indicates a comment.
760 ; core variables
761 [core]
762         ; Don't trust file modes
763         filemode = false
765 ; user identity
766 [user]
767         name = "Junio C Hamano"
768         email = "gitster@pobox.com"
770 ------------
772 Various commands read from the configuration file and adjust
773 their operation accordingly.  See linkgit:git-config[1] for a
774 list and more details about the configuration mechanism.
777 Identifier Terminology
778 ----------------------
779 <object>::
780         Indicates the object name for any type of object.
782 <blob>::
783         Indicates a blob object name.
785 <tree>::
786         Indicates a tree object name.
788 <commit>::
789         Indicates a commit object name.
791 <tree-ish>::
792         Indicates a tree, commit or tag object name.  A
793         command that takes a <tree-ish> argument ultimately wants to
794         operate on a <tree> object but automatically dereferences
795         <commit> and <tag> objects that point at a <tree>.
797 <commit-ish>::
798         Indicates a commit or tag object name.  A
799         command that takes a <commit-ish> argument ultimately wants to
800         operate on a <commit> object but automatically dereferences
801         <tag> objects that point at a <commit>.
803 <type>::
804         Indicates that an object type is required.
805         Currently one of: `blob`, `tree`, `commit`, or `tag`.
807 <file>::
808         Indicates a filename - almost always relative to the
809         root of the tree structure `GIT_INDEX_FILE` describes.
811 Symbolic Identifiers
812 --------------------
813 Any Git command accepting any <object> can also use the following
814 symbolic notation:
816 HEAD::
817         indicates the head of the current branch.
819 <tag>::
820         a valid tag 'name'
821         (i.e. a `refs/tags/<tag>` reference).
823 <head>::
824         a valid head 'name'
825         (i.e. a `refs/heads/<head>` reference).
827 For a more complete list of ways to spell object names, see
828 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
831 File/Directory Structure
832 ------------------------
834 Please see the linkgit:gitrepository-layout[5] document.
836 Read linkgit:githooks[5] for more details about each hook.
838 Higher level SCMs may provide and manage additional information in the
839 `$GIT_DIR`.
842 Terminology
843 -----------
844 Please see linkgit:gitglossary[7].
847 Environment Variables
848 ---------------------
849 Various Git commands use the following environment variables:
851 The Git Repository
852 ~~~~~~~~~~~~~~~~~~
853 These environment variables apply to 'all' core Git commands. Nb: it
854 is worth noting that they may be used/overridden by SCMS sitting above
855 Git so take care if using a foreign front-end.
857 `GIT_INDEX_FILE`::
858         This environment allows the specification of an alternate
859         index file. If not specified, the default of `$GIT_DIR/index`
860         is used.
862 `GIT_INDEX_VERSION`::
863         This environment variable allows the specification of an index
864         version for new repositories.  It won't affect existing index
865         files.  By default index file version 2 or 3 is used. See
866         linkgit:git-update-index[1] for more information.
868 `GIT_OBJECT_DIRECTORY`::
869         If the object storage directory is specified via this
870         environment variable then the sha1 directories are created
871         underneath - otherwise the default `$GIT_DIR/objects`
872         directory is used.
874 `GIT_ALTERNATE_OBJECT_DIRECTORIES`::
875         Due to the immutable nature of Git objects, old objects can be
876         archived into shared, read-only directories. This variable
877         specifies a ":" separated (on Windows ";" separated) list
878         of Git object directories which can be used to search for Git
879         objects. New objects will not be written to these directories.
881         Entries that begin with `"` (double-quote) will be interpreted
882         as C-style quoted paths, removing leading and trailing
883         double-quotes and respecting backslash escapes. E.g., the value
884         `"path-with-\"-and-:-in-it":vanilla-path` has two paths:
885         `path-with-"-and-:-in-it` and `vanilla-path`.
887 `GIT_DIR`::
888         If the `GIT_DIR` environment variable is set then it
889         specifies a path to use instead of the default `.git`
890         for the base of the repository.
891         The `--git-dir` command-line option also sets this value.
893 `GIT_WORK_TREE`::
894         Set the path to the root of the working tree.
895         This can also be controlled by the `--work-tree` command-line
896         option and the core.worktree configuration variable.
898 `GIT_NAMESPACE`::
899         Set the Git namespace; see linkgit:gitnamespaces[7] for details.
900         The `--namespace` command-line option also sets this value.
902 `GIT_CEILING_DIRECTORIES`::
903         This should be a colon-separated list of absolute paths.  If
904         set, it is a list of directories that Git should not chdir up
905         into while looking for a repository directory (useful for
906         excluding slow-loading network directories).  It will not
907         exclude the current working directory or a GIT_DIR set on the
908         command line or in the environment.  Normally, Git has to read
909         the entries in this list and resolve any symlink that
910         might be present in order to compare them with the current
911         directory.  However, if even this access is slow, you
912         can add an empty entry to the list to tell Git that the
913         subsequent entries are not symlinks and needn't be resolved;
914         e.g.,
915         `GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink`.
917 `GIT_DISCOVERY_ACROSS_FILESYSTEM`::
918         When run in a directory that does not have ".git" repository
919         directory, Git tries to find such a directory in the parent
920         directories to find the top of the working tree, but by default it
921         does not cross filesystem boundaries.  This environment variable
922         can be set to true to tell Git not to stop at filesystem
923         boundaries.  Like `GIT_CEILING_DIRECTORIES`, this will not affect
924         an explicit repository directory set via `GIT_DIR` or on the
925         command line.
927 `GIT_COMMON_DIR`::
928         If this variable is set to a path, non-worktree files that are
929         normally in $GIT_DIR will be taken from this path
930         instead. Worktree-specific files such as HEAD or index are
931         taken from $GIT_DIR. See linkgit:gitrepository-layout[5] and
932         linkgit:git-worktree[1] for
933         details. This variable has lower precedence than other path
934         variables such as GIT_INDEX_FILE, GIT_OBJECT_DIRECTORY...
936 Git Commits
937 ~~~~~~~~~~~
938 `GIT_AUTHOR_NAME`::
939 `GIT_AUTHOR_EMAIL`::
940 `GIT_AUTHOR_DATE`::
941 `GIT_COMMITTER_NAME`::
942 `GIT_COMMITTER_EMAIL`::
943 `GIT_COMMITTER_DATE`::
944 'EMAIL'::
945         see linkgit:git-commit-tree[1]
947 Git Diffs
948 ~~~~~~~~~
949 `GIT_DIFF_OPTS`::
950         Only valid setting is "--unified=??" or "-u??" to set the
951         number of context lines shown when a unified diff is created.
952         This takes precedence over any "-U" or "--unified" option
953         value passed on the Git diff command line.
955 `GIT_EXTERNAL_DIFF`::
956         When the environment variable `GIT_EXTERNAL_DIFF` is set, the
957         program named by it is called, instead of the diff invocation
958         described above.  For a path that is added, removed, or modified,
959         `GIT_EXTERNAL_DIFF` is called with 7 parameters:
961         path old-file old-hex old-mode new-file new-hex new-mode
963 where:
965         <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
966                          contents of <old|new>,
967         <old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
968         <old|new>-mode:: are the octal representation of the file modes.
970 The file parameters can point at the user's working file
971 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
972 when a new file is added), or a temporary file (e.g. `old-file` in the
973 index).  `GIT_EXTERNAL_DIFF` should not worry about unlinking the
974 temporary file --- it is removed when `GIT_EXTERNAL_DIFF` exits.
976 For a path that is unmerged, `GIT_EXTERNAL_DIFF` is called with 1
977 parameter, <path>.
979 For each path `GIT_EXTERNAL_DIFF` is called, two environment variables,
980 `GIT_DIFF_PATH_COUNTER` and `GIT_DIFF_PATH_TOTAL` are set.
982 `GIT_DIFF_PATH_COUNTER`::
983         A 1-based counter incremented by one for every path.
985 `GIT_DIFF_PATH_TOTAL`::
986         The total number of paths.
988 other
989 ~~~~~
990 `GIT_MERGE_VERBOSITY`::
991         A number controlling the amount of output shown by
992         the recursive merge strategy.  Overrides merge.verbosity.
993         See linkgit:git-merge[1]
995 `GIT_PAGER`::
996         This environment variable overrides `$PAGER`. If it is set
997         to an empty string or to the value "cat", Git will not launch
998         a pager.  See also the `core.pager` option in
999         linkgit:git-config[1].
1001 `GIT_EDITOR`::
1002         This environment variable overrides `$EDITOR` and `$VISUAL`.
1003         It is used by several Git commands when, on interactive mode,
1004         an editor is to be launched. See also linkgit:git-var[1]
1005         and the `core.editor` option in linkgit:git-config[1].
1007 `GIT_SSH`::
1008 `GIT_SSH_COMMAND`::
1009         If either of these environment variables is set then 'git fetch'
1010         and 'git push' will use the specified command instead of 'ssh'
1011         when they need to connect to a remote system.
1012         The command will be given exactly two or four arguments: the
1013         'username@host' (or just 'host') from the URL and the shell
1014         command to execute on that remote system, optionally preceded by
1015         `-p` (literally) and the 'port' from the URL when it specifies
1016         something other than the default SSH port.
1018 `$GIT_SSH_COMMAND` takes precedence over `$GIT_SSH`, and is interpreted
1019 by the shell, which allows additional arguments to be included.
1020 `$GIT_SSH` on the other hand must be just the path to a program
1021 (which can be a wrapper shell script, if additional arguments are
1022 needed).
1024 Usually it is easier to configure any desired options through your
1025 personal `.ssh/config` file.  Please consult your ssh documentation
1026 for further details.
1028 `GIT_SSH_VARIANT`::
1029         If this environment variable is set, it overrides Git's autodetection
1030         whether `GIT_SSH`/`GIT_SSH_COMMAND`/`core.sshCommand` refer to OpenSSH,
1031         plink or tortoiseplink. This variable overrides the config setting
1032         `ssh.variant` that serves the same purpose.
1034 `GIT_ASKPASS`::
1035         If this environment variable is set, then Git commands which need to
1036         acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
1037         will call this program with a suitable prompt as command-line argument
1038         and read the password from its STDOUT. See also the `core.askPass`
1039         option in linkgit:git-config[1].
1041 `GIT_TERMINAL_PROMPT`::
1042         If this environment variable is set to `0`, git will not prompt
1043         on the terminal (e.g., when asking for HTTP authentication).
1045 `GIT_CONFIG_NOSYSTEM`::
1046         Whether to skip reading settings from the system-wide
1047         `$(prefix)/etc/gitconfig` file.  This environment variable can
1048         be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
1049         predictable environment for a picky script, or you can set it
1050         temporarily to avoid using a buggy `/etc/gitconfig` file while
1051         waiting for someone with sufficient permissions to fix it.
1053 `GIT_FLUSH`::
1054         If this environment variable is set to "1", then commands such
1055         as 'git blame' (in incremental mode), 'git rev-list', 'git log',
1056         'git check-attr' and 'git check-ignore' will
1057         force a flush of the output stream after each record have been
1058         flushed. If this
1059         variable is set to "0", the output of these commands will be done
1060         using completely buffered I/O.   If this environment variable is
1061         not set, Git will choose buffered or record-oriented flushing
1062         based on whether stdout appears to be redirected to a file or not.
1064 `GIT_TRACE`::
1065         Enables general trace messages, e.g. alias expansion, built-in
1066         command execution and external command execution.
1068 If this variable is set to "1", "2" or "true" (comparison
1069 is case insensitive), trace messages will be printed to
1070 stderr.
1072 If the variable is set to an integer value greater than 2
1073 and lower than 10 (strictly) then Git will interpret this
1074 value as an open file descriptor and will try to write the
1075 trace messages into this file descriptor.
1077 Alternatively, if the variable is set to an absolute path
1078 (starting with a '/' character), Git will interpret this
1079 as a file path and will try to write the trace messages
1080 into it.
1082 Unsetting the variable, or setting it to empty, "0" or
1083 "false" (case insensitive) disables trace messages.
1085 `GIT_TRACE_PACK_ACCESS`::
1086         Enables trace messages for all accesses to any packs. For each
1087         access, the pack file name and an offset in the pack is
1088         recorded. This may be helpful for troubleshooting some
1089         pack-related performance problems.
1090         See `GIT_TRACE` for available trace output options.
1092 `GIT_TRACE_PACKET`::
1093         Enables trace messages for all packets coming in or out of a
1094         given program. This can help with debugging object negotiation
1095         or other protocol issues. Tracing is turned off at a packet
1096         starting with "PACK" (but see `GIT_TRACE_PACKFILE` below).
1097         See `GIT_TRACE` for available trace output options.
1099 `GIT_TRACE_PACKFILE`::
1100         Enables tracing of packfiles sent or received by a
1101         given program. Unlike other trace output, this trace is
1102         verbatim: no headers, and no quoting of binary data. You almost
1103         certainly want to direct into a file (e.g.,
1104         `GIT_TRACE_PACKFILE=/tmp/my.pack`) rather than displaying it on
1105         the terminal or mixing it with other trace output.
1107 Note that this is currently only implemented for the client side
1108 of clones and fetches.
1110 `GIT_TRACE_PERFORMANCE`::
1111         Enables performance related trace messages, e.g. total execution
1112         time of each Git command.
1113         See `GIT_TRACE` for available trace output options.
1115 `GIT_TRACE_SETUP`::
1116         Enables trace messages printing the .git, working tree and current
1117         working directory after Git has completed its setup phase.
1118         See `GIT_TRACE` for available trace output options.
1120 `GIT_TRACE_SHALLOW`::
1121         Enables trace messages that can help debugging fetching /
1122         cloning of shallow repositories.
1123         See `GIT_TRACE` for available trace output options.
1125 `GIT_TRACE_CURL`::
1126         Enables a curl full trace dump of all incoming and outgoing data,
1127         including descriptive information, of the git transport protocol.
1128         This is similar to doing curl `--trace-ascii` on the command line.
1129         This option overrides setting the `GIT_CURL_VERBOSE` environment
1130         variable.
1131         See `GIT_TRACE` for available trace output options.
1133 `GIT_LITERAL_PATHSPECS`::
1134         Setting this variable to `1` will cause Git to treat all
1135         pathspecs literally, rather than as glob patterns. For example,
1136         running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
1137         for commits that touch the path `*.c`, not any paths that the
1138         glob `*.c` matches. You might want this if you are feeding
1139         literal paths to Git (e.g., paths previously given to you by
1140         `git ls-tree`, `--raw` diff output, etc).
1142 `GIT_GLOB_PATHSPECS`::
1143         Setting this variable to `1` will cause Git to treat all
1144         pathspecs as glob patterns (aka "glob" magic).
1146 `GIT_NOGLOB_PATHSPECS`::
1147         Setting this variable to `1` will cause Git to treat all
1148         pathspecs as literal (aka "literal" magic).
1150 `GIT_ICASE_PATHSPECS`::
1151         Setting this variable to `1` will cause Git to treat all
1152         pathspecs as case-insensitive.
1154 `GIT_REFLOG_ACTION`::
1155         When a ref is updated, reflog entries are created to keep
1156         track of the reason why the ref was updated (which is
1157         typically the name of the high-level command that updated
1158         the ref), in addition to the old and new values of the ref.
1159         A scripted Porcelain command can use set_reflog_action
1160         helper function in `git-sh-setup` to set its name to this
1161         variable when it is invoked as the top level command by the
1162         end user, to be recorded in the body of the reflog.
1164 `GIT_REF_PARANOIA`::
1165         If set to `1`, include broken or badly named refs when iterating
1166         over lists of refs. In a normal, non-corrupted repository, this
1167         does nothing. However, enabling it may help git to detect and
1168         abort some operations in the presence of broken refs. Git sets
1169         this variable automatically when performing destructive
1170         operations like linkgit:git-prune[1]. You should not need to set
1171         it yourself unless you want to be paranoid about making sure
1172         an operation has touched every ref (e.g., because you are
1173         cloning a repository to make a backup).
1175 `GIT_ALLOW_PROTOCOL`::
1176         If set to a colon-separated list of protocols, behave as if
1177         `protocol.allow` is set to `never`, and each of the listed
1178         protocols has `protocol.<name>.allow` set to `always`
1179         (overriding any existing configuration). In other words, any
1180         protocol not mentioned will be disallowed (i.e., this is a
1181         whitelist, not a blacklist). See the description of
1182         `protocol.allow` in linkgit:git-config[1] for more details.
1184 `GIT_PROTOCOL_FROM_USER`::
1185         Set to 0 to prevent protocols used by fetch/push/clone which are
1186         configured to the `user` state.  This is useful to restrict recursive
1187         submodule initialization from an untrusted repository or for programs
1188         which feed potentially-untrusted URLS to git commands.  See
1189         linkgit:git-config[1] for more details.
1191 Discussion[[Discussion]]
1192 ------------------------
1194 More detail on the following is available from the
1195 link:user-manual.html#git-concepts[Git concepts chapter of the
1196 user-manual] and linkgit:gitcore-tutorial[7].
1198 A Git project normally consists of a working directory with a ".git"
1199 subdirectory at the top level.  The .git directory contains, among other
1200 things, a compressed object database representing the complete history
1201 of the project, an "index" file which links that history to the current
1202 contents of the working tree, and named pointers into that history such
1203 as tags and branch heads.
1205 The object database contains objects of three main types: blobs, which
1206 hold file data; trees, which point to blobs and other trees to build up
1207 directory hierarchies; and commits, which each reference a single tree
1208 and some number of parent commits.
1210 The commit, equivalent to what other systems call a "changeset" or
1211 "version", represents a step in the project's history, and each parent
1212 represents an immediately preceding step.  Commits with more than one
1213 parent represent merges of independent lines of development.
1215 All objects are named by the SHA-1 hash of their contents, normally
1216 written as a string of 40 hex digits.  Such names are globally unique.
1217 The entire history leading up to a commit can be vouched for by signing
1218 just that commit.  A fourth object type, the tag, is provided for this
1219 purpose.
1221 When first created, objects are stored in individual files, but for
1222 efficiency may later be compressed together into "pack files".
1224 Named pointers called refs mark interesting points in history.  A ref
1225 may contain the SHA-1 name of an object or the name of another ref.  Refs
1226 with names beginning `ref/head/` contain the SHA-1 name of the most
1227 recent commit (or "head") of a branch under development.  SHA-1 names of
1228 tags of interest are stored under `ref/tags/`.  A special ref named
1229 `HEAD` contains the name of the currently checked-out branch.
1231 The index file is initialized with a list of all paths and, for each
1232 path, a blob object and a set of attributes.  The blob object represents
1233 the contents of the file as of the head of the current branch.  The
1234 attributes (last modified time, size, etc.) are taken from the
1235 corresponding file in the working tree.  Subsequent changes to the
1236 working tree can be found by comparing these attributes.  The index may
1237 be updated with new content, and new commits may be created from the
1238 content stored in the index.
1240 The index is also capable of storing multiple entries (called "stages")
1241 for a given pathname.  These stages are used to hold the various
1242 unmerged version of a file when a merge is in progress.
1244 FURTHER DOCUMENTATION
1245 ---------------------
1247 See the references in the "description" section to get started
1248 using Git.  The following is probably more detail than necessary
1249 for a first-time user.
1251 The link:user-manual.html#git-concepts[Git concepts chapter of the
1252 user-manual] and linkgit:gitcore-tutorial[7] both provide
1253 introductions to the underlying Git architecture.
1255 See linkgit:gitworkflows[7] for an overview of recommended workflows.
1257 See also the link:howto-index.html[howto] documents for some useful
1258 examples.
1260 The internals are documented in the
1261 link:technical/api-index.html[Git API documentation].
1263 Users migrating from CVS may also want to
1264 read linkgit:gitcvs-migration[7].
1267 Authors
1268 -------
1269 Git was started by Linus Torvalds, and is currently maintained by Junio
1270 C Hamano. Numerous contributions have come from the Git mailing list
1271 <git@vger.kernel.org>.  http://www.openhub.net/p/git/contributors/summary
1272 gives you a more complete list of contributors.
1274 If you have a clone of git.git itself, the
1275 output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
1276 the authors for specific parts of the project.
1278 Reporting Bugs
1279 --------------
1281 Report bugs to the Git mailing list <git@vger.kernel.org> where the
1282 development and maintenance is primarily done.  You do not have to be
1283 subscribed to the list to send a message there.
1285 SEE ALSO
1286 --------
1287 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
1288 linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
1289 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
1290 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
1291 linkgit:gitworkflows[7]
1295 Part of the linkgit:git[1] suite