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.10/git.html[documentation for release 2.3.10]
49 link:RelNotes/2.3.10.txt[2.3.10],
50 link:RelNotes/2.3.9.txt[2.3.9],
51 link:RelNotes/2.3.8.txt[2.3.8],
52 link:RelNotes/2.3.7.txt[2.3.7],
53 link:RelNotes/2.3.6.txt[2.3.6],
54 link:RelNotes/2.3.5.txt[2.3.5],
55 link:RelNotes/2.3.4.txt[2.3.4],
56 link:RelNotes/2.3.3.txt[2.3.3],
57 link:RelNotes/2.3.2.txt[2.3.2],
58 link:RelNotes/2.3.1.txt[2.3.1],
59 link:RelNotes/2.3.0.txt[2.3].
61 * link:v2.2.3/git.html[documentation for release 2.2.3]
64 link:RelNotes/2.2.3.txt[2.2.3],
65 link:RelNotes/2.2.2.txt[2.2.2],
66 link:RelNotes/2.2.1.txt[2.2.1],
67 link:RelNotes/2.2.0.txt[2.2].
69 * link:v2.1.4/git.html[documentation for release 2.1.4]
72 link:RelNotes/2.1.4.txt[2.1.4],
73 link:RelNotes/2.1.3.txt[2.1.3],
74 link:RelNotes/2.1.2.txt[2.1.2],
75 link:RelNotes/2.1.1.txt[2.1.1],
76 link:RelNotes/2.1.0.txt[2.1].
78 * link:v2.0.5/git.html[documentation for release 2.0.5]
81 link:RelNotes/2.0.5.txt[2.0.5],
82 link:RelNotes/2.0.4.txt[2.0.4],
83 link:RelNotes/2.0.3.txt[2.0.3],
84 link:RelNotes/2.0.2.txt[2.0.2],
85 link:RelNotes/2.0.1.txt[2.0.1],
86 link:RelNotes/2.0.0.txt[2.0.0].
88 * link:v1.9.5/git.html[documentation for release 1.9.5]
91 link:RelNotes/1.9.5.txt[1.9.5],
92 link:RelNotes/1.9.4.txt[1.9.4],
93 link:RelNotes/1.9.3.txt[1.9.3],
94 link:RelNotes/1.9.2.txt[1.9.2],
95 link:RelNotes/1.9.1.txt[1.9.1],
96 link:RelNotes/1.9.0.txt[1.9.0].
98 * link:v1.8.5.6/git.html[documentation for release 1.8.5.6]
101 link:RelNotes/1.8.5.6.txt[1.8.5.6],
102 link:RelNotes/1.8.5.5.txt[1.8.5.5],
103 link:RelNotes/1.8.5.4.txt[1.8.5.4],
104 link:RelNotes/1.8.5.3.txt[1.8.5.3],
105 link:RelNotes/1.8.5.2.txt[1.8.5.2],
106 link:RelNotes/1.8.5.1.txt[1.8.5.1],
107 link:RelNotes/1.8.5.txt[1.8.5].
109 * link:v1.8.4.5/git.html[documentation for release 1.8.4.5]
112 link:RelNotes/1.8.4.5.txt[1.8.4.5],
113 link:RelNotes/1.8.4.4.txt[1.8.4.4],
114 link:RelNotes/1.8.4.3.txt[1.8.4.3],
115 link:RelNotes/1.8.4.2.txt[1.8.4.2],
116 link:RelNotes/1.8.4.1.txt[1.8.4.1],
117 link:RelNotes/1.8.4.txt[1.8.4].
119 * link:v1.8.3.4/git.html[documentation for release 1.8.3.4]
122 link:RelNotes/1.8.3.4.txt[1.8.3.4],
123 link:RelNotes/1.8.3.3.txt[1.8.3.3],
124 link:RelNotes/1.8.3.2.txt[1.8.3.2],
125 link:RelNotes/1.8.3.1.txt[1.8.3.1],
126 link:RelNotes/1.8.3.txt[1.8.3].
128 * link:v1.8.2.3/git.html[documentation for release 1.8.2.3]
131 link:RelNotes/1.8.2.3.txt[1.8.2.3],
132 link:RelNotes/1.8.2.2.txt[1.8.2.2],
133 link:RelNotes/1.8.2.1.txt[1.8.2.1],
134 link:RelNotes/1.8.2.txt[1.8.2].
136 * link:v1.8.1.6/git.html[documentation for release 1.8.1.6]
139 link:RelNotes/1.8.1.6.txt[1.8.1.6],
140 link:RelNotes/1.8.1.5.txt[1.8.1.5],
141 link:RelNotes/1.8.1.4.txt[1.8.1.4],
142 link:RelNotes/1.8.1.3.txt[1.8.1.3],
143 link:RelNotes/1.8.1.2.txt[1.8.1.2],
144 link:RelNotes/1.8.1.1.txt[1.8.1.1],
145 link:RelNotes/1.8.1.txt[1.8.1].
147 * link:v1.8.0.3/git.html[documentation for release 1.8.0.3]
150 link:RelNotes/1.8.0.3.txt[1.8.0.3],
151 link:RelNotes/1.8.0.2.txt[1.8.0.2],
152 link:RelNotes/1.8.0.1.txt[1.8.0.1],
153 link:RelNotes/1.8.0.txt[1.8.0].
155 * link:v1.7.12.4/git.html[documentation for release 1.7.12.4]
158 link:RelNotes/1.7.12.4.txt[1.7.12.4],
159 link:RelNotes/1.7.12.3.txt[1.7.12.3],
160 link:RelNotes/1.7.12.2.txt[1.7.12.2],
161 link:RelNotes/1.7.12.1.txt[1.7.12.1],
162 link:RelNotes/1.7.12.txt[1.7.12].
164 * link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
167 link:RelNotes/1.7.11.7.txt[1.7.11.7],
168 link:RelNotes/1.7.11.6.txt[1.7.11.6],
169 link:RelNotes/1.7.11.5.txt[1.7.11.5],
170 link:RelNotes/1.7.11.4.txt[1.7.11.4],
171 link:RelNotes/1.7.11.3.txt[1.7.11.3],
172 link:RelNotes/1.7.11.2.txt[1.7.11.2],
173 link:RelNotes/1.7.11.1.txt[1.7.11.1],
174 link:RelNotes/1.7.11.txt[1.7.11].
176 * link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
179 link:RelNotes/1.7.10.5.txt[1.7.10.5],
180 link:RelNotes/1.7.10.4.txt[1.7.10.4],
181 link:RelNotes/1.7.10.3.txt[1.7.10.3],
182 link:RelNotes/1.7.10.2.txt[1.7.10.2],
183 link:RelNotes/1.7.10.1.txt[1.7.10.1],
184 link:RelNotes/1.7.10.txt[1.7.10].
186 * link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
189 link:RelNotes/1.7.9.7.txt[1.7.9.7],
190 link:RelNotes/1.7.9.6.txt[1.7.9.6],
191 link:RelNotes/1.7.9.5.txt[1.7.9.5],
192 link:RelNotes/1.7.9.4.txt[1.7.9.4],
193 link:RelNotes/1.7.9.3.txt[1.7.9.3],
194 link:RelNotes/1.7.9.2.txt[1.7.9.2],
195 link:RelNotes/1.7.9.1.txt[1.7.9.1],
196 link:RelNotes/1.7.9.txt[1.7.9].
198 * link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
201 link:RelNotes/1.7.8.6.txt[1.7.8.6],
202 link:RelNotes/1.7.8.5.txt[1.7.8.5],
203 link:RelNotes/1.7.8.4.txt[1.7.8.4],
204 link:RelNotes/1.7.8.3.txt[1.7.8.3],
205 link:RelNotes/1.7.8.2.txt[1.7.8.2],
206 link:RelNotes/1.7.8.1.txt[1.7.8.1],
207 link:RelNotes/1.7.8.txt[1.7.8].
209 * link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
212 link:RelNotes/1.7.7.7.txt[1.7.7.7],
213 link:RelNotes/1.7.7.6.txt[1.7.7.6],
214 link:RelNotes/1.7.7.5.txt[1.7.7.5],
215 link:RelNotes/1.7.7.4.txt[1.7.7.4],
216 link:RelNotes/1.7.7.3.txt[1.7.7.3],
217 link:RelNotes/1.7.7.2.txt[1.7.7.2],
218 link:RelNotes/1.7.7.1.txt[1.7.7.1],
219 link:RelNotes/1.7.7.txt[1.7.7].
221 * link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
224 link:RelNotes/1.7.6.6.txt[1.7.6.6],
225 link:RelNotes/1.7.6.5.txt[1.7.6.5],
226 link:RelNotes/1.7.6.4.txt[1.7.6.4],
227 link:RelNotes/1.7.6.3.txt[1.7.6.3],
228 link:RelNotes/1.7.6.2.txt[1.7.6.2],
229 link:RelNotes/1.7.6.1.txt[1.7.6.1],
230 link:RelNotes/1.7.6.txt[1.7.6].
232 * link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
235 link:RelNotes/1.7.5.4.txt[1.7.5.4],
236 link:RelNotes/1.7.5.3.txt[1.7.5.3],
237 link:RelNotes/1.7.5.2.txt[1.7.5.2],
238 link:RelNotes/1.7.5.1.txt[1.7.5.1],
239 link:RelNotes/1.7.5.txt[1.7.5].
241 * link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
244 link:RelNotes/1.7.4.5.txt[1.7.4.5],
245 link:RelNotes/1.7.4.4.txt[1.7.4.4],
246 link:RelNotes/1.7.4.3.txt[1.7.4.3],
247 link:RelNotes/1.7.4.2.txt[1.7.4.2],
248 link:RelNotes/1.7.4.1.txt[1.7.4.1],
249 link:RelNotes/1.7.4.txt[1.7.4].
251 * link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
254 link:RelNotes/1.7.3.5.txt[1.7.3.5],
255 link:RelNotes/1.7.3.4.txt[1.7.3.4],
256 link:RelNotes/1.7.3.3.txt[1.7.3.3],
257 link:RelNotes/1.7.3.2.txt[1.7.3.2],
258 link:RelNotes/1.7.3.1.txt[1.7.3.1],
259 link:RelNotes/1.7.3.txt[1.7.3].
261 * link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
264 link:RelNotes/1.7.2.5.txt[1.7.2.5],
265 link:RelNotes/1.7.2.4.txt[1.7.2.4],
266 link:RelNotes/1.7.2.3.txt[1.7.2.3],
267 link:RelNotes/1.7.2.2.txt[1.7.2.2],
268 link:RelNotes/1.7.2.1.txt[1.7.2.1],
269 link:RelNotes/1.7.2.txt[1.7.2].
271 * link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
274 link:RelNotes/1.7.1.4.txt[1.7.1.4],
275 link:RelNotes/1.7.1.3.txt[1.7.1.3],
276 link:RelNotes/1.7.1.2.txt[1.7.1.2],
277 link:RelNotes/1.7.1.1.txt[1.7.1.1],
278 link:RelNotes/1.7.1.txt[1.7.1].
280 * link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
283 link:RelNotes/1.7.0.9.txt[1.7.0.9],
284 link:RelNotes/1.7.0.8.txt[1.7.0.8],
285 link:RelNotes/1.7.0.7.txt[1.7.0.7],
286 link:RelNotes/1.7.0.6.txt[1.7.0.6],
287 link:RelNotes/1.7.0.5.txt[1.7.0.5],
288 link:RelNotes/1.7.0.4.txt[1.7.0.4],
289 link:RelNotes/1.7.0.3.txt[1.7.0.3],
290 link:RelNotes/1.7.0.2.txt[1.7.0.2],
291 link:RelNotes/1.7.0.1.txt[1.7.0.1],
292 link:RelNotes/1.7.0.txt[1.7.0].
294 * link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
297 link:RelNotes/1.6.6.3.txt[1.6.6.3],
298 link:RelNotes/1.6.6.2.txt[1.6.6.2],
299 link:RelNotes/1.6.6.1.txt[1.6.6.1],
300 link:RelNotes/1.6.6.txt[1.6.6].
302 * link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
305 link:RelNotes/1.6.5.9.txt[1.6.5.9],
306 link:RelNotes/1.6.5.8.txt[1.6.5.8],
307 link:RelNotes/1.6.5.7.txt[1.6.5.7],
308 link:RelNotes/1.6.5.6.txt[1.6.5.6],
309 link:RelNotes/1.6.5.5.txt[1.6.5.5],
310 link:RelNotes/1.6.5.4.txt[1.6.5.4],
311 link:RelNotes/1.6.5.3.txt[1.6.5.3],
312 link:RelNotes/1.6.5.2.txt[1.6.5.2],
313 link:RelNotes/1.6.5.1.txt[1.6.5.1],
314 link:RelNotes/1.6.5.txt[1.6.5].
316 * link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
319 link:RelNotes/1.6.4.5.txt[1.6.4.5],
320 link:RelNotes/1.6.4.4.txt[1.6.4.4],
321 link:RelNotes/1.6.4.3.txt[1.6.4.3],
322 link:RelNotes/1.6.4.2.txt[1.6.4.2],
323 link:RelNotes/1.6.4.1.txt[1.6.4.1],
324 link:RelNotes/1.6.4.txt[1.6.4].
326 * link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
329 link:RelNotes/1.6.3.4.txt[1.6.3.4],
330 link:RelNotes/1.6.3.3.txt[1.6.3.3],
331 link:RelNotes/1.6.3.2.txt[1.6.3.2],
332 link:RelNotes/1.6.3.1.txt[1.6.3.1],
333 link:RelNotes/1.6.3.txt[1.6.3].
336 link:RelNotes/1.6.2.5.txt[1.6.2.5],
337 link:RelNotes/1.6.2.4.txt[1.6.2.4],
338 link:RelNotes/1.6.2.3.txt[1.6.2.3],
339 link:RelNotes/1.6.2.2.txt[1.6.2.2],
340 link:RelNotes/1.6.2.1.txt[1.6.2.1],
341 link:RelNotes/1.6.2.txt[1.6.2].
343 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
346 link:RelNotes/1.6.1.3.txt[1.6.1.3],
347 link:RelNotes/1.6.1.2.txt[1.6.1.2],
348 link:RelNotes/1.6.1.1.txt[1.6.1.1],
349 link:RelNotes/1.6.1.txt[1.6.1].
351 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
354 link:RelNotes/1.6.0.6.txt[1.6.0.6],
355 link:RelNotes/1.6.0.5.txt[1.6.0.5],
356 link:RelNotes/1.6.0.4.txt[1.6.0.4],
357 link:RelNotes/1.6.0.3.txt[1.6.0.3],
358 link:RelNotes/1.6.0.2.txt[1.6.0.2],
359 link:RelNotes/1.6.0.1.txt[1.6.0.1],
360 link:RelNotes/1.6.0.txt[1.6.0].
362 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
365 link:RelNotes/1.5.6.6.txt[1.5.6.6],
366 link:RelNotes/1.5.6.5.txt[1.5.6.5],
367 link:RelNotes/1.5.6.4.txt[1.5.6.4],
368 link:RelNotes/1.5.6.3.txt[1.5.6.3],
369 link:RelNotes/1.5.6.2.txt[1.5.6.2],
370 link:RelNotes/1.5.6.1.txt[1.5.6.1],
371 link:RelNotes/1.5.6.txt[1.5.6].
373 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
376 link:RelNotes/1.5.5.6.txt[1.5.5.6],
377 link:RelNotes/1.5.5.5.txt[1.5.5.5],
378 link:RelNotes/1.5.5.4.txt[1.5.5.4],
379 link:RelNotes/1.5.5.3.txt[1.5.5.3],
380 link:RelNotes/1.5.5.2.txt[1.5.5.2],
381 link:RelNotes/1.5.5.1.txt[1.5.5.1],
382 link:RelNotes/1.5.5.txt[1.5.5].
384 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
387 link:RelNotes/1.5.4.7.txt[1.5.4.7],
388 link:RelNotes/1.5.4.6.txt[1.5.4.6],
389 link:RelNotes/1.5.4.5.txt[1.5.4.5],
390 link:RelNotes/1.5.4.4.txt[1.5.4.4],
391 link:RelNotes/1.5.4.3.txt[1.5.4.3],
392 link:RelNotes/1.5.4.2.txt[1.5.4.2],
393 link:RelNotes/1.5.4.1.txt[1.5.4.1],
394 link:RelNotes/1.5.4.txt[1.5.4].
396 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
399 link:RelNotes/1.5.3.8.txt[1.5.3.8],
400 link:RelNotes/1.5.3.7.txt[1.5.3.7],
401 link:RelNotes/1.5.3.6.txt[1.5.3.6],
402 link:RelNotes/1.5.3.5.txt[1.5.3.5],
403 link:RelNotes/1.5.3.4.txt[1.5.3.4],
404 link:RelNotes/1.5.3.3.txt[1.5.3.3],
405 link:RelNotes/1.5.3.2.txt[1.5.3.2],
406 link:RelNotes/1.5.3.1.txt[1.5.3.1],
407 link:RelNotes/1.5.3.txt[1.5.3].
409 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
412 link:RelNotes/1.5.2.5.txt[1.5.2.5],
413 link:RelNotes/1.5.2.4.txt[1.5.2.4],
414 link:RelNotes/1.5.2.3.txt[1.5.2.3],
415 link:RelNotes/1.5.2.2.txt[1.5.2.2],
416 link:RelNotes/1.5.2.1.txt[1.5.2.1],
417 link:RelNotes/1.5.2.txt[1.5.2].
419 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
422 link:RelNotes/1.5.1.6.txt[1.5.1.6],
423 link:RelNotes/1.5.1.5.txt[1.5.1.5],
424 link:RelNotes/1.5.1.4.txt[1.5.1.4],
425 link:RelNotes/1.5.1.3.txt[1.5.1.3],
426 link:RelNotes/1.5.1.2.txt[1.5.1.2],
427 link:RelNotes/1.5.1.1.txt[1.5.1.1],
428 link:RelNotes/1.5.1.txt[1.5.1].
430 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
433 link:RelNotes/1.5.0.7.txt[1.5.0.7],
434 link:RelNotes/1.5.0.6.txt[1.5.0.6],
435 link:RelNotes/1.5.0.5.txt[1.5.0.5],
436 link:RelNotes/1.5.0.3.txt[1.5.0.3],
437 link:RelNotes/1.5.0.2.txt[1.5.0.2],
438 link:RelNotes/1.5.0.1.txt[1.5.0.1],
439 link:RelNotes/1.5.0.txt[1.5.0].
441 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
442 link:v1.3.3/git.html[1.3.3],
443 link:v1.2.6/git.html[1.2.6],
444 link:v1.0.13/git.html[1.0.13].
453 Prints the Git suite version that the 'git' program came from.
456 Prints the synopsis and a list of the most commonly used
457 commands. If the option '--all' or '-a' is given then all
458 available commands are printed. If a Git command is named this
459 option will bring up the manual page for that command.
461 Other options are available to control how the manual page is
462 displayed. See linkgit:git-help[1] for more information,
463 because `git --help ...` is converted internally into `git
467 Run as if git was started in '<path>' instead of the current working
468 directory. When multiple `-C` options are given, each subsequent
469 non-absolute `-C <path>` is interpreted relative to the preceding `-C
472 This option affects options that expect path name like `--git-dir` and
473 `--work-tree` in that their interpretations of the path names would be
474 made relative to the working directory caused by the `-C` option. For
475 example the following invocations are equivalent:
477 git --git-dir=a.git --work-tree=b -C c status
478 git --git-dir=c/a.git --work-tree=c/b status
481 Pass a configuration parameter to the command. The value
482 given will override values from configuration files.
483 The <name> is expected in the same format as listed by
484 'git config' (subkeys separated by dots).
486 Note that omitting the `=` in `git -c foo.bar ...` is allowed and sets
487 `foo.bar` to the boolean true value (just like `[foo]bar` would in a
488 config file). Including the equals but with an empty value (like `git -c
489 foo.bar= ...`) sets `foo.bar` to the empty string.
491 --exec-path[=<path>]::
492 Path to wherever your core Git programs are installed.
493 This can also be controlled by setting the GIT_EXEC_PATH
494 environment variable. If no path is given, 'git' will print
495 the current setting and then exit.
498 Print the path, without trailing slash, where Git's HTML
499 documentation is installed and exit.
502 Print the manpath (see `man(1)`) for the man pages for
503 this version of Git and exit.
506 Print the path where the Info files documenting this
507 version of Git are installed and exit.
511 Pipe all output into 'less' (or if set, $PAGER) if standard
512 output is a terminal. This overrides the `pager.<cmd>`
513 configuration options (see the "Configuration Mechanism" section
517 Do not pipe Git output into a pager.
520 Set the path to the repository. This can also be controlled by
521 setting the GIT_DIR environment variable. It can be an absolute
522 path or relative path to current working directory.
525 Set the path to the working tree. It can be an absolute path
526 or a path relative to the current working directory.
527 This can also be controlled by setting the GIT_WORK_TREE
528 environment variable and the core.worktree configuration
529 variable (see core.worktree in linkgit:git-config[1] for a
530 more detailed discussion).
533 Set the Git namespace. See linkgit:gitnamespaces[7] for more
534 details. Equivalent to setting the `GIT_NAMESPACE` environment
538 Treat the repository as a bare repository. If GIT_DIR
539 environment is not set, it is set to the current working
542 --no-replace-objects::
543 Do not use replacement refs to replace Git objects. See
544 linkgit:git-replace[1] for more information.
546 --literal-pathspecs::
547 Treat pathspecs literally (i.e. no globbing, no pathspec magic).
548 This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
552 Add "glob" magic to all pathspec. This is equivalent to setting
553 the `GIT_GLOB_PATHSPECS` environment variable to `1`. Disabling
554 globbing on individual pathspecs can be done using pathspec
558 Add "literal" magic to all pathspec. This is equivalent to setting
559 the `GIT_NOGLOB_PATHSPECS` environment variable to `1`. Enabling
560 globbing on individual pathspecs can be done using pathspec
564 Add "icase" magic to all pathspec. This is equivalent to setting
565 the `GIT_ICASE_PATHSPECS` environment variable to `1`.
570 We divide Git into high level ("porcelain") commands and low level
571 ("plumbing") commands.
573 High-level commands (porcelain)
574 -------------------------------
576 We separate the porcelain commands into the main commands and some
577 ancillary user utilities.
579 Main porcelain commands
580 ~~~~~~~~~~~~~~~~~~~~~~~
582 include::cmds-mainporcelain.txt[]
588 include::cmds-ancillarymanipulators.txt[]
592 include::cmds-ancillaryinterrogators.txt[]
595 Interacting with Others
596 ~~~~~~~~~~~~~~~~~~~~~~~
598 These commands are to interact with foreign SCM and with other
599 people via patch over e-mail.
601 include::cmds-foreignscminterface.txt[]
604 Low-level commands (plumbing)
605 -----------------------------
607 Although Git includes its
608 own porcelain layer, its low-level commands are sufficient to support
609 development of alternative porcelains. Developers of such porcelains
610 might start by reading about linkgit:git-update-index[1] and
611 linkgit:git-read-tree[1].
613 The interface (input, output, set of options and the semantics)
614 to these low-level commands are meant to be a lot more stable
615 than Porcelain level commands, because these commands are
616 primarily for scripted use. The interface to Porcelain commands
617 on the other hand are subject to change in order to improve the
620 The following description divides
621 the low-level commands into commands that manipulate objects (in
622 the repository, index, and working tree), commands that interrogate and
623 compare objects, and commands that move objects and references between
627 Manipulation commands
628 ~~~~~~~~~~~~~~~~~~~~~
630 include::cmds-plumbingmanipulators.txt[]
633 Interrogation commands
634 ~~~~~~~~~~~~~~~~~~~~~~
636 include::cmds-plumbinginterrogators.txt[]
638 In general, the interrogate commands do not touch the files in
642 Synching repositories
643 ~~~~~~~~~~~~~~~~~~~~~
645 include::cmds-synchingrepositories.txt[]
647 The following are helper commands used by the above; end users
648 typically do not use them directly.
650 include::cmds-synchelpers.txt[]
653 Internal helper commands
654 ~~~~~~~~~~~~~~~~~~~~~~~~
656 These are internal helper commands used by other commands; end
657 users typically do not use them directly.
659 include::cmds-purehelpers.txt[]
662 Configuration Mechanism
663 -----------------------
665 Git uses a simple text format to store customizations that are per
666 repository and are per user. Such a configuration file may look
671 # A '#' or ';' character indicates a comment.
676 ; Don't trust file modes
681 name = "Junio C Hamano"
682 email = "gitster@pobox.com"
686 Various commands read from the configuration file and adjust
687 their operation accordingly. See linkgit:git-config[1] for a
688 list and more details about the configuration mechanism.
691 Identifier Terminology
692 ----------------------
694 Indicates the object name for any type of object.
697 Indicates a blob object name.
700 Indicates a tree object name.
703 Indicates a commit object name.
706 Indicates a tree, commit or tag object name. A
707 command that takes a <tree-ish> argument ultimately wants to
708 operate on a <tree> object but automatically dereferences
709 <commit> and <tag> objects that point at a <tree>.
712 Indicates a commit or tag object name. A
713 command that takes a <commit-ish> argument ultimately wants to
714 operate on a <commit> object but automatically dereferences
715 <tag> objects that point at a <commit>.
718 Indicates that an object type is required.
719 Currently one of: `blob`, `tree`, `commit`, or `tag`.
722 Indicates a filename - almost always relative to the
723 root of the tree structure `GIT_INDEX_FILE` describes.
727 Any Git command accepting any <object> can also use the following
731 indicates the head of the current branch.
735 (i.e. a `refs/tags/<tag>` reference).
739 (i.e. a `refs/heads/<head>` reference).
741 For a more complete list of ways to spell object names, see
742 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
745 File/Directory Structure
746 ------------------------
748 Please see the linkgit:gitrepository-layout[5] document.
750 Read linkgit:githooks[5] for more details about each hook.
752 Higher level SCMs may provide and manage additional information in the
758 Please see linkgit:gitglossary[7].
761 Environment Variables
762 ---------------------
763 Various Git commands use the following environment variables:
767 These environment variables apply to 'all' core Git commands. Nb: it
768 is worth noting that they may be used/overridden by SCMS sitting above
769 Git so take care if using Cogito etc.
772 This environment allows the specification of an alternate
773 index file. If not specified, the default of `$GIT_DIR/index`
776 'GIT_INDEX_VERSION'::
777 This environment variable allows the specification of an index
778 version for new repositories. It won't affect existing index
779 files. By default index file version 2 or 3 is used. See
780 linkgit:git-update-index[1] for more information.
782 'GIT_OBJECT_DIRECTORY'::
783 If the object storage directory is specified via this
784 environment variable then the sha1 directories are created
785 underneath - otherwise the default `$GIT_DIR/objects`
788 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
789 Due to the immutable nature of Git objects, old objects can be
790 archived into shared, read-only directories. This variable
791 specifies a ":" separated (on Windows ";" separated) list
792 of Git object directories which can be used to search for Git
793 objects. New objects will not be written to these directories.
796 If the 'GIT_DIR' environment variable is set then it
797 specifies a path to use instead of the default `.git`
798 for the base of the repository.
799 The '--git-dir' command-line option also sets this value.
802 Set the path to the root of the working tree.
803 This can also be controlled by the '--work-tree' command-line
804 option and the core.worktree configuration variable.
807 Set the Git namespace; see linkgit:gitnamespaces[7] for details.
808 The '--namespace' command-line option also sets this value.
810 'GIT_CEILING_DIRECTORIES'::
811 This should be a colon-separated list of absolute paths. If
812 set, it is a list of directories that Git should not chdir up
813 into while looking for a repository directory (useful for
814 excluding slow-loading network directories). It will not
815 exclude the current working directory or a GIT_DIR set on the
816 command line or in the environment. Normally, Git has to read
817 the entries in this list and resolve any symlink that
818 might be present in order to compare them with the current
819 directory. However, if even this access is slow, you
820 can add an empty entry to the list to tell Git that the
821 subsequent entries are not symlinks and needn't be resolved;
823 'GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink'.
825 'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
826 When run in a directory that does not have ".git" repository
827 directory, Git tries to find such a directory in the parent
828 directories to find the top of the working tree, but by default it
829 does not cross filesystem boundaries. This environment variable
830 can be set to true to tell Git not to stop at filesystem
831 boundaries. Like 'GIT_CEILING_DIRECTORIES', this will not affect
832 an explicit repository directory set via 'GIT_DIR' or on the
840 'GIT_COMMITTER_NAME'::
841 'GIT_COMMITTER_EMAIL'::
842 'GIT_COMMITTER_DATE'::
844 see linkgit:git-commit-tree[1]
849 Only valid setting is "--unified=??" or "-u??" to set the
850 number of context lines shown when a unified diff is created.
851 This takes precedence over any "-U" or "--unified" option
852 value passed on the Git diff command line.
854 'GIT_EXTERNAL_DIFF'::
855 When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
856 program named by it is called, instead of the diff invocation
857 described above. For a path that is added, removed, or modified,
858 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
860 path old-file old-hex old-mode new-file new-hex new-mode
864 <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
865 contents of <old|new>,
866 <old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
867 <old|new>-mode:: are the octal representation of the file modes.
869 The file parameters can point at the user's working file
870 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
871 when a new file is added), or a temporary file (e.g. `old-file` in the
872 index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
873 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
875 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
878 For each path 'GIT_EXTERNAL_DIFF' is called, two environment variables,
879 'GIT_DIFF_PATH_COUNTER' and 'GIT_DIFF_PATH_TOTAL' are set.
881 'GIT_DIFF_PATH_COUNTER'::
882 A 1-based counter incremented by one for every path.
884 'GIT_DIFF_PATH_TOTAL'::
885 The total number of paths.
889 'GIT_MERGE_VERBOSITY'::
890 A number controlling the amount of output shown by
891 the recursive merge strategy. Overrides merge.verbosity.
892 See linkgit:git-merge[1]
895 This environment variable overrides `$PAGER`. If it is set
896 to an empty string or to the value "cat", Git will not launch
897 a pager. See also the `core.pager` option in
898 linkgit:git-config[1].
901 This environment variable overrides `$EDITOR` and `$VISUAL`.
902 It is used by several Git commands when, on interactive mode,
903 an editor is to be launched. See also linkgit:git-var[1]
904 and the `core.editor` option in linkgit:git-config[1].
908 If either of these environment variables is set then 'git fetch'
909 and 'git push' will use the specified command instead of 'ssh'
910 when they need to connect to a remote system.
911 The command will be given exactly two or four arguments: the
912 'username@host' (or just 'host') from the URL and the shell
913 command to execute on that remote system, optionally preceded by
914 '-p' (literally) and the 'port' from the URL when it specifies
915 something other than the default SSH port.
917 `$GIT_SSH_COMMAND` takes precedence over `$GIT_SSH`, and is interpreted
918 by the shell, which allows additional arguments to be included.
919 `$GIT_SSH` on the other hand must be just the path to a program
920 (which can be a wrapper shell script, if additional arguments are
923 Usually it is easier to configure any desired options through your
924 personal `.ssh/config` file. Please consult your ssh documentation
928 If this environment variable is set, then Git commands which need to
929 acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
930 will call this program with a suitable prompt as command-line argument
931 and read the password from its STDOUT. See also the 'core.askpass'
932 option in linkgit:git-config[1].
934 'GIT_TERMINAL_PROMPT'::
935 If this environment variable is set to `0`, git will not prompt
936 on the terminal (e.g., when asking for HTTP authentication).
938 'GIT_CONFIG_NOSYSTEM'::
939 Whether to skip reading settings from the system-wide
940 `$(prefix)/etc/gitconfig` file. This environment variable can
941 be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
942 predictable environment for a picky script, or you can set it
943 temporarily to avoid using a buggy `/etc/gitconfig` file while
944 waiting for someone with sufficient permissions to fix it.
947 If this environment variable is set to "1", then commands such
948 as 'git blame' (in incremental mode), 'git rev-list', 'git log',
949 'git check-attr' and 'git check-ignore' will
950 force a flush of the output stream after each record have been
952 variable is set to "0", the output of these commands will be done
953 using completely buffered I/O. If this environment variable is
954 not set, Git will choose buffered or record-oriented flushing
955 based on whether stdout appears to be redirected to a file or not.
958 Enables general trace messages, e.g. alias expansion, built-in
959 command execution and external command execution.
961 If this variable is set to "1", "2" or "true" (comparison
962 is case insensitive), trace messages will be printed to
965 If the variable is set to an integer value greater than 2
966 and lower than 10 (strictly) then Git will interpret this
967 value as an open file descriptor and will try to write the
968 trace messages into this file descriptor.
970 Alternatively, if the variable is set to an absolute path
971 (starting with a '/' character), Git will interpret this
972 as a file path and will try to write the trace messages
975 Unsetting the variable, or setting it to empty, "0" or
976 "false" (case insensitive) disables trace messages.
978 'GIT_TRACE_PACK_ACCESS'::
979 Enables trace messages for all accesses to any packs. For each
980 access, the pack file name and an offset in the pack is
981 recorded. This may be helpful for troubleshooting some
982 pack-related performance problems.
983 See 'GIT_TRACE' for available trace output options.
986 Enables trace messages for all packets coming in or out of a
987 given program. This can help with debugging object negotiation
988 or other protocol issues. Tracing is turned off at a packet
989 starting with "PACK".
990 See 'GIT_TRACE' for available trace output options.
992 'GIT_TRACE_PERFORMANCE'::
993 Enables performance related trace messages, e.g. total execution
994 time of each Git command.
995 See 'GIT_TRACE' for available trace output options.
998 Enables trace messages printing the .git, working tree and current
999 working directory after Git has completed its setup phase.
1000 See 'GIT_TRACE' for available trace output options.
1002 'GIT_TRACE_SHALLOW'::
1003 Enables trace messages that can help debugging fetching /
1004 cloning of shallow repositories.
1005 See 'GIT_TRACE' for available trace output options.
1007 GIT_LITERAL_PATHSPECS::
1008 Setting this variable to `1` will cause Git to treat all
1009 pathspecs literally, rather than as glob patterns. For example,
1010 running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
1011 for commits that touch the path `*.c`, not any paths that the
1012 glob `*.c` matches. You might want this if you are feeding
1013 literal paths to Git (e.g., paths previously given to you by
1014 `git ls-tree`, `--raw` diff output, etc).
1016 GIT_GLOB_PATHSPECS::
1017 Setting this variable to `1` will cause Git to treat all
1018 pathspecs as glob patterns (aka "glob" magic).
1020 GIT_NOGLOB_PATHSPECS::
1021 Setting this variable to `1` will cause Git to treat all
1022 pathspecs as literal (aka "literal" magic).
1024 GIT_ICASE_PATHSPECS::
1025 Setting this variable to `1` will cause Git to treat all
1026 pathspecs as case-insensitive.
1028 'GIT_REFLOG_ACTION'::
1029 When a ref is updated, reflog entries are created to keep
1030 track of the reason why the ref was updated (which is
1031 typically the name of the high-level command that updated
1032 the ref), in addition to the old and new values of the ref.
1033 A scripted Porcelain command can use set_reflog_action
1034 helper function in `git-sh-setup` to set its name to this
1035 variable when it is invoked as the top level command by the
1036 end user, to be recorded in the body of the reflog.
1038 `GIT_REF_PARANOIA`::
1039 If set to `1`, include broken or badly named refs when iterating
1040 over lists of refs. In a normal, non-corrupted repository, this
1041 does nothing. However, enabling it may help git to detect and
1042 abort some operations in the presence of broken refs. Git sets
1043 this variable automatically when performing destructive
1044 operations like linkgit:git-prune[1]. You should not need to set
1045 it yourself unless you want to be paranoid about making sure
1046 an operation has touched every ref (e.g., because you are
1047 cloning a repository to make a backup).
1049 `GIT_ALLOW_PROTOCOL`::
1050 If set, provide a colon-separated list of protocols which are
1051 allowed to be used with fetch/push/clone. This is useful to
1052 restrict recursive submodule initialization from an untrusted
1053 repository. Any protocol not mentioned will be disallowed (i.e.,
1054 this is a whitelist, not a blacklist). If the variable is not
1055 set at all, all protocols are enabled. The protocol names
1056 currently used by git are:
1058 - `file`: any local file-based path (including `file://` URLs,
1061 - `git`: the anonymous git protocol over a direct TCP
1062 connection (or proxy, if configured)
1064 - `ssh`: git over ssh (including `host:path` syntax,
1067 - `rsync`: git over rsync
1069 - `http`: git over http, both "smart http" and "dumb http".
1070 Note that this does _not_ include `https`; if you want both,
1071 you should specify both as `http:https`.
1073 - any external helpers are named by their protocol (e.g., use
1074 `hg` to allow the `git-remote-hg` helper)
1077 Discussion[[Discussion]]
1078 ------------------------
1080 More detail on the following is available from the
1081 link:user-manual.html#git-concepts[Git concepts chapter of the
1082 user-manual] and linkgit:gitcore-tutorial[7].
1084 A Git project normally consists of a working directory with a ".git"
1085 subdirectory at the top level. The .git directory contains, among other
1086 things, a compressed object database representing the complete history
1087 of the project, an "index" file which links that history to the current
1088 contents of the working tree, and named pointers into that history such
1089 as tags and branch heads.
1091 The object database contains objects of three main types: blobs, which
1092 hold file data; trees, which point to blobs and other trees to build up
1093 directory hierarchies; and commits, which each reference a single tree
1094 and some number of parent commits.
1096 The commit, equivalent to what other systems call a "changeset" or
1097 "version", represents a step in the project's history, and each parent
1098 represents an immediately preceding step. Commits with more than one
1099 parent represent merges of independent lines of development.
1101 All objects are named by the SHA-1 hash of their contents, normally
1102 written as a string of 40 hex digits. Such names are globally unique.
1103 The entire history leading up to a commit can be vouched for by signing
1104 just that commit. A fourth object type, the tag, is provided for this
1107 When first created, objects are stored in individual files, but for
1108 efficiency may later be compressed together into "pack files".
1110 Named pointers called refs mark interesting points in history. A ref
1111 may contain the SHA-1 name of an object or the name of another ref. Refs
1112 with names beginning `ref/head/` contain the SHA-1 name of the most
1113 recent commit (or "head") of a branch under development. SHA-1 names of
1114 tags of interest are stored under `ref/tags/`. A special ref named
1115 `HEAD` contains the name of the currently checked-out branch.
1117 The index file is initialized with a list of all paths and, for each
1118 path, a blob object and a set of attributes. The blob object represents
1119 the contents of the file as of the head of the current branch. The
1120 attributes (last modified time, size, etc.) are taken from the
1121 corresponding file in the working tree. Subsequent changes to the
1122 working tree can be found by comparing these attributes. The index may
1123 be updated with new content, and new commits may be created from the
1124 content stored in the index.
1126 The index is also capable of storing multiple entries (called "stages")
1127 for a given pathname. These stages are used to hold the various
1128 unmerged version of a file when a merge is in progress.
1130 FURTHER DOCUMENTATION
1131 ---------------------
1133 See the references in the "description" section to get started
1134 using Git. The following is probably more detail than necessary
1135 for a first-time user.
1137 The link:user-manual.html#git-concepts[Git concepts chapter of the
1138 user-manual] and linkgit:gitcore-tutorial[7] both provide
1139 introductions to the underlying Git architecture.
1141 See linkgit:gitworkflows[7] for an overview of recommended workflows.
1143 See also the link:howto-index.html[howto] documents for some useful
1146 The internals are documented in the
1147 link:technical/api-index.html[Git API documentation].
1149 Users migrating from CVS may also want to
1150 read linkgit:gitcvs-migration[7].
1155 Git was started by Linus Torvalds, and is currently maintained by Junio
1156 C Hamano. Numerous contributions have come from the Git mailing list
1157 <git@vger.kernel.org>. http://www.openhub.net/p/git/contributors/summary
1158 gives you a more complete list of contributors.
1160 If you have a clone of git.git itself, the
1161 output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
1162 the authors for specific parts of the project.
1167 Report bugs to the Git mailing list <git@vger.kernel.org> where the
1168 development and maintenance is primarily done. You do not have to be
1169 subscribed to the list to send a message there.
1173 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
1174 linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
1175 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
1176 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
1177 linkgit:gitworkflows[7]
1181 Part of the linkgit:git[1] suite