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