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