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.4.5/git.html[documentation for release 2.4.5]
49 link:RelNotes/2.4.5.txt[2.4.5],
50 link:RelNotes/2.4.4.txt[2.4.4],
51 link:RelNotes/2.4.3.txt[2.4.3],
52 link:RelNotes/2.4.2.txt[2.4.2],
53 link:RelNotes/2.4.1.txt[2.4.1],
54 link:RelNotes/2.4.0.txt[2.4].
56 * link:v2.3.8/git.html[documentation for release 2.3.8]
59 link:RelNotes/2.3.8.txt[2.3.8],
60 link:RelNotes/2.3.7.txt[2.3.7],
61 link:RelNotes/2.3.6.txt[2.3.6],
62 link:RelNotes/2.3.5.txt[2.3.5],
63 link:RelNotes/2.3.4.txt[2.3.4],
64 link:RelNotes/2.3.3.txt[2.3.3],
65 link:RelNotes/2.3.2.txt[2.3.2],
66 link:RelNotes/2.3.1.txt[2.3.1],
67 link:RelNotes/2.3.0.txt[2.3].
69 * link:v2.2.2/git.html[documentation for release 2.2.2]
72 link:RelNotes/2.2.2.txt[2.2.2],
73 link:RelNotes/2.2.1.txt[2.2.1],
74 link:RelNotes/2.2.0.txt[2.2].
76 * link:v2.1.4/git.html[documentation for release 2.1.4]
79 link:RelNotes/2.1.4.txt[2.1.4],
80 link:RelNotes/2.1.3.txt[2.1.3],
81 link:RelNotes/2.1.2.txt[2.1.2],
82 link:RelNotes/2.1.1.txt[2.1.1],
83 link:RelNotes/2.1.0.txt[2.1].
85 * link:v2.0.5/git.html[documentation for release 2.0.5]
88 link:RelNotes/2.0.5.txt[2.0.5],
89 link:RelNotes/2.0.4.txt[2.0.4],
90 link:RelNotes/2.0.3.txt[2.0.3],
91 link:RelNotes/2.0.2.txt[2.0.2],
92 link:RelNotes/2.0.1.txt[2.0.1],
93 link:RelNotes/2.0.0.txt[2.0.0].
95 * link:v1.9.5/git.html[documentation for release 1.9.5]
98 link:RelNotes/1.9.5.txt[1.9.5],
99 link:RelNotes/1.9.4.txt[1.9.4],
100 link:RelNotes/1.9.3.txt[1.9.3],
101 link:RelNotes/1.9.2.txt[1.9.2],
102 link:RelNotes/1.9.1.txt[1.9.1],
103 link:RelNotes/1.9.0.txt[1.9.0].
105 * link:v1.8.5.6/git.html[documentation for release 1.8.5.6]
108 link:RelNotes/1.8.5.6.txt[1.8.5.6],
109 link:RelNotes/1.8.5.5.txt[1.8.5.5],
110 link:RelNotes/1.8.5.4.txt[1.8.5.4],
111 link:RelNotes/1.8.5.3.txt[1.8.5.3],
112 link:RelNotes/1.8.5.2.txt[1.8.5.2],
113 link:RelNotes/1.8.5.1.txt[1.8.5.1],
114 link:RelNotes/1.8.5.txt[1.8.5].
116 * link:v1.8.4.5/git.html[documentation for release 1.8.4.5]
119 link:RelNotes/1.8.4.5.txt[1.8.4.5],
120 link:RelNotes/1.8.4.4.txt[1.8.4.4],
121 link:RelNotes/1.8.4.3.txt[1.8.4.3],
122 link:RelNotes/1.8.4.2.txt[1.8.4.2],
123 link:RelNotes/1.8.4.1.txt[1.8.4.1],
124 link:RelNotes/1.8.4.txt[1.8.4].
126 * link:v1.8.3.4/git.html[documentation for release 1.8.3.4]
129 link:RelNotes/1.8.3.4.txt[1.8.3.4],
130 link:RelNotes/1.8.3.3.txt[1.8.3.3],
131 link:RelNotes/1.8.3.2.txt[1.8.3.2],
132 link:RelNotes/1.8.3.1.txt[1.8.3.1],
133 link:RelNotes/1.8.3.txt[1.8.3].
135 * link:v1.8.2.3/git.html[documentation for release 1.8.2.3]
138 link:RelNotes/1.8.2.3.txt[1.8.2.3],
139 link:RelNotes/1.8.2.2.txt[1.8.2.2],
140 link:RelNotes/1.8.2.1.txt[1.8.2.1],
141 link:RelNotes/1.8.2.txt[1.8.2].
143 * link:v1.8.1.6/git.html[documentation for release 1.8.1.6]
146 link:RelNotes/1.8.1.6.txt[1.8.1.6],
147 link:RelNotes/1.8.1.5.txt[1.8.1.5],
148 link:RelNotes/1.8.1.4.txt[1.8.1.4],
149 link:RelNotes/1.8.1.3.txt[1.8.1.3],
150 link:RelNotes/1.8.1.2.txt[1.8.1.2],
151 link:RelNotes/1.8.1.1.txt[1.8.1.1],
152 link:RelNotes/1.8.1.txt[1.8.1].
154 * link:v1.8.0.3/git.html[documentation for release 1.8.0.3]
157 link:RelNotes/1.8.0.3.txt[1.8.0.3],
158 link:RelNotes/1.8.0.2.txt[1.8.0.2],
159 link:RelNotes/1.8.0.1.txt[1.8.0.1],
160 link:RelNotes/1.8.0.txt[1.8.0].
162 * link:v1.7.12.4/git.html[documentation for release 1.7.12.4]
165 link:RelNotes/1.7.12.4.txt[1.7.12.4],
166 link:RelNotes/1.7.12.3.txt[1.7.12.3],
167 link:RelNotes/1.7.12.2.txt[1.7.12.2],
168 link:RelNotes/1.7.12.1.txt[1.7.12.1],
169 link:RelNotes/1.7.12.txt[1.7.12].
171 * link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
174 link:RelNotes/1.7.11.7.txt[1.7.11.7],
175 link:RelNotes/1.7.11.6.txt[1.7.11.6],
176 link:RelNotes/1.7.11.5.txt[1.7.11.5],
177 link:RelNotes/1.7.11.4.txt[1.7.11.4],
178 link:RelNotes/1.7.11.3.txt[1.7.11.3],
179 link:RelNotes/1.7.11.2.txt[1.7.11.2],
180 link:RelNotes/1.7.11.1.txt[1.7.11.1],
181 link:RelNotes/1.7.11.txt[1.7.11].
183 * link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
186 link:RelNotes/1.7.10.5.txt[1.7.10.5],
187 link:RelNotes/1.7.10.4.txt[1.7.10.4],
188 link:RelNotes/1.7.10.3.txt[1.7.10.3],
189 link:RelNotes/1.7.10.2.txt[1.7.10.2],
190 link:RelNotes/1.7.10.1.txt[1.7.10.1],
191 link:RelNotes/1.7.10.txt[1.7.10].
193 * link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
196 link:RelNotes/1.7.9.7.txt[1.7.9.7],
197 link:RelNotes/1.7.9.6.txt[1.7.9.6],
198 link:RelNotes/1.7.9.5.txt[1.7.9.5],
199 link:RelNotes/1.7.9.4.txt[1.7.9.4],
200 link:RelNotes/1.7.9.3.txt[1.7.9.3],
201 link:RelNotes/1.7.9.2.txt[1.7.9.2],
202 link:RelNotes/1.7.9.1.txt[1.7.9.1],
203 link:RelNotes/1.7.9.txt[1.7.9].
205 * link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
208 link:RelNotes/1.7.8.6.txt[1.7.8.6],
209 link:RelNotes/1.7.8.5.txt[1.7.8.5],
210 link:RelNotes/1.7.8.4.txt[1.7.8.4],
211 link:RelNotes/1.7.8.3.txt[1.7.8.3],
212 link:RelNotes/1.7.8.2.txt[1.7.8.2],
213 link:RelNotes/1.7.8.1.txt[1.7.8.1],
214 link:RelNotes/1.7.8.txt[1.7.8].
216 * link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
219 link:RelNotes/1.7.7.7.txt[1.7.7.7],
220 link:RelNotes/1.7.7.6.txt[1.7.7.6],
221 link:RelNotes/1.7.7.5.txt[1.7.7.5],
222 link:RelNotes/1.7.7.4.txt[1.7.7.4],
223 link:RelNotes/1.7.7.3.txt[1.7.7.3],
224 link:RelNotes/1.7.7.2.txt[1.7.7.2],
225 link:RelNotes/1.7.7.1.txt[1.7.7.1],
226 link:RelNotes/1.7.7.txt[1.7.7].
228 * link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
231 link:RelNotes/1.7.6.6.txt[1.7.6.6],
232 link:RelNotes/1.7.6.5.txt[1.7.6.5],
233 link:RelNotes/1.7.6.4.txt[1.7.6.4],
234 link:RelNotes/1.7.6.3.txt[1.7.6.3],
235 link:RelNotes/1.7.6.2.txt[1.7.6.2],
236 link:RelNotes/1.7.6.1.txt[1.7.6.1],
237 link:RelNotes/1.7.6.txt[1.7.6].
239 * link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
242 link:RelNotes/1.7.5.4.txt[1.7.5.4],
243 link:RelNotes/1.7.5.3.txt[1.7.5.3],
244 link:RelNotes/1.7.5.2.txt[1.7.5.2],
245 link:RelNotes/1.7.5.1.txt[1.7.5.1],
246 link:RelNotes/1.7.5.txt[1.7.5].
248 * link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
251 link:RelNotes/1.7.4.5.txt[1.7.4.5],
252 link:RelNotes/1.7.4.4.txt[1.7.4.4],
253 link:RelNotes/1.7.4.3.txt[1.7.4.3],
254 link:RelNotes/1.7.4.2.txt[1.7.4.2],
255 link:RelNotes/1.7.4.1.txt[1.7.4.1],
256 link:RelNotes/1.7.4.txt[1.7.4].
258 * link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
261 link:RelNotes/1.7.3.5.txt[1.7.3.5],
262 link:RelNotes/1.7.3.4.txt[1.7.3.4],
263 link:RelNotes/1.7.3.3.txt[1.7.3.3],
264 link:RelNotes/1.7.3.2.txt[1.7.3.2],
265 link:RelNotes/1.7.3.1.txt[1.7.3.1],
266 link:RelNotes/1.7.3.txt[1.7.3].
268 * link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
271 link:RelNotes/1.7.2.5.txt[1.7.2.5],
272 link:RelNotes/1.7.2.4.txt[1.7.2.4],
273 link:RelNotes/1.7.2.3.txt[1.7.2.3],
274 link:RelNotes/1.7.2.2.txt[1.7.2.2],
275 link:RelNotes/1.7.2.1.txt[1.7.2.1],
276 link:RelNotes/1.7.2.txt[1.7.2].
278 * link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
281 link:RelNotes/1.7.1.4.txt[1.7.1.4],
282 link:RelNotes/1.7.1.3.txt[1.7.1.3],
283 link:RelNotes/1.7.1.2.txt[1.7.1.2],
284 link:RelNotes/1.7.1.1.txt[1.7.1.1],
285 link:RelNotes/1.7.1.txt[1.7.1].
287 * link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
290 link:RelNotes/1.7.0.9.txt[1.7.0.9],
291 link:RelNotes/1.7.0.8.txt[1.7.0.8],
292 link:RelNotes/1.7.0.7.txt[1.7.0.7],
293 link:RelNotes/1.7.0.6.txt[1.7.0.6],
294 link:RelNotes/1.7.0.5.txt[1.7.0.5],
295 link:RelNotes/1.7.0.4.txt[1.7.0.4],
296 link:RelNotes/1.7.0.3.txt[1.7.0.3],
297 link:RelNotes/1.7.0.2.txt[1.7.0.2],
298 link:RelNotes/1.7.0.1.txt[1.7.0.1],
299 link:RelNotes/1.7.0.txt[1.7.0].
301 * link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
304 link:RelNotes/1.6.6.3.txt[1.6.6.3],
305 link:RelNotes/1.6.6.2.txt[1.6.6.2],
306 link:RelNotes/1.6.6.1.txt[1.6.6.1],
307 link:RelNotes/1.6.6.txt[1.6.6].
309 * link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
312 link:RelNotes/1.6.5.9.txt[1.6.5.9],
313 link:RelNotes/1.6.5.8.txt[1.6.5.8],
314 link:RelNotes/1.6.5.7.txt[1.6.5.7],
315 link:RelNotes/1.6.5.6.txt[1.6.5.6],
316 link:RelNotes/1.6.5.5.txt[1.6.5.5],
317 link:RelNotes/1.6.5.4.txt[1.6.5.4],
318 link:RelNotes/1.6.5.3.txt[1.6.5.3],
319 link:RelNotes/1.6.5.2.txt[1.6.5.2],
320 link:RelNotes/1.6.5.1.txt[1.6.5.1],
321 link:RelNotes/1.6.5.txt[1.6.5].
323 * link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
326 link:RelNotes/1.6.4.5.txt[1.6.4.5],
327 link:RelNotes/1.6.4.4.txt[1.6.4.4],
328 link:RelNotes/1.6.4.3.txt[1.6.4.3],
329 link:RelNotes/1.6.4.2.txt[1.6.4.2],
330 link:RelNotes/1.6.4.1.txt[1.6.4.1],
331 link:RelNotes/1.6.4.txt[1.6.4].
333 * link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
336 link:RelNotes/1.6.3.4.txt[1.6.3.4],
337 link:RelNotes/1.6.3.3.txt[1.6.3.3],
338 link:RelNotes/1.6.3.2.txt[1.6.3.2],
339 link:RelNotes/1.6.3.1.txt[1.6.3.1],
340 link:RelNotes/1.6.3.txt[1.6.3].
343 link:RelNotes/1.6.2.5.txt[1.6.2.5],
344 link:RelNotes/1.6.2.4.txt[1.6.2.4],
345 link:RelNotes/1.6.2.3.txt[1.6.2.3],
346 link:RelNotes/1.6.2.2.txt[1.6.2.2],
347 link:RelNotes/1.6.2.1.txt[1.6.2.1],
348 link:RelNotes/1.6.2.txt[1.6.2].
350 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
353 link:RelNotes/1.6.1.3.txt[1.6.1.3],
354 link:RelNotes/1.6.1.2.txt[1.6.1.2],
355 link:RelNotes/1.6.1.1.txt[1.6.1.1],
356 link:RelNotes/1.6.1.txt[1.6.1].
358 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
361 link:RelNotes/1.6.0.6.txt[1.6.0.6],
362 link:RelNotes/1.6.0.5.txt[1.6.0.5],
363 link:RelNotes/1.6.0.4.txt[1.6.0.4],
364 link:RelNotes/1.6.0.3.txt[1.6.0.3],
365 link:RelNotes/1.6.0.2.txt[1.6.0.2],
366 link:RelNotes/1.6.0.1.txt[1.6.0.1],
367 link:RelNotes/1.6.0.txt[1.6.0].
369 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
372 link:RelNotes/1.5.6.6.txt[1.5.6.6],
373 link:RelNotes/1.5.6.5.txt[1.5.6.5],
374 link:RelNotes/1.5.6.4.txt[1.5.6.4],
375 link:RelNotes/1.5.6.3.txt[1.5.6.3],
376 link:RelNotes/1.5.6.2.txt[1.5.6.2],
377 link:RelNotes/1.5.6.1.txt[1.5.6.1],
378 link:RelNotes/1.5.6.txt[1.5.6].
380 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
383 link:RelNotes/1.5.5.6.txt[1.5.5.6],
384 link:RelNotes/1.5.5.5.txt[1.5.5.5],
385 link:RelNotes/1.5.5.4.txt[1.5.5.4],
386 link:RelNotes/1.5.5.3.txt[1.5.5.3],
387 link:RelNotes/1.5.5.2.txt[1.5.5.2],
388 link:RelNotes/1.5.5.1.txt[1.5.5.1],
389 link:RelNotes/1.5.5.txt[1.5.5].
391 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
394 link:RelNotes/1.5.4.7.txt[1.5.4.7],
395 link:RelNotes/1.5.4.6.txt[1.5.4.6],
396 link:RelNotes/1.5.4.5.txt[1.5.4.5],
397 link:RelNotes/1.5.4.4.txt[1.5.4.4],
398 link:RelNotes/1.5.4.3.txt[1.5.4.3],
399 link:RelNotes/1.5.4.2.txt[1.5.4.2],
400 link:RelNotes/1.5.4.1.txt[1.5.4.1],
401 link:RelNotes/1.5.4.txt[1.5.4].
403 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
406 link:RelNotes/1.5.3.8.txt[1.5.3.8],
407 link:RelNotes/1.5.3.7.txt[1.5.3.7],
408 link:RelNotes/1.5.3.6.txt[1.5.3.6],
409 link:RelNotes/1.5.3.5.txt[1.5.3.5],
410 link:RelNotes/1.5.3.4.txt[1.5.3.4],
411 link:RelNotes/1.5.3.3.txt[1.5.3.3],
412 link:RelNotes/1.5.3.2.txt[1.5.3.2],
413 link:RelNotes/1.5.3.1.txt[1.5.3.1],
414 link:RelNotes/1.5.3.txt[1.5.3].
416 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
419 link:RelNotes/1.5.2.5.txt[1.5.2.5],
420 link:RelNotes/1.5.2.4.txt[1.5.2.4],
421 link:RelNotes/1.5.2.3.txt[1.5.2.3],
422 link:RelNotes/1.5.2.2.txt[1.5.2.2],
423 link:RelNotes/1.5.2.1.txt[1.5.2.1],
424 link:RelNotes/1.5.2.txt[1.5.2].
426 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
429 link:RelNotes/1.5.1.6.txt[1.5.1.6],
430 link:RelNotes/1.5.1.5.txt[1.5.1.5],
431 link:RelNotes/1.5.1.4.txt[1.5.1.4],
432 link:RelNotes/1.5.1.3.txt[1.5.1.3],
433 link:RelNotes/1.5.1.2.txt[1.5.1.2],
434 link:RelNotes/1.5.1.1.txt[1.5.1.1],
435 link:RelNotes/1.5.1.txt[1.5.1].
437 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
440 link:RelNotes/1.5.0.7.txt[1.5.0.7],
441 link:RelNotes/1.5.0.6.txt[1.5.0.6],
442 link:RelNotes/1.5.0.5.txt[1.5.0.5],
443 link:RelNotes/1.5.0.3.txt[1.5.0.3],
444 link:RelNotes/1.5.0.2.txt[1.5.0.2],
445 link:RelNotes/1.5.0.1.txt[1.5.0.1],
446 link:RelNotes/1.5.0.txt[1.5.0].
448 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
449 link:v1.3.3/git.html[1.3.3],
450 link:v1.2.6/git.html[1.2.6],
451 link:v1.0.13/git.html[1.0.13].
460 Prints the Git suite version that the 'git' program came from.
463 Prints the synopsis and a list of the most commonly used
464 commands. If the option '--all' or '-a' is given then all
465 available commands are printed. If a Git command is named this
466 option will bring up the manual page for that command.
468 Other options are available to control how the manual page is
469 displayed. See linkgit:git-help[1] for more information,
470 because `git --help ...` is converted internally into `git
474 Run as if git was started in '<path>' instead of the current working
475 directory. When multiple `-C` options are given, each subsequent
476 non-absolute `-C <path>` is interpreted relative to the preceding `-C
479 This option affects options that expect path name like `--git-dir` and
480 `--work-tree` in that their interpretations of the path names would be
481 made relative to the working directory caused by the `-C` option. For
482 example the following invocations are equivalent:
484 git --git-dir=a.git --work-tree=b -C c status
485 git --git-dir=c/a.git --work-tree=c/b status
488 Pass a configuration parameter to the command. The value
489 given will override values from configuration files.
490 The <name> is expected in the same format as listed by
491 'git config' (subkeys separated by dots).
493 Note that omitting the `=` in `git -c foo.bar ...` is allowed and sets
494 `foo.bar` to the boolean true value (just like `[foo]bar` would in a
495 config file). Including the equals but with an empty value (like `git -c
496 foo.bar= ...`) sets `foo.bar` to the empty string.
498 --exec-path[=<path>]::
499 Path to wherever your core Git programs are installed.
500 This can also be controlled by setting the GIT_EXEC_PATH
501 environment variable. If no path is given, 'git' will print
502 the current setting and then exit.
505 Print the path, without trailing slash, where Git's HTML
506 documentation is installed and exit.
509 Print the manpath (see `man(1)`) for the man pages for
510 this version of Git and exit.
513 Print the path where the Info files documenting this
514 version of Git are installed and exit.
518 Pipe all output into 'less' (or if set, $PAGER) if standard
519 output is a terminal. This overrides the `pager.<cmd>`
520 configuration options (see the "Configuration Mechanism" section
524 Do not pipe Git output into a pager.
527 Set the path to the repository. This can also be controlled by
528 setting the GIT_DIR environment variable. It can be an absolute
529 path or relative path to current working directory.
532 Set the path to the working tree. It can be an absolute path
533 or a path relative to the current working directory.
534 This can also be controlled by setting the GIT_WORK_TREE
535 environment variable and the core.worktree configuration
536 variable (see core.worktree in linkgit:git-config[1] for a
537 more detailed discussion).
540 Set the Git namespace. See linkgit:gitnamespaces[7] for more
541 details. Equivalent to setting the `GIT_NAMESPACE` environment
545 Treat the repository as a bare repository. If GIT_DIR
546 environment is not set, it is set to the current working
549 --no-replace-objects::
550 Do not use replacement refs to replace Git objects. See
551 linkgit:git-replace[1] for more information.
553 --literal-pathspecs::
554 Treat pathspecs literally (i.e. no globbing, no pathspec magic).
555 This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
559 Add "glob" magic to all pathspec. This is equivalent to setting
560 the `GIT_GLOB_PATHSPECS` environment variable to `1`. Disabling
561 globbing on individual pathspecs can be done using pathspec
565 Add "literal" magic to all pathspec. This is equivalent to setting
566 the `GIT_NOGLOB_PATHSPECS` environment variable to `1`. Enabling
567 globbing on individual pathspecs can be done using pathspec
571 Add "icase" magic to all pathspec. This is equivalent to setting
572 the `GIT_ICASE_PATHSPECS` environment variable to `1`.
577 We divide Git into high level ("porcelain") commands and low level
578 ("plumbing") commands.
580 High-level commands (porcelain)
581 -------------------------------
583 We separate the porcelain commands into the main commands and some
584 ancillary user utilities.
586 Main porcelain commands
587 ~~~~~~~~~~~~~~~~~~~~~~~
589 include::cmds-mainporcelain.txt[]
595 include::cmds-ancillarymanipulators.txt[]
599 include::cmds-ancillaryinterrogators.txt[]
602 Interacting with Others
603 ~~~~~~~~~~~~~~~~~~~~~~~
605 These commands are to interact with foreign SCM and with other
606 people via patch over e-mail.
608 include::cmds-foreignscminterface.txt[]
611 Low-level commands (plumbing)
612 -----------------------------
614 Although Git includes its
615 own porcelain layer, its low-level commands are sufficient to support
616 development of alternative porcelains. Developers of such porcelains
617 might start by reading about linkgit:git-update-index[1] and
618 linkgit:git-read-tree[1].
620 The interface (input, output, set of options and the semantics)
621 to these low-level commands are meant to be a lot more stable
622 than Porcelain level commands, because these commands are
623 primarily for scripted use. The interface to Porcelain commands
624 on the other hand are subject to change in order to improve the
627 The following description divides
628 the low-level commands into commands that manipulate objects (in
629 the repository, index, and working tree), commands that interrogate and
630 compare objects, and commands that move objects and references between
634 Manipulation commands
635 ~~~~~~~~~~~~~~~~~~~~~
637 include::cmds-plumbingmanipulators.txt[]
640 Interrogation commands
641 ~~~~~~~~~~~~~~~~~~~~~~
643 include::cmds-plumbinginterrogators.txt[]
645 In general, the interrogate commands do not touch the files in
649 Synching repositories
650 ~~~~~~~~~~~~~~~~~~~~~
652 include::cmds-synchingrepositories.txt[]
654 The following are helper commands used by the above; end users
655 typically do not use them directly.
657 include::cmds-synchelpers.txt[]
660 Internal helper commands
661 ~~~~~~~~~~~~~~~~~~~~~~~~
663 These are internal helper commands used by other commands; end
664 users typically do not use them directly.
666 include::cmds-purehelpers.txt[]
669 Configuration Mechanism
670 -----------------------
672 Git uses a simple text format to store customizations that are per
673 repository and are per user. Such a configuration file may look
678 # A '#' or ';' character indicates a comment.
683 ; Don't trust file modes
688 name = "Junio C Hamano"
689 email = "gitster@pobox.com"
693 Various commands read from the configuration file and adjust
694 their operation accordingly. See linkgit:git-config[1] for a
695 list and more details about the configuration mechanism.
698 Identifier Terminology
699 ----------------------
701 Indicates the object name for any type of object.
704 Indicates a blob object name.
707 Indicates a tree object name.
710 Indicates a commit object name.
713 Indicates a tree, commit or tag object name. A
714 command that takes a <tree-ish> argument ultimately wants to
715 operate on a <tree> object but automatically dereferences
716 <commit> and <tag> objects that point at a <tree>.
719 Indicates a commit or tag object name. A
720 command that takes a <commit-ish> argument ultimately wants to
721 operate on a <commit> object but automatically dereferences
722 <tag> objects that point at a <commit>.
725 Indicates that an object type is required.
726 Currently one of: `blob`, `tree`, `commit`, or `tag`.
729 Indicates a filename - almost always relative to the
730 root of the tree structure `GIT_INDEX_FILE` describes.
734 Any Git command accepting any <object> can also use the following
738 indicates the head of the current branch.
742 (i.e. a `refs/tags/<tag>` reference).
746 (i.e. a `refs/heads/<head>` reference).
748 For a more complete list of ways to spell object names, see
749 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
752 File/Directory Structure
753 ------------------------
755 Please see the linkgit:gitrepository-layout[5] document.
757 Read linkgit:githooks[5] for more details about each hook.
759 Higher level SCMs may provide and manage additional information in the
765 Please see linkgit:gitglossary[7].
768 Environment Variables
769 ---------------------
770 Various Git commands use the following environment variables:
774 These environment variables apply to 'all' core Git commands. Nb: it
775 is worth noting that they may be used/overridden by SCMS sitting above
776 Git so take care if using Cogito etc.
779 This environment allows the specification of an alternate
780 index file. If not specified, the default of `$GIT_DIR/index`
783 'GIT_INDEX_VERSION'::
784 This environment variable allows the specification of an index
785 version for new repositories. It won't affect existing index
786 files. By default index file version 2 or 3 is used. See
787 linkgit:git-update-index[1] for more information.
789 'GIT_OBJECT_DIRECTORY'::
790 If the object storage directory is specified via this
791 environment variable then the sha1 directories are created
792 underneath - otherwise the default `$GIT_DIR/objects`
795 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
796 Due to the immutable nature of Git objects, old objects can be
797 archived into shared, read-only directories. This variable
798 specifies a ":" separated (on Windows ";" separated) list
799 of Git object directories which can be used to search for Git
800 objects. New objects will not be written to these directories.
803 If the 'GIT_DIR' environment variable is set then it
804 specifies a path to use instead of the default `.git`
805 for the base of the repository.
806 The '--git-dir' command-line option also sets this value.
809 Set the path to the root of the working tree.
810 This can also be controlled by the '--work-tree' command-line
811 option and the core.worktree configuration variable.
814 Set the Git namespace; see linkgit:gitnamespaces[7] for details.
815 The '--namespace' command-line option also sets this value.
817 'GIT_CEILING_DIRECTORIES'::
818 This should be a colon-separated list of absolute paths. If
819 set, it is a list of directories that Git should not chdir up
820 into while looking for a repository directory (useful for
821 excluding slow-loading network directories). It will not
822 exclude the current working directory or a GIT_DIR set on the
823 command line or in the environment. Normally, Git has to read
824 the entries in this list and resolve any symlink that
825 might be present in order to compare them with the current
826 directory. However, if even this access is slow, you
827 can add an empty entry to the list to tell Git that the
828 subsequent entries are not symlinks and needn't be resolved;
830 'GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink'.
832 'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
833 When run in a directory that does not have ".git" repository
834 directory, Git tries to find such a directory in the parent
835 directories to find the top of the working tree, but by default it
836 does not cross filesystem boundaries. This environment variable
837 can be set to true to tell Git not to stop at filesystem
838 boundaries. Like 'GIT_CEILING_DIRECTORIES', this will not affect
839 an explicit repository directory set via 'GIT_DIR' or on the
847 'GIT_COMMITTER_NAME'::
848 'GIT_COMMITTER_EMAIL'::
849 'GIT_COMMITTER_DATE'::
851 see linkgit:git-commit-tree[1]
856 Only valid setting is "--unified=??" or "-u??" to set the
857 number of context lines shown when a unified diff is created.
858 This takes precedence over any "-U" or "--unified" option
859 value passed on the Git diff command line.
861 'GIT_EXTERNAL_DIFF'::
862 When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
863 program named by it is called, instead of the diff invocation
864 described above. For a path that is added, removed, or modified,
865 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
867 path old-file old-hex old-mode new-file new-hex new-mode
871 <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
872 contents of <old|new>,
873 <old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
874 <old|new>-mode:: are the octal representation of the file modes.
876 The file parameters can point at the user's working file
877 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
878 when a new file is added), or a temporary file (e.g. `old-file` in the
879 index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
880 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
882 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
885 For each path 'GIT_EXTERNAL_DIFF' is called, two environment variables,
886 'GIT_DIFF_PATH_COUNTER' and 'GIT_DIFF_PATH_TOTAL' are set.
888 'GIT_DIFF_PATH_COUNTER'::
889 A 1-based counter incremented by one for every path.
891 'GIT_DIFF_PATH_TOTAL'::
892 The total number of paths.
896 'GIT_MERGE_VERBOSITY'::
897 A number controlling the amount of output shown by
898 the recursive merge strategy. Overrides merge.verbosity.
899 See linkgit:git-merge[1]
902 This environment variable overrides `$PAGER`. If it is set
903 to an empty string or to the value "cat", Git will not launch
904 a pager. See also the `core.pager` option in
905 linkgit:git-config[1].
908 This environment variable overrides `$EDITOR` and `$VISUAL`.
909 It is used by several Git commands when, on interactive mode,
910 an editor is to be launched. See also linkgit:git-var[1]
911 and the `core.editor` option in linkgit:git-config[1].
915 If either of these environment variables is set then 'git fetch'
916 and 'git push' will use the specified command instead of 'ssh'
917 when they need to connect to a remote system.
918 The command will be given exactly two or four arguments: the
919 'username@host' (or just 'host') from the URL and the shell
920 command to execute on that remote system, optionally preceded by
921 '-p' (literally) and the 'port' from the URL when it specifies
922 something other than the default SSH port.
924 `$GIT_SSH_COMMAND` takes precedence over `$GIT_SSH`, and is interpreted
925 by the shell, which allows additional arguments to be included.
926 `$GIT_SSH` on the other hand must be just the path to a program
927 (which can be a wrapper shell script, if additional arguments are
930 Usually it is easier to configure any desired options through your
931 personal `.ssh/config` file. Please consult your ssh documentation
935 If this environment variable is set, then Git commands which need to
936 acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
937 will call this program with a suitable prompt as command-line argument
938 and read the password from its STDOUT. See also the 'core.askPass'
939 option in linkgit:git-config[1].
941 'GIT_TERMINAL_PROMPT'::
942 If this environment variable is set to `0`, git will not prompt
943 on the terminal (e.g., when asking for HTTP authentication).
945 'GIT_CONFIG_NOSYSTEM'::
946 Whether to skip reading settings from the system-wide
947 `$(prefix)/etc/gitconfig` file. This environment variable can
948 be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
949 predictable environment for a picky script, or you can set it
950 temporarily to avoid using a buggy `/etc/gitconfig` file while
951 waiting for someone with sufficient permissions to fix it.
954 If this environment variable is set to "1", then commands such
955 as 'git blame' (in incremental mode), 'git rev-list', 'git log',
956 'git check-attr' and 'git check-ignore' will
957 force a flush of the output stream after each record have been
959 variable is set to "0", the output of these commands will be done
960 using completely buffered I/O. If this environment variable is
961 not set, Git will choose buffered or record-oriented flushing
962 based on whether stdout appears to be redirected to a file or not.
965 Enables general trace messages, e.g. alias expansion, built-in
966 command execution and external command execution.
968 If this variable is set to "1", "2" or "true" (comparison
969 is case insensitive), trace messages will be printed to
972 If the variable is set to an integer value greater than 2
973 and lower than 10 (strictly) then Git will interpret this
974 value as an open file descriptor and will try to write the
975 trace messages into this file descriptor.
977 Alternatively, if the variable is set to an absolute path
978 (starting with a '/' character), Git will interpret this
979 as a file path and will try to write the trace messages
982 Unsetting the variable, or setting it to empty, "0" or
983 "false" (case insensitive) disables trace messages.
985 'GIT_TRACE_PACK_ACCESS'::
986 Enables trace messages for all accesses to any packs. For each
987 access, the pack file name and an offset in the pack is
988 recorded. This may be helpful for troubleshooting some
989 pack-related performance problems.
990 See 'GIT_TRACE' for available trace output options.
993 Enables trace messages for all packets coming in or out of a
994 given program. This can help with debugging object negotiation
995 or other protocol issues. Tracing is turned off at a packet
996 starting with "PACK".
997 See 'GIT_TRACE' for available trace output options.
999 'GIT_TRACE_PERFORMANCE'::
1000 Enables performance related trace messages, e.g. total execution
1001 time of each Git command.
1002 See 'GIT_TRACE' for available trace output options.
1005 Enables trace messages printing the .git, working tree and current
1006 working directory after Git has completed its setup phase.
1007 See 'GIT_TRACE' for available trace output options.
1009 'GIT_TRACE_SHALLOW'::
1010 Enables trace messages that can help debugging fetching /
1011 cloning of shallow repositories.
1012 See 'GIT_TRACE' for available trace output options.
1014 GIT_LITERAL_PATHSPECS::
1015 Setting this variable to `1` will cause Git to treat all
1016 pathspecs literally, rather than as glob patterns. For example,
1017 running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
1018 for commits that touch the path `*.c`, not any paths that the
1019 glob `*.c` matches. You might want this if you are feeding
1020 literal paths to Git (e.g., paths previously given to you by
1021 `git ls-tree`, `--raw` diff output, etc).
1023 GIT_GLOB_PATHSPECS::
1024 Setting this variable to `1` will cause Git to treat all
1025 pathspecs as glob patterns (aka "glob" magic).
1027 GIT_NOGLOB_PATHSPECS::
1028 Setting this variable to `1` will cause Git to treat all
1029 pathspecs as literal (aka "literal" magic).
1031 GIT_ICASE_PATHSPECS::
1032 Setting this variable to `1` will cause Git to treat all
1033 pathspecs as case-insensitive.
1035 'GIT_REFLOG_ACTION'::
1036 When a ref is updated, reflog entries are created to keep
1037 track of the reason why the ref was updated (which is
1038 typically the name of the high-level command that updated
1039 the ref), in addition to the old and new values of the ref.
1040 A scripted Porcelain command can use set_reflog_action
1041 helper function in `git-sh-setup` to set its name to this
1042 variable when it is invoked as the top level command by the
1043 end user, to be recorded in the body of the reflog.
1045 `GIT_REF_PARANOIA`::
1046 If set to `1`, include broken or badly named refs when iterating
1047 over lists of refs. In a normal, non-corrupted repository, this
1048 does nothing. However, enabling it may help git to detect and
1049 abort some operations in the presence of broken refs. Git sets
1050 this variable automatically when performing destructive
1051 operations like linkgit:git-prune[1]. You should not need to set
1052 it yourself unless you want to be paranoid about making sure
1053 an operation has touched every ref (e.g., because you are
1054 cloning a repository to make a backup).
1057 Discussion[[Discussion]]
1058 ------------------------
1060 More detail on the following is available from the
1061 link:user-manual.html#git-concepts[Git concepts chapter of the
1062 user-manual] and linkgit:gitcore-tutorial[7].
1064 A Git project normally consists of a working directory with a ".git"
1065 subdirectory at the top level. The .git directory contains, among other
1066 things, a compressed object database representing the complete history
1067 of the project, an "index" file which links that history to the current
1068 contents of the working tree, and named pointers into that history such
1069 as tags and branch heads.
1071 The object database contains objects of three main types: blobs, which
1072 hold file data; trees, which point to blobs and other trees to build up
1073 directory hierarchies; and commits, which each reference a single tree
1074 and some number of parent commits.
1076 The commit, equivalent to what other systems call a "changeset" or
1077 "version", represents a step in the project's history, and each parent
1078 represents an immediately preceding step. Commits with more than one
1079 parent represent merges of independent lines of development.
1081 All objects are named by the SHA-1 hash of their contents, normally
1082 written as a string of 40 hex digits. Such names are globally unique.
1083 The entire history leading up to a commit can be vouched for by signing
1084 just that commit. A fourth object type, the tag, is provided for this
1087 When first created, objects are stored in individual files, but for
1088 efficiency may later be compressed together into "pack files".
1090 Named pointers called refs mark interesting points in history. A ref
1091 may contain the SHA-1 name of an object or the name of another ref. Refs
1092 with names beginning `ref/head/` contain the SHA-1 name of the most
1093 recent commit (or "head") of a branch under development. SHA-1 names of
1094 tags of interest are stored under `ref/tags/`. A special ref named
1095 `HEAD` contains the name of the currently checked-out branch.
1097 The index file is initialized with a list of all paths and, for each
1098 path, a blob object and a set of attributes. The blob object represents
1099 the contents of the file as of the head of the current branch. The
1100 attributes (last modified time, size, etc.) are taken from the
1101 corresponding file in the working tree. Subsequent changes to the
1102 working tree can be found by comparing these attributes. The index may
1103 be updated with new content, and new commits may be created from the
1104 content stored in the index.
1106 The index is also capable of storing multiple entries (called "stages")
1107 for a given pathname. These stages are used to hold the various
1108 unmerged version of a file when a merge is in progress.
1110 FURTHER DOCUMENTATION
1111 ---------------------
1113 See the references in the "description" section to get started
1114 using Git. The following is probably more detail than necessary
1115 for a first-time user.
1117 The link:user-manual.html#git-concepts[Git concepts chapter of the
1118 user-manual] and linkgit:gitcore-tutorial[7] both provide
1119 introductions to the underlying Git architecture.
1121 See linkgit:gitworkflows[7] for an overview of recommended workflows.
1123 See also the link:howto-index.html[howto] documents for some useful
1126 The internals are documented in the
1127 link:technical/api-index.html[Git API documentation].
1129 Users migrating from CVS may also want to
1130 read linkgit:gitcvs-migration[7].
1135 Git was started by Linus Torvalds, and is currently maintained by Junio
1136 C Hamano. Numerous contributions have come from the Git mailing list
1137 <git@vger.kernel.org>. http://www.openhub.net/p/git/contributors/summary
1138 gives you a more complete list of contributors.
1140 If you have a clone of git.git itself, the
1141 output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
1142 the authors for specific parts of the project.
1147 Report bugs to the Git mailing list <git@vger.kernel.org> where the
1148 development and maintenance is primarily done. You do not have to be
1149 subscribed to the list to send a message there.
1153 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
1154 linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
1155 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
1156 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
1157 linkgit:gitworkflows[7]
1161 Part of the linkgit:git[1] suite