6 git - the stupid content tracker
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>]
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`.
41 You are reading the documentation for the latest (possibly
42 unreleased) version of Git, that is available from the 'master'
43 branch of the `git.git` repository.
44 Documentation for older releases are available here:
46 * link:v2.3.0/git.html[documentation for release 2.3]
49 link:RelNotes/2.3.0.txt[2.3].
51 * link:v2.2.2/git.html[documentation for release 2.2.2]
54 link:RelNotes/2.2.2.txt[2.2.2],
55 link:RelNotes/2.2.1.txt[2.2.1],
56 link:RelNotes/2.2.0.txt[2.2].
58 * link:v2.1.4/git.html[documentation for release 2.1.4]
61 link:RelNotes/2.1.4.txt[2.1.4],
62 link:RelNotes/2.1.3.txt[2.1.3],
63 link:RelNotes/2.1.2.txt[2.1.2],
64 link:RelNotes/2.1.1.txt[2.1.1],
65 link:RelNotes/2.1.0.txt[2.1].
67 * link:v2.0.5/git.html[documentation for release 2.0.5]
70 link:RelNotes/2.0.5.txt[2.0.5],
71 link:RelNotes/2.0.4.txt[2.0.4],
72 link:RelNotes/2.0.3.txt[2.0.3],
73 link:RelNotes/2.0.2.txt[2.0.2],
74 link:RelNotes/2.0.1.txt[2.0.1],
75 link:RelNotes/2.0.0.txt[2.0.0].
77 * link:v1.9.5/git.html[documentation for release 1.9.5]
80 link:RelNotes/1.9.5.txt[1.9.5],
81 link:RelNotes/1.9.4.txt[1.9.4],
82 link:RelNotes/1.9.3.txt[1.9.3],
83 link:RelNotes/1.9.2.txt[1.9.2],
84 link:RelNotes/1.9.1.txt[1.9.1],
85 link:RelNotes/1.9.0.txt[1.9.0].
87 * link:v1.8.5.6/git.html[documentation for release 1.8.5.6]
90 link:RelNotes/1.8.5.6.txt[1.8.5.6],
91 link:RelNotes/1.8.5.5.txt[1.8.5.5],
92 link:RelNotes/1.8.5.4.txt[1.8.5.4],
93 link:RelNotes/1.8.5.3.txt[1.8.5.3],
94 link:RelNotes/1.8.5.2.txt[1.8.5.2],
95 link:RelNotes/1.8.5.1.txt[1.8.5.1],
96 link:RelNotes/1.8.5.txt[1.8.5].
98 * link:v1.8.4.5/git.html[documentation for release 1.8.4.5]
101 link:RelNotes/1.8.4.5.txt[1.8.4.5],
102 link:RelNotes/1.8.4.4.txt[1.8.4.4],
103 link:RelNotes/1.8.4.3.txt[1.8.4.3],
104 link:RelNotes/1.8.4.2.txt[1.8.4.2],
105 link:RelNotes/1.8.4.1.txt[1.8.4.1],
106 link:RelNotes/1.8.4.txt[1.8.4].
108 * link:v1.8.3.4/git.html[documentation for release 1.8.3.4]
111 link:RelNotes/1.8.3.4.txt[1.8.3.4],
112 link:RelNotes/1.8.3.3.txt[1.8.3.3],
113 link:RelNotes/1.8.3.2.txt[1.8.3.2],
114 link:RelNotes/1.8.3.1.txt[1.8.3.1],
115 link:RelNotes/1.8.3.txt[1.8.3].
117 * link:v1.8.2.3/git.html[documentation for release 1.8.2.3]
120 link:RelNotes/1.8.2.3.txt[1.8.2.3],
121 link:RelNotes/1.8.2.2.txt[1.8.2.2],
122 link:RelNotes/1.8.2.1.txt[1.8.2.1],
123 link:RelNotes/1.8.2.txt[1.8.2].
125 * link:v1.8.1.6/git.html[documentation for release 1.8.1.6]
128 link:RelNotes/1.8.1.6.txt[1.8.1.6],
129 link:RelNotes/1.8.1.5.txt[1.8.1.5],
130 link:RelNotes/1.8.1.4.txt[1.8.1.4],
131 link:RelNotes/1.8.1.3.txt[1.8.1.3],
132 link:RelNotes/1.8.1.2.txt[1.8.1.2],
133 link:RelNotes/1.8.1.1.txt[1.8.1.1],
134 link:RelNotes/1.8.1.txt[1.8.1].
136 * link:v1.8.0.3/git.html[documentation for release 1.8.0.3]
139 link:RelNotes/1.8.0.3.txt[1.8.0.3],
140 link:RelNotes/1.8.0.2.txt[1.8.0.2],
141 link:RelNotes/1.8.0.1.txt[1.8.0.1],
142 link:RelNotes/1.8.0.txt[1.8.0].
144 * link:v1.7.12.4/git.html[documentation for release 1.7.12.4]
147 link:RelNotes/1.7.12.4.txt[1.7.12.4],
148 link:RelNotes/1.7.12.3.txt[1.7.12.3],
149 link:RelNotes/1.7.12.2.txt[1.7.12.2],
150 link:RelNotes/1.7.12.1.txt[1.7.12.1],
151 link:RelNotes/1.7.12.txt[1.7.12].
153 * link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
156 link:RelNotes/1.7.11.7.txt[1.7.11.7],
157 link:RelNotes/1.7.11.6.txt[1.7.11.6],
158 link:RelNotes/1.7.11.5.txt[1.7.11.5],
159 link:RelNotes/1.7.11.4.txt[1.7.11.4],
160 link:RelNotes/1.7.11.3.txt[1.7.11.3],
161 link:RelNotes/1.7.11.2.txt[1.7.11.2],
162 link:RelNotes/1.7.11.1.txt[1.7.11.1],
163 link:RelNotes/1.7.11.txt[1.7.11].
165 * link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
168 link:RelNotes/1.7.10.5.txt[1.7.10.5],
169 link:RelNotes/1.7.10.4.txt[1.7.10.4],
170 link:RelNotes/1.7.10.3.txt[1.7.10.3],
171 link:RelNotes/1.7.10.2.txt[1.7.10.2],
172 link:RelNotes/1.7.10.1.txt[1.7.10.1],
173 link:RelNotes/1.7.10.txt[1.7.10].
175 * link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
178 link:RelNotes/1.7.9.7.txt[1.7.9.7],
179 link:RelNotes/1.7.9.6.txt[1.7.9.6],
180 link:RelNotes/1.7.9.5.txt[1.7.9.5],
181 link:RelNotes/1.7.9.4.txt[1.7.9.4],
182 link:RelNotes/1.7.9.3.txt[1.7.9.3],
183 link:RelNotes/1.7.9.2.txt[1.7.9.2],
184 link:RelNotes/1.7.9.1.txt[1.7.9.1],
185 link:RelNotes/1.7.9.txt[1.7.9].
187 * link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
190 link:RelNotes/1.7.8.6.txt[1.7.8.6],
191 link:RelNotes/1.7.8.5.txt[1.7.8.5],
192 link:RelNotes/1.7.8.4.txt[1.7.8.4],
193 link:RelNotes/1.7.8.3.txt[1.7.8.3],
194 link:RelNotes/1.7.8.2.txt[1.7.8.2],
195 link:RelNotes/1.7.8.1.txt[1.7.8.1],
196 link:RelNotes/1.7.8.txt[1.7.8].
198 * link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
201 link:RelNotes/1.7.7.7.txt[1.7.7.7],
202 link:RelNotes/1.7.7.6.txt[1.7.7.6],
203 link:RelNotes/1.7.7.5.txt[1.7.7.5],
204 link:RelNotes/1.7.7.4.txt[1.7.7.4],
205 link:RelNotes/1.7.7.3.txt[1.7.7.3],
206 link:RelNotes/1.7.7.2.txt[1.7.7.2],
207 link:RelNotes/1.7.7.1.txt[1.7.7.1],
208 link:RelNotes/1.7.7.txt[1.7.7].
210 * link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
213 link:RelNotes/1.7.6.6.txt[1.7.6.6],
214 link:RelNotes/1.7.6.5.txt[1.7.6.5],
215 link:RelNotes/1.7.6.4.txt[1.7.6.4],
216 link:RelNotes/1.7.6.3.txt[1.7.6.3],
217 link:RelNotes/1.7.6.2.txt[1.7.6.2],
218 link:RelNotes/1.7.6.1.txt[1.7.6.1],
219 link:RelNotes/1.7.6.txt[1.7.6].
221 * link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
224 link:RelNotes/1.7.5.4.txt[1.7.5.4],
225 link:RelNotes/1.7.5.3.txt[1.7.5.3],
226 link:RelNotes/1.7.5.2.txt[1.7.5.2],
227 link:RelNotes/1.7.5.1.txt[1.7.5.1],
228 link:RelNotes/1.7.5.txt[1.7.5].
230 * link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
233 link:RelNotes/1.7.4.5.txt[1.7.4.5],
234 link:RelNotes/1.7.4.4.txt[1.7.4.4],
235 link:RelNotes/1.7.4.3.txt[1.7.4.3],
236 link:RelNotes/1.7.4.2.txt[1.7.4.2],
237 link:RelNotes/1.7.4.1.txt[1.7.4.1],
238 link:RelNotes/1.7.4.txt[1.7.4].
240 * link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
243 link:RelNotes/1.7.3.5.txt[1.7.3.5],
244 link:RelNotes/1.7.3.4.txt[1.7.3.4],
245 link:RelNotes/1.7.3.3.txt[1.7.3.3],
246 link:RelNotes/1.7.3.2.txt[1.7.3.2],
247 link:RelNotes/1.7.3.1.txt[1.7.3.1],
248 link:RelNotes/1.7.3.txt[1.7.3].
250 * link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
253 link:RelNotes/1.7.2.5.txt[1.7.2.5],
254 link:RelNotes/1.7.2.4.txt[1.7.2.4],
255 link:RelNotes/1.7.2.3.txt[1.7.2.3],
256 link:RelNotes/1.7.2.2.txt[1.7.2.2],
257 link:RelNotes/1.7.2.1.txt[1.7.2.1],
258 link:RelNotes/1.7.2.txt[1.7.2].
260 * link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
263 link:RelNotes/1.7.1.4.txt[1.7.1.4],
264 link:RelNotes/1.7.1.3.txt[1.7.1.3],
265 link:RelNotes/1.7.1.2.txt[1.7.1.2],
266 link:RelNotes/1.7.1.1.txt[1.7.1.1],
267 link:RelNotes/1.7.1.txt[1.7.1].
269 * link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
272 link:RelNotes/1.7.0.9.txt[1.7.0.9],
273 link:RelNotes/1.7.0.8.txt[1.7.0.8],
274 link:RelNotes/1.7.0.7.txt[1.7.0.7],
275 link:RelNotes/1.7.0.6.txt[1.7.0.6],
276 link:RelNotes/1.7.0.5.txt[1.7.0.5],
277 link:RelNotes/1.7.0.4.txt[1.7.0.4],
278 link:RelNotes/1.7.0.3.txt[1.7.0.3],
279 link:RelNotes/1.7.0.2.txt[1.7.0.2],
280 link:RelNotes/1.7.0.1.txt[1.7.0.1],
281 link:RelNotes/1.7.0.txt[1.7.0].
283 * link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
286 link:RelNotes/1.6.6.3.txt[1.6.6.3],
287 link:RelNotes/1.6.6.2.txt[1.6.6.2],
288 link:RelNotes/1.6.6.1.txt[1.6.6.1],
289 link:RelNotes/1.6.6.txt[1.6.6].
291 * link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
294 link:RelNotes/1.6.5.9.txt[1.6.5.9],
295 link:RelNotes/1.6.5.8.txt[1.6.5.8],
296 link:RelNotes/1.6.5.7.txt[1.6.5.7],
297 link:RelNotes/1.6.5.6.txt[1.6.5.6],
298 link:RelNotes/1.6.5.5.txt[1.6.5.5],
299 link:RelNotes/1.6.5.4.txt[1.6.5.4],
300 link:RelNotes/1.6.5.3.txt[1.6.5.3],
301 link:RelNotes/1.6.5.2.txt[1.6.5.2],
302 link:RelNotes/1.6.5.1.txt[1.6.5.1],
303 link:RelNotes/1.6.5.txt[1.6.5].
305 * link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
308 link:RelNotes/1.6.4.5.txt[1.6.4.5],
309 link:RelNotes/1.6.4.4.txt[1.6.4.4],
310 link:RelNotes/1.6.4.3.txt[1.6.4.3],
311 link:RelNotes/1.6.4.2.txt[1.6.4.2],
312 link:RelNotes/1.6.4.1.txt[1.6.4.1],
313 link:RelNotes/1.6.4.txt[1.6.4].
315 * link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
318 link:RelNotes/1.6.3.4.txt[1.6.3.4],
319 link:RelNotes/1.6.3.3.txt[1.6.3.3],
320 link:RelNotes/1.6.3.2.txt[1.6.3.2],
321 link:RelNotes/1.6.3.1.txt[1.6.3.1],
322 link:RelNotes/1.6.3.txt[1.6.3].
325 link:RelNotes/1.6.2.5.txt[1.6.2.5],
326 link:RelNotes/1.6.2.4.txt[1.6.2.4],
327 link:RelNotes/1.6.2.3.txt[1.6.2.3],
328 link:RelNotes/1.6.2.2.txt[1.6.2.2],
329 link:RelNotes/1.6.2.1.txt[1.6.2.1],
330 link:RelNotes/1.6.2.txt[1.6.2].
332 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
335 link:RelNotes/1.6.1.3.txt[1.6.1.3],
336 link:RelNotes/1.6.1.2.txt[1.6.1.2],
337 link:RelNotes/1.6.1.1.txt[1.6.1.1],
338 link:RelNotes/1.6.1.txt[1.6.1].
340 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
343 link:RelNotes/1.6.0.6.txt[1.6.0.6],
344 link:RelNotes/1.6.0.5.txt[1.6.0.5],
345 link:RelNotes/1.6.0.4.txt[1.6.0.4],
346 link:RelNotes/1.6.0.3.txt[1.6.0.3],
347 link:RelNotes/1.6.0.2.txt[1.6.0.2],
348 link:RelNotes/1.6.0.1.txt[1.6.0.1],
349 link:RelNotes/1.6.0.txt[1.6.0].
351 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
354 link:RelNotes/1.5.6.6.txt[1.5.6.6],
355 link:RelNotes/1.5.6.5.txt[1.5.6.5],
356 link:RelNotes/1.5.6.4.txt[1.5.6.4],
357 link:RelNotes/1.5.6.3.txt[1.5.6.3],
358 link:RelNotes/1.5.6.2.txt[1.5.6.2],
359 link:RelNotes/1.5.6.1.txt[1.5.6.1],
360 link:RelNotes/1.5.6.txt[1.5.6].
362 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
365 link:RelNotes/1.5.5.6.txt[1.5.5.6],
366 link:RelNotes/1.5.5.5.txt[1.5.5.5],
367 link:RelNotes/1.5.5.4.txt[1.5.5.4],
368 link:RelNotes/1.5.5.3.txt[1.5.5.3],
369 link:RelNotes/1.5.5.2.txt[1.5.5.2],
370 link:RelNotes/1.5.5.1.txt[1.5.5.1],
371 link:RelNotes/1.5.5.txt[1.5.5].
373 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
376 link:RelNotes/1.5.4.7.txt[1.5.4.7],
377 link:RelNotes/1.5.4.6.txt[1.5.4.6],
378 link:RelNotes/1.5.4.5.txt[1.5.4.5],
379 link:RelNotes/1.5.4.4.txt[1.5.4.4],
380 link:RelNotes/1.5.4.3.txt[1.5.4.3],
381 link:RelNotes/1.5.4.2.txt[1.5.4.2],
382 link:RelNotes/1.5.4.1.txt[1.5.4.1],
383 link:RelNotes/1.5.4.txt[1.5.4].
385 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
388 link:RelNotes/1.5.3.8.txt[1.5.3.8],
389 link:RelNotes/1.5.3.7.txt[1.5.3.7],
390 link:RelNotes/1.5.3.6.txt[1.5.3.6],
391 link:RelNotes/1.5.3.5.txt[1.5.3.5],
392 link:RelNotes/1.5.3.4.txt[1.5.3.4],
393 link:RelNotes/1.5.3.3.txt[1.5.3.3],
394 link:RelNotes/1.5.3.2.txt[1.5.3.2],
395 link:RelNotes/1.5.3.1.txt[1.5.3.1],
396 link:RelNotes/1.5.3.txt[1.5.3].
398 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
401 link:RelNotes/1.5.2.5.txt[1.5.2.5],
402 link:RelNotes/1.5.2.4.txt[1.5.2.4],
403 link:RelNotes/1.5.2.3.txt[1.5.2.3],
404 link:RelNotes/1.5.2.2.txt[1.5.2.2],
405 link:RelNotes/1.5.2.1.txt[1.5.2.1],
406 link:RelNotes/1.5.2.txt[1.5.2].
408 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
411 link:RelNotes/1.5.1.6.txt[1.5.1.6],
412 link:RelNotes/1.5.1.5.txt[1.5.1.5],
413 link:RelNotes/1.5.1.4.txt[1.5.1.4],
414 link:RelNotes/1.5.1.3.txt[1.5.1.3],
415 link:RelNotes/1.5.1.2.txt[1.5.1.2],
416 link:RelNotes/1.5.1.1.txt[1.5.1.1],
417 link:RelNotes/1.5.1.txt[1.5.1].
419 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
422 link:RelNotes/1.5.0.7.txt[1.5.0.7],
423 link:RelNotes/1.5.0.6.txt[1.5.0.6],
424 link:RelNotes/1.5.0.5.txt[1.5.0.5],
425 link:RelNotes/1.5.0.3.txt[1.5.0.3],
426 link:RelNotes/1.5.0.2.txt[1.5.0.2],
427 link:RelNotes/1.5.0.1.txt[1.5.0.1],
428 link:RelNotes/1.5.0.txt[1.5.0].
430 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
431 link:v1.3.3/git.html[1.3.3],
432 link:v1.2.6/git.html[1.2.6],
433 link:v1.0.13/git.html[1.0.13].
442 Prints the Git suite version that the 'git' program came from.
445 Prints the synopsis and a list of the most commonly used
446 commands. If the option '--all' or '-a' is given then all
447 available commands are printed. If a Git command is named this
448 option will bring up the manual page for that command.
450 Other options are available to control how the manual page is
451 displayed. See linkgit:git-help[1] for more information,
452 because `git --help ...` is converted internally into `git
456 Run as if git was started in '<path>' instead of the current working
457 directory. When multiple `-C` options are given, each subsequent
458 non-absolute `-C <path>` is interpreted relative to the preceding `-C
461 This option affects options that expect path name like `--git-dir` and
462 `--work-tree` in that their interpretations of the path names would be
463 made relative to the working directory caused by the `-C` option. For
464 example the following invocations are equivalent:
466 git --git-dir=a.git --work-tree=b -C c status
467 git --git-dir=c/a.git --work-tree=c/b status
470 Pass a configuration parameter to the command. The value
471 given will override values from configuration files.
472 The <name> is expected in the same format as listed by
473 'git config' (subkeys separated by dots).
475 Note that omitting the `=` in `git -c foo.bar ...` is allowed and sets
476 `foo.bar` to the boolean true value (just like `[foo]bar` would in a
477 config file). Including the equals but with an empty value (like `git -c
478 foo.bar= ...`) sets `foo.bar` to the empty string.
480 --exec-path[=<path>]::
481 Path to wherever your core Git programs are installed.
482 This can also be controlled by setting the GIT_EXEC_PATH
483 environment variable. If no path is given, 'git' will print
484 the current setting and then exit.
487 Print the path, without trailing slash, where Git's HTML
488 documentation is installed and exit.
491 Print the manpath (see `man(1)`) for the man pages for
492 this version of Git and exit.
495 Print the path where the Info files documenting this
496 version of Git are installed and exit.
500 Pipe all output into 'less' (or if set, $PAGER) if standard
501 output is a terminal. This overrides the `pager.<cmd>`
502 configuration options (see the "Configuration Mechanism" section
506 Do not pipe Git output into a pager.
509 Set the path to the repository. This can also be controlled by
510 setting the GIT_DIR environment variable. It can be an absolute
511 path or relative path to current working directory.
514 Set the path to the working tree. It can be an absolute path
515 or a path relative to the current working directory.
516 This can also be controlled by setting the GIT_WORK_TREE
517 environment variable and the core.worktree configuration
518 variable (see core.worktree in linkgit:git-config[1] for a
519 more detailed discussion).
522 Set the Git namespace. See linkgit:gitnamespaces[7] for more
523 details. Equivalent to setting the `GIT_NAMESPACE` environment
527 Treat the repository as a bare repository. If GIT_DIR
528 environment is not set, it is set to the current working
531 --no-replace-objects::
532 Do not use replacement refs to replace Git objects. See
533 linkgit:git-replace[1] for more information.
535 --literal-pathspecs::
536 Treat pathspecs literally (i.e. no globbing, no pathspec magic).
537 This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
541 Add "glob" magic to all pathspec. This is equivalent to setting
542 the `GIT_GLOB_PATHSPECS` environment variable to `1`. Disabling
543 globbing on individual pathspecs can be done using pathspec
547 Add "literal" magic to all pathspec. This is equivalent to setting
548 the `GIT_NOGLOB_PATHSPECS` environment variable to `1`. Enabling
549 globbing on individual pathspecs can be done using pathspec
553 Add "icase" magic to all pathspec. This is equivalent to setting
554 the `GIT_ICASE_PATHSPECS` environment variable to `1`.
559 We divide Git into high level ("porcelain") commands and low level
560 ("plumbing") commands.
562 High-level commands (porcelain)
563 -------------------------------
565 We separate the porcelain commands into the main commands and some
566 ancillary user utilities.
568 Main porcelain commands
569 ~~~~~~~~~~~~~~~~~~~~~~~
571 include::cmds-mainporcelain.txt[]
577 include::cmds-ancillarymanipulators.txt[]
581 include::cmds-ancillaryinterrogators.txt[]
584 Interacting with Others
585 ~~~~~~~~~~~~~~~~~~~~~~~
587 These commands are to interact with foreign SCM and with other
588 people via patch over e-mail.
590 include::cmds-foreignscminterface.txt[]
593 Low-level commands (plumbing)
594 -----------------------------
596 Although Git includes its
597 own porcelain layer, its low-level commands are sufficient to support
598 development of alternative porcelains. Developers of such porcelains
599 might start by reading about linkgit:git-update-index[1] and
600 linkgit:git-read-tree[1].
602 The interface (input, output, set of options and the semantics)
603 to these low-level commands are meant to be a lot more stable
604 than Porcelain level commands, because these commands are
605 primarily for scripted use. The interface to Porcelain commands
606 on the other hand are subject to change in order to improve the
609 The following description divides
610 the low-level commands into commands that manipulate objects (in
611 the repository, index, and working tree), commands that interrogate and
612 compare objects, and commands that move objects and references between
616 Manipulation commands
617 ~~~~~~~~~~~~~~~~~~~~~
619 include::cmds-plumbingmanipulators.txt[]
622 Interrogation commands
623 ~~~~~~~~~~~~~~~~~~~~~~
625 include::cmds-plumbinginterrogators.txt[]
627 In general, the interrogate commands do not touch the files in
631 Synching repositories
632 ~~~~~~~~~~~~~~~~~~~~~
634 include::cmds-synchingrepositories.txt[]
636 The following are helper commands used by the above; end users
637 typically do not use them directly.
639 include::cmds-synchelpers.txt[]
642 Internal helper commands
643 ~~~~~~~~~~~~~~~~~~~~~~~~
645 These are internal helper commands used by other commands; end
646 users typically do not use them directly.
648 include::cmds-purehelpers.txt[]
651 Configuration Mechanism
652 -----------------------
654 Git uses a simple text format to store customizations that are per
655 repository and are per user. Such a configuration file may look
660 # A '#' or ';' character indicates a comment.
665 ; Don't trust file modes
670 name = "Junio C Hamano"
671 email = "gitster@pobox.com"
675 Various commands read from the configuration file and adjust
676 their operation accordingly. See linkgit:git-config[1] for a
677 list and more details about the configuration mechanism.
680 Identifier Terminology
681 ----------------------
683 Indicates the object name for any type of object.
686 Indicates a blob object name.
689 Indicates a tree object name.
692 Indicates a commit object name.
695 Indicates a tree, commit or tag object name. A
696 command that takes a <tree-ish> argument ultimately wants to
697 operate on a <tree> object but automatically dereferences
698 <commit> and <tag> objects that point at a <tree>.
701 Indicates a commit or tag object name. A
702 command that takes a <commit-ish> argument ultimately wants to
703 operate on a <commit> object but automatically dereferences
704 <tag> objects that point at a <commit>.
707 Indicates that an object type is required.
708 Currently one of: `blob`, `tree`, `commit`, or `tag`.
711 Indicates a filename - almost always relative to the
712 root of the tree structure `GIT_INDEX_FILE` describes.
716 Any Git command accepting any <object> can also use the following
720 indicates the head of the current branch.
724 (i.e. a `refs/tags/<tag>` reference).
728 (i.e. a `refs/heads/<head>` reference).
730 For a more complete list of ways to spell object names, see
731 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
734 File/Directory Structure
735 ------------------------
737 Please see the linkgit:gitrepository-layout[5] document.
739 Read linkgit:githooks[5] for more details about each hook.
741 Higher level SCMs may provide and manage additional information in the
747 Please see linkgit:gitglossary[7].
750 Environment Variables
751 ---------------------
752 Various Git commands use the following environment variables:
756 These environment variables apply to 'all' core Git commands. Nb: it
757 is worth noting that they may be used/overridden by SCMS sitting above
758 Git so take care if using Cogito etc.
761 This environment allows the specification of an alternate
762 index file. If not specified, the default of `$GIT_DIR/index`
765 'GIT_INDEX_VERSION'::
766 This environment variable allows the specification of an index
767 version for new repositories. It won't affect existing index
768 files. By default index file version [23] is used.
770 'GIT_OBJECT_DIRECTORY'::
771 If the object storage directory is specified via this
772 environment variable then the sha1 directories are created
773 underneath - otherwise the default `$GIT_DIR/objects`
776 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
777 Due to the immutable nature of Git objects, old objects can be
778 archived into shared, read-only directories. This variable
779 specifies a ":" separated (on Windows ";" separated) list
780 of Git object directories which can be used to search for Git
781 objects. New objects will not be written to these directories.
784 If the 'GIT_DIR' environment variable is set then it
785 specifies a path to use instead of the default `.git`
786 for the base of the repository.
787 The '--git-dir' command-line option also sets this value.
790 Set the path to the root of the working tree.
791 This can also be controlled by the '--work-tree' command-line
792 option and the core.worktree configuration variable.
795 Set the Git namespace; see linkgit:gitnamespaces[7] for details.
796 The '--namespace' command-line option also sets this value.
798 'GIT_CEILING_DIRECTORIES'::
799 This should be a colon-separated list of absolute paths. If
800 set, it is a list of directories that Git should not chdir up
801 into while looking for a repository directory (useful for
802 excluding slow-loading network directories). It will not
803 exclude the current working directory or a GIT_DIR set on the
804 command line or in the environment. Normally, Git has to read
805 the entries in this list and resolve any symlink that
806 might be present in order to compare them with the current
807 directory. However, if even this access is slow, you
808 can add an empty entry to the list to tell Git that the
809 subsequent entries are not symlinks and needn't be resolved;
811 'GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink'.
813 'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
814 When run in a directory that does not have ".git" repository
815 directory, Git tries to find such a directory in the parent
816 directories to find the top of the working tree, but by default it
817 does not cross filesystem boundaries. This environment variable
818 can be set to true to tell Git not to stop at filesystem
819 boundaries. Like 'GIT_CEILING_DIRECTORIES', this will not affect
820 an explicit repository directory set via 'GIT_DIR' or on the
828 'GIT_COMMITTER_NAME'::
829 'GIT_COMMITTER_EMAIL'::
830 'GIT_COMMITTER_DATE'::
832 see linkgit:git-commit-tree[1]
837 Only valid setting is "--unified=??" or "-u??" to set the
838 number of context lines shown when a unified diff is created.
839 This takes precedence over any "-U" or "--unified" option
840 value passed on the Git diff command line.
842 'GIT_EXTERNAL_DIFF'::
843 When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
844 program named by it is called, instead of the diff invocation
845 described above. For a path that is added, removed, or modified,
846 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
848 path old-file old-hex old-mode new-file new-hex new-mode
852 <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
853 contents of <old|new>,
854 <old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
855 <old|new>-mode:: are the octal representation of the file modes.
857 The file parameters can point at the user's working file
858 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
859 when a new file is added), or a temporary file (e.g. `old-file` in the
860 index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
861 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
863 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
866 For each path 'GIT_EXTERNAL_DIFF' is called, two environment variables,
867 'GIT_DIFF_PATH_COUNTER' and 'GIT_DIFF_PATH_TOTAL' are set.
869 'GIT_DIFF_PATH_COUNTER'::
870 A 1-based counter incremented by one for every path.
872 'GIT_DIFF_PATH_TOTAL'::
873 The total number of paths.
877 'GIT_MERGE_VERBOSITY'::
878 A number controlling the amount of output shown by
879 the recursive merge strategy. Overrides merge.verbosity.
880 See linkgit:git-merge[1]
883 This environment variable overrides `$PAGER`. If it is set
884 to an empty string or to the value "cat", Git will not launch
885 a pager. See also the `core.pager` option in
886 linkgit:git-config[1].
889 This environment variable overrides `$EDITOR` and `$VISUAL`.
890 It is used by several Git commands when, on interactive mode,
891 an editor is to be launched. See also linkgit:git-var[1]
892 and the `core.editor` option in linkgit:git-config[1].
896 If either of these environment variables is set then 'git fetch'
897 and 'git push' will use the specified command instead of 'ssh'
898 when they need to connect to a remote system.
899 The command will be given exactly two or four arguments: the
900 'username@host' (or just 'host') from the URL and the shell
901 command to execute on that remote system, optionally preceded by
902 '-p' (literally) and the 'port' from the URL when it specifies
903 something other than the default SSH port.
905 `$GIT_SSH_COMMAND` takes precedence over `$GIT_SSH`, and is interpreted
906 by the shell, which allows additional arguments to be included.
907 `$GIT_SSH` on the other hand must be just the path to a program
908 (which can be a wrapper shell script, if additional arguments are
911 Usually it is easier to configure any desired options through your
912 personal `.ssh/config` file. Please consult your ssh documentation
916 If this environment variable is set, then Git commands which need to
917 acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
918 will call this program with a suitable prompt as command-line argument
919 and read the password from its STDOUT. See also the 'core.askpass'
920 option in linkgit:git-config[1].
922 'GIT_TERMINAL_PROMPT'::
923 If this environment variable is set to `0`, git will not prompt
924 on the terminal (e.g., when asking for HTTP authentication).
926 'GIT_CONFIG_NOSYSTEM'::
927 Whether to skip reading settings from the system-wide
928 `$(prefix)/etc/gitconfig` file. This environment variable can
929 be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
930 predictable environment for a picky script, or you can set it
931 temporarily to avoid using a buggy `/etc/gitconfig` file while
932 waiting for someone with sufficient permissions to fix it.
935 If this environment variable is set to "1", then commands such
936 as 'git blame' (in incremental mode), 'git rev-list', 'git log',
937 'git check-attr' and 'git check-ignore' will
938 force a flush of the output stream after each record have been
940 variable is set to "0", the output of these commands will be done
941 using completely buffered I/O. If this environment variable is
942 not set, Git will choose buffered or record-oriented flushing
943 based on whether stdout appears to be redirected to a file or not.
946 Enables general trace messages, e.g. alias expansion, built-in
947 command execution and external command execution.
949 If this variable is set to "1", "2" or "true" (comparison
950 is case insensitive), trace messages will be printed to
953 If the variable is set to an integer value greater than 2
954 and lower than 10 (strictly) then Git will interpret this
955 value as an open file descriptor and will try to write the
956 trace messages into this file descriptor.
958 Alternatively, if the variable is set to an absolute path
959 (starting with a '/' character), Git will interpret this
960 as a file path and will try to write the trace messages
963 Unsetting the variable, or setting it to empty, "0" or
964 "false" (case insensitive) disables trace messages.
966 'GIT_TRACE_PACK_ACCESS'::
967 Enables trace messages for all accesses to any packs. For each
968 access, the pack file name and an offset in the pack is
969 recorded. This may be helpful for troubleshooting some
970 pack-related performance problems.
971 See 'GIT_TRACE' for available trace output options.
974 Enables trace messages for all packets coming in or out of a
975 given program. This can help with debugging object negotiation
976 or other protocol issues. Tracing is turned off at a packet
977 starting with "PACK".
978 See 'GIT_TRACE' for available trace output options.
980 'GIT_TRACE_PERFORMANCE'::
981 Enables performance related trace messages, e.g. total execution
982 time of each Git command.
983 See 'GIT_TRACE' for available trace output options.
986 Enables trace messages printing the .git, working tree and current
987 working directory after Git has completed its setup phase.
988 See 'GIT_TRACE' for available trace output options.
990 'GIT_TRACE_SHALLOW'::
991 Enables trace messages that can help debugging fetching /
992 cloning of shallow repositories.
993 See 'GIT_TRACE' for available trace output options.
995 GIT_LITERAL_PATHSPECS::
996 Setting this variable to `1` will cause Git to treat all
997 pathspecs literally, rather than as glob patterns. For example,
998 running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
999 for commits that touch the path `*.c`, not any paths that the
1000 glob `*.c` matches. You might want this if you are feeding
1001 literal paths to Git (e.g., paths previously given to you by
1002 `git ls-tree`, `--raw` diff output, etc).
1004 GIT_GLOB_PATHSPECS::
1005 Setting this variable to `1` will cause Git to treat all
1006 pathspecs as glob patterns (aka "glob" magic).
1008 GIT_NOGLOB_PATHSPECS::
1009 Setting this variable to `1` will cause Git to treat all
1010 pathspecs as literal (aka "literal" magic).
1012 GIT_ICASE_PATHSPECS::
1013 Setting this variable to `1` will cause Git to treat all
1014 pathspecs as case-insensitive.
1016 'GIT_REFLOG_ACTION'::
1017 When a ref is updated, reflog entries are created to keep
1018 track of the reason why the ref was updated (which is
1019 typically the name of the high-level command that updated
1020 the ref), in addition to the old and new values of the ref.
1021 A scripted Porcelain command can use set_reflog_action
1022 helper function in `git-sh-setup` to set its name to this
1023 variable when it is invoked as the top level command by the
1024 end user, to be recorded in the body of the reflog.
1027 Discussion[[Discussion]]
1028 ------------------------
1030 More detail on the following is available from the
1031 link:user-manual.html#git-concepts[Git concepts chapter of the
1032 user-manual] and linkgit:gitcore-tutorial[7].
1034 A Git project normally consists of a working directory with a ".git"
1035 subdirectory at the top level. The .git directory contains, among other
1036 things, a compressed object database representing the complete history
1037 of the project, an "index" file which links that history to the current
1038 contents of the working tree, and named pointers into that history such
1039 as tags and branch heads.
1041 The object database contains objects of three main types: blobs, which
1042 hold file data; trees, which point to blobs and other trees to build up
1043 directory hierarchies; and commits, which each reference a single tree
1044 and some number of parent commits.
1046 The commit, equivalent to what other systems call a "changeset" or
1047 "version", represents a step in the project's history, and each parent
1048 represents an immediately preceding step. Commits with more than one
1049 parent represent merges of independent lines of development.
1051 All objects are named by the SHA-1 hash of their contents, normally
1052 written as a string of 40 hex digits. Such names are globally unique.
1053 The entire history leading up to a commit can be vouched for by signing
1054 just that commit. A fourth object type, the tag, is provided for this
1057 When first created, objects are stored in individual files, but for
1058 efficiency may later be compressed together into "pack files".
1060 Named pointers called refs mark interesting points in history. A ref
1061 may contain the SHA-1 name of an object or the name of another ref. Refs
1062 with names beginning `ref/head/` contain the SHA-1 name of the most
1063 recent commit (or "head") of a branch under development. SHA-1 names of
1064 tags of interest are stored under `ref/tags/`. A special ref named
1065 `HEAD` contains the name of the currently checked-out branch.
1067 The index file is initialized with a list of all paths and, for each
1068 path, a blob object and a set of attributes. The blob object represents
1069 the contents of the file as of the head of the current branch. The
1070 attributes (last modified time, size, etc.) are taken from the
1071 corresponding file in the working tree. Subsequent changes to the
1072 working tree can be found by comparing these attributes. The index may
1073 be updated with new content, and new commits may be created from the
1074 content stored in the index.
1076 The index is also capable of storing multiple entries (called "stages")
1077 for a given pathname. These stages are used to hold the various
1078 unmerged version of a file when a merge is in progress.
1080 FURTHER DOCUMENTATION
1081 ---------------------
1083 See the references in the "description" section to get started
1084 using Git. The following is probably more detail than necessary
1085 for a first-time user.
1087 The link:user-manual.html#git-concepts[Git concepts chapter of the
1088 user-manual] and linkgit:gitcore-tutorial[7] both provide
1089 introductions to the underlying Git architecture.
1091 See linkgit:gitworkflows[7] for an overview of recommended workflows.
1093 See also the link:howto-index.html[howto] documents for some useful
1096 The internals are documented in the
1097 link:technical/api-index.html[Git API documentation].
1099 Users migrating from CVS may also want to
1100 read linkgit:gitcvs-migration[7].
1105 Git was started by Linus Torvalds, and is currently maintained by Junio
1106 C Hamano. Numerous contributions have come from the Git mailing list
1107 <git@vger.kernel.org>. http://www.openhub.net/p/git/contributors/summary
1108 gives you a more complete list of contributors.
1110 If you have a clone of git.git itself, the
1111 output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
1112 the authors for specific parts of the project.
1117 Report bugs to the Git mailing list <git@vger.kernel.org> where the
1118 development and maintenance is primarily done. You do not have to be
1119 subscribed to the list to send a message there.
1123 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
1124 linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
1125 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
1126 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
1127 linkgit:gitworkflows[7]
1131 Part of the linkgit:git[1] suite