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.6.0/git.html[documentation for release 2.6]
49 link:RelNotes/2.6.0.txt[2.6].
51 * link:v2.5.4/git.html[documentation for release 2.5.4]
54 link:RelNotes/2.5.4.txt[2.5.4],
55 link:RelNotes/2.5.3.txt[2.5.3],
56 link:RelNotes/2.5.2.txt[2.5.2],
57 link:RelNotes/2.5.1.txt[2.5.1],
58 link:RelNotes/2.5.0.txt[2.5].
60 * link:v2.4.10/git.html[documentation for release 2.4.10]
63 link:RelNotes/2.4.10.txt[2.4.10],
64 link:RelNotes/2.4.9.txt[2.4.9],
65 link:RelNotes/2.4.8.txt[2.4.8],
66 link:RelNotes/2.4.7.txt[2.4.7],
67 link:RelNotes/2.4.6.txt[2.4.6],
68 link:RelNotes/2.4.5.txt[2.4.5],
69 link:RelNotes/2.4.4.txt[2.4.4],
70 link:RelNotes/2.4.3.txt[2.4.3],
71 link:RelNotes/2.4.2.txt[2.4.2],
72 link:RelNotes/2.4.1.txt[2.4.1],
73 link:RelNotes/2.4.0.txt[2.4].
75 * link:v2.3.10/git.html[documentation for release 2.3.10]
78 link:RelNotes/2.3.10.txt[2.3.10],
79 link:RelNotes/2.3.9.txt[2.3.9],
80 link:RelNotes/2.3.8.txt[2.3.8],
81 link:RelNotes/2.3.7.txt[2.3.7],
82 link:RelNotes/2.3.6.txt[2.3.6],
83 link:RelNotes/2.3.5.txt[2.3.5],
84 link:RelNotes/2.3.4.txt[2.3.4],
85 link:RelNotes/2.3.3.txt[2.3.3],
86 link:RelNotes/2.3.2.txt[2.3.2],
87 link:RelNotes/2.3.1.txt[2.3.1],
88 link:RelNotes/2.3.0.txt[2.3].
90 * link:v2.2.3/git.html[documentation for release 2.2.3]
93 link:RelNotes/2.2.3.txt[2.2.3],
94 link:RelNotes/2.2.2.txt[2.2.2],
95 link:RelNotes/2.2.1.txt[2.2.1],
96 link:RelNotes/2.2.0.txt[2.2].
98 * link:v2.1.4/git.html[documentation for release 2.1.4]
101 link:RelNotes/2.1.4.txt[2.1.4],
102 link:RelNotes/2.1.3.txt[2.1.3],
103 link:RelNotes/2.1.2.txt[2.1.2],
104 link:RelNotes/2.1.1.txt[2.1.1],
105 link:RelNotes/2.1.0.txt[2.1].
107 * link:v2.0.5/git.html[documentation for release 2.0.5]
110 link:RelNotes/2.0.5.txt[2.0.5],
111 link:RelNotes/2.0.4.txt[2.0.4],
112 link:RelNotes/2.0.3.txt[2.0.3],
113 link:RelNotes/2.0.2.txt[2.0.2],
114 link:RelNotes/2.0.1.txt[2.0.1],
115 link:RelNotes/2.0.0.txt[2.0.0].
117 * link:v1.9.5/git.html[documentation for release 1.9.5]
120 link:RelNotes/1.9.5.txt[1.9.5],
121 link:RelNotes/1.9.4.txt[1.9.4],
122 link:RelNotes/1.9.3.txt[1.9.3],
123 link:RelNotes/1.9.2.txt[1.9.2],
124 link:RelNotes/1.9.1.txt[1.9.1],
125 link:RelNotes/1.9.0.txt[1.9.0].
127 * link:v1.8.5.6/git.html[documentation for release 1.8.5.6]
130 link:RelNotes/1.8.5.6.txt[1.8.5.6],
131 link:RelNotes/1.8.5.5.txt[1.8.5.5],
132 link:RelNotes/1.8.5.4.txt[1.8.5.4],
133 link:RelNotes/1.8.5.3.txt[1.8.5.3],
134 link:RelNotes/1.8.5.2.txt[1.8.5.2],
135 link:RelNotes/1.8.5.1.txt[1.8.5.1],
136 link:RelNotes/1.8.5.txt[1.8.5].
138 * link:v1.8.4.5/git.html[documentation for release 1.8.4.5]
141 link:RelNotes/1.8.4.5.txt[1.8.4.5],
142 link:RelNotes/1.8.4.4.txt[1.8.4.4],
143 link:RelNotes/1.8.4.3.txt[1.8.4.3],
144 link:RelNotes/1.8.4.2.txt[1.8.4.2],
145 link:RelNotes/1.8.4.1.txt[1.8.4.1],
146 link:RelNotes/1.8.4.txt[1.8.4].
148 * link:v1.8.3.4/git.html[documentation for release 1.8.3.4]
151 link:RelNotes/1.8.3.4.txt[1.8.3.4],
152 link:RelNotes/1.8.3.3.txt[1.8.3.3],
153 link:RelNotes/1.8.3.2.txt[1.8.3.2],
154 link:RelNotes/1.8.3.1.txt[1.8.3.1],
155 link:RelNotes/1.8.3.txt[1.8.3].
157 * link:v1.8.2.3/git.html[documentation for release 1.8.2.3]
160 link:RelNotes/1.8.2.3.txt[1.8.2.3],
161 link:RelNotes/1.8.2.2.txt[1.8.2.2],
162 link:RelNotes/1.8.2.1.txt[1.8.2.1],
163 link:RelNotes/1.8.2.txt[1.8.2].
165 * link:v1.8.1.6/git.html[documentation for release 1.8.1.6]
168 link:RelNotes/1.8.1.6.txt[1.8.1.6],
169 link:RelNotes/1.8.1.5.txt[1.8.1.5],
170 link:RelNotes/1.8.1.4.txt[1.8.1.4],
171 link:RelNotes/1.8.1.3.txt[1.8.1.3],
172 link:RelNotes/1.8.1.2.txt[1.8.1.2],
173 link:RelNotes/1.8.1.1.txt[1.8.1.1],
174 link:RelNotes/1.8.1.txt[1.8.1].
176 * link:v1.8.0.3/git.html[documentation for release 1.8.0.3]
179 link:RelNotes/1.8.0.3.txt[1.8.0.3],
180 link:RelNotes/1.8.0.2.txt[1.8.0.2],
181 link:RelNotes/1.8.0.1.txt[1.8.0.1],
182 link:RelNotes/1.8.0.txt[1.8.0].
184 * link:v1.7.12.4/git.html[documentation for release 1.7.12.4]
187 link:RelNotes/1.7.12.4.txt[1.7.12.4],
188 link:RelNotes/1.7.12.3.txt[1.7.12.3],
189 link:RelNotes/1.7.12.2.txt[1.7.12.2],
190 link:RelNotes/1.7.12.1.txt[1.7.12.1],
191 link:RelNotes/1.7.12.txt[1.7.12].
193 * link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
196 link:RelNotes/1.7.11.7.txt[1.7.11.7],
197 link:RelNotes/1.7.11.6.txt[1.7.11.6],
198 link:RelNotes/1.7.11.5.txt[1.7.11.5],
199 link:RelNotes/1.7.11.4.txt[1.7.11.4],
200 link:RelNotes/1.7.11.3.txt[1.7.11.3],
201 link:RelNotes/1.7.11.2.txt[1.7.11.2],
202 link:RelNotes/1.7.11.1.txt[1.7.11.1],
203 link:RelNotes/1.7.11.txt[1.7.11].
205 * link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
208 link:RelNotes/1.7.10.5.txt[1.7.10.5],
209 link:RelNotes/1.7.10.4.txt[1.7.10.4],
210 link:RelNotes/1.7.10.3.txt[1.7.10.3],
211 link:RelNotes/1.7.10.2.txt[1.7.10.2],
212 link:RelNotes/1.7.10.1.txt[1.7.10.1],
213 link:RelNotes/1.7.10.txt[1.7.10].
215 * link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
218 link:RelNotes/1.7.9.7.txt[1.7.9.7],
219 link:RelNotes/1.7.9.6.txt[1.7.9.6],
220 link:RelNotes/1.7.9.5.txt[1.7.9.5],
221 link:RelNotes/1.7.9.4.txt[1.7.9.4],
222 link:RelNotes/1.7.9.3.txt[1.7.9.3],
223 link:RelNotes/1.7.9.2.txt[1.7.9.2],
224 link:RelNotes/1.7.9.1.txt[1.7.9.1],
225 link:RelNotes/1.7.9.txt[1.7.9].
227 * link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
230 link:RelNotes/1.7.8.6.txt[1.7.8.6],
231 link:RelNotes/1.7.8.5.txt[1.7.8.5],
232 link:RelNotes/1.7.8.4.txt[1.7.8.4],
233 link:RelNotes/1.7.8.3.txt[1.7.8.3],
234 link:RelNotes/1.7.8.2.txt[1.7.8.2],
235 link:RelNotes/1.7.8.1.txt[1.7.8.1],
236 link:RelNotes/1.7.8.txt[1.7.8].
238 * link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
241 link:RelNotes/1.7.7.7.txt[1.7.7.7],
242 link:RelNotes/1.7.7.6.txt[1.7.7.6],
243 link:RelNotes/1.7.7.5.txt[1.7.7.5],
244 link:RelNotes/1.7.7.4.txt[1.7.7.4],
245 link:RelNotes/1.7.7.3.txt[1.7.7.3],
246 link:RelNotes/1.7.7.2.txt[1.7.7.2],
247 link:RelNotes/1.7.7.1.txt[1.7.7.1],
248 link:RelNotes/1.7.7.txt[1.7.7].
250 * link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
253 link:RelNotes/1.7.6.6.txt[1.7.6.6],
254 link:RelNotes/1.7.6.5.txt[1.7.6.5],
255 link:RelNotes/1.7.6.4.txt[1.7.6.4],
256 link:RelNotes/1.7.6.3.txt[1.7.6.3],
257 link:RelNotes/1.7.6.2.txt[1.7.6.2],
258 link:RelNotes/1.7.6.1.txt[1.7.6.1],
259 link:RelNotes/1.7.6.txt[1.7.6].
261 * link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
264 link:RelNotes/1.7.5.4.txt[1.7.5.4],
265 link:RelNotes/1.7.5.3.txt[1.7.5.3],
266 link:RelNotes/1.7.5.2.txt[1.7.5.2],
267 link:RelNotes/1.7.5.1.txt[1.7.5.1],
268 link:RelNotes/1.7.5.txt[1.7.5].
270 * link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
273 link:RelNotes/1.7.4.5.txt[1.7.4.5],
274 link:RelNotes/1.7.4.4.txt[1.7.4.4],
275 link:RelNotes/1.7.4.3.txt[1.7.4.3],
276 link:RelNotes/1.7.4.2.txt[1.7.4.2],
277 link:RelNotes/1.7.4.1.txt[1.7.4.1],
278 link:RelNotes/1.7.4.txt[1.7.4].
280 * link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
283 link:RelNotes/1.7.3.5.txt[1.7.3.5],
284 link:RelNotes/1.7.3.4.txt[1.7.3.4],
285 link:RelNotes/1.7.3.3.txt[1.7.3.3],
286 link:RelNotes/1.7.3.2.txt[1.7.3.2],
287 link:RelNotes/1.7.3.1.txt[1.7.3.1],
288 link:RelNotes/1.7.3.txt[1.7.3].
290 * link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
293 link:RelNotes/1.7.2.5.txt[1.7.2.5],
294 link:RelNotes/1.7.2.4.txt[1.7.2.4],
295 link:RelNotes/1.7.2.3.txt[1.7.2.3],
296 link:RelNotes/1.7.2.2.txt[1.7.2.2],
297 link:RelNotes/1.7.2.1.txt[1.7.2.1],
298 link:RelNotes/1.7.2.txt[1.7.2].
300 * link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
303 link:RelNotes/1.7.1.4.txt[1.7.1.4],
304 link:RelNotes/1.7.1.3.txt[1.7.1.3],
305 link:RelNotes/1.7.1.2.txt[1.7.1.2],
306 link:RelNotes/1.7.1.1.txt[1.7.1.1],
307 link:RelNotes/1.7.1.txt[1.7.1].
309 * link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
312 link:RelNotes/1.7.0.9.txt[1.7.0.9],
313 link:RelNotes/1.7.0.8.txt[1.7.0.8],
314 link:RelNotes/1.7.0.7.txt[1.7.0.7],
315 link:RelNotes/1.7.0.6.txt[1.7.0.6],
316 link:RelNotes/1.7.0.5.txt[1.7.0.5],
317 link:RelNotes/1.7.0.4.txt[1.7.0.4],
318 link:RelNotes/1.7.0.3.txt[1.7.0.3],
319 link:RelNotes/1.7.0.2.txt[1.7.0.2],
320 link:RelNotes/1.7.0.1.txt[1.7.0.1],
321 link:RelNotes/1.7.0.txt[1.7.0].
323 * link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
326 link:RelNotes/1.6.6.3.txt[1.6.6.3],
327 link:RelNotes/1.6.6.2.txt[1.6.6.2],
328 link:RelNotes/1.6.6.1.txt[1.6.6.1],
329 link:RelNotes/1.6.6.txt[1.6.6].
331 * link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
334 link:RelNotes/1.6.5.9.txt[1.6.5.9],
335 link:RelNotes/1.6.5.8.txt[1.6.5.8],
336 link:RelNotes/1.6.5.7.txt[1.6.5.7],
337 link:RelNotes/1.6.5.6.txt[1.6.5.6],
338 link:RelNotes/1.6.5.5.txt[1.6.5.5],
339 link:RelNotes/1.6.5.4.txt[1.6.5.4],
340 link:RelNotes/1.6.5.3.txt[1.6.5.3],
341 link:RelNotes/1.6.5.2.txt[1.6.5.2],
342 link:RelNotes/1.6.5.1.txt[1.6.5.1],
343 link:RelNotes/1.6.5.txt[1.6.5].
345 * link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
348 link:RelNotes/1.6.4.5.txt[1.6.4.5],
349 link:RelNotes/1.6.4.4.txt[1.6.4.4],
350 link:RelNotes/1.6.4.3.txt[1.6.4.3],
351 link:RelNotes/1.6.4.2.txt[1.6.4.2],
352 link:RelNotes/1.6.4.1.txt[1.6.4.1],
353 link:RelNotes/1.6.4.txt[1.6.4].
355 * link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
358 link:RelNotes/1.6.3.4.txt[1.6.3.4],
359 link:RelNotes/1.6.3.3.txt[1.6.3.3],
360 link:RelNotes/1.6.3.2.txt[1.6.3.2],
361 link:RelNotes/1.6.3.1.txt[1.6.3.1],
362 link:RelNotes/1.6.3.txt[1.6.3].
365 link:RelNotes/1.6.2.5.txt[1.6.2.5],
366 link:RelNotes/1.6.2.4.txt[1.6.2.4],
367 link:RelNotes/1.6.2.3.txt[1.6.2.3],
368 link:RelNotes/1.6.2.2.txt[1.6.2.2],
369 link:RelNotes/1.6.2.1.txt[1.6.2.1],
370 link:RelNotes/1.6.2.txt[1.6.2].
372 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
375 link:RelNotes/1.6.1.3.txt[1.6.1.3],
376 link:RelNotes/1.6.1.2.txt[1.6.1.2],
377 link:RelNotes/1.6.1.1.txt[1.6.1.1],
378 link:RelNotes/1.6.1.txt[1.6.1].
380 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
383 link:RelNotes/1.6.0.6.txt[1.6.0.6],
384 link:RelNotes/1.6.0.5.txt[1.6.0.5],
385 link:RelNotes/1.6.0.4.txt[1.6.0.4],
386 link:RelNotes/1.6.0.3.txt[1.6.0.3],
387 link:RelNotes/1.6.0.2.txt[1.6.0.2],
388 link:RelNotes/1.6.0.1.txt[1.6.0.1],
389 link:RelNotes/1.6.0.txt[1.6.0].
391 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
394 link:RelNotes/1.5.6.6.txt[1.5.6.6],
395 link:RelNotes/1.5.6.5.txt[1.5.6.5],
396 link:RelNotes/1.5.6.4.txt[1.5.6.4],
397 link:RelNotes/1.5.6.3.txt[1.5.6.3],
398 link:RelNotes/1.5.6.2.txt[1.5.6.2],
399 link:RelNotes/1.5.6.1.txt[1.5.6.1],
400 link:RelNotes/1.5.6.txt[1.5.6].
402 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
405 link:RelNotes/1.5.5.6.txt[1.5.5.6],
406 link:RelNotes/1.5.5.5.txt[1.5.5.5],
407 link:RelNotes/1.5.5.4.txt[1.5.5.4],
408 link:RelNotes/1.5.5.3.txt[1.5.5.3],
409 link:RelNotes/1.5.5.2.txt[1.5.5.2],
410 link:RelNotes/1.5.5.1.txt[1.5.5.1],
411 link:RelNotes/1.5.5.txt[1.5.5].
413 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
416 link:RelNotes/1.5.4.7.txt[1.5.4.7],
417 link:RelNotes/1.5.4.6.txt[1.5.4.6],
418 link:RelNotes/1.5.4.5.txt[1.5.4.5],
419 link:RelNotes/1.5.4.4.txt[1.5.4.4],
420 link:RelNotes/1.5.4.3.txt[1.5.4.3],
421 link:RelNotes/1.5.4.2.txt[1.5.4.2],
422 link:RelNotes/1.5.4.1.txt[1.5.4.1],
423 link:RelNotes/1.5.4.txt[1.5.4].
425 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
428 link:RelNotes/1.5.3.8.txt[1.5.3.8],
429 link:RelNotes/1.5.3.7.txt[1.5.3.7],
430 link:RelNotes/1.5.3.6.txt[1.5.3.6],
431 link:RelNotes/1.5.3.5.txt[1.5.3.5],
432 link:RelNotes/1.5.3.4.txt[1.5.3.4],
433 link:RelNotes/1.5.3.3.txt[1.5.3.3],
434 link:RelNotes/1.5.3.2.txt[1.5.3.2],
435 link:RelNotes/1.5.3.1.txt[1.5.3.1],
436 link:RelNotes/1.5.3.txt[1.5.3].
438 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
441 link:RelNotes/1.5.2.5.txt[1.5.2.5],
442 link:RelNotes/1.5.2.4.txt[1.5.2.4],
443 link:RelNotes/1.5.2.3.txt[1.5.2.3],
444 link:RelNotes/1.5.2.2.txt[1.5.2.2],
445 link:RelNotes/1.5.2.1.txt[1.5.2.1],
446 link:RelNotes/1.5.2.txt[1.5.2].
448 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
451 link:RelNotes/1.5.1.6.txt[1.5.1.6],
452 link:RelNotes/1.5.1.5.txt[1.5.1.5],
453 link:RelNotes/1.5.1.4.txt[1.5.1.4],
454 link:RelNotes/1.5.1.3.txt[1.5.1.3],
455 link:RelNotes/1.5.1.2.txt[1.5.1.2],
456 link:RelNotes/1.5.1.1.txt[1.5.1.1],
457 link:RelNotes/1.5.1.txt[1.5.1].
459 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
462 link:RelNotes/1.5.0.7.txt[1.5.0.7],
463 link:RelNotes/1.5.0.6.txt[1.5.0.6],
464 link:RelNotes/1.5.0.5.txt[1.5.0.5],
465 link:RelNotes/1.5.0.3.txt[1.5.0.3],
466 link:RelNotes/1.5.0.2.txt[1.5.0.2],
467 link:RelNotes/1.5.0.1.txt[1.5.0.1],
468 link:RelNotes/1.5.0.txt[1.5.0].
470 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
471 link:v1.3.3/git.html[1.3.3],
472 link:v1.2.6/git.html[1.2.6],
473 link:v1.0.13/git.html[1.0.13].
482 Prints the Git suite version that the 'git' program came from.
485 Prints the synopsis and a list of the most commonly used
486 commands. If the option '--all' or '-a' is given then all
487 available commands are printed. If a Git command is named this
488 option will bring up the manual page for that command.
490 Other options are available to control how the manual page is
491 displayed. See linkgit:git-help[1] for more information,
492 because `git --help ...` is converted internally into `git
496 Run as if git was started in '<path>' instead of the current working
497 directory. When multiple `-C` options are given, each subsequent
498 non-absolute `-C <path>` is interpreted relative to the preceding `-C
501 This option affects options that expect path name like `--git-dir` and
502 `--work-tree` in that their interpretations of the path names would be
503 made relative to the working directory caused by the `-C` option. For
504 example the following invocations are equivalent:
506 git --git-dir=a.git --work-tree=b -C c status
507 git --git-dir=c/a.git --work-tree=c/b status
510 Pass a configuration parameter to the command. The value
511 given will override values from configuration files.
512 The <name> is expected in the same format as listed by
513 'git config' (subkeys separated by dots).
515 Note that omitting the `=` in `git -c foo.bar ...` is allowed and sets
516 `foo.bar` to the boolean true value (just like `[foo]bar` would in a
517 config file). Including the equals but with an empty value (like `git -c
518 foo.bar= ...`) sets `foo.bar` to the empty string.
520 --exec-path[=<path>]::
521 Path to wherever your core Git programs are installed.
522 This can also be controlled by setting the GIT_EXEC_PATH
523 environment variable. If no path is given, 'git' will print
524 the current setting and then exit.
527 Print the path, without trailing slash, where Git's HTML
528 documentation is installed and exit.
531 Print the manpath (see `man(1)`) for the man pages for
532 this version of Git and exit.
535 Print the path where the Info files documenting this
536 version of Git are installed and exit.
540 Pipe all output into 'less' (or if set, $PAGER) if standard
541 output is a terminal. This overrides the `pager.<cmd>`
542 configuration options (see the "Configuration Mechanism" section
546 Do not pipe Git output into a pager.
549 Set the path to the repository. This can also be controlled by
550 setting the GIT_DIR environment variable. It can be an absolute
551 path or relative path to current working directory.
554 Set the path to the working tree. It can be an absolute path
555 or a path relative to the current working directory.
556 This can also be controlled by setting the GIT_WORK_TREE
557 environment variable and the core.worktree configuration
558 variable (see core.worktree in linkgit:git-config[1] for a
559 more detailed discussion).
562 Set the Git namespace. See linkgit:gitnamespaces[7] for more
563 details. Equivalent to setting the `GIT_NAMESPACE` environment
567 Treat the repository as a bare repository. If GIT_DIR
568 environment is not set, it is set to the current working
571 --no-replace-objects::
572 Do not use replacement refs to replace Git objects. See
573 linkgit:git-replace[1] for more information.
575 --literal-pathspecs::
576 Treat pathspecs literally (i.e. no globbing, no pathspec magic).
577 This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
581 Add "glob" magic to all pathspec. This is equivalent to setting
582 the `GIT_GLOB_PATHSPECS` environment variable to `1`. Disabling
583 globbing on individual pathspecs can be done using pathspec
587 Add "literal" magic to all pathspec. This is equivalent to setting
588 the `GIT_NOGLOB_PATHSPECS` environment variable to `1`. Enabling
589 globbing on individual pathspecs can be done using pathspec
593 Add "icase" magic to all pathspec. This is equivalent to setting
594 the `GIT_ICASE_PATHSPECS` environment variable to `1`.
599 We divide Git into high level ("porcelain") commands and low level
600 ("plumbing") commands.
602 High-level commands (porcelain)
603 -------------------------------
605 We separate the porcelain commands into the main commands and some
606 ancillary user utilities.
608 Main porcelain commands
609 ~~~~~~~~~~~~~~~~~~~~~~~
611 include::cmds-mainporcelain.txt[]
617 include::cmds-ancillarymanipulators.txt[]
621 include::cmds-ancillaryinterrogators.txt[]
624 Interacting with Others
625 ~~~~~~~~~~~~~~~~~~~~~~~
627 These commands are to interact with foreign SCM and with other
628 people via patch over e-mail.
630 include::cmds-foreignscminterface.txt[]
633 Low-level commands (plumbing)
634 -----------------------------
636 Although Git includes its
637 own porcelain layer, its low-level commands are sufficient to support
638 development of alternative porcelains. Developers of such porcelains
639 might start by reading about linkgit:git-update-index[1] and
640 linkgit:git-read-tree[1].
642 The interface (input, output, set of options and the semantics)
643 to these low-level commands are meant to be a lot more stable
644 than Porcelain level commands, because these commands are
645 primarily for scripted use. The interface to Porcelain commands
646 on the other hand are subject to change in order to improve the
649 The following description divides
650 the low-level commands into commands that manipulate objects (in
651 the repository, index, and working tree), commands that interrogate and
652 compare objects, and commands that move objects and references between
656 Manipulation commands
657 ~~~~~~~~~~~~~~~~~~~~~
659 include::cmds-plumbingmanipulators.txt[]
662 Interrogation commands
663 ~~~~~~~~~~~~~~~~~~~~~~
665 include::cmds-plumbinginterrogators.txt[]
667 In general, the interrogate commands do not touch the files in
671 Synching repositories
672 ~~~~~~~~~~~~~~~~~~~~~
674 include::cmds-synchingrepositories.txt[]
676 The following are helper commands used by the above; end users
677 typically do not use them directly.
679 include::cmds-synchelpers.txt[]
682 Internal helper commands
683 ~~~~~~~~~~~~~~~~~~~~~~~~
685 These are internal helper commands used by other commands; end
686 users typically do not use them directly.
688 include::cmds-purehelpers.txt[]
691 Configuration Mechanism
692 -----------------------
694 Git uses a simple text format to store customizations that are per
695 repository and are per user. Such a configuration file may look
700 # A '#' or ';' character indicates a comment.
705 ; Don't trust file modes
710 name = "Junio C Hamano"
711 email = "gitster@pobox.com"
715 Various commands read from the configuration file and adjust
716 their operation accordingly. See linkgit:git-config[1] for a
717 list and more details about the configuration mechanism.
720 Identifier Terminology
721 ----------------------
723 Indicates the object name for any type of object.
726 Indicates a blob object name.
729 Indicates a tree object name.
732 Indicates a commit object name.
735 Indicates a tree, commit or tag object name. A
736 command that takes a <tree-ish> argument ultimately wants to
737 operate on a <tree> object but automatically dereferences
738 <commit> and <tag> objects that point at a <tree>.
741 Indicates a commit or tag object name. A
742 command that takes a <commit-ish> argument ultimately wants to
743 operate on a <commit> object but automatically dereferences
744 <tag> objects that point at a <commit>.
747 Indicates that an object type is required.
748 Currently one of: `blob`, `tree`, `commit`, or `tag`.
751 Indicates a filename - almost always relative to the
752 root of the tree structure `GIT_INDEX_FILE` describes.
756 Any Git command accepting any <object> can also use the following
760 indicates the head of the current branch.
764 (i.e. a `refs/tags/<tag>` reference).
768 (i.e. a `refs/heads/<head>` reference).
770 For a more complete list of ways to spell object names, see
771 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
774 File/Directory Structure
775 ------------------------
777 Please see the linkgit:gitrepository-layout[5] document.
779 Read linkgit:githooks[5] for more details about each hook.
781 Higher level SCMs may provide and manage additional information in the
787 Please see linkgit:gitglossary[7].
790 Environment Variables
791 ---------------------
792 Various Git commands use the following environment variables:
796 These environment variables apply to 'all' core Git commands. Nb: it
797 is worth noting that they may be used/overridden by SCMS sitting above
798 Git so take care if using a foreign front-end.
801 This environment allows the specification of an alternate
802 index file. If not specified, the default of `$GIT_DIR/index`
805 'GIT_INDEX_VERSION'::
806 This environment variable allows the specification of an index
807 version for new repositories. It won't affect existing index
808 files. By default index file version 2 or 3 is used. See
809 linkgit:git-update-index[1] for more information.
811 'GIT_OBJECT_DIRECTORY'::
812 If the object storage directory is specified via this
813 environment variable then the sha1 directories are created
814 underneath - otherwise the default `$GIT_DIR/objects`
817 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
818 Due to the immutable nature of Git objects, old objects can be
819 archived into shared, read-only directories. This variable
820 specifies a ":" separated (on Windows ";" separated) list
821 of Git object directories which can be used to search for Git
822 objects. New objects will not be written to these directories.
825 If the 'GIT_DIR' environment variable is set then it
826 specifies a path to use instead of the default `.git`
827 for the base of the repository.
828 The '--git-dir' command-line option also sets this value.
831 Set the path to the root of the working tree.
832 This can also be controlled by the '--work-tree' command-line
833 option and the core.worktree configuration variable.
836 Set the Git namespace; see linkgit:gitnamespaces[7] for details.
837 The '--namespace' command-line option also sets this value.
839 'GIT_CEILING_DIRECTORIES'::
840 This should be a colon-separated list of absolute paths. If
841 set, it is a list of directories that Git should not chdir up
842 into while looking for a repository directory (useful for
843 excluding slow-loading network directories). It will not
844 exclude the current working directory or a GIT_DIR set on the
845 command line or in the environment. Normally, Git has to read
846 the entries in this list and resolve any symlink that
847 might be present in order to compare them with the current
848 directory. However, if even this access is slow, you
849 can add an empty entry to the list to tell Git that the
850 subsequent entries are not symlinks and needn't be resolved;
852 'GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink'.
854 'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
855 When run in a directory that does not have ".git" repository
856 directory, Git tries to find such a directory in the parent
857 directories to find the top of the working tree, but by default it
858 does not cross filesystem boundaries. This environment variable
859 can be set to true to tell Git not to stop at filesystem
860 boundaries. Like 'GIT_CEILING_DIRECTORIES', this will not affect
861 an explicit repository directory set via 'GIT_DIR' or on the
865 If this variable is set to a path, non-worktree files that are
866 normally in $GIT_DIR will be taken from this path
867 instead. Worktree-specific files such as HEAD or index are
868 taken from $GIT_DIR. See linkgit:gitrepository-layout[5] and
869 linkgit:git-worktree[1] for
870 details. This variable has lower precedence than other path
871 variables such as GIT_INDEX_FILE, GIT_OBJECT_DIRECTORY...
878 'GIT_COMMITTER_NAME'::
879 'GIT_COMMITTER_EMAIL'::
880 'GIT_COMMITTER_DATE'::
882 see linkgit:git-commit-tree[1]
887 Only valid setting is "--unified=??" or "-u??" to set the
888 number of context lines shown when a unified diff is created.
889 This takes precedence over any "-U" or "--unified" option
890 value passed on the Git diff command line.
892 'GIT_EXTERNAL_DIFF'::
893 When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
894 program named by it is called, instead of the diff invocation
895 described above. For a path that is added, removed, or modified,
896 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
898 path old-file old-hex old-mode new-file new-hex new-mode
902 <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
903 contents of <old|new>,
904 <old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
905 <old|new>-mode:: are the octal representation of the file modes.
907 The file parameters can point at the user's working file
908 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
909 when a new file is added), or a temporary file (e.g. `old-file` in the
910 index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
911 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
913 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
916 For each path 'GIT_EXTERNAL_DIFF' is called, two environment variables,
917 'GIT_DIFF_PATH_COUNTER' and 'GIT_DIFF_PATH_TOTAL' are set.
919 'GIT_DIFF_PATH_COUNTER'::
920 A 1-based counter incremented by one for every path.
922 'GIT_DIFF_PATH_TOTAL'::
923 The total number of paths.
927 'GIT_MERGE_VERBOSITY'::
928 A number controlling the amount of output shown by
929 the recursive merge strategy. Overrides merge.verbosity.
930 See linkgit:git-merge[1]
933 This environment variable overrides `$PAGER`. If it is set
934 to an empty string or to the value "cat", Git will not launch
935 a pager. See also the `core.pager` option in
936 linkgit:git-config[1].
939 This environment variable overrides `$EDITOR` and `$VISUAL`.
940 It is used by several Git commands when, on interactive mode,
941 an editor is to be launched. See also linkgit:git-var[1]
942 and the `core.editor` option in linkgit:git-config[1].
946 If either of these environment variables is set then 'git fetch'
947 and 'git push' will use the specified command instead of 'ssh'
948 when they need to connect to a remote system.
949 The command will be given exactly two or four arguments: the
950 'username@host' (or just 'host') from the URL and the shell
951 command to execute on that remote system, optionally preceded by
952 '-p' (literally) and the 'port' from the URL when it specifies
953 something other than the default SSH port.
955 `$GIT_SSH_COMMAND` takes precedence over `$GIT_SSH`, and is interpreted
956 by the shell, which allows additional arguments to be included.
957 `$GIT_SSH` on the other hand must be just the path to a program
958 (which can be a wrapper shell script, if additional arguments are
961 Usually it is easier to configure any desired options through your
962 personal `.ssh/config` file. Please consult your ssh documentation
966 If this environment variable is set, then Git commands which need to
967 acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
968 will call this program with a suitable prompt as command-line argument
969 and read the password from its STDOUT. See also the 'core.askPass'
970 option in linkgit:git-config[1].
972 'GIT_TERMINAL_PROMPT'::
973 If this environment variable is set to `0`, git will not prompt
974 on the terminal (e.g., when asking for HTTP authentication).
976 'GIT_CONFIG_NOSYSTEM'::
977 Whether to skip reading settings from the system-wide
978 `$(prefix)/etc/gitconfig` file. This environment variable can
979 be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
980 predictable environment for a picky script, or you can set it
981 temporarily to avoid using a buggy `/etc/gitconfig` file while
982 waiting for someone with sufficient permissions to fix it.
985 If this environment variable is set to "1", then commands such
986 as 'git blame' (in incremental mode), 'git rev-list', 'git log',
987 'git check-attr' and 'git check-ignore' will
988 force a flush of the output stream after each record have been
990 variable is set to "0", the output of these commands will be done
991 using completely buffered I/O. If this environment variable is
992 not set, Git will choose buffered or record-oriented flushing
993 based on whether stdout appears to be redirected to a file or not.
996 Enables general trace messages, e.g. alias expansion, built-in
997 command execution and external command execution.
999 If this variable is set to "1", "2" or "true" (comparison
1000 is case insensitive), trace messages will be printed to
1003 If the variable is set to an integer value greater than 2
1004 and lower than 10 (strictly) then Git will interpret this
1005 value as an open file descriptor and will try to write the
1006 trace messages into this file descriptor.
1008 Alternatively, if the variable is set to an absolute path
1009 (starting with a '/' character), Git will interpret this
1010 as a file path and will try to write the trace messages
1013 Unsetting the variable, or setting it to empty, "0" or
1014 "false" (case insensitive) disables trace messages.
1016 'GIT_TRACE_PACK_ACCESS'::
1017 Enables trace messages for all accesses to any packs. For each
1018 access, the pack file name and an offset in the pack is
1019 recorded. This may be helpful for troubleshooting some
1020 pack-related performance problems.
1021 See 'GIT_TRACE' for available trace output options.
1023 'GIT_TRACE_PACKET'::
1024 Enables trace messages for all packets coming in or out of a
1025 given program. This can help with debugging object negotiation
1026 or other protocol issues. Tracing is turned off at a packet
1027 starting with "PACK" (but see 'GIT_TRACE_PACKFILE' below).
1028 See 'GIT_TRACE' for available trace output options.
1030 'GIT_TRACE_PACKFILE'::
1031 Enables tracing of packfiles sent or received by a
1032 given program. Unlike other trace output, this trace is
1033 verbatim: no headers, and no quoting of binary data. You almost
1034 certainly want to direct into a file (e.g.,
1035 `GIT_TRACE_PACKFILE=/tmp/my.pack`) rather than displaying it on
1036 the terminal or mixing it with other trace output.
1038 Note that this is currently only implemented for the client side
1039 of clones and fetches.
1041 'GIT_TRACE_PERFORMANCE'::
1042 Enables performance related trace messages, e.g. total execution
1043 time of each Git command.
1044 See 'GIT_TRACE' for available trace output options.
1047 Enables trace messages printing the .git, working tree and current
1048 working directory after Git has completed its setup phase.
1049 See 'GIT_TRACE' for available trace output options.
1051 'GIT_TRACE_SHALLOW'::
1052 Enables trace messages that can help debugging fetching /
1053 cloning of shallow repositories.
1054 See 'GIT_TRACE' for available trace output options.
1056 GIT_LITERAL_PATHSPECS::
1057 Setting this variable to `1` will cause Git to treat all
1058 pathspecs literally, rather than as glob patterns. For example,
1059 running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
1060 for commits that touch the path `*.c`, not any paths that the
1061 glob `*.c` matches. You might want this if you are feeding
1062 literal paths to Git (e.g., paths previously given to you by
1063 `git ls-tree`, `--raw` diff output, etc).
1065 GIT_GLOB_PATHSPECS::
1066 Setting this variable to `1` will cause Git to treat all
1067 pathspecs as glob patterns (aka "glob" magic).
1069 GIT_NOGLOB_PATHSPECS::
1070 Setting this variable to `1` will cause Git to treat all
1071 pathspecs as literal (aka "literal" magic).
1073 GIT_ICASE_PATHSPECS::
1074 Setting this variable to `1` will cause Git to treat all
1075 pathspecs as case-insensitive.
1077 'GIT_REFLOG_ACTION'::
1078 When a ref is updated, reflog entries are created to keep
1079 track of the reason why the ref was updated (which is
1080 typically the name of the high-level command that updated
1081 the ref), in addition to the old and new values of the ref.
1082 A scripted Porcelain command can use set_reflog_action
1083 helper function in `git-sh-setup` to set its name to this
1084 variable when it is invoked as the top level command by the
1085 end user, to be recorded in the body of the reflog.
1087 `GIT_REF_PARANOIA`::
1088 If set to `1`, include broken or badly named refs when iterating
1089 over lists of refs. In a normal, non-corrupted repository, this
1090 does nothing. However, enabling it may help git to detect and
1091 abort some operations in the presence of broken refs. Git sets
1092 this variable automatically when performing destructive
1093 operations like linkgit:git-prune[1]. You should not need to set
1094 it yourself unless you want to be paranoid about making sure
1095 an operation has touched every ref (e.g., because you are
1096 cloning a repository to make a backup).
1098 `GIT_ALLOW_PROTOCOL`::
1099 If set, provide a colon-separated list of protocols which are
1100 allowed to be used with fetch/push/clone. This is useful to
1101 restrict recursive submodule initialization from an untrusted
1102 repository. Any protocol not mentioned will be disallowed (i.e.,
1103 this is a whitelist, not a blacklist). If the variable is not
1104 set at all, all protocols are enabled. The protocol names
1105 currently used by git are:
1107 - `file`: any local file-based path (including `file://` URLs,
1110 - `git`: the anonymous git protocol over a direct TCP
1111 connection (or proxy, if configured)
1113 - `ssh`: git over ssh (including `host:path` syntax,
1116 - `rsync`: git over rsync
1118 - `http`: git over http, both "smart http" and "dumb http".
1119 Note that this does _not_ include `https`; if you want both,
1120 you should specify both as `http:https`.
1122 - any external helpers are named by their protocol (e.g., use
1123 `hg` to allow the `git-remote-hg` helper)
1126 Discussion[[Discussion]]
1127 ------------------------
1129 More detail on the following is available from the
1130 link:user-manual.html#git-concepts[Git concepts chapter of the
1131 user-manual] and linkgit:gitcore-tutorial[7].
1133 A Git project normally consists of a working directory with a ".git"
1134 subdirectory at the top level. The .git directory contains, among other
1135 things, a compressed object database representing the complete history
1136 of the project, an "index" file which links that history to the current
1137 contents of the working tree, and named pointers into that history such
1138 as tags and branch heads.
1140 The object database contains objects of three main types: blobs, which
1141 hold file data; trees, which point to blobs and other trees to build up
1142 directory hierarchies; and commits, which each reference a single tree
1143 and some number of parent commits.
1145 The commit, equivalent to what other systems call a "changeset" or
1146 "version", represents a step in the project's history, and each parent
1147 represents an immediately preceding step. Commits with more than one
1148 parent represent merges of independent lines of development.
1150 All objects are named by the SHA-1 hash of their contents, normally
1151 written as a string of 40 hex digits. Such names are globally unique.
1152 The entire history leading up to a commit can be vouched for by signing
1153 just that commit. A fourth object type, the tag, is provided for this
1156 When first created, objects are stored in individual files, but for
1157 efficiency may later be compressed together into "pack files".
1159 Named pointers called refs mark interesting points in history. A ref
1160 may contain the SHA-1 name of an object or the name of another ref. Refs
1161 with names beginning `ref/head/` contain the SHA-1 name of the most
1162 recent commit (or "head") of a branch under development. SHA-1 names of
1163 tags of interest are stored under `ref/tags/`. A special ref named
1164 `HEAD` contains the name of the currently checked-out branch.
1166 The index file is initialized with a list of all paths and, for each
1167 path, a blob object and a set of attributes. The blob object represents
1168 the contents of the file as of the head of the current branch. The
1169 attributes (last modified time, size, etc.) are taken from the
1170 corresponding file in the working tree. Subsequent changes to the
1171 working tree can be found by comparing these attributes. The index may
1172 be updated with new content, and new commits may be created from the
1173 content stored in the index.
1175 The index is also capable of storing multiple entries (called "stages")
1176 for a given pathname. These stages are used to hold the various
1177 unmerged version of a file when a merge is in progress.
1179 FURTHER DOCUMENTATION
1180 ---------------------
1182 See the references in the "description" section to get started
1183 using Git. The following is probably more detail than necessary
1184 for a first-time user.
1186 The link:user-manual.html#git-concepts[Git concepts chapter of the
1187 user-manual] and linkgit:gitcore-tutorial[7] both provide
1188 introductions to the underlying Git architecture.
1190 See linkgit:gitworkflows[7] for an overview of recommended workflows.
1192 See also the link:howto-index.html[howto] documents for some useful
1195 The internals are documented in the
1196 link:technical/api-index.html[Git API documentation].
1198 Users migrating from CVS may also want to
1199 read linkgit:gitcvs-migration[7].
1204 Git was started by Linus Torvalds, and is currently maintained by Junio
1205 C Hamano. Numerous contributions have come from the Git mailing list
1206 <git@vger.kernel.org>. http://www.openhub.net/p/git/contributors/summary
1207 gives you a more complete list of contributors.
1209 If you have a clone of git.git itself, the
1210 output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
1211 the authors for specific parts of the project.
1216 Report bugs to the Git mailing list <git@vger.kernel.org> where the
1217 development and maintenance is primarily done. You do not have to be
1218 subscribed to the list to send a message there.
1222 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
1223 linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
1224 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
1225 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
1226 linkgit:gitworkflows[7]
1230 Part of the linkgit:git[1] suite