msysGit-based Git for Windows 1.x was superseded by Git for Windows 2.x
[git/mingw/4msysgit.git] / Documentation / git.txt
blobde7b870a35e63e43652be6468e6e5a17d2708a14
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 link:everyday.html[Everyday Git] 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.1.0/git.html[documentation for release 2.1]
48 * release notes for
49   link:RelNotes/2.1.0.txt[2.1].
51 * link:v2.0.4/git.html[documentation for release 2.0.4]
53 * release notes for
54   link:RelNotes/2.0.4.txt[2.0.4],
55   link:RelNotes/2.0.3.txt[2.0.3],
56   link:RelNotes/2.0.2.txt[2.0.2],
57   link:RelNotes/2.0.1.txt[2.0.1],
58   link:RelNotes/2.0.0.txt[2.0.0].
60 * link:v1.9.4/git.html[documentation for release 1.9.4]
62 * release notes for
63   link:RelNotes/1.9.4.txt[1.9.4],
64   link:RelNotes/1.9.3.txt[1.9.3],
65   link:RelNotes/1.9.2.txt[1.9.2],
66   link:RelNotes/1.9.1.txt[1.9.1],
67   link:RelNotes/1.9.0.txt[1.9.0].
69 * link:v1.8.5.5/git.html[documentation for release 1.8.5.5]
71 * release notes for
72   link:RelNotes/1.8.5.5.txt[1.8.5.5],
73   link:RelNotes/1.8.5.4.txt[1.8.5.4],
74   link:RelNotes/1.8.5.3.txt[1.8.5.3],
75   link:RelNotes/1.8.5.2.txt[1.8.5.2],
76   link:RelNotes/1.8.5.1.txt[1.8.5.1],
77   link:RelNotes/1.8.5.txt[1.8.5].
79 * link:v1.8.4.5/git.html[documentation for release 1.8.4.5]
81 * release notes for
82   link:RelNotes/1.8.4.5.txt[1.8.4.5],
83   link:RelNotes/1.8.4.4.txt[1.8.4.4],
84   link:RelNotes/1.8.4.3.txt[1.8.4.3],
85   link:RelNotes/1.8.4.2.txt[1.8.4.2],
86   link:RelNotes/1.8.4.1.txt[1.8.4.1],
87   link:RelNotes/1.8.4.txt[1.8.4].
89 * link:v1.8.3.4/git.html[documentation for release 1.8.3.4]
91 * release notes for
92   link:RelNotes/1.8.3.4.txt[1.8.3.4],
93   link:RelNotes/1.8.3.3.txt[1.8.3.3],
94   link:RelNotes/1.8.3.2.txt[1.8.3.2],
95   link:RelNotes/1.8.3.1.txt[1.8.3.1],
96   link:RelNotes/1.8.3.txt[1.8.3].
98 * link:v1.8.2.3/git.html[documentation for release 1.8.2.3]
100 * release notes for
101   link:RelNotes/1.8.2.3.txt[1.8.2.3],
102   link:RelNotes/1.8.2.2.txt[1.8.2.2],
103   link:RelNotes/1.8.2.1.txt[1.8.2.1],
104   link:RelNotes/1.8.2.txt[1.8.2].
106 * link:v1.8.1.6/git.html[documentation for release 1.8.1.6]
108 * release notes for
109   link:RelNotes/1.8.1.6.txt[1.8.1.6],
110   link:RelNotes/1.8.1.5.txt[1.8.1.5],
111   link:RelNotes/1.8.1.4.txt[1.8.1.4],
112   link:RelNotes/1.8.1.3.txt[1.8.1.3],
113   link:RelNotes/1.8.1.2.txt[1.8.1.2],
114   link:RelNotes/1.8.1.1.txt[1.8.1.1],
115   link:RelNotes/1.8.1.txt[1.8.1].
117 * link:v1.8.0.3/git.html[documentation for release 1.8.0.3]
119 * release notes for
120   link:RelNotes/1.8.0.3.txt[1.8.0.3],
121   link:RelNotes/1.8.0.2.txt[1.8.0.2],
122   link:RelNotes/1.8.0.1.txt[1.8.0.1],
123   link:RelNotes/1.8.0.txt[1.8.0].
125 * link:v1.7.12.4/git.html[documentation for release 1.7.12.4]
127 * release notes for
128   link:RelNotes/1.7.12.4.txt[1.7.12.4],
129   link:RelNotes/1.7.12.3.txt[1.7.12.3],
130   link:RelNotes/1.7.12.2.txt[1.7.12.2],
131   link:RelNotes/1.7.12.1.txt[1.7.12.1],
132   link:RelNotes/1.7.12.txt[1.7.12].
134 * link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
136 * release notes for
137   link:RelNotes/1.7.11.7.txt[1.7.11.7],
138   link:RelNotes/1.7.11.6.txt[1.7.11.6],
139   link:RelNotes/1.7.11.5.txt[1.7.11.5],
140   link:RelNotes/1.7.11.4.txt[1.7.11.4],
141   link:RelNotes/1.7.11.3.txt[1.7.11.3],
142   link:RelNotes/1.7.11.2.txt[1.7.11.2],
143   link:RelNotes/1.7.11.1.txt[1.7.11.1],
144   link:RelNotes/1.7.11.txt[1.7.11].
146 * link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
148 * release notes for
149   link:RelNotes/1.7.10.5.txt[1.7.10.5],
150   link:RelNotes/1.7.10.4.txt[1.7.10.4],
151   link:RelNotes/1.7.10.3.txt[1.7.10.3],
152   link:RelNotes/1.7.10.2.txt[1.7.10.2],
153   link:RelNotes/1.7.10.1.txt[1.7.10.1],
154   link:RelNotes/1.7.10.txt[1.7.10].
156 * link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
158 * release notes for
159   link:RelNotes/1.7.9.7.txt[1.7.9.7],
160   link:RelNotes/1.7.9.6.txt[1.7.9.6],
161   link:RelNotes/1.7.9.5.txt[1.7.9.5],
162   link:RelNotes/1.7.9.4.txt[1.7.9.4],
163   link:RelNotes/1.7.9.3.txt[1.7.9.3],
164   link:RelNotes/1.7.9.2.txt[1.7.9.2],
165   link:RelNotes/1.7.9.1.txt[1.7.9.1],
166   link:RelNotes/1.7.9.txt[1.7.9].
168 * link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
170 * release notes for
171   link:RelNotes/1.7.8.6.txt[1.7.8.6],
172   link:RelNotes/1.7.8.5.txt[1.7.8.5],
173   link:RelNotes/1.7.8.4.txt[1.7.8.4],
174   link:RelNotes/1.7.8.3.txt[1.7.8.3],
175   link:RelNotes/1.7.8.2.txt[1.7.8.2],
176   link:RelNotes/1.7.8.1.txt[1.7.8.1],
177   link:RelNotes/1.7.8.txt[1.7.8].
179 * link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
181 * release notes for
182   link:RelNotes/1.7.7.7.txt[1.7.7.7],
183   link:RelNotes/1.7.7.6.txt[1.7.7.6],
184   link:RelNotes/1.7.7.5.txt[1.7.7.5],
185   link:RelNotes/1.7.7.4.txt[1.7.7.4],
186   link:RelNotes/1.7.7.3.txt[1.7.7.3],
187   link:RelNotes/1.7.7.2.txt[1.7.7.2],
188   link:RelNotes/1.7.7.1.txt[1.7.7.1],
189   link:RelNotes/1.7.7.txt[1.7.7].
191 * link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
193 * release notes for
194   link:RelNotes/1.7.6.6.txt[1.7.6.6],
195   link:RelNotes/1.7.6.5.txt[1.7.6.5],
196   link:RelNotes/1.7.6.4.txt[1.7.6.4],
197   link:RelNotes/1.7.6.3.txt[1.7.6.3],
198   link:RelNotes/1.7.6.2.txt[1.7.6.2],
199   link:RelNotes/1.7.6.1.txt[1.7.6.1],
200   link:RelNotes/1.7.6.txt[1.7.6].
202 * link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
204 * release notes for
205   link:RelNotes/1.7.5.4.txt[1.7.5.4],
206   link:RelNotes/1.7.5.3.txt[1.7.5.3],
207   link:RelNotes/1.7.5.2.txt[1.7.5.2],
208   link:RelNotes/1.7.5.1.txt[1.7.5.1],
209   link:RelNotes/1.7.5.txt[1.7.5].
211 * link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
213 * release notes for
214   link:RelNotes/1.7.4.5.txt[1.7.4.5],
215   link:RelNotes/1.7.4.4.txt[1.7.4.4],
216   link:RelNotes/1.7.4.3.txt[1.7.4.3],
217   link:RelNotes/1.7.4.2.txt[1.7.4.2],
218   link:RelNotes/1.7.4.1.txt[1.7.4.1],
219   link:RelNotes/1.7.4.txt[1.7.4].
221 * link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
223 * release notes for
224   link:RelNotes/1.7.3.5.txt[1.7.3.5],
225   link:RelNotes/1.7.3.4.txt[1.7.3.4],
226   link:RelNotes/1.7.3.3.txt[1.7.3.3],
227   link:RelNotes/1.7.3.2.txt[1.7.3.2],
228   link:RelNotes/1.7.3.1.txt[1.7.3.1],
229   link:RelNotes/1.7.3.txt[1.7.3].
231 * link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
233 * release notes for
234   link:RelNotes/1.7.2.5.txt[1.7.2.5],
235   link:RelNotes/1.7.2.4.txt[1.7.2.4],
236   link:RelNotes/1.7.2.3.txt[1.7.2.3],
237   link:RelNotes/1.7.2.2.txt[1.7.2.2],
238   link:RelNotes/1.7.2.1.txt[1.7.2.1],
239   link:RelNotes/1.7.2.txt[1.7.2].
241 * link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
243 * release notes for
244   link:RelNotes/1.7.1.4.txt[1.7.1.4],
245   link:RelNotes/1.7.1.3.txt[1.7.1.3],
246   link:RelNotes/1.7.1.2.txt[1.7.1.2],
247   link:RelNotes/1.7.1.1.txt[1.7.1.1],
248   link:RelNotes/1.7.1.txt[1.7.1].
250 * link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
252 * release notes for
253   link:RelNotes/1.7.0.9.txt[1.7.0.9],
254   link:RelNotes/1.7.0.8.txt[1.7.0.8],
255   link:RelNotes/1.7.0.7.txt[1.7.0.7],
256   link:RelNotes/1.7.0.6.txt[1.7.0.6],
257   link:RelNotes/1.7.0.5.txt[1.7.0.5],
258   link:RelNotes/1.7.0.4.txt[1.7.0.4],
259   link:RelNotes/1.7.0.3.txt[1.7.0.3],
260   link:RelNotes/1.7.0.2.txt[1.7.0.2],
261   link:RelNotes/1.7.0.1.txt[1.7.0.1],
262   link:RelNotes/1.7.0.txt[1.7.0].
264 * link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
266 * release notes for
267   link:RelNotes/1.6.6.3.txt[1.6.6.3],
268   link:RelNotes/1.6.6.2.txt[1.6.6.2],
269   link:RelNotes/1.6.6.1.txt[1.6.6.1],
270   link:RelNotes/1.6.6.txt[1.6.6].
272 * link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
274 * release notes for
275   link:RelNotes/1.6.5.9.txt[1.6.5.9],
276   link:RelNotes/1.6.5.8.txt[1.6.5.8],
277   link:RelNotes/1.6.5.7.txt[1.6.5.7],
278   link:RelNotes/1.6.5.6.txt[1.6.5.6],
279   link:RelNotes/1.6.5.5.txt[1.6.5.5],
280   link:RelNotes/1.6.5.4.txt[1.6.5.4],
281   link:RelNotes/1.6.5.3.txt[1.6.5.3],
282   link:RelNotes/1.6.5.2.txt[1.6.5.2],
283   link:RelNotes/1.6.5.1.txt[1.6.5.1],
284   link:RelNotes/1.6.5.txt[1.6.5].
286 * link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
288 * release notes for
289   link:RelNotes/1.6.4.5.txt[1.6.4.5],
290   link:RelNotes/1.6.4.4.txt[1.6.4.4],
291   link:RelNotes/1.6.4.3.txt[1.6.4.3],
292   link:RelNotes/1.6.4.2.txt[1.6.4.2],
293   link:RelNotes/1.6.4.1.txt[1.6.4.1],
294   link:RelNotes/1.6.4.txt[1.6.4].
296 * link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
298 * release notes for
299   link:RelNotes/1.6.3.4.txt[1.6.3.4],
300   link:RelNotes/1.6.3.3.txt[1.6.3.3],
301   link:RelNotes/1.6.3.2.txt[1.6.3.2],
302   link:RelNotes/1.6.3.1.txt[1.6.3.1],
303   link:RelNotes/1.6.3.txt[1.6.3].
305 * release notes for
306   link:RelNotes/1.6.2.5.txt[1.6.2.5],
307   link:RelNotes/1.6.2.4.txt[1.6.2.4],
308   link:RelNotes/1.6.2.3.txt[1.6.2.3],
309   link:RelNotes/1.6.2.2.txt[1.6.2.2],
310   link:RelNotes/1.6.2.1.txt[1.6.2.1],
311   link:RelNotes/1.6.2.txt[1.6.2].
313 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
315 * release notes for
316   link:RelNotes/1.6.1.3.txt[1.6.1.3],
317   link:RelNotes/1.6.1.2.txt[1.6.1.2],
318   link:RelNotes/1.6.1.1.txt[1.6.1.1],
319   link:RelNotes/1.6.1.txt[1.6.1].
321 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
323 * release notes for
324   link:RelNotes/1.6.0.6.txt[1.6.0.6],
325   link:RelNotes/1.6.0.5.txt[1.6.0.5],
326   link:RelNotes/1.6.0.4.txt[1.6.0.4],
327   link:RelNotes/1.6.0.3.txt[1.6.0.3],
328   link:RelNotes/1.6.0.2.txt[1.6.0.2],
329   link:RelNotes/1.6.0.1.txt[1.6.0.1],
330   link:RelNotes/1.6.0.txt[1.6.0].
332 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
334 * release notes for
335   link:RelNotes/1.5.6.6.txt[1.5.6.6],
336   link:RelNotes/1.5.6.5.txt[1.5.6.5],
337   link:RelNotes/1.5.6.4.txt[1.5.6.4],
338   link:RelNotes/1.5.6.3.txt[1.5.6.3],
339   link:RelNotes/1.5.6.2.txt[1.5.6.2],
340   link:RelNotes/1.5.6.1.txt[1.5.6.1],
341   link:RelNotes/1.5.6.txt[1.5.6].
343 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
345 * release notes for
346   link:RelNotes/1.5.5.6.txt[1.5.5.6],
347   link:RelNotes/1.5.5.5.txt[1.5.5.5],
348   link:RelNotes/1.5.5.4.txt[1.5.5.4],
349   link:RelNotes/1.5.5.3.txt[1.5.5.3],
350   link:RelNotes/1.5.5.2.txt[1.5.5.2],
351   link:RelNotes/1.5.5.1.txt[1.5.5.1],
352   link:RelNotes/1.5.5.txt[1.5.5].
354 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
356 * release notes for
357   link:RelNotes/1.5.4.7.txt[1.5.4.7],
358   link:RelNotes/1.5.4.6.txt[1.5.4.6],
359   link:RelNotes/1.5.4.5.txt[1.5.4.5],
360   link:RelNotes/1.5.4.4.txt[1.5.4.4],
361   link:RelNotes/1.5.4.3.txt[1.5.4.3],
362   link:RelNotes/1.5.4.2.txt[1.5.4.2],
363   link:RelNotes/1.5.4.1.txt[1.5.4.1],
364   link:RelNotes/1.5.4.txt[1.5.4].
366 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
368 * release notes for
369   link:RelNotes/1.5.3.8.txt[1.5.3.8],
370   link:RelNotes/1.5.3.7.txt[1.5.3.7],
371   link:RelNotes/1.5.3.6.txt[1.5.3.6],
372   link:RelNotes/1.5.3.5.txt[1.5.3.5],
373   link:RelNotes/1.5.3.4.txt[1.5.3.4],
374   link:RelNotes/1.5.3.3.txt[1.5.3.3],
375   link:RelNotes/1.5.3.2.txt[1.5.3.2],
376   link:RelNotes/1.5.3.1.txt[1.5.3.1],
377   link:RelNotes/1.5.3.txt[1.5.3].
379 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
381 * release notes for
382   link:RelNotes/1.5.2.5.txt[1.5.2.5],
383   link:RelNotes/1.5.2.4.txt[1.5.2.4],
384   link:RelNotes/1.5.2.3.txt[1.5.2.3],
385   link:RelNotes/1.5.2.2.txt[1.5.2.2],
386   link:RelNotes/1.5.2.1.txt[1.5.2.1],
387   link:RelNotes/1.5.2.txt[1.5.2].
389 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
391 * release notes for
392   link:RelNotes/1.5.1.6.txt[1.5.1.6],
393   link:RelNotes/1.5.1.5.txt[1.5.1.5],
394   link:RelNotes/1.5.1.4.txt[1.5.1.4],
395   link:RelNotes/1.5.1.3.txt[1.5.1.3],
396   link:RelNotes/1.5.1.2.txt[1.5.1.2],
397   link:RelNotes/1.5.1.1.txt[1.5.1.1],
398   link:RelNotes/1.5.1.txt[1.5.1].
400 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
402 * release notes for
403   link:RelNotes/1.5.0.7.txt[1.5.0.7],
404   link:RelNotes/1.5.0.6.txt[1.5.0.6],
405   link:RelNotes/1.5.0.5.txt[1.5.0.5],
406   link:RelNotes/1.5.0.3.txt[1.5.0.3],
407   link:RelNotes/1.5.0.2.txt[1.5.0.2],
408   link:RelNotes/1.5.0.1.txt[1.5.0.1],
409   link:RelNotes/1.5.0.txt[1.5.0].
411 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
412   link:v1.3.3/git.html[1.3.3],
413   link:v1.2.6/git.html[1.2.6],
414   link:v1.0.13/git.html[1.0.13].
416 ============
418 endif::stalenotes[]
420 OPTIONS
421 -------
422 --version::
423         Prints the Git suite version that the 'git' program came from.
425 --help::
426         Prints the synopsis and a list of the most commonly used
427         commands. If the option '--all' or '-a' is given then all
428         available commands are printed. If a Git command is named this
429         option will bring up the manual page for that command.
431 Other options are available to control how the manual page is
432 displayed. See linkgit:git-help[1] for more information,
433 because `git --help ...` is converted internally into `git
434 help ...`.
436 -C <path>::
437         Run as if git was started in '<path>' instead of the current working
438         directory.  When multiple `-C` options are given, each subsequent
439         non-absolute `-C <path>` is interpreted relative to the preceding `-C
440         <path>`.
442 This option affects options that expect path name like `--git-dir` and
443 `--work-tree` in that their interpretations of the path names would be
444 made relative to the working directory caused by the `-C` option. For
445 example the following invocations are equivalent:
447     git --git-dir=a.git --work-tree=b -C c status
448     git --git-dir=c/a.git --work-tree=c/b status
450 -c <name>=<value>::
451         Pass a configuration parameter to the command. The value
452         given will override values from configuration files.
453         The <name> is expected in the same format as listed by
454         'git config' (subkeys separated by dots).
456 --exec-path[=<path>]::
457         Path to wherever your core Git programs are installed.
458         This can also be controlled by setting the GIT_EXEC_PATH
459         environment variable. If no path is given, 'git' will print
460         the current setting and then exit.
462 --html-path::
463         Print the path, without trailing slash, where Git's HTML
464         documentation is installed and exit.
466 --man-path::
467         Print the manpath (see `man(1)`) for the man pages for
468         this version of Git and exit.
470 --info-path::
471         Print the path where the Info files documenting this
472         version of Git are installed and exit.
474 -p::
475 --paginate::
476         Pipe all output into 'less' (or if set, $PAGER) if standard
477         output is a terminal.  This overrides the `pager.<cmd>`
478         configuration options (see the "Configuration Mechanism" section
479         below).
481 --no-pager::
482         Do not pipe Git output into a pager.
484 --git-dir=<path>::
485         Set the path to the repository. This can also be controlled by
486         setting the GIT_DIR environment variable. It can be an absolute
487         path or relative path to current working directory.
489 --work-tree=<path>::
490         Set the path to the working tree. It can be an absolute path
491         or a path relative to the current working directory.
492         This can also be controlled by setting the GIT_WORK_TREE
493         environment variable and the core.worktree configuration
494         variable (see core.worktree in linkgit:git-config[1] for a
495         more detailed discussion).
497 --namespace=<path>::
498         Set the Git namespace.  See linkgit:gitnamespaces[7] for more
499         details.  Equivalent to setting the `GIT_NAMESPACE` environment
500         variable.
502 --bare::
503         Treat the repository as a bare repository.  If GIT_DIR
504         environment is not set, it is set to the current working
505         directory.
507 --no-replace-objects::
508         Do not use replacement refs to replace Git objects. See
509         linkgit:git-replace[1] for more information.
511 --literal-pathspecs::
512         Treat pathspecs literally (i.e. no globbing, no pathspec magic).
513         This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
514         variable to `1`.
516 --glob-pathspecs::
517         Add "glob" magic to all pathspec. This is equivalent to setting
518         the `GIT_GLOB_PATHSPECS` environment variable to `1`. Disabling
519         globbing on individual pathspecs can be done using pathspec
520         magic ":(literal)"
522 --noglob-pathspecs::
523         Add "literal" magic to all pathspec. This is equivalent to setting
524         the `GIT_NOGLOB_PATHSPECS` environment variable to `1`. Enabling
525         globbing on individual pathspecs can be done using pathspec
526         magic ":(glob)"
528 --icase-pathspecs::
529         Add "icase" magic to all pathspec. This is equivalent to setting
530         the `GIT_ICASE_PATHSPECS` environment variable to `1`.
532 GIT COMMANDS
533 ------------
535 We divide Git into high level ("porcelain") commands and low level
536 ("plumbing") commands.
538 High-level commands (porcelain)
539 -------------------------------
541 We separate the porcelain commands into the main commands and some
542 ancillary user utilities.
544 Main porcelain commands
545 ~~~~~~~~~~~~~~~~~~~~~~~
547 include::cmds-mainporcelain.txt[]
549 Ancillary Commands
550 ~~~~~~~~~~~~~~~~~~
551 Manipulators:
553 include::cmds-ancillarymanipulators.txt[]
555 Interrogators:
557 include::cmds-ancillaryinterrogators.txt[]
560 Interacting with Others
561 ~~~~~~~~~~~~~~~~~~~~~~~
563 These commands are to interact with foreign SCM and with other
564 people via patch over e-mail.
566 include::cmds-foreignscminterface.txt[]
569 Low-level commands (plumbing)
570 -----------------------------
572 Although Git includes its
573 own porcelain layer, its low-level commands are sufficient to support
574 development of alternative porcelains.  Developers of such porcelains
575 might start by reading about linkgit:git-update-index[1] and
576 linkgit:git-read-tree[1].
578 The interface (input, output, set of options and the semantics)
579 to these low-level commands are meant to be a lot more stable
580 than Porcelain level commands, because these commands are
581 primarily for scripted use.  The interface to Porcelain commands
582 on the other hand are subject to change in order to improve the
583 end user experience.
585 The following description divides
586 the low-level commands into commands that manipulate objects (in
587 the repository, index, and working tree), commands that interrogate and
588 compare objects, and commands that move objects and references between
589 repositories.
592 Manipulation commands
593 ~~~~~~~~~~~~~~~~~~~~~
595 include::cmds-plumbingmanipulators.txt[]
598 Interrogation commands
599 ~~~~~~~~~~~~~~~~~~~~~~
601 include::cmds-plumbinginterrogators.txt[]
603 In general, the interrogate commands do not touch the files in
604 the working tree.
607 Synching repositories
608 ~~~~~~~~~~~~~~~~~~~~~
610 include::cmds-synchingrepositories.txt[]
612 The following are helper commands used by the above; end users
613 typically do not use them directly.
615 include::cmds-synchelpers.txt[]
618 Internal helper commands
619 ~~~~~~~~~~~~~~~~~~~~~~~~
621 These are internal helper commands used by other commands; end
622 users typically do not use them directly.
624 include::cmds-purehelpers.txt[]
627 Configuration Mechanism
628 -----------------------
630 Git uses a simple text format to store customizations that are per
631 repository and are per user.  Such a configuration file may look
632 like this:
634 ------------
636 # A '#' or ';' character indicates a comment.
639 ; core variables
640 [core]
641         ; Don't trust file modes
642         filemode = false
644 ; user identity
645 [user]
646         name = "Junio C Hamano"
647         email = "gitster@pobox.com"
649 ------------
651 Various commands read from the configuration file and adjust
652 their operation accordingly.  See linkgit:git-config[1] for a
653 list and more details about the configuration mechanism.
656 Identifier Terminology
657 ----------------------
658 <object>::
659         Indicates the object name for any type of object.
661 <blob>::
662         Indicates a blob object name.
664 <tree>::
665         Indicates a tree object name.
667 <commit>::
668         Indicates a commit object name.
670 <tree-ish>::
671         Indicates a tree, commit or tag object name.  A
672         command that takes a <tree-ish> argument ultimately wants to
673         operate on a <tree> object but automatically dereferences
674         <commit> and <tag> objects that point at a <tree>.
676 <commit-ish>::
677         Indicates a commit or tag object name.  A
678         command that takes a <commit-ish> argument ultimately wants to
679         operate on a <commit> object but automatically dereferences
680         <tag> objects that point at a <commit>.
682 <type>::
683         Indicates that an object type is required.
684         Currently one of: `blob`, `tree`, `commit`, or `tag`.
686 <file>::
687         Indicates a filename - almost always relative to the
688         root of the tree structure `GIT_INDEX_FILE` describes.
690 Symbolic Identifiers
691 --------------------
692 Any Git command accepting any <object> can also use the following
693 symbolic notation:
695 HEAD::
696         indicates the head of the current branch.
698 <tag>::
699         a valid tag 'name'
700         (i.e. a `refs/tags/<tag>` reference).
702 <head>::
703         a valid head 'name'
704         (i.e. a `refs/heads/<head>` reference).
706 For a more complete list of ways to spell object names, see
707 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
710 File/Directory Structure
711 ------------------------
713 Please see the linkgit:gitrepository-layout[5] document.
715 Read linkgit:githooks[5] for more details about each hook.
717 Higher level SCMs may provide and manage additional information in the
718 `$GIT_DIR`.
721 Terminology
722 -----------
723 Please see linkgit:gitglossary[7].
726 Environment Variables
727 ---------------------
728 Various Git commands use the following environment variables:
730 The Git Repository
731 ~~~~~~~~~~~~~~~~~~
732 These environment variables apply to 'all' core Git commands. Nb: it
733 is worth noting that they may be used/overridden by SCMS sitting above
734 Git so take care if using Cogito etc.
736 'GIT_INDEX_FILE'::
737         This environment allows the specification of an alternate
738         index file. If not specified, the default of `$GIT_DIR/index`
739         is used.
741 'GIT_INDEX_VERSION'::
742         This environment variable allows the specification of an index
743         version for new repositories.  It won't affect existing index
744         files.  By default index file version [23] is used.
746 'GIT_OBJECT_DIRECTORY'::
747         If the object storage directory is specified via this
748         environment variable then the sha1 directories are created
749         underneath - otherwise the default `$GIT_DIR/objects`
750         directory is used.
752 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
753         Due to the immutable nature of Git objects, old objects can be
754         archived into shared, read-only directories. This variable
755         specifies a ":" separated (on Windows ";" separated) list
756         of Git object directories which can be used to search for Git
757         objects. New objects will not be written to these directories.
759 'GIT_DIR'::
760         If the 'GIT_DIR' environment variable is set then it
761         specifies a path to use instead of the default `.git`
762         for the base of the repository.
763         The '--git-dir' command-line option also sets this value.
765 'GIT_WORK_TREE'::
766         Set the path to the root of the working tree.
767         This can also be controlled by the '--work-tree' command-line
768         option and the core.worktree configuration variable.
770 'GIT_NAMESPACE'::
771         Set the Git namespace; see linkgit:gitnamespaces[7] for details.
772         The '--namespace' command-line option also sets this value.
774 'GIT_CEILING_DIRECTORIES'::
775         This should be a colon-separated list of absolute paths.  If
776         set, it is a list of directories that Git should not chdir up
777         into while looking for a repository directory (useful for
778         excluding slow-loading network directories).  It will not
779         exclude the current working directory or a GIT_DIR set on the
780         command line or in the environment.  Normally, Git has to read
781         the entries in this list and resolve any symlink that
782         might be present in order to compare them with the current
783         directory.  However, if even this access is slow, you
784         can add an empty entry to the list to tell Git that the
785         subsequent entries are not symlinks and needn't be resolved;
786         e.g.,
787         'GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink'.
789 'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
790         When run in a directory that does not have ".git" repository
791         directory, Git tries to find such a directory in the parent
792         directories to find the top of the working tree, but by default it
793         does not cross filesystem boundaries.  This environment variable
794         can be set to true to tell Git not to stop at filesystem
795         boundaries.  Like 'GIT_CEILING_DIRECTORIES', this will not affect
796         an explicit repository directory set via 'GIT_DIR' or on the
797         command line.
799 Git Commits
800 ~~~~~~~~~~~
801 'GIT_AUTHOR_NAME'::
802 'GIT_AUTHOR_EMAIL'::
803 'GIT_AUTHOR_DATE'::
804 'GIT_COMMITTER_NAME'::
805 'GIT_COMMITTER_EMAIL'::
806 'GIT_COMMITTER_DATE'::
807 'EMAIL'::
808         see linkgit:git-commit-tree[1]
810 Git Diffs
811 ~~~~~~~~~
812 'GIT_DIFF_OPTS'::
813         Only valid setting is "--unified=??" or "-u??" to set the
814         number of context lines shown when a unified diff is created.
815         This takes precedence over any "-U" or "--unified" option
816         value passed on the Git diff command line.
818 'GIT_EXTERNAL_DIFF'::
819         When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
820         program named by it is called, instead of the diff invocation
821         described above.  For a path that is added, removed, or modified,
822         'GIT_EXTERNAL_DIFF' is called with 7 parameters:
824         path old-file old-hex old-mode new-file new-hex new-mode
826 where:
828         <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
829                          contents of <old|new>,
830         <old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
831         <old|new>-mode:: are the octal representation of the file modes.
833 The file parameters can point at the user's working file
834 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
835 when a new file is added), or a temporary file (e.g. `old-file` in the
836 index).  'GIT_EXTERNAL_DIFF' should not worry about unlinking the
837 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
839 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
840 parameter, <path>.
842 For each path 'GIT_EXTERNAL_DIFF' is called, two environment variables,
843 'GIT_DIFF_PATH_COUNTER' and 'GIT_DIFF_PATH_TOTAL' are set.
845 'GIT_DIFF_PATH_COUNTER'::
846         A 1-based counter incremented by one for every path.
848 'GIT_DIFF_PATH_TOTAL'::
849         The total number of paths.
851 other
852 ~~~~~
853 'GIT_MERGE_VERBOSITY'::
854         A number controlling the amount of output shown by
855         the recursive merge strategy.  Overrides merge.verbosity.
856         See linkgit:git-merge[1]
858 'GIT_PAGER'::
859         This environment variable overrides `$PAGER`. If it is set
860         to an empty string or to the value "cat", Git will not launch
861         a pager.  See also the `core.pager` option in
862         linkgit:git-config[1].
864 'GIT_EDITOR'::
865         This environment variable overrides `$EDITOR` and `$VISUAL`.
866         It is used by several Git commands when, on interactive mode,
867         an editor is to be launched. See also linkgit:git-var[1]
868         and the `core.editor` option in linkgit:git-config[1].
870 'GIT_SSH'::
871         If this environment variable is set then 'git fetch'
872         and 'git push' will use this command instead
873         of 'ssh' when they need to connect to a remote system.
874         The '$GIT_SSH' command will be given exactly two or
875         four arguments: the 'username@host' (or just 'host')
876         from the URL and the shell command to execute on that
877         remote system, optionally preceded by '-p' (literally) and
878         the 'port' from the URL when it specifies something other
879         than the default SSH port.
881 To pass options to the program that you want to list in GIT_SSH
882 you will need to wrap the program and options into a shell script,
883 then set GIT_SSH to refer to the shell script.
885 Usually it is easier to configure any desired options through your
886 personal `.ssh/config` file.  Please consult your ssh documentation
887 for further details.
889 'GIT_ASKPASS'::
890         If this environment variable is set, then Git commands which need to
891         acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
892         will call this program with a suitable prompt as command-line argument
893         and read the password from its STDOUT. See also the 'core.askpass'
894         option in linkgit:git-config[1].
896 'GIT_CONFIG_NOSYSTEM'::
897         Whether to skip reading settings from the system-wide
898         `$(prefix)/etc/gitconfig` file.  This environment variable can
899         be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
900         predictable environment for a picky script, or you can set it
901         temporarily to avoid using a buggy `/etc/gitconfig` file while
902         waiting for someone with sufficient permissions to fix it.
904 'GIT_FLUSH'::
905         If this environment variable is set to "1", then commands such
906         as 'git blame' (in incremental mode), 'git rev-list', 'git log',
907         'git check-attr' and 'git check-ignore' will
908         force a flush of the output stream after each record have been
909         flushed. If this
910         variable is set to "0", the output of these commands will be done
911         using completely buffered I/O.   If this environment variable is
912         not set, Git will choose buffered or record-oriented flushing
913         based on whether stdout appears to be redirected to a file or not.
915 'GIT_TRACE'::
916         Enables general trace messages, e.g. alias expansion, built-in
917         command execution and external command execution.
919 If this variable is set to "1", "2" or "true" (comparison
920 is case insensitive), trace messages will be printed to
921 stderr.
923 If the variable is set to an integer value greater than 2
924 and lower than 10 (strictly) then Git will interpret this
925 value as an open file descriptor and will try to write the
926 trace messages into this file descriptor.
928 Alternatively, if the variable is set to an absolute path
929 (starting with a '/' character), Git will interpret this
930 as a file path and will try to write the trace messages
931 into it.
933 Unsetting the variable, or setting it to empty, "0" or
934 "false" (case insensitive) disables trace messages.
936 'GIT_TRACE_PACK_ACCESS'::
937         Enables trace messages for all accesses to any packs. For each
938         access, the pack file name and an offset in the pack is
939         recorded. This may be helpful for troubleshooting some
940         pack-related performance problems.
941         See 'GIT_TRACE' for available trace output options.
943 'GIT_TRACE_PACKET'::
944         Enables trace messages for all packets coming in or out of a
945         given program. This can help with debugging object negotiation
946         or other protocol issues. Tracing is turned off at a packet
947         starting with "PACK".
948         See 'GIT_TRACE' for available trace output options.
950 'GIT_TRACE_PERFORMANCE'::
951         Enables performance related trace messages, e.g. total execution
952         time of each Git command.
953         See 'GIT_TRACE' for available trace output options.
955 'GIT_TRACE_SETUP'::
956         Enables trace messages printing the .git, working tree and current
957         working directory after Git has completed its setup phase.
958         See 'GIT_TRACE' for available trace output options.
960 'GIT_TRACE_SHALLOW'::
961         Enables trace messages that can help debugging fetching /
962         cloning of shallow repositories.
963         See 'GIT_TRACE' for available trace output options.
965 GIT_LITERAL_PATHSPECS::
966         Setting this variable to `1` will cause Git to treat all
967         pathspecs literally, rather than as glob patterns. For example,
968         running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
969         for commits that touch the path `*.c`, not any paths that the
970         glob `*.c` matches. You might want this if you are feeding
971         literal paths to Git (e.g., paths previously given to you by
972         `git ls-tree`, `--raw` diff output, etc).
974 GIT_GLOB_PATHSPECS::
975         Setting this variable to `1` will cause Git to treat all
976         pathspecs as glob patterns (aka "glob" magic).
978 GIT_NOGLOB_PATHSPECS::
979         Setting this variable to `1` will cause Git to treat all
980         pathspecs as literal (aka "literal" magic).
982 GIT_ICASE_PATHSPECS::
983         Setting this variable to `1` will cause Git to treat all
984         pathspecs as case-insensitive.
986 'GIT_REFLOG_ACTION'::
987         When a ref is updated, reflog entries are created to keep
988         track of the reason why the ref was updated (which is
989         typically the name of the high-level command that updated
990         the ref), in addition to the old and new values of the ref.
991         A scripted Porcelain command can use set_reflog_action
992         helper function in `git-sh-setup` to set its name to this
993         variable when it is invoked as the top level command by the
994         end user, to be recorded in the body of the reflog.
997 Discussion[[Discussion]]
998 ------------------------
1000 More detail on the following is available from the
1001 link:user-manual.html#git-concepts[Git concepts chapter of the
1002 user-manual] and linkgit:gitcore-tutorial[7].
1004 A Git project normally consists of a working directory with a ".git"
1005 subdirectory at the top level.  The .git directory contains, among other
1006 things, a compressed object database representing the complete history
1007 of the project, an "index" file which links that history to the current
1008 contents of the working tree, and named pointers into that history such
1009 as tags and branch heads.
1011 The object database contains objects of three main types: blobs, which
1012 hold file data; trees, which point to blobs and other trees to build up
1013 directory hierarchies; and commits, which each reference a single tree
1014 and some number of parent commits.
1016 The commit, equivalent to what other systems call a "changeset" or
1017 "version", represents a step in the project's history, and each parent
1018 represents an immediately preceding step.  Commits with more than one
1019 parent represent merges of independent lines of development.
1021 All objects are named by the SHA-1 hash of their contents, normally
1022 written as a string of 40 hex digits.  Such names are globally unique.
1023 The entire history leading up to a commit can be vouched for by signing
1024 just that commit.  A fourth object type, the tag, is provided for this
1025 purpose.
1027 When first created, objects are stored in individual files, but for
1028 efficiency may later be compressed together into "pack files".
1030 Named pointers called refs mark interesting points in history.  A ref
1031 may contain the SHA-1 name of an object or the name of another ref.  Refs
1032 with names beginning `ref/head/` contain the SHA-1 name of the most
1033 recent commit (or "head") of a branch under development.  SHA-1 names of
1034 tags of interest are stored under `ref/tags/`.  A special ref named
1035 `HEAD` contains the name of the currently checked-out branch.
1037 The index file is initialized with a list of all paths and, for each
1038 path, a blob object and a set of attributes.  The blob object represents
1039 the contents of the file as of the head of the current branch.  The
1040 attributes (last modified time, size, etc.) are taken from the
1041 corresponding file in the working tree.  Subsequent changes to the
1042 working tree can be found by comparing these attributes.  The index may
1043 be updated with new content, and new commits may be created from the
1044 content stored in the index.
1046 The index is also capable of storing multiple entries (called "stages")
1047 for a given pathname.  These stages are used to hold the various
1048 unmerged version of a file when a merge is in progress.
1050 FURTHER DOCUMENTATION
1051 ---------------------
1053 See the references in the "description" section to get started
1054 using Git.  The following is probably more detail than necessary
1055 for a first-time user.
1057 The link:user-manual.html#git-concepts[Git concepts chapter of the
1058 user-manual] and linkgit:gitcore-tutorial[7] both provide
1059 introductions to the underlying Git architecture.
1061 See linkgit:gitworkflows[7] for an overview of recommended workflows.
1063 See also the link:howto-index.html[howto] documents for some useful
1064 examples.
1066 The internals are documented in the
1067 link:technical/api-index.html[Git API documentation].
1069 Users migrating from CVS may also want to
1070 read linkgit:gitcvs-migration[7].
1073 Authors
1074 -------
1075 Git was started by Linus Torvalds, and is currently maintained by Junio
1076 C Hamano. Numerous contributions have come from the Git mailing list
1077 <git@vger.kernel.org>.  http://www.openhub.net/p/git/contributors/summary
1078 gives you a more complete list of contributors.
1080 If you have a clone of git.git itself, the
1081 output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
1082 the authors for specific parts of the project.
1084 Reporting Bugs
1085 --------------
1087 Report bugs to the Git mailing list <git@vger.kernel.org> where the
1088 development and maintenance is primarily done.  You do not have to be
1089 subscribed to the list to send a message there.
1091 SEE ALSO
1092 --------
1093 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
1094 link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
1095 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
1096 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
1097 linkgit:gitworkflows[7]
1101 Part of the linkgit:git[1] suite