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.5.1/git.html[documentation for release 2.5.1]
49 link:RelNotes/2.5.1.txt[2.5.1],
50 link:RelNotes/2.5.0.txt[2.5].
52 * link:v2.4.8/git.html[documentation for release 2.4.8]
55 link:RelNotes/2.4.8.txt[2.4.8],
56 link:RelNotes/2.4.7.txt[2.4.7],
57 link:RelNotes/2.4.6.txt[2.4.6],
58 link:RelNotes/2.4.5.txt[2.4.5],
59 link:RelNotes/2.4.4.txt[2.4.4],
60 link:RelNotes/2.4.3.txt[2.4.3],
61 link:RelNotes/2.4.2.txt[2.4.2],
62 link:RelNotes/2.4.1.txt[2.4.1],
63 link:RelNotes/2.4.0.txt[2.4].
65 * link:v2.3.8/git.html[documentation for release 2.3.8]
68 link:RelNotes/2.3.8.txt[2.3.8],
69 link:RelNotes/2.3.7.txt[2.3.7],
70 link:RelNotes/2.3.6.txt[2.3.6],
71 link:RelNotes/2.3.5.txt[2.3.5],
72 link:RelNotes/2.3.4.txt[2.3.4],
73 link:RelNotes/2.3.3.txt[2.3.3],
74 link:RelNotes/2.3.2.txt[2.3.2],
75 link:RelNotes/2.3.1.txt[2.3.1],
76 link:RelNotes/2.3.0.txt[2.3].
78 * link:v2.2.2/git.html[documentation for release 2.2.2]
81 link:RelNotes/2.2.2.txt[2.2.2],
82 link:RelNotes/2.2.1.txt[2.2.1],
83 link:RelNotes/2.2.0.txt[2.2].
85 * link:v2.1.4/git.html[documentation for release 2.1.4]
88 link:RelNotes/2.1.4.txt[2.1.4],
89 link:RelNotes/2.1.3.txt[2.1.3],
90 link:RelNotes/2.1.2.txt[2.1.2],
91 link:RelNotes/2.1.1.txt[2.1.1],
92 link:RelNotes/2.1.0.txt[2.1].
94 * link:v2.0.5/git.html[documentation for release 2.0.5]
97 link:RelNotes/2.0.5.txt[2.0.5],
98 link:RelNotes/2.0.4.txt[2.0.4],
99 link:RelNotes/2.0.3.txt[2.0.3],
100 link:RelNotes/2.0.2.txt[2.0.2],
101 link:RelNotes/2.0.1.txt[2.0.1],
102 link:RelNotes/2.0.0.txt[2.0.0].
104 * link:v1.9.5/git.html[documentation for release 1.9.5]
107 link:RelNotes/1.9.5.txt[1.9.5],
108 link:RelNotes/1.9.4.txt[1.9.4],
109 link:RelNotes/1.9.3.txt[1.9.3],
110 link:RelNotes/1.9.2.txt[1.9.2],
111 link:RelNotes/1.9.1.txt[1.9.1],
112 link:RelNotes/1.9.0.txt[1.9.0].
114 * link:v1.8.5.6/git.html[documentation for release 1.8.5.6]
117 link:RelNotes/1.8.5.6.txt[1.8.5.6],
118 link:RelNotes/1.8.5.5.txt[1.8.5.5],
119 link:RelNotes/1.8.5.4.txt[1.8.5.4],
120 link:RelNotes/1.8.5.3.txt[1.8.5.3],
121 link:RelNotes/1.8.5.2.txt[1.8.5.2],
122 link:RelNotes/1.8.5.1.txt[1.8.5.1],
123 link:RelNotes/1.8.5.txt[1.8.5].
125 * link:v1.8.4.5/git.html[documentation for release 1.8.4.5]
128 link:RelNotes/1.8.4.5.txt[1.8.4.5],
129 link:RelNotes/1.8.4.4.txt[1.8.4.4],
130 link:RelNotes/1.8.4.3.txt[1.8.4.3],
131 link:RelNotes/1.8.4.2.txt[1.8.4.2],
132 link:RelNotes/1.8.4.1.txt[1.8.4.1],
133 link:RelNotes/1.8.4.txt[1.8.4].
135 * link:v1.8.3.4/git.html[documentation for release 1.8.3.4]
138 link:RelNotes/1.8.3.4.txt[1.8.3.4],
139 link:RelNotes/1.8.3.3.txt[1.8.3.3],
140 link:RelNotes/1.8.3.2.txt[1.8.3.2],
141 link:RelNotes/1.8.3.1.txt[1.8.3.1],
142 link:RelNotes/1.8.3.txt[1.8.3].
144 * link:v1.8.2.3/git.html[documentation for release 1.8.2.3]
147 link:RelNotes/1.8.2.3.txt[1.8.2.3],
148 link:RelNotes/1.8.2.2.txt[1.8.2.2],
149 link:RelNotes/1.8.2.1.txt[1.8.2.1],
150 link:RelNotes/1.8.2.txt[1.8.2].
152 * link:v1.8.1.6/git.html[documentation for release 1.8.1.6]
155 link:RelNotes/1.8.1.6.txt[1.8.1.6],
156 link:RelNotes/1.8.1.5.txt[1.8.1.5],
157 link:RelNotes/1.8.1.4.txt[1.8.1.4],
158 link:RelNotes/1.8.1.3.txt[1.8.1.3],
159 link:RelNotes/1.8.1.2.txt[1.8.1.2],
160 link:RelNotes/1.8.1.1.txt[1.8.1.1],
161 link:RelNotes/1.8.1.txt[1.8.1].
163 * link:v1.8.0.3/git.html[documentation for release 1.8.0.3]
166 link:RelNotes/1.8.0.3.txt[1.8.0.3],
167 link:RelNotes/1.8.0.2.txt[1.8.0.2],
168 link:RelNotes/1.8.0.1.txt[1.8.0.1],
169 link:RelNotes/1.8.0.txt[1.8.0].
171 * link:v1.7.12.4/git.html[documentation for release 1.7.12.4]
174 link:RelNotes/1.7.12.4.txt[1.7.12.4],
175 link:RelNotes/1.7.12.3.txt[1.7.12.3],
176 link:RelNotes/1.7.12.2.txt[1.7.12.2],
177 link:RelNotes/1.7.12.1.txt[1.7.12.1],
178 link:RelNotes/1.7.12.txt[1.7.12].
180 * link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
183 link:RelNotes/1.7.11.7.txt[1.7.11.7],
184 link:RelNotes/1.7.11.6.txt[1.7.11.6],
185 link:RelNotes/1.7.11.5.txt[1.7.11.5],
186 link:RelNotes/1.7.11.4.txt[1.7.11.4],
187 link:RelNotes/1.7.11.3.txt[1.7.11.3],
188 link:RelNotes/1.7.11.2.txt[1.7.11.2],
189 link:RelNotes/1.7.11.1.txt[1.7.11.1],
190 link:RelNotes/1.7.11.txt[1.7.11].
192 * link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
195 link:RelNotes/1.7.10.5.txt[1.7.10.5],
196 link:RelNotes/1.7.10.4.txt[1.7.10.4],
197 link:RelNotes/1.7.10.3.txt[1.7.10.3],
198 link:RelNotes/1.7.10.2.txt[1.7.10.2],
199 link:RelNotes/1.7.10.1.txt[1.7.10.1],
200 link:RelNotes/1.7.10.txt[1.7.10].
202 * link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
205 link:RelNotes/1.7.9.7.txt[1.7.9.7],
206 link:RelNotes/1.7.9.6.txt[1.7.9.6],
207 link:RelNotes/1.7.9.5.txt[1.7.9.5],
208 link:RelNotes/1.7.9.4.txt[1.7.9.4],
209 link:RelNotes/1.7.9.3.txt[1.7.9.3],
210 link:RelNotes/1.7.9.2.txt[1.7.9.2],
211 link:RelNotes/1.7.9.1.txt[1.7.9.1],
212 link:RelNotes/1.7.9.txt[1.7.9].
214 * link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
217 link:RelNotes/1.7.8.6.txt[1.7.8.6],
218 link:RelNotes/1.7.8.5.txt[1.7.8.5],
219 link:RelNotes/1.7.8.4.txt[1.7.8.4],
220 link:RelNotes/1.7.8.3.txt[1.7.8.3],
221 link:RelNotes/1.7.8.2.txt[1.7.8.2],
222 link:RelNotes/1.7.8.1.txt[1.7.8.1],
223 link:RelNotes/1.7.8.txt[1.7.8].
225 * link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
228 link:RelNotes/1.7.7.7.txt[1.7.7.7],
229 link:RelNotes/1.7.7.6.txt[1.7.7.6],
230 link:RelNotes/1.7.7.5.txt[1.7.7.5],
231 link:RelNotes/1.7.7.4.txt[1.7.7.4],
232 link:RelNotes/1.7.7.3.txt[1.7.7.3],
233 link:RelNotes/1.7.7.2.txt[1.7.7.2],
234 link:RelNotes/1.7.7.1.txt[1.7.7.1],
235 link:RelNotes/1.7.7.txt[1.7.7].
237 * link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
240 link:RelNotes/1.7.6.6.txt[1.7.6.6],
241 link:RelNotes/1.7.6.5.txt[1.7.6.5],
242 link:RelNotes/1.7.6.4.txt[1.7.6.4],
243 link:RelNotes/1.7.6.3.txt[1.7.6.3],
244 link:RelNotes/1.7.6.2.txt[1.7.6.2],
245 link:RelNotes/1.7.6.1.txt[1.7.6.1],
246 link:RelNotes/1.7.6.txt[1.7.6].
248 * link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
251 link:RelNotes/1.7.5.4.txt[1.7.5.4],
252 link:RelNotes/1.7.5.3.txt[1.7.5.3],
253 link:RelNotes/1.7.5.2.txt[1.7.5.2],
254 link:RelNotes/1.7.5.1.txt[1.7.5.1],
255 link:RelNotes/1.7.5.txt[1.7.5].
257 * link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
260 link:RelNotes/1.7.4.5.txt[1.7.4.5],
261 link:RelNotes/1.7.4.4.txt[1.7.4.4],
262 link:RelNotes/1.7.4.3.txt[1.7.4.3],
263 link:RelNotes/1.7.4.2.txt[1.7.4.2],
264 link:RelNotes/1.7.4.1.txt[1.7.4.1],
265 link:RelNotes/1.7.4.txt[1.7.4].
267 * link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
270 link:RelNotes/1.7.3.5.txt[1.7.3.5],
271 link:RelNotes/1.7.3.4.txt[1.7.3.4],
272 link:RelNotes/1.7.3.3.txt[1.7.3.3],
273 link:RelNotes/1.7.3.2.txt[1.7.3.2],
274 link:RelNotes/1.7.3.1.txt[1.7.3.1],
275 link:RelNotes/1.7.3.txt[1.7.3].
277 * link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
280 link:RelNotes/1.7.2.5.txt[1.7.2.5],
281 link:RelNotes/1.7.2.4.txt[1.7.2.4],
282 link:RelNotes/1.7.2.3.txt[1.7.2.3],
283 link:RelNotes/1.7.2.2.txt[1.7.2.2],
284 link:RelNotes/1.7.2.1.txt[1.7.2.1],
285 link:RelNotes/1.7.2.txt[1.7.2].
287 * link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
290 link:RelNotes/1.7.1.4.txt[1.7.1.4],
291 link:RelNotes/1.7.1.3.txt[1.7.1.3],
292 link:RelNotes/1.7.1.2.txt[1.7.1.2],
293 link:RelNotes/1.7.1.1.txt[1.7.1.1],
294 link:RelNotes/1.7.1.txt[1.7.1].
296 * link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
299 link:RelNotes/1.7.0.9.txt[1.7.0.9],
300 link:RelNotes/1.7.0.8.txt[1.7.0.8],
301 link:RelNotes/1.7.0.7.txt[1.7.0.7],
302 link:RelNotes/1.7.0.6.txt[1.7.0.6],
303 link:RelNotes/1.7.0.5.txt[1.7.0.5],
304 link:RelNotes/1.7.0.4.txt[1.7.0.4],
305 link:RelNotes/1.7.0.3.txt[1.7.0.3],
306 link:RelNotes/1.7.0.2.txt[1.7.0.2],
307 link:RelNotes/1.7.0.1.txt[1.7.0.1],
308 link:RelNotes/1.7.0.txt[1.7.0].
310 * link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
313 link:RelNotes/1.6.6.3.txt[1.6.6.3],
314 link:RelNotes/1.6.6.2.txt[1.6.6.2],
315 link:RelNotes/1.6.6.1.txt[1.6.6.1],
316 link:RelNotes/1.6.6.txt[1.6.6].
318 * link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
321 link:RelNotes/1.6.5.9.txt[1.6.5.9],
322 link:RelNotes/1.6.5.8.txt[1.6.5.8],
323 link:RelNotes/1.6.5.7.txt[1.6.5.7],
324 link:RelNotes/1.6.5.6.txt[1.6.5.6],
325 link:RelNotes/1.6.5.5.txt[1.6.5.5],
326 link:RelNotes/1.6.5.4.txt[1.6.5.4],
327 link:RelNotes/1.6.5.3.txt[1.6.5.3],
328 link:RelNotes/1.6.5.2.txt[1.6.5.2],
329 link:RelNotes/1.6.5.1.txt[1.6.5.1],
330 link:RelNotes/1.6.5.txt[1.6.5].
332 * link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
335 link:RelNotes/1.6.4.5.txt[1.6.4.5],
336 link:RelNotes/1.6.4.4.txt[1.6.4.4],
337 link:RelNotes/1.6.4.3.txt[1.6.4.3],
338 link:RelNotes/1.6.4.2.txt[1.6.4.2],
339 link:RelNotes/1.6.4.1.txt[1.6.4.1],
340 link:RelNotes/1.6.4.txt[1.6.4].
342 * link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
345 link:RelNotes/1.6.3.4.txt[1.6.3.4],
346 link:RelNotes/1.6.3.3.txt[1.6.3.3],
347 link:RelNotes/1.6.3.2.txt[1.6.3.2],
348 link:RelNotes/1.6.3.1.txt[1.6.3.1],
349 link:RelNotes/1.6.3.txt[1.6.3].
352 link:RelNotes/1.6.2.5.txt[1.6.2.5],
353 link:RelNotes/1.6.2.4.txt[1.6.2.4],
354 link:RelNotes/1.6.2.3.txt[1.6.2.3],
355 link:RelNotes/1.6.2.2.txt[1.6.2.2],
356 link:RelNotes/1.6.2.1.txt[1.6.2.1],
357 link:RelNotes/1.6.2.txt[1.6.2].
359 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
362 link:RelNotes/1.6.1.3.txt[1.6.1.3],
363 link:RelNotes/1.6.1.2.txt[1.6.1.2],
364 link:RelNotes/1.6.1.1.txt[1.6.1.1],
365 link:RelNotes/1.6.1.txt[1.6.1].
367 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
370 link:RelNotes/1.6.0.6.txt[1.6.0.6],
371 link:RelNotes/1.6.0.5.txt[1.6.0.5],
372 link:RelNotes/1.6.0.4.txt[1.6.0.4],
373 link:RelNotes/1.6.0.3.txt[1.6.0.3],
374 link:RelNotes/1.6.0.2.txt[1.6.0.2],
375 link:RelNotes/1.6.0.1.txt[1.6.0.1],
376 link:RelNotes/1.6.0.txt[1.6.0].
378 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
381 link:RelNotes/1.5.6.6.txt[1.5.6.6],
382 link:RelNotes/1.5.6.5.txt[1.5.6.5],
383 link:RelNotes/1.5.6.4.txt[1.5.6.4],
384 link:RelNotes/1.5.6.3.txt[1.5.6.3],
385 link:RelNotes/1.5.6.2.txt[1.5.6.2],
386 link:RelNotes/1.5.6.1.txt[1.5.6.1],
387 link:RelNotes/1.5.6.txt[1.5.6].
389 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
392 link:RelNotes/1.5.5.6.txt[1.5.5.6],
393 link:RelNotes/1.5.5.5.txt[1.5.5.5],
394 link:RelNotes/1.5.5.4.txt[1.5.5.4],
395 link:RelNotes/1.5.5.3.txt[1.5.5.3],
396 link:RelNotes/1.5.5.2.txt[1.5.5.2],
397 link:RelNotes/1.5.5.1.txt[1.5.5.1],
398 link:RelNotes/1.5.5.txt[1.5.5].
400 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
403 link:RelNotes/1.5.4.7.txt[1.5.4.7],
404 link:RelNotes/1.5.4.6.txt[1.5.4.6],
405 link:RelNotes/1.5.4.5.txt[1.5.4.5],
406 link:RelNotes/1.5.4.4.txt[1.5.4.4],
407 link:RelNotes/1.5.4.3.txt[1.5.4.3],
408 link:RelNotes/1.5.4.2.txt[1.5.4.2],
409 link:RelNotes/1.5.4.1.txt[1.5.4.1],
410 link:RelNotes/1.5.4.txt[1.5.4].
412 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
415 link:RelNotes/1.5.3.8.txt[1.5.3.8],
416 link:RelNotes/1.5.3.7.txt[1.5.3.7],
417 link:RelNotes/1.5.3.6.txt[1.5.3.6],
418 link:RelNotes/1.5.3.5.txt[1.5.3.5],
419 link:RelNotes/1.5.3.4.txt[1.5.3.4],
420 link:RelNotes/1.5.3.3.txt[1.5.3.3],
421 link:RelNotes/1.5.3.2.txt[1.5.3.2],
422 link:RelNotes/1.5.3.1.txt[1.5.3.1],
423 link:RelNotes/1.5.3.txt[1.5.3].
425 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
428 link:RelNotes/1.5.2.5.txt[1.5.2.5],
429 link:RelNotes/1.5.2.4.txt[1.5.2.4],
430 link:RelNotes/1.5.2.3.txt[1.5.2.3],
431 link:RelNotes/1.5.2.2.txt[1.5.2.2],
432 link:RelNotes/1.5.2.1.txt[1.5.2.1],
433 link:RelNotes/1.5.2.txt[1.5.2].
435 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
438 link:RelNotes/1.5.1.6.txt[1.5.1.6],
439 link:RelNotes/1.5.1.5.txt[1.5.1.5],
440 link:RelNotes/1.5.1.4.txt[1.5.1.4],
441 link:RelNotes/1.5.1.3.txt[1.5.1.3],
442 link:RelNotes/1.5.1.2.txt[1.5.1.2],
443 link:RelNotes/1.5.1.1.txt[1.5.1.1],
444 link:RelNotes/1.5.1.txt[1.5.1].
446 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
449 link:RelNotes/1.5.0.7.txt[1.5.0.7],
450 link:RelNotes/1.5.0.6.txt[1.5.0.6],
451 link:RelNotes/1.5.0.5.txt[1.5.0.5],
452 link:RelNotes/1.5.0.3.txt[1.5.0.3],
453 link:RelNotes/1.5.0.2.txt[1.5.0.2],
454 link:RelNotes/1.5.0.1.txt[1.5.0.1],
455 link:RelNotes/1.5.0.txt[1.5.0].
457 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
458 link:v1.3.3/git.html[1.3.3],
459 link:v1.2.6/git.html[1.2.6],
460 link:v1.0.13/git.html[1.0.13].
469 Prints the Git suite version that the 'git' program came from.
472 Prints the synopsis and a list of the most commonly used
473 commands. If the option '--all' or '-a' is given then all
474 available commands are printed. If a Git command is named this
475 option will bring up the manual page for that command.
477 Other options are available to control how the manual page is
478 displayed. See linkgit:git-help[1] for more information,
479 because `git --help ...` is converted internally into `git
483 Run as if git was started in '<path>' instead of the current working
484 directory. When multiple `-C` options are given, each subsequent
485 non-absolute `-C <path>` is interpreted relative to the preceding `-C
488 This option affects options that expect path name like `--git-dir` and
489 `--work-tree` in that their interpretations of the path names would be
490 made relative to the working directory caused by the `-C` option. For
491 example the following invocations are equivalent:
493 git --git-dir=a.git --work-tree=b -C c status
494 git --git-dir=c/a.git --work-tree=c/b status
497 Pass a configuration parameter to the command. The value
498 given will override values from configuration files.
499 The <name> is expected in the same format as listed by
500 'git config' (subkeys separated by dots).
502 Note that omitting the `=` in `git -c foo.bar ...` is allowed and sets
503 `foo.bar` to the boolean true value (just like `[foo]bar` would in a
504 config file). Including the equals but with an empty value (like `git -c
505 foo.bar= ...`) sets `foo.bar` to the empty string.
507 --exec-path[=<path>]::
508 Path to wherever your core Git programs are installed.
509 This can also be controlled by setting the GIT_EXEC_PATH
510 environment variable. If no path is given, 'git' will print
511 the current setting and then exit.
514 Print the path, without trailing slash, where Git's HTML
515 documentation is installed and exit.
518 Print the manpath (see `man(1)`) for the man pages for
519 this version of Git and exit.
522 Print the path where the Info files documenting this
523 version of Git are installed and exit.
527 Pipe all output into 'less' (or if set, $PAGER) if standard
528 output is a terminal. This overrides the `pager.<cmd>`
529 configuration options (see the "Configuration Mechanism" section
533 Do not pipe Git output into a pager.
536 Set the path to the repository. This can also be controlled by
537 setting the GIT_DIR environment variable. It can be an absolute
538 path or relative path to current working directory.
541 Set the path to the working tree. It can be an absolute path
542 or a path relative to the current working directory.
543 This can also be controlled by setting the GIT_WORK_TREE
544 environment variable and the core.worktree configuration
545 variable (see core.worktree in linkgit:git-config[1] for a
546 more detailed discussion).
549 Set the Git namespace. See linkgit:gitnamespaces[7] for more
550 details. Equivalent to setting the `GIT_NAMESPACE` environment
554 Treat the repository as a bare repository. If GIT_DIR
555 environment is not set, it is set to the current working
558 --no-replace-objects::
559 Do not use replacement refs to replace Git objects. See
560 linkgit:git-replace[1] for more information.
562 --literal-pathspecs::
563 Treat pathspecs literally (i.e. no globbing, no pathspec magic).
564 This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
568 Add "glob" magic to all pathspec. This is equivalent to setting
569 the `GIT_GLOB_PATHSPECS` environment variable to `1`. Disabling
570 globbing on individual pathspecs can be done using pathspec
574 Add "literal" magic to all pathspec. This is equivalent to setting
575 the `GIT_NOGLOB_PATHSPECS` environment variable to `1`. Enabling
576 globbing on individual pathspecs can be done using pathspec
580 Add "icase" magic to all pathspec. This is equivalent to setting
581 the `GIT_ICASE_PATHSPECS` environment variable to `1`.
586 We divide Git into high level ("porcelain") commands and low level
587 ("plumbing") commands.
589 High-level commands (porcelain)
590 -------------------------------
592 We separate the porcelain commands into the main commands and some
593 ancillary user utilities.
595 Main porcelain commands
596 ~~~~~~~~~~~~~~~~~~~~~~~
598 include::cmds-mainporcelain.txt[]
604 include::cmds-ancillarymanipulators.txt[]
608 include::cmds-ancillaryinterrogators.txt[]
611 Interacting with Others
612 ~~~~~~~~~~~~~~~~~~~~~~~
614 These commands are to interact with foreign SCM and with other
615 people via patch over e-mail.
617 include::cmds-foreignscminterface.txt[]
620 Low-level commands (plumbing)
621 -----------------------------
623 Although Git includes its
624 own porcelain layer, its low-level commands are sufficient to support
625 development of alternative porcelains. Developers of such porcelains
626 might start by reading about linkgit:git-update-index[1] and
627 linkgit:git-read-tree[1].
629 The interface (input, output, set of options and the semantics)
630 to these low-level commands are meant to be a lot more stable
631 than Porcelain level commands, because these commands are
632 primarily for scripted use. The interface to Porcelain commands
633 on the other hand are subject to change in order to improve the
636 The following description divides
637 the low-level commands into commands that manipulate objects (in
638 the repository, index, and working tree), commands that interrogate and
639 compare objects, and commands that move objects and references between
643 Manipulation commands
644 ~~~~~~~~~~~~~~~~~~~~~
646 include::cmds-plumbingmanipulators.txt[]
649 Interrogation commands
650 ~~~~~~~~~~~~~~~~~~~~~~
652 include::cmds-plumbinginterrogators.txt[]
654 In general, the interrogate commands do not touch the files in
658 Synching repositories
659 ~~~~~~~~~~~~~~~~~~~~~
661 include::cmds-synchingrepositories.txt[]
663 The following are helper commands used by the above; end users
664 typically do not use them directly.
666 include::cmds-synchelpers.txt[]
669 Internal helper commands
670 ~~~~~~~~~~~~~~~~~~~~~~~~
672 These are internal helper commands used by other commands; end
673 users typically do not use them directly.
675 include::cmds-purehelpers.txt[]
678 Configuration Mechanism
679 -----------------------
681 Git uses a simple text format to store customizations that are per
682 repository and are per user. Such a configuration file may look
687 # A '#' or ';' character indicates a comment.
692 ; Don't trust file modes
697 name = "Junio C Hamano"
698 email = "gitster@pobox.com"
702 Various commands read from the configuration file and adjust
703 their operation accordingly. See linkgit:git-config[1] for a
704 list and more details about the configuration mechanism.
707 Identifier Terminology
708 ----------------------
710 Indicates the object name for any type of object.
713 Indicates a blob object name.
716 Indicates a tree object name.
719 Indicates a commit object name.
722 Indicates a tree, commit or tag object name. A
723 command that takes a <tree-ish> argument ultimately wants to
724 operate on a <tree> object but automatically dereferences
725 <commit> and <tag> objects that point at a <tree>.
728 Indicates a commit or tag object name. A
729 command that takes a <commit-ish> argument ultimately wants to
730 operate on a <commit> object but automatically dereferences
731 <tag> objects that point at a <commit>.
734 Indicates that an object type is required.
735 Currently one of: `blob`, `tree`, `commit`, or `tag`.
738 Indicates a filename - almost always relative to the
739 root of the tree structure `GIT_INDEX_FILE` describes.
743 Any Git command accepting any <object> can also use the following
747 indicates the head of the current branch.
751 (i.e. a `refs/tags/<tag>` reference).
755 (i.e. a `refs/heads/<head>` reference).
757 For a more complete list of ways to spell object names, see
758 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
761 File/Directory Structure
762 ------------------------
764 Please see the linkgit:gitrepository-layout[5] document.
766 Read linkgit:githooks[5] for more details about each hook.
768 Higher level SCMs may provide and manage additional information in the
774 Please see linkgit:gitglossary[7].
777 Environment Variables
778 ---------------------
779 Various Git commands use the following environment variables:
783 These environment variables apply to 'all' core Git commands. Nb: it
784 is worth noting that they may be used/overridden by SCMS sitting above
785 Git so take care if using a foreign front-end.
788 This environment allows the specification of an alternate
789 index file. If not specified, the default of `$GIT_DIR/index`
792 'GIT_INDEX_VERSION'::
793 This environment variable allows the specification of an index
794 version for new repositories. It won't affect existing index
795 files. By default index file version 2 or 3 is used. See
796 linkgit:git-update-index[1] for more information.
798 'GIT_OBJECT_DIRECTORY'::
799 If the object storage directory is specified via this
800 environment variable then the sha1 directories are created
801 underneath - otherwise the default `$GIT_DIR/objects`
804 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
805 Due to the immutable nature of Git objects, old objects can be
806 archived into shared, read-only directories. This variable
807 specifies a ":" separated (on Windows ";" separated) list
808 of Git object directories which can be used to search for Git
809 objects. New objects will not be written to these directories.
812 If the 'GIT_DIR' environment variable is set then it
813 specifies a path to use instead of the default `.git`
814 for the base of the repository.
815 The '--git-dir' command-line option also sets this value.
818 Set the path to the root of the working tree.
819 This can also be controlled by the '--work-tree' command-line
820 option and the core.worktree configuration variable.
823 Set the Git namespace; see linkgit:gitnamespaces[7] for details.
824 The '--namespace' command-line option also sets this value.
826 'GIT_CEILING_DIRECTORIES'::
827 This should be a colon-separated list of absolute paths. If
828 set, it is a list of directories that Git should not chdir up
829 into while looking for a repository directory (useful for
830 excluding slow-loading network directories). It will not
831 exclude the current working directory or a GIT_DIR set on the
832 command line or in the environment. Normally, Git has to read
833 the entries in this list and resolve any symlink that
834 might be present in order to compare them with the current
835 directory. However, if even this access is slow, you
836 can add an empty entry to the list to tell Git that the
837 subsequent entries are not symlinks and needn't be resolved;
839 'GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink'.
841 'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
842 When run in a directory that does not have ".git" repository
843 directory, Git tries to find such a directory in the parent
844 directories to find the top of the working tree, but by default it
845 does not cross filesystem boundaries. This environment variable
846 can be set to true to tell Git not to stop at filesystem
847 boundaries. Like 'GIT_CEILING_DIRECTORIES', this will not affect
848 an explicit repository directory set via 'GIT_DIR' or on the
852 If this variable is set to a path, non-worktree files that are
853 normally in $GIT_DIR will be taken from this path
854 instead. Worktree-specific files such as HEAD or index are
855 taken from $GIT_DIR. See linkgit:gitrepository-layout[5] and
856 linkgit:git-worktree[1] for
857 details. This variable has lower precedence than other path
858 variables such as GIT_INDEX_FILE, GIT_OBJECT_DIRECTORY...
865 'GIT_COMMITTER_NAME'::
866 'GIT_COMMITTER_EMAIL'::
867 'GIT_COMMITTER_DATE'::
869 see linkgit:git-commit-tree[1]
874 Only valid setting is "--unified=??" or "-u??" to set the
875 number of context lines shown when a unified diff is created.
876 This takes precedence over any "-U" or "--unified" option
877 value passed on the Git diff command line.
879 'GIT_EXTERNAL_DIFF'::
880 When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
881 program named by it is called, instead of the diff invocation
882 described above. For a path that is added, removed, or modified,
883 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
885 path old-file old-hex old-mode new-file new-hex new-mode
889 <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
890 contents of <old|new>,
891 <old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
892 <old|new>-mode:: are the octal representation of the file modes.
894 The file parameters can point at the user's working file
895 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
896 when a new file is added), or a temporary file (e.g. `old-file` in the
897 index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
898 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
900 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
903 For each path 'GIT_EXTERNAL_DIFF' is called, two environment variables,
904 'GIT_DIFF_PATH_COUNTER' and 'GIT_DIFF_PATH_TOTAL' are set.
906 'GIT_DIFF_PATH_COUNTER'::
907 A 1-based counter incremented by one for every path.
909 'GIT_DIFF_PATH_TOTAL'::
910 The total number of paths.
914 'GIT_MERGE_VERBOSITY'::
915 A number controlling the amount of output shown by
916 the recursive merge strategy. Overrides merge.verbosity.
917 See linkgit:git-merge[1]
920 This environment variable overrides `$PAGER`. If it is set
921 to an empty string or to the value "cat", Git will not launch
922 a pager. See also the `core.pager` option in
923 linkgit:git-config[1].
926 This environment variable overrides `$EDITOR` and `$VISUAL`.
927 It is used by several Git commands when, on interactive mode,
928 an editor is to be launched. See also linkgit:git-var[1]
929 and the `core.editor` option in linkgit:git-config[1].
933 If either of these environment variables is set then 'git fetch'
934 and 'git push' will use the specified command instead of 'ssh'
935 when they need to connect to a remote system.
936 The command will be given exactly two or four arguments: the
937 'username@host' (or just 'host') from the URL and the shell
938 command to execute on that remote system, optionally preceded by
939 '-p' (literally) and the 'port' from the URL when it specifies
940 something other than the default SSH port.
942 `$GIT_SSH_COMMAND` takes precedence over `$GIT_SSH`, and is interpreted
943 by the shell, which allows additional arguments to be included.
944 `$GIT_SSH` on the other hand must be just the path to a program
945 (which can be a wrapper shell script, if additional arguments are
948 Usually it is easier to configure any desired options through your
949 personal `.ssh/config` file. Please consult your ssh documentation
953 If this environment variable is set, then Git commands which need to
954 acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
955 will call this program with a suitable prompt as command-line argument
956 and read the password from its STDOUT. See also the 'core.askPass'
957 option in linkgit:git-config[1].
959 'GIT_TERMINAL_PROMPT'::
960 If this environment variable is set to `0`, git will not prompt
961 on the terminal (e.g., when asking for HTTP authentication).
963 'GIT_CONFIG_NOSYSTEM'::
964 Whether to skip reading settings from the system-wide
965 `$(prefix)/etc/gitconfig` file. This environment variable can
966 be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
967 predictable environment for a picky script, or you can set it
968 temporarily to avoid using a buggy `/etc/gitconfig` file while
969 waiting for someone with sufficient permissions to fix it.
972 If this environment variable is set to "1", then commands such
973 as 'git blame' (in incremental mode), 'git rev-list', 'git log',
974 'git check-attr' and 'git check-ignore' will
975 force a flush of the output stream after each record have been
977 variable is set to "0", the output of these commands will be done
978 using completely buffered I/O. If this environment variable is
979 not set, Git will choose buffered or record-oriented flushing
980 based on whether stdout appears to be redirected to a file or not.
983 Enables general trace messages, e.g. alias expansion, built-in
984 command execution and external command execution.
986 If this variable is set to "1", "2" or "true" (comparison
987 is case insensitive), trace messages will be printed to
990 If the variable is set to an integer value greater than 2
991 and lower than 10 (strictly) then Git will interpret this
992 value as an open file descriptor and will try to write the
993 trace messages into this file descriptor.
995 Alternatively, if the variable is set to an absolute path
996 (starting with a '/' character), Git will interpret this
997 as a file path and will try to write the trace messages
1000 Unsetting the variable, or setting it to empty, "0" or
1001 "false" (case insensitive) disables trace messages.
1003 'GIT_TRACE_PACK_ACCESS'::
1004 Enables trace messages for all accesses to any packs. For each
1005 access, the pack file name and an offset in the pack is
1006 recorded. This may be helpful for troubleshooting some
1007 pack-related performance problems.
1008 See 'GIT_TRACE' for available trace output options.
1010 'GIT_TRACE_PACKET'::
1011 Enables trace messages for all packets coming in or out of a
1012 given program. This can help with debugging object negotiation
1013 or other protocol issues. Tracing is turned off at a packet
1014 starting with "PACK" (but see 'GIT_TRACE_PACKFILE' below).
1015 See 'GIT_TRACE' for available trace output options.
1017 'GIT_TRACE_PACKFILE'::
1018 Enables tracing of packfiles sent or received by a
1019 given program. Unlike other trace output, this trace is
1020 verbatim: no headers, and no quoting of binary data. You almost
1021 certainly want to direct into a file (e.g.,
1022 `GIT_TRACE_PACKFILE=/tmp/my.pack`) rather than displaying it on
1023 the terminal or mixing it with other trace output.
1025 Note that this is currently only implemented for the client side
1026 of clones and fetches.
1028 'GIT_TRACE_PERFORMANCE'::
1029 Enables performance related trace messages, e.g. total execution
1030 time of each Git command.
1031 See 'GIT_TRACE' for available trace output options.
1034 Enables trace messages printing the .git, working tree and current
1035 working directory after Git has completed its setup phase.
1036 See 'GIT_TRACE' for available trace output options.
1038 'GIT_TRACE_SHALLOW'::
1039 Enables trace messages that can help debugging fetching /
1040 cloning of shallow repositories.
1041 See 'GIT_TRACE' for available trace output options.
1043 GIT_LITERAL_PATHSPECS::
1044 Setting this variable to `1` will cause Git to treat all
1045 pathspecs literally, rather than as glob patterns. For example,
1046 running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
1047 for commits that touch the path `*.c`, not any paths that the
1048 glob `*.c` matches. You might want this if you are feeding
1049 literal paths to Git (e.g., paths previously given to you by
1050 `git ls-tree`, `--raw` diff output, etc).
1052 GIT_GLOB_PATHSPECS::
1053 Setting this variable to `1` will cause Git to treat all
1054 pathspecs as glob patterns (aka "glob" magic).
1056 GIT_NOGLOB_PATHSPECS::
1057 Setting this variable to `1` will cause Git to treat all
1058 pathspecs as literal (aka "literal" magic).
1060 GIT_ICASE_PATHSPECS::
1061 Setting this variable to `1` will cause Git to treat all
1062 pathspecs as case-insensitive.
1064 'GIT_REFLOG_ACTION'::
1065 When a ref is updated, reflog entries are created to keep
1066 track of the reason why the ref was updated (which is
1067 typically the name of the high-level command that updated
1068 the ref), in addition to the old and new values of the ref.
1069 A scripted Porcelain command can use set_reflog_action
1070 helper function in `git-sh-setup` to set its name to this
1071 variable when it is invoked as the top level command by the
1072 end user, to be recorded in the body of the reflog.
1074 `GIT_REF_PARANOIA`::
1075 If set to `1`, include broken or badly named refs when iterating
1076 over lists of refs. In a normal, non-corrupted repository, this
1077 does nothing. However, enabling it may help git to detect and
1078 abort some operations in the presence of broken refs. Git sets
1079 this variable automatically when performing destructive
1080 operations like linkgit:git-prune[1]. You should not need to set
1081 it yourself unless you want to be paranoid about making sure
1082 an operation has touched every ref (e.g., because you are
1083 cloning a repository to make a backup).
1086 Discussion[[Discussion]]
1087 ------------------------
1089 More detail on the following is available from the
1090 link:user-manual.html#git-concepts[Git concepts chapter of the
1091 user-manual] and linkgit:gitcore-tutorial[7].
1093 A Git project normally consists of a working directory with a ".git"
1094 subdirectory at the top level. The .git directory contains, among other
1095 things, a compressed object database representing the complete history
1096 of the project, an "index" file which links that history to the current
1097 contents of the working tree, and named pointers into that history such
1098 as tags and branch heads.
1100 The object database contains objects of three main types: blobs, which
1101 hold file data; trees, which point to blobs and other trees to build up
1102 directory hierarchies; and commits, which each reference a single tree
1103 and some number of parent commits.
1105 The commit, equivalent to what other systems call a "changeset" or
1106 "version", represents a step in the project's history, and each parent
1107 represents an immediately preceding step. Commits with more than one
1108 parent represent merges of independent lines of development.
1110 All objects are named by the SHA-1 hash of their contents, normally
1111 written as a string of 40 hex digits. Such names are globally unique.
1112 The entire history leading up to a commit can be vouched for by signing
1113 just that commit. A fourth object type, the tag, is provided for this
1116 When first created, objects are stored in individual files, but for
1117 efficiency may later be compressed together into "pack files".
1119 Named pointers called refs mark interesting points in history. A ref
1120 may contain the SHA-1 name of an object or the name of another ref. Refs
1121 with names beginning `ref/head/` contain the SHA-1 name of the most
1122 recent commit (or "head") of a branch under development. SHA-1 names of
1123 tags of interest are stored under `ref/tags/`. A special ref named
1124 `HEAD` contains the name of the currently checked-out branch.
1126 The index file is initialized with a list of all paths and, for each
1127 path, a blob object and a set of attributes. The blob object represents
1128 the contents of the file as of the head of the current branch. The
1129 attributes (last modified time, size, etc.) are taken from the
1130 corresponding file in the working tree. Subsequent changes to the
1131 working tree can be found by comparing these attributes. The index may
1132 be updated with new content, and new commits may be created from the
1133 content stored in the index.
1135 The index is also capable of storing multiple entries (called "stages")
1136 for a given pathname. These stages are used to hold the various
1137 unmerged version of a file when a merge is in progress.
1139 FURTHER DOCUMENTATION
1140 ---------------------
1142 See the references in the "description" section to get started
1143 using Git. The following is probably more detail than necessary
1144 for a first-time user.
1146 The link:user-manual.html#git-concepts[Git concepts chapter of the
1147 user-manual] and linkgit:gitcore-tutorial[7] both provide
1148 introductions to the underlying Git architecture.
1150 See linkgit:gitworkflows[7] for an overview of recommended workflows.
1152 See also the link:howto-index.html[howto] documents for some useful
1155 The internals are documented in the
1156 link:technical/api-index.html[Git API documentation].
1158 Users migrating from CVS may also want to
1159 read linkgit:gitcvs-migration[7].
1164 Git was started by Linus Torvalds, and is currently maintained by Junio
1165 C Hamano. Numerous contributions have come from the Git mailing list
1166 <git@vger.kernel.org>. http://www.openhub.net/p/git/contributors/summary
1167 gives you a more complete list of contributors.
1169 If you have a clone of git.git itself, the
1170 output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
1171 the authors for specific parts of the project.
1176 Report bugs to the Git mailing list <git@vger.kernel.org> where the
1177 development and maintenance is primarily done. You do not have to be
1178 subscribed to the list to send a message there.
1182 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
1183 linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
1184 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
1185 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
1186 linkgit:gitworkflows[7]
1190 Part of the linkgit:git[1] suite