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