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.2.1/git.html[documentation for release 2.2.1]
49 link:RelNotes/2.2.1.txt[2.2.1],
50 link:RelNotes/2.2.0.txt[2.2].
52 * link:v2.1.4/git.html[documentation for release 2.1.4]
55 link:RelNotes/2.1.4.txt[2.1.4],
56 link:RelNotes/2.1.3.txt[2.1.3],
57 link:RelNotes/2.1.2.txt[2.1.2],
58 link:RelNotes/2.1.1.txt[2.1.1],
59 link:RelNotes/2.1.0.txt[2.1].
61 * link:v2.0.5/git.html[documentation for release 2.0.5]
64 link:RelNotes/2.0.5.txt[2.0.5],
65 link:RelNotes/2.0.4.txt[2.0.4],
66 link:RelNotes/2.0.3.txt[2.0.3],
67 link:RelNotes/2.0.2.txt[2.0.2],
68 link:RelNotes/2.0.1.txt[2.0.1],
69 link:RelNotes/2.0.0.txt[2.0.0].
71 * link:v1.9.5/git.html[documentation for release 1.9.5]
74 link:RelNotes/1.9.5.txt[1.9.5],
75 link:RelNotes/1.9.4.txt[1.9.4],
76 link:RelNotes/1.9.3.txt[1.9.3],
77 link:RelNotes/1.9.2.txt[1.9.2],
78 link:RelNotes/1.9.1.txt[1.9.1],
79 link:RelNotes/1.9.0.txt[1.9.0].
81 * link:v1.8.5.6/git.html[documentation for release 1.8.5.6]
84 link:RelNotes/1.8.5.6.txt[1.8.5.6],
85 link:RelNotes/1.8.5.5.txt[1.8.5.5],
86 link:RelNotes/1.8.5.4.txt[1.8.5.4],
87 link:RelNotes/1.8.5.3.txt[1.8.5.3],
88 link:RelNotes/1.8.5.2.txt[1.8.5.2],
89 link:RelNotes/1.8.5.1.txt[1.8.5.1],
90 link:RelNotes/1.8.5.txt[1.8.5].
92 * link:v1.8.4.5/git.html[documentation for release 1.8.4.5]
95 link:RelNotes/1.8.4.5.txt[1.8.4.5],
96 link:RelNotes/1.8.4.4.txt[1.8.4.4],
97 link:RelNotes/1.8.4.3.txt[1.8.4.3],
98 link:RelNotes/1.8.4.2.txt[1.8.4.2],
99 link:RelNotes/1.8.4.1.txt[1.8.4.1],
100 link:RelNotes/1.8.4.txt[1.8.4].
102 * link:v1.8.3.4/git.html[documentation for release 1.8.3.4]
105 link:RelNotes/1.8.3.4.txt[1.8.3.4],
106 link:RelNotes/1.8.3.3.txt[1.8.3.3],
107 link:RelNotes/1.8.3.2.txt[1.8.3.2],
108 link:RelNotes/1.8.3.1.txt[1.8.3.1],
109 link:RelNotes/1.8.3.txt[1.8.3].
111 * link:v1.8.2.3/git.html[documentation for release 1.8.2.3]
114 link:RelNotes/1.8.2.3.txt[1.8.2.3],
115 link:RelNotes/1.8.2.2.txt[1.8.2.2],
116 link:RelNotes/1.8.2.1.txt[1.8.2.1],
117 link:RelNotes/1.8.2.txt[1.8.2].
119 * link:v1.8.1.6/git.html[documentation for release 1.8.1.6]
122 link:RelNotes/1.8.1.6.txt[1.8.1.6],
123 link:RelNotes/1.8.1.5.txt[1.8.1.5],
124 link:RelNotes/1.8.1.4.txt[1.8.1.4],
125 link:RelNotes/1.8.1.3.txt[1.8.1.3],
126 link:RelNotes/1.8.1.2.txt[1.8.1.2],
127 link:RelNotes/1.8.1.1.txt[1.8.1.1],
128 link:RelNotes/1.8.1.txt[1.8.1].
130 * link:v1.8.0.3/git.html[documentation for release 1.8.0.3]
133 link:RelNotes/1.8.0.3.txt[1.8.0.3],
134 link:RelNotes/1.8.0.2.txt[1.8.0.2],
135 link:RelNotes/1.8.0.1.txt[1.8.0.1],
136 link:RelNotes/1.8.0.txt[1.8.0].
138 * link:v1.7.12.4/git.html[documentation for release 1.7.12.4]
141 link:RelNotes/1.7.12.4.txt[1.7.12.4],
142 link:RelNotes/1.7.12.3.txt[1.7.12.3],
143 link:RelNotes/1.7.12.2.txt[1.7.12.2],
144 link:RelNotes/1.7.12.1.txt[1.7.12.1],
145 link:RelNotes/1.7.12.txt[1.7.12].
147 * link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
150 link:RelNotes/1.7.11.7.txt[1.7.11.7],
151 link:RelNotes/1.7.11.6.txt[1.7.11.6],
152 link:RelNotes/1.7.11.5.txt[1.7.11.5],
153 link:RelNotes/1.7.11.4.txt[1.7.11.4],
154 link:RelNotes/1.7.11.3.txt[1.7.11.3],
155 link:RelNotes/1.7.11.2.txt[1.7.11.2],
156 link:RelNotes/1.7.11.1.txt[1.7.11.1],
157 link:RelNotes/1.7.11.txt[1.7.11].
159 * link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
162 link:RelNotes/1.7.10.5.txt[1.7.10.5],
163 link:RelNotes/1.7.10.4.txt[1.7.10.4],
164 link:RelNotes/1.7.10.3.txt[1.7.10.3],
165 link:RelNotes/1.7.10.2.txt[1.7.10.2],
166 link:RelNotes/1.7.10.1.txt[1.7.10.1],
167 link:RelNotes/1.7.10.txt[1.7.10].
169 * link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
172 link:RelNotes/1.7.9.7.txt[1.7.9.7],
173 link:RelNotes/1.7.9.6.txt[1.7.9.6],
174 link:RelNotes/1.7.9.5.txt[1.7.9.5],
175 link:RelNotes/1.7.9.4.txt[1.7.9.4],
176 link:RelNotes/1.7.9.3.txt[1.7.9.3],
177 link:RelNotes/1.7.9.2.txt[1.7.9.2],
178 link:RelNotes/1.7.9.1.txt[1.7.9.1],
179 link:RelNotes/1.7.9.txt[1.7.9].
181 * link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
184 link:RelNotes/1.7.8.6.txt[1.7.8.6],
185 link:RelNotes/1.7.8.5.txt[1.7.8.5],
186 link:RelNotes/1.7.8.4.txt[1.7.8.4],
187 link:RelNotes/1.7.8.3.txt[1.7.8.3],
188 link:RelNotes/1.7.8.2.txt[1.7.8.2],
189 link:RelNotes/1.7.8.1.txt[1.7.8.1],
190 link:RelNotes/1.7.8.txt[1.7.8].
192 * link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
195 link:RelNotes/1.7.7.7.txt[1.7.7.7],
196 link:RelNotes/1.7.7.6.txt[1.7.7.6],
197 link:RelNotes/1.7.7.5.txt[1.7.7.5],
198 link:RelNotes/1.7.7.4.txt[1.7.7.4],
199 link:RelNotes/1.7.7.3.txt[1.7.7.3],
200 link:RelNotes/1.7.7.2.txt[1.7.7.2],
201 link:RelNotes/1.7.7.1.txt[1.7.7.1],
202 link:RelNotes/1.7.7.txt[1.7.7].
204 * link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
207 link:RelNotes/1.7.6.6.txt[1.7.6.6],
208 link:RelNotes/1.7.6.5.txt[1.7.6.5],
209 link:RelNotes/1.7.6.4.txt[1.7.6.4],
210 link:RelNotes/1.7.6.3.txt[1.7.6.3],
211 link:RelNotes/1.7.6.2.txt[1.7.6.2],
212 link:RelNotes/1.7.6.1.txt[1.7.6.1],
213 link:RelNotes/1.7.6.txt[1.7.6].
215 * link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
218 link:RelNotes/1.7.5.4.txt[1.7.5.4],
219 link:RelNotes/1.7.5.3.txt[1.7.5.3],
220 link:RelNotes/1.7.5.2.txt[1.7.5.2],
221 link:RelNotes/1.7.5.1.txt[1.7.5.1],
222 link:RelNotes/1.7.5.txt[1.7.5].
224 * link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
227 link:RelNotes/1.7.4.5.txt[1.7.4.5],
228 link:RelNotes/1.7.4.4.txt[1.7.4.4],
229 link:RelNotes/1.7.4.3.txt[1.7.4.3],
230 link:RelNotes/1.7.4.2.txt[1.7.4.2],
231 link:RelNotes/1.7.4.1.txt[1.7.4.1],
232 link:RelNotes/1.7.4.txt[1.7.4].
234 * link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
237 link:RelNotes/1.7.3.5.txt[1.7.3.5],
238 link:RelNotes/1.7.3.4.txt[1.7.3.4],
239 link:RelNotes/1.7.3.3.txt[1.7.3.3],
240 link:RelNotes/1.7.3.2.txt[1.7.3.2],
241 link:RelNotes/1.7.3.1.txt[1.7.3.1],
242 link:RelNotes/1.7.3.txt[1.7.3].
244 * link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
247 link:RelNotes/1.7.2.5.txt[1.7.2.5],
248 link:RelNotes/1.7.2.4.txt[1.7.2.4],
249 link:RelNotes/1.7.2.3.txt[1.7.2.3],
250 link:RelNotes/1.7.2.2.txt[1.7.2.2],
251 link:RelNotes/1.7.2.1.txt[1.7.2.1],
252 link:RelNotes/1.7.2.txt[1.7.2].
254 * link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
257 link:RelNotes/1.7.1.4.txt[1.7.1.4],
258 link:RelNotes/1.7.1.3.txt[1.7.1.3],
259 link:RelNotes/1.7.1.2.txt[1.7.1.2],
260 link:RelNotes/1.7.1.1.txt[1.7.1.1],
261 link:RelNotes/1.7.1.txt[1.7.1].
263 * link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
266 link:RelNotes/1.7.0.9.txt[1.7.0.9],
267 link:RelNotes/1.7.0.8.txt[1.7.0.8],
268 link:RelNotes/1.7.0.7.txt[1.7.0.7],
269 link:RelNotes/1.7.0.6.txt[1.7.0.6],
270 link:RelNotes/1.7.0.5.txt[1.7.0.5],
271 link:RelNotes/1.7.0.4.txt[1.7.0.4],
272 link:RelNotes/1.7.0.3.txt[1.7.0.3],
273 link:RelNotes/1.7.0.2.txt[1.7.0.2],
274 link:RelNotes/1.7.0.1.txt[1.7.0.1],
275 link:RelNotes/1.7.0.txt[1.7.0].
277 * link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
280 link:RelNotes/1.6.6.3.txt[1.6.6.3],
281 link:RelNotes/1.6.6.2.txt[1.6.6.2],
282 link:RelNotes/1.6.6.1.txt[1.6.6.1],
283 link:RelNotes/1.6.6.txt[1.6.6].
285 * link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
288 link:RelNotes/1.6.5.9.txt[1.6.5.9],
289 link:RelNotes/1.6.5.8.txt[1.6.5.8],
290 link:RelNotes/1.6.5.7.txt[1.6.5.7],
291 link:RelNotes/1.6.5.6.txt[1.6.5.6],
292 link:RelNotes/1.6.5.5.txt[1.6.5.5],
293 link:RelNotes/1.6.5.4.txt[1.6.5.4],
294 link:RelNotes/1.6.5.3.txt[1.6.5.3],
295 link:RelNotes/1.6.5.2.txt[1.6.5.2],
296 link:RelNotes/1.6.5.1.txt[1.6.5.1],
297 link:RelNotes/1.6.5.txt[1.6.5].
299 * link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
302 link:RelNotes/1.6.4.5.txt[1.6.4.5],
303 link:RelNotes/1.6.4.4.txt[1.6.4.4],
304 link:RelNotes/1.6.4.3.txt[1.6.4.3],
305 link:RelNotes/1.6.4.2.txt[1.6.4.2],
306 link:RelNotes/1.6.4.1.txt[1.6.4.1],
307 link:RelNotes/1.6.4.txt[1.6.4].
309 * link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
312 link:RelNotes/1.6.3.4.txt[1.6.3.4],
313 link:RelNotes/1.6.3.3.txt[1.6.3.3],
314 link:RelNotes/1.6.3.2.txt[1.6.3.2],
315 link:RelNotes/1.6.3.1.txt[1.6.3.1],
316 link:RelNotes/1.6.3.txt[1.6.3].
319 link:RelNotes/1.6.2.5.txt[1.6.2.5],
320 link:RelNotes/1.6.2.4.txt[1.6.2.4],
321 link:RelNotes/1.6.2.3.txt[1.6.2.3],
322 link:RelNotes/1.6.2.2.txt[1.6.2.2],
323 link:RelNotes/1.6.2.1.txt[1.6.2.1],
324 link:RelNotes/1.6.2.txt[1.6.2].
326 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
329 link:RelNotes/1.6.1.3.txt[1.6.1.3],
330 link:RelNotes/1.6.1.2.txt[1.6.1.2],
331 link:RelNotes/1.6.1.1.txt[1.6.1.1],
332 link:RelNotes/1.6.1.txt[1.6.1].
334 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
337 link:RelNotes/1.6.0.6.txt[1.6.0.6],
338 link:RelNotes/1.6.0.5.txt[1.6.0.5],
339 link:RelNotes/1.6.0.4.txt[1.6.0.4],
340 link:RelNotes/1.6.0.3.txt[1.6.0.3],
341 link:RelNotes/1.6.0.2.txt[1.6.0.2],
342 link:RelNotes/1.6.0.1.txt[1.6.0.1],
343 link:RelNotes/1.6.0.txt[1.6.0].
345 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
348 link:RelNotes/1.5.6.6.txt[1.5.6.6],
349 link:RelNotes/1.5.6.5.txt[1.5.6.5],
350 link:RelNotes/1.5.6.4.txt[1.5.6.4],
351 link:RelNotes/1.5.6.3.txt[1.5.6.3],
352 link:RelNotes/1.5.6.2.txt[1.5.6.2],
353 link:RelNotes/1.5.6.1.txt[1.5.6.1],
354 link:RelNotes/1.5.6.txt[1.5.6].
356 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
359 link:RelNotes/1.5.5.6.txt[1.5.5.6],
360 link:RelNotes/1.5.5.5.txt[1.5.5.5],
361 link:RelNotes/1.5.5.4.txt[1.5.5.4],
362 link:RelNotes/1.5.5.3.txt[1.5.5.3],
363 link:RelNotes/1.5.5.2.txt[1.5.5.2],
364 link:RelNotes/1.5.5.1.txt[1.5.5.1],
365 link:RelNotes/1.5.5.txt[1.5.5].
367 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
370 link:RelNotes/1.5.4.7.txt[1.5.4.7],
371 link:RelNotes/1.5.4.6.txt[1.5.4.6],
372 link:RelNotes/1.5.4.5.txt[1.5.4.5],
373 link:RelNotes/1.5.4.4.txt[1.5.4.4],
374 link:RelNotes/1.5.4.3.txt[1.5.4.3],
375 link:RelNotes/1.5.4.2.txt[1.5.4.2],
376 link:RelNotes/1.5.4.1.txt[1.5.4.1],
377 link:RelNotes/1.5.4.txt[1.5.4].
379 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
382 link:RelNotes/1.5.3.8.txt[1.5.3.8],
383 link:RelNotes/1.5.3.7.txt[1.5.3.7],
384 link:RelNotes/1.5.3.6.txt[1.5.3.6],
385 link:RelNotes/1.5.3.5.txt[1.5.3.5],
386 link:RelNotes/1.5.3.4.txt[1.5.3.4],
387 link:RelNotes/1.5.3.3.txt[1.5.3.3],
388 link:RelNotes/1.5.3.2.txt[1.5.3.2],
389 link:RelNotes/1.5.3.1.txt[1.5.3.1],
390 link:RelNotes/1.5.3.txt[1.5.3].
392 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
395 link:RelNotes/1.5.2.5.txt[1.5.2.5],
396 link:RelNotes/1.5.2.4.txt[1.5.2.4],
397 link:RelNotes/1.5.2.3.txt[1.5.2.3],
398 link:RelNotes/1.5.2.2.txt[1.5.2.2],
399 link:RelNotes/1.5.2.1.txt[1.5.2.1],
400 link:RelNotes/1.5.2.txt[1.5.2].
402 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
405 link:RelNotes/1.5.1.6.txt[1.5.1.6],
406 link:RelNotes/1.5.1.5.txt[1.5.1.5],
407 link:RelNotes/1.5.1.4.txt[1.5.1.4],
408 link:RelNotes/1.5.1.3.txt[1.5.1.3],
409 link:RelNotes/1.5.1.2.txt[1.5.1.2],
410 link:RelNotes/1.5.1.1.txt[1.5.1.1],
411 link:RelNotes/1.5.1.txt[1.5.1].
413 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
416 link:RelNotes/1.5.0.7.txt[1.5.0.7],
417 link:RelNotes/1.5.0.6.txt[1.5.0.6],
418 link:RelNotes/1.5.0.5.txt[1.5.0.5],
419 link:RelNotes/1.5.0.3.txt[1.5.0.3],
420 link:RelNotes/1.5.0.2.txt[1.5.0.2],
421 link:RelNotes/1.5.0.1.txt[1.5.0.1],
422 link:RelNotes/1.5.0.txt[1.5.0].
424 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
425 link:v1.3.3/git.html[1.3.3],
426 link:v1.2.6/git.html[1.2.6],
427 link:v1.0.13/git.html[1.0.13].
436 Prints the Git suite version that the 'git' program came from.
439 Prints the synopsis and a list of the most commonly used
440 commands. If the option '--all' or '-a' is given then all
441 available commands are printed. If a Git command is named this
442 option will bring up the manual page for that command.
444 Other options are available to control how the manual page is
445 displayed. See linkgit:git-help[1] for more information,
446 because `git --help ...` is converted internally into `git
450 Run as if git was started in '<path>' instead of the current working
451 directory. When multiple `-C` options are given, each subsequent
452 non-absolute `-C <path>` is interpreted relative to the preceding `-C
455 This option affects options that expect path name like `--git-dir` and
456 `--work-tree` in that their interpretations of the path names would be
457 made relative to the working directory caused by the `-C` option. For
458 example the following invocations are equivalent:
460 git --git-dir=a.git --work-tree=b -C c status
461 git --git-dir=c/a.git --work-tree=c/b status
464 Pass a configuration parameter to the command. The value
465 given will override values from configuration files.
466 The <name> is expected in the same format as listed by
467 'git config' (subkeys separated by dots).
469 Note that omitting the `=` in `git -c foo.bar ...` is allowed and sets
470 `foo.bar` to the boolean true value (just like `[foo]bar` would in a
471 config file). Including the equals but with an empty value (like `git -c
472 foo.bar= ...`) sets `foo.bar` to the empty string.
474 --exec-path[=<path>]::
475 Path to wherever your core Git programs are installed.
476 This can also be controlled by setting the GIT_EXEC_PATH
477 environment variable. If no path is given, 'git' will print
478 the current setting and then exit.
481 Print the path, without trailing slash, where Git's HTML
482 documentation is installed and exit.
485 Print the manpath (see `man(1)`) for the man pages for
486 this version of Git and exit.
489 Print the path where the Info files documenting this
490 version of Git are installed and exit.
494 Pipe all output into 'less' (or if set, $PAGER) if standard
495 output is a terminal. This overrides the `pager.<cmd>`
496 configuration options (see the "Configuration Mechanism" section
500 Do not pipe Git output into a pager.
503 Set the path to the repository. This can also be controlled by
504 setting the GIT_DIR environment variable. It can be an absolute
505 path or relative path to current working directory.
508 Set the path to the working tree. It can be an absolute path
509 or a path relative to the current working directory.
510 This can also be controlled by setting the GIT_WORK_TREE
511 environment variable and the core.worktree configuration
512 variable (see core.worktree in linkgit:git-config[1] for a
513 more detailed discussion).
516 Set the Git namespace. See linkgit:gitnamespaces[7] for more
517 details. Equivalent to setting the `GIT_NAMESPACE` environment
521 Treat the repository as a bare repository. If GIT_DIR
522 environment is not set, it is set to the current working
525 --no-replace-objects::
526 Do not use replacement refs to replace Git objects. See
527 linkgit:git-replace[1] for more information.
529 --literal-pathspecs::
530 Treat pathspecs literally (i.e. no globbing, no pathspec magic).
531 This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
535 Add "glob" magic to all pathspec. This is equivalent to setting
536 the `GIT_GLOB_PATHSPECS` environment variable to `1`. Disabling
537 globbing on individual pathspecs can be done using pathspec
541 Add "literal" magic to all pathspec. This is equivalent to setting
542 the `GIT_NOGLOB_PATHSPECS` environment variable to `1`. Enabling
543 globbing on individual pathspecs can be done using pathspec
547 Add "icase" magic to all pathspec. This is equivalent to setting
548 the `GIT_ICASE_PATHSPECS` environment variable to `1`.
553 We divide Git into high level ("porcelain") commands and low level
554 ("plumbing") commands.
556 High-level commands (porcelain)
557 -------------------------------
559 We separate the porcelain commands into the main commands and some
560 ancillary user utilities.
562 Main porcelain commands
563 ~~~~~~~~~~~~~~~~~~~~~~~
565 include::cmds-mainporcelain.txt[]
571 include::cmds-ancillarymanipulators.txt[]
575 include::cmds-ancillaryinterrogators.txt[]
578 Interacting with Others
579 ~~~~~~~~~~~~~~~~~~~~~~~
581 These commands are to interact with foreign SCM and with other
582 people via patch over e-mail.
584 include::cmds-foreignscminterface.txt[]
587 Low-level commands (plumbing)
588 -----------------------------
590 Although Git includes its
591 own porcelain layer, its low-level commands are sufficient to support
592 development of alternative porcelains. Developers of such porcelains
593 might start by reading about linkgit:git-update-index[1] and
594 linkgit:git-read-tree[1].
596 The interface (input, output, set of options and the semantics)
597 to these low-level commands are meant to be a lot more stable
598 than Porcelain level commands, because these commands are
599 primarily for scripted use. The interface to Porcelain commands
600 on the other hand are subject to change in order to improve the
603 The following description divides
604 the low-level commands into commands that manipulate objects (in
605 the repository, index, and working tree), commands that interrogate and
606 compare objects, and commands that move objects and references between
610 Manipulation commands
611 ~~~~~~~~~~~~~~~~~~~~~
613 include::cmds-plumbingmanipulators.txt[]
616 Interrogation commands
617 ~~~~~~~~~~~~~~~~~~~~~~
619 include::cmds-plumbinginterrogators.txt[]
621 In general, the interrogate commands do not touch the files in
625 Synching repositories
626 ~~~~~~~~~~~~~~~~~~~~~
628 include::cmds-synchingrepositories.txt[]
630 The following are helper commands used by the above; end users
631 typically do not use them directly.
633 include::cmds-synchelpers.txt[]
636 Internal helper commands
637 ~~~~~~~~~~~~~~~~~~~~~~~~
639 These are internal helper commands used by other commands; end
640 users typically do not use them directly.
642 include::cmds-purehelpers.txt[]
645 Configuration Mechanism
646 -----------------------
648 Git uses a simple text format to store customizations that are per
649 repository and are per user. Such a configuration file may look
654 # A '#' or ';' character indicates a comment.
659 ; Don't trust file modes
664 name = "Junio C Hamano"
665 email = "gitster@pobox.com"
669 Various commands read from the configuration file and adjust
670 their operation accordingly. See linkgit:git-config[1] for a
671 list and more details about the configuration mechanism.
674 Identifier Terminology
675 ----------------------
677 Indicates the object name for any type of object.
680 Indicates a blob object name.
683 Indicates a tree object name.
686 Indicates a commit object name.
689 Indicates a tree, commit or tag object name. A
690 command that takes a <tree-ish> argument ultimately wants to
691 operate on a <tree> object but automatically dereferences
692 <commit> and <tag> objects that point at a <tree>.
695 Indicates a commit or tag object name. A
696 command that takes a <commit-ish> argument ultimately wants to
697 operate on a <commit> object but automatically dereferences
698 <tag> objects that point at a <commit>.
701 Indicates that an object type is required.
702 Currently one of: `blob`, `tree`, `commit`, or `tag`.
705 Indicates a filename - almost always relative to the
706 root of the tree structure `GIT_INDEX_FILE` describes.
710 Any Git command accepting any <object> can also use the following
714 indicates the head of the current branch.
718 (i.e. a `refs/tags/<tag>` reference).
722 (i.e. a `refs/heads/<head>` reference).
724 For a more complete list of ways to spell object names, see
725 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
728 File/Directory Structure
729 ------------------------
731 Please see the linkgit:gitrepository-layout[5] document.
733 Read linkgit:githooks[5] for more details about each hook.
735 Higher level SCMs may provide and manage additional information in the
741 Please see linkgit:gitglossary[7].
744 Environment Variables
745 ---------------------
746 Various Git commands use the following environment variables:
750 These environment variables apply to 'all' core Git commands. Nb: it
751 is worth noting that they may be used/overridden by SCMS sitting above
752 Git so take care if using Cogito etc.
755 This environment allows the specification of an alternate
756 index file. If not specified, the default of `$GIT_DIR/index`
759 'GIT_INDEX_VERSION'::
760 This environment variable allows the specification of an index
761 version for new repositories. It won't affect existing index
762 files. By default index file version [23] is used.
764 'GIT_OBJECT_DIRECTORY'::
765 If the object storage directory is specified via this
766 environment variable then the sha1 directories are created
767 underneath - otherwise the default `$GIT_DIR/objects`
770 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
771 Due to the immutable nature of Git objects, old objects can be
772 archived into shared, read-only directories. This variable
773 specifies a ":" separated (on Windows ";" separated) list
774 of Git object directories which can be used to search for Git
775 objects. New objects will not be written to these directories.
778 If the 'GIT_DIR' environment variable is set then it
779 specifies a path to use instead of the default `.git`
780 for the base of the repository.
781 The '--git-dir' command-line option also sets this value.
784 Set the path to the root of the working tree.
785 This can also be controlled by the '--work-tree' command-line
786 option and the core.worktree configuration variable.
789 Set the Git namespace; see linkgit:gitnamespaces[7] for details.
790 The '--namespace' command-line option also sets this value.
792 'GIT_CEILING_DIRECTORIES'::
793 This should be a colon-separated list of absolute paths. If
794 set, it is a list of directories that Git should not chdir up
795 into while looking for a repository directory (useful for
796 excluding slow-loading network directories). It will not
797 exclude the current working directory or a GIT_DIR set on the
798 command line or in the environment. Normally, Git has to read
799 the entries in this list and resolve any symlink that
800 might be present in order to compare them with the current
801 directory. However, if even this access is slow, you
802 can add an empty entry to the list to tell Git that the
803 subsequent entries are not symlinks and needn't be resolved;
805 'GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink'.
807 'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
808 When run in a directory that does not have ".git" repository
809 directory, Git tries to find such a directory in the parent
810 directories to find the top of the working tree, but by default it
811 does not cross filesystem boundaries. This environment variable
812 can be set to true to tell Git not to stop at filesystem
813 boundaries. Like 'GIT_CEILING_DIRECTORIES', this will not affect
814 an explicit repository directory set via 'GIT_DIR' or on the
822 'GIT_COMMITTER_NAME'::
823 'GIT_COMMITTER_EMAIL'::
824 'GIT_COMMITTER_DATE'::
826 see linkgit:git-commit-tree[1]
831 Only valid setting is "--unified=??" or "-u??" to set the
832 number of context lines shown when a unified diff is created.
833 This takes precedence over any "-U" or "--unified" option
834 value passed on the Git diff command line.
836 'GIT_EXTERNAL_DIFF'::
837 When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
838 program named by it is called, instead of the diff invocation
839 described above. For a path that is added, removed, or modified,
840 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
842 path old-file old-hex old-mode new-file new-hex new-mode
846 <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
847 contents of <old|new>,
848 <old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
849 <old|new>-mode:: are the octal representation of the file modes.
851 The file parameters can point at the user's working file
852 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
853 when a new file is added), or a temporary file (e.g. `old-file` in the
854 index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
855 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
857 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
860 For each path 'GIT_EXTERNAL_DIFF' is called, two environment variables,
861 'GIT_DIFF_PATH_COUNTER' and 'GIT_DIFF_PATH_TOTAL' are set.
863 'GIT_DIFF_PATH_COUNTER'::
864 A 1-based counter incremented by one for every path.
866 'GIT_DIFF_PATH_TOTAL'::
867 The total number of paths.
871 'GIT_MERGE_VERBOSITY'::
872 A number controlling the amount of output shown by
873 the recursive merge strategy. Overrides merge.verbosity.
874 See linkgit:git-merge[1]
877 This environment variable overrides `$PAGER`. If it is set
878 to an empty string or to the value "cat", Git will not launch
879 a pager. See also the `core.pager` option in
880 linkgit:git-config[1].
883 This environment variable overrides `$EDITOR` and `$VISUAL`.
884 It is used by several Git commands when, on interactive mode,
885 an editor is to be launched. See also linkgit:git-var[1]
886 and the `core.editor` option in linkgit:git-config[1].
890 If either of these environment variables is set then 'git fetch'
891 and 'git push' will use the specified command instead of 'ssh'
892 when they need to connect to a remote system.
893 The command will be given exactly two or four arguments: the
894 'username@host' (or just 'host') from the URL and the shell
895 command to execute on that remote system, optionally preceded by
896 '-p' (literally) and the 'port' from the URL when it specifies
897 something other than the default SSH port.
899 `$GIT_SSH_COMMAND` takes precedence over `$GIT_SSH`, and is interpreted
900 by the shell, which allows additional arguments to be included.
901 `$GIT_SSH` on the other hand must be just the path to a program
902 (which can be a wrapper shell script, if additional arguments are
905 Usually it is easier to configure any desired options through your
906 personal `.ssh/config` file. Please consult your ssh documentation
910 If this environment variable is set, then Git commands which need to
911 acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
912 will call this program with a suitable prompt as command-line argument
913 and read the password from its STDOUT. See also the 'core.askpass'
914 option in linkgit:git-config[1].
916 'GIT_CONFIG_NOSYSTEM'::
917 Whether to skip reading settings from the system-wide
918 `$(prefix)/etc/gitconfig` file. This environment variable can
919 be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
920 predictable environment for a picky script, or you can set it
921 temporarily to avoid using a buggy `/etc/gitconfig` file while
922 waiting for someone with sufficient permissions to fix it.
925 If this environment variable is set to "1", then commands such
926 as 'git blame' (in incremental mode), 'git rev-list', 'git log',
927 'git check-attr' and 'git check-ignore' will
928 force a flush of the output stream after each record have been
930 variable is set to "0", the output of these commands will be done
931 using completely buffered I/O. If this environment variable is
932 not set, Git will choose buffered or record-oriented flushing
933 based on whether stdout appears to be redirected to a file or not.
936 Enables general trace messages, e.g. alias expansion, built-in
937 command execution and external command execution.
939 If this variable is set to "1", "2" or "true" (comparison
940 is case insensitive), trace messages will be printed to
943 If the variable is set to an integer value greater than 2
944 and lower than 10 (strictly) then Git will interpret this
945 value as an open file descriptor and will try to write the
946 trace messages into this file descriptor.
948 Alternatively, if the variable is set to an absolute path
949 (starting with a '/' character), Git will interpret this
950 as a file path and will try to write the trace messages
953 Unsetting the variable, or setting it to empty, "0" or
954 "false" (case insensitive) disables trace messages.
956 'GIT_TRACE_PACK_ACCESS'::
957 Enables trace messages for all accesses to any packs. For each
958 access, the pack file name and an offset in the pack is
959 recorded. This may be helpful for troubleshooting some
960 pack-related performance problems.
961 See 'GIT_TRACE' for available trace output options.
964 Enables trace messages for all packets coming in or out of a
965 given program. This can help with debugging object negotiation
966 or other protocol issues. Tracing is turned off at a packet
967 starting with "PACK".
968 See 'GIT_TRACE' for available trace output options.
970 'GIT_TRACE_PERFORMANCE'::
971 Enables performance related trace messages, e.g. total execution
972 time of each Git command.
973 See 'GIT_TRACE' for available trace output options.
976 Enables trace messages printing the .git, working tree and current
977 working directory after Git has completed its setup phase.
978 See 'GIT_TRACE' for available trace output options.
980 'GIT_TRACE_SHALLOW'::
981 Enables trace messages that can help debugging fetching /
982 cloning of shallow repositories.
983 See 'GIT_TRACE' for available trace output options.
985 GIT_LITERAL_PATHSPECS::
986 Setting this variable to `1` will cause Git to treat all
987 pathspecs literally, rather than as glob patterns. For example,
988 running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
989 for commits that touch the path `*.c`, not any paths that the
990 glob `*.c` matches. You might want this if you are feeding
991 literal paths to Git (e.g., paths previously given to you by
992 `git ls-tree`, `--raw` diff output, etc).
995 Setting this variable to `1` will cause Git to treat all
996 pathspecs as glob patterns (aka "glob" magic).
998 GIT_NOGLOB_PATHSPECS::
999 Setting this variable to `1` will cause Git to treat all
1000 pathspecs as literal (aka "literal" magic).
1002 GIT_ICASE_PATHSPECS::
1003 Setting this variable to `1` will cause Git to treat all
1004 pathspecs as case-insensitive.
1006 'GIT_REFLOG_ACTION'::
1007 When a ref is updated, reflog entries are created to keep
1008 track of the reason why the ref was updated (which is
1009 typically the name of the high-level command that updated
1010 the ref), in addition to the old and new values of the ref.
1011 A scripted Porcelain command can use set_reflog_action
1012 helper function in `git-sh-setup` to set its name to this
1013 variable when it is invoked as the top level command by the
1014 end user, to be recorded in the body of the reflog.
1017 Discussion[[Discussion]]
1018 ------------------------
1020 More detail on the following is available from the
1021 link:user-manual.html#git-concepts[Git concepts chapter of the
1022 user-manual] and linkgit:gitcore-tutorial[7].
1024 A Git project normally consists of a working directory with a ".git"
1025 subdirectory at the top level. The .git directory contains, among other
1026 things, a compressed object database representing the complete history
1027 of the project, an "index" file which links that history to the current
1028 contents of the working tree, and named pointers into that history such
1029 as tags and branch heads.
1031 The object database contains objects of three main types: blobs, which
1032 hold file data; trees, which point to blobs and other trees to build up
1033 directory hierarchies; and commits, which each reference a single tree
1034 and some number of parent commits.
1036 The commit, equivalent to what other systems call a "changeset" or
1037 "version", represents a step in the project's history, and each parent
1038 represents an immediately preceding step. Commits with more than one
1039 parent represent merges of independent lines of development.
1041 All objects are named by the SHA-1 hash of their contents, normally
1042 written as a string of 40 hex digits. Such names are globally unique.
1043 The entire history leading up to a commit can be vouched for by signing
1044 just that commit. A fourth object type, the tag, is provided for this
1047 When first created, objects are stored in individual files, but for
1048 efficiency may later be compressed together into "pack files".
1050 Named pointers called refs mark interesting points in history. A ref
1051 may contain the SHA-1 name of an object or the name of another ref. Refs
1052 with names beginning `ref/head/` contain the SHA-1 name of the most
1053 recent commit (or "head") of a branch under development. SHA-1 names of
1054 tags of interest are stored under `ref/tags/`. A special ref named
1055 `HEAD` contains the name of the currently checked-out branch.
1057 The index file is initialized with a list of all paths and, for each
1058 path, a blob object and a set of attributes. The blob object represents
1059 the contents of the file as of the head of the current branch. The
1060 attributes (last modified time, size, etc.) are taken from the
1061 corresponding file in the working tree. Subsequent changes to the
1062 working tree can be found by comparing these attributes. The index may
1063 be updated with new content, and new commits may be created from the
1064 content stored in the index.
1066 The index is also capable of storing multiple entries (called "stages")
1067 for a given pathname. These stages are used to hold the various
1068 unmerged version of a file when a merge is in progress.
1070 FURTHER DOCUMENTATION
1071 ---------------------
1073 See the references in the "description" section to get started
1074 using Git. The following is probably more detail than necessary
1075 for a first-time user.
1077 The link:user-manual.html#git-concepts[Git concepts chapter of the
1078 user-manual] and linkgit:gitcore-tutorial[7] both provide
1079 introductions to the underlying Git architecture.
1081 See linkgit:gitworkflows[7] for an overview of recommended workflows.
1083 See also the link:howto-index.html[howto] documents for some useful
1086 The internals are documented in the
1087 link:technical/api-index.html[Git API documentation].
1089 Users migrating from CVS may also want to
1090 read linkgit:gitcvs-migration[7].
1095 Git was started by Linus Torvalds, and is currently maintained by Junio
1096 C Hamano. Numerous contributions have come from the Git mailing list
1097 <git@vger.kernel.org>. http://www.openhub.net/p/git/contributors/summary
1098 gives you a more complete list of contributors.
1100 If you have a clone of git.git itself, the
1101 output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
1102 the authors for specific parts of the project.
1107 Report bugs to the Git mailing list <git@vger.kernel.org> where the
1108 development and maintenance is primarily done. You do not have to be
1109 subscribed to the list to send a message there.
1113 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
1114 linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
1115 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
1116 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
1117 linkgit:gitworkflows[7]
1121 Part of the linkgit:git[1] suite