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