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