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.7/git.html[documentation for release 2.4.7]
49 link:RelNotes/2.4.7.txt[2.4.7],
50 link:RelNotes/2.4.6.txt[2.4.6],
51 link:RelNotes/2.4.5.txt[2.4.5],
52 link:RelNotes/2.4.4.txt[2.4.4],
53 link:RelNotes/2.4.3.txt[2.4.3],
54 link:RelNotes/2.4.2.txt[2.4.2],
55 link:RelNotes/2.4.1.txt[2.4.1],
56 link:RelNotes/2.4.0.txt[2.4].
58 * link:v2.3.8/git.html[documentation for release 2.3.8]
61 link:RelNotes/2.3.8.txt[2.3.8],
62 link:RelNotes/2.3.7.txt[2.3.7],
63 link:RelNotes/2.3.6.txt[2.3.6],
64 link:RelNotes/2.3.5.txt[2.3.5],
65 link:RelNotes/2.3.4.txt[2.3.4],
66 link:RelNotes/2.3.3.txt[2.3.3],
67 link:RelNotes/2.3.2.txt[2.3.2],
68 link:RelNotes/2.3.1.txt[2.3.1],
69 link:RelNotes/2.3.0.txt[2.3].
71 * link:v2.2.2/git.html[documentation for release 2.2.2]
74 link:RelNotes/2.2.2.txt[2.2.2],
75 link:RelNotes/2.2.1.txt[2.2.1],
76 link:RelNotes/2.2.0.txt[2.2].
78 * link:v2.1.4/git.html[documentation for release 2.1.4]
81 link:RelNotes/2.1.4.txt[2.1.4],
82 link:RelNotes/2.1.3.txt[2.1.3],
83 link:RelNotes/2.1.2.txt[2.1.2],
84 link:RelNotes/2.1.1.txt[2.1.1],
85 link:RelNotes/2.1.0.txt[2.1].
87 * link:v2.0.5/git.html[documentation for release 2.0.5]
90 link:RelNotes/2.0.5.txt[2.0.5],
91 link:RelNotes/2.0.4.txt[2.0.4],
92 link:RelNotes/2.0.3.txt[2.0.3],
93 link:RelNotes/2.0.2.txt[2.0.2],
94 link:RelNotes/2.0.1.txt[2.0.1],
95 link:RelNotes/2.0.0.txt[2.0.0].
97 * link:v1.9.5/git.html[documentation for release 1.9.5]
100 link:RelNotes/1.9.5.txt[1.9.5],
101 link:RelNotes/1.9.4.txt[1.9.4],
102 link:RelNotes/1.9.3.txt[1.9.3],
103 link:RelNotes/1.9.2.txt[1.9.2],
104 link:RelNotes/1.9.1.txt[1.9.1],
105 link:RelNotes/1.9.0.txt[1.9.0].
107 * link:v1.8.5.6/git.html[documentation for release 1.8.5.6]
110 link:RelNotes/1.8.5.6.txt[1.8.5.6],
111 link:RelNotes/1.8.5.5.txt[1.8.5.5],
112 link:RelNotes/1.8.5.4.txt[1.8.5.4],
113 link:RelNotes/1.8.5.3.txt[1.8.5.3],
114 link:RelNotes/1.8.5.2.txt[1.8.5.2],
115 link:RelNotes/1.8.5.1.txt[1.8.5.1],
116 link:RelNotes/1.8.5.txt[1.8.5].
118 * link:v1.8.4.5/git.html[documentation for release 1.8.4.5]
121 link:RelNotes/1.8.4.5.txt[1.8.4.5],
122 link:RelNotes/1.8.4.4.txt[1.8.4.4],
123 link:RelNotes/1.8.4.3.txt[1.8.4.3],
124 link:RelNotes/1.8.4.2.txt[1.8.4.2],
125 link:RelNotes/1.8.4.1.txt[1.8.4.1],
126 link:RelNotes/1.8.4.txt[1.8.4].
128 * link:v1.8.3.4/git.html[documentation for release 1.8.3.4]
131 link:RelNotes/1.8.3.4.txt[1.8.3.4],
132 link:RelNotes/1.8.3.3.txt[1.8.3.3],
133 link:RelNotes/1.8.3.2.txt[1.8.3.2],
134 link:RelNotes/1.8.3.1.txt[1.8.3.1],
135 link:RelNotes/1.8.3.txt[1.8.3].
137 * link:v1.8.2.3/git.html[documentation for release 1.8.2.3]
140 link:RelNotes/1.8.2.3.txt[1.8.2.3],
141 link:RelNotes/1.8.2.2.txt[1.8.2.2],
142 link:RelNotes/1.8.2.1.txt[1.8.2.1],
143 link:RelNotes/1.8.2.txt[1.8.2].
145 * link:v1.8.1.6/git.html[documentation for release 1.8.1.6]
148 link:RelNotes/1.8.1.6.txt[1.8.1.6],
149 link:RelNotes/1.8.1.5.txt[1.8.1.5],
150 link:RelNotes/1.8.1.4.txt[1.8.1.4],
151 link:RelNotes/1.8.1.3.txt[1.8.1.3],
152 link:RelNotes/1.8.1.2.txt[1.8.1.2],
153 link:RelNotes/1.8.1.1.txt[1.8.1.1],
154 link:RelNotes/1.8.1.txt[1.8.1].
156 * link:v1.8.0.3/git.html[documentation for release 1.8.0.3]
159 link:RelNotes/1.8.0.3.txt[1.8.0.3],
160 link:RelNotes/1.8.0.2.txt[1.8.0.2],
161 link:RelNotes/1.8.0.1.txt[1.8.0.1],
162 link:RelNotes/1.8.0.txt[1.8.0].
164 * link:v1.7.12.4/git.html[documentation for release 1.7.12.4]
167 link:RelNotes/1.7.12.4.txt[1.7.12.4],
168 link:RelNotes/1.7.12.3.txt[1.7.12.3],
169 link:RelNotes/1.7.12.2.txt[1.7.12.2],
170 link:RelNotes/1.7.12.1.txt[1.7.12.1],
171 link:RelNotes/1.7.12.txt[1.7.12].
173 * link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
176 link:RelNotes/1.7.11.7.txt[1.7.11.7],
177 link:RelNotes/1.7.11.6.txt[1.7.11.6],
178 link:RelNotes/1.7.11.5.txt[1.7.11.5],
179 link:RelNotes/1.7.11.4.txt[1.7.11.4],
180 link:RelNotes/1.7.11.3.txt[1.7.11.3],
181 link:RelNotes/1.7.11.2.txt[1.7.11.2],
182 link:RelNotes/1.7.11.1.txt[1.7.11.1],
183 link:RelNotes/1.7.11.txt[1.7.11].
185 * link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
188 link:RelNotes/1.7.10.5.txt[1.7.10.5],
189 link:RelNotes/1.7.10.4.txt[1.7.10.4],
190 link:RelNotes/1.7.10.3.txt[1.7.10.3],
191 link:RelNotes/1.7.10.2.txt[1.7.10.2],
192 link:RelNotes/1.7.10.1.txt[1.7.10.1],
193 link:RelNotes/1.7.10.txt[1.7.10].
195 * link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
198 link:RelNotes/1.7.9.7.txt[1.7.9.7],
199 link:RelNotes/1.7.9.6.txt[1.7.9.6],
200 link:RelNotes/1.7.9.5.txt[1.7.9.5],
201 link:RelNotes/1.7.9.4.txt[1.7.9.4],
202 link:RelNotes/1.7.9.3.txt[1.7.9.3],
203 link:RelNotes/1.7.9.2.txt[1.7.9.2],
204 link:RelNotes/1.7.9.1.txt[1.7.9.1],
205 link:RelNotes/1.7.9.txt[1.7.9].
207 * link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
210 link:RelNotes/1.7.8.6.txt[1.7.8.6],
211 link:RelNotes/1.7.8.5.txt[1.7.8.5],
212 link:RelNotes/1.7.8.4.txt[1.7.8.4],
213 link:RelNotes/1.7.8.3.txt[1.7.8.3],
214 link:RelNotes/1.7.8.2.txt[1.7.8.2],
215 link:RelNotes/1.7.8.1.txt[1.7.8.1],
216 link:RelNotes/1.7.8.txt[1.7.8].
218 * link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
221 link:RelNotes/1.7.7.7.txt[1.7.7.7],
222 link:RelNotes/1.7.7.6.txt[1.7.7.6],
223 link:RelNotes/1.7.7.5.txt[1.7.7.5],
224 link:RelNotes/1.7.7.4.txt[1.7.7.4],
225 link:RelNotes/1.7.7.3.txt[1.7.7.3],
226 link:RelNotes/1.7.7.2.txt[1.7.7.2],
227 link:RelNotes/1.7.7.1.txt[1.7.7.1],
228 link:RelNotes/1.7.7.txt[1.7.7].
230 * link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
233 link:RelNotes/1.7.6.6.txt[1.7.6.6],
234 link:RelNotes/1.7.6.5.txt[1.7.6.5],
235 link:RelNotes/1.7.6.4.txt[1.7.6.4],
236 link:RelNotes/1.7.6.3.txt[1.7.6.3],
237 link:RelNotes/1.7.6.2.txt[1.7.6.2],
238 link:RelNotes/1.7.6.1.txt[1.7.6.1],
239 link:RelNotes/1.7.6.txt[1.7.6].
241 * link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
244 link:RelNotes/1.7.5.4.txt[1.7.5.4],
245 link:RelNotes/1.7.5.3.txt[1.7.5.3],
246 link:RelNotes/1.7.5.2.txt[1.7.5.2],
247 link:RelNotes/1.7.5.1.txt[1.7.5.1],
248 link:RelNotes/1.7.5.txt[1.7.5].
250 * link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
253 link:RelNotes/1.7.4.5.txt[1.7.4.5],
254 link:RelNotes/1.7.4.4.txt[1.7.4.4],
255 link:RelNotes/1.7.4.3.txt[1.7.4.3],
256 link:RelNotes/1.7.4.2.txt[1.7.4.2],
257 link:RelNotes/1.7.4.1.txt[1.7.4.1],
258 link:RelNotes/1.7.4.txt[1.7.4].
260 * link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
263 link:RelNotes/1.7.3.5.txt[1.7.3.5],
264 link:RelNotes/1.7.3.4.txt[1.7.3.4],
265 link:RelNotes/1.7.3.3.txt[1.7.3.3],
266 link:RelNotes/1.7.3.2.txt[1.7.3.2],
267 link:RelNotes/1.7.3.1.txt[1.7.3.1],
268 link:RelNotes/1.7.3.txt[1.7.3].
270 * link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
273 link:RelNotes/1.7.2.5.txt[1.7.2.5],
274 link:RelNotes/1.7.2.4.txt[1.7.2.4],
275 link:RelNotes/1.7.2.3.txt[1.7.2.3],
276 link:RelNotes/1.7.2.2.txt[1.7.2.2],
277 link:RelNotes/1.7.2.1.txt[1.7.2.1],
278 link:RelNotes/1.7.2.txt[1.7.2].
280 * link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
283 link:RelNotes/1.7.1.4.txt[1.7.1.4],
284 link:RelNotes/1.7.1.3.txt[1.7.1.3],
285 link:RelNotes/1.7.1.2.txt[1.7.1.2],
286 link:RelNotes/1.7.1.1.txt[1.7.1.1],
287 link:RelNotes/1.7.1.txt[1.7.1].
289 * link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
292 link:RelNotes/1.7.0.9.txt[1.7.0.9],
293 link:RelNotes/1.7.0.8.txt[1.7.0.8],
294 link:RelNotes/1.7.0.7.txt[1.7.0.7],
295 link:RelNotes/1.7.0.6.txt[1.7.0.6],
296 link:RelNotes/1.7.0.5.txt[1.7.0.5],
297 link:RelNotes/1.7.0.4.txt[1.7.0.4],
298 link:RelNotes/1.7.0.3.txt[1.7.0.3],
299 link:RelNotes/1.7.0.2.txt[1.7.0.2],
300 link:RelNotes/1.7.0.1.txt[1.7.0.1],
301 link:RelNotes/1.7.0.txt[1.7.0].
303 * link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
306 link:RelNotes/1.6.6.3.txt[1.6.6.3],
307 link:RelNotes/1.6.6.2.txt[1.6.6.2],
308 link:RelNotes/1.6.6.1.txt[1.6.6.1],
309 link:RelNotes/1.6.6.txt[1.6.6].
311 * link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
314 link:RelNotes/1.6.5.9.txt[1.6.5.9],
315 link:RelNotes/1.6.5.8.txt[1.6.5.8],
316 link:RelNotes/1.6.5.7.txt[1.6.5.7],
317 link:RelNotes/1.6.5.6.txt[1.6.5.6],
318 link:RelNotes/1.6.5.5.txt[1.6.5.5],
319 link:RelNotes/1.6.5.4.txt[1.6.5.4],
320 link:RelNotes/1.6.5.3.txt[1.6.5.3],
321 link:RelNotes/1.6.5.2.txt[1.6.5.2],
322 link:RelNotes/1.6.5.1.txt[1.6.5.1],
323 link:RelNotes/1.6.5.txt[1.6.5].
325 * link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
328 link:RelNotes/1.6.4.5.txt[1.6.4.5],
329 link:RelNotes/1.6.4.4.txt[1.6.4.4],
330 link:RelNotes/1.6.4.3.txt[1.6.4.3],
331 link:RelNotes/1.6.4.2.txt[1.6.4.2],
332 link:RelNotes/1.6.4.1.txt[1.6.4.1],
333 link:RelNotes/1.6.4.txt[1.6.4].
335 * link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
338 link:RelNotes/1.6.3.4.txt[1.6.3.4],
339 link:RelNotes/1.6.3.3.txt[1.6.3.3],
340 link:RelNotes/1.6.3.2.txt[1.6.3.2],
341 link:RelNotes/1.6.3.1.txt[1.6.3.1],
342 link:RelNotes/1.6.3.txt[1.6.3].
345 link:RelNotes/1.6.2.5.txt[1.6.2.5],
346 link:RelNotes/1.6.2.4.txt[1.6.2.4],
347 link:RelNotes/1.6.2.3.txt[1.6.2.3],
348 link:RelNotes/1.6.2.2.txt[1.6.2.2],
349 link:RelNotes/1.6.2.1.txt[1.6.2.1],
350 link:RelNotes/1.6.2.txt[1.6.2].
352 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
355 link:RelNotes/1.6.1.3.txt[1.6.1.3],
356 link:RelNotes/1.6.1.2.txt[1.6.1.2],
357 link:RelNotes/1.6.1.1.txt[1.6.1.1],
358 link:RelNotes/1.6.1.txt[1.6.1].
360 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
363 link:RelNotes/1.6.0.6.txt[1.6.0.6],
364 link:RelNotes/1.6.0.5.txt[1.6.0.5],
365 link:RelNotes/1.6.0.4.txt[1.6.0.4],
366 link:RelNotes/1.6.0.3.txt[1.6.0.3],
367 link:RelNotes/1.6.0.2.txt[1.6.0.2],
368 link:RelNotes/1.6.0.1.txt[1.6.0.1],
369 link:RelNotes/1.6.0.txt[1.6.0].
371 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
374 link:RelNotes/1.5.6.6.txt[1.5.6.6],
375 link:RelNotes/1.5.6.5.txt[1.5.6.5],
376 link:RelNotes/1.5.6.4.txt[1.5.6.4],
377 link:RelNotes/1.5.6.3.txt[1.5.6.3],
378 link:RelNotes/1.5.6.2.txt[1.5.6.2],
379 link:RelNotes/1.5.6.1.txt[1.5.6.1],
380 link:RelNotes/1.5.6.txt[1.5.6].
382 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
385 link:RelNotes/1.5.5.6.txt[1.5.5.6],
386 link:RelNotes/1.5.5.5.txt[1.5.5.5],
387 link:RelNotes/1.5.5.4.txt[1.5.5.4],
388 link:RelNotes/1.5.5.3.txt[1.5.5.3],
389 link:RelNotes/1.5.5.2.txt[1.5.5.2],
390 link:RelNotes/1.5.5.1.txt[1.5.5.1],
391 link:RelNotes/1.5.5.txt[1.5.5].
393 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
396 link:RelNotes/1.5.4.7.txt[1.5.4.7],
397 link:RelNotes/1.5.4.6.txt[1.5.4.6],
398 link:RelNotes/1.5.4.5.txt[1.5.4.5],
399 link:RelNotes/1.5.4.4.txt[1.5.4.4],
400 link:RelNotes/1.5.4.3.txt[1.5.4.3],
401 link:RelNotes/1.5.4.2.txt[1.5.4.2],
402 link:RelNotes/1.5.4.1.txt[1.5.4.1],
403 link:RelNotes/1.5.4.txt[1.5.4].
405 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
408 link:RelNotes/1.5.3.8.txt[1.5.3.8],
409 link:RelNotes/1.5.3.7.txt[1.5.3.7],
410 link:RelNotes/1.5.3.6.txt[1.5.3.6],
411 link:RelNotes/1.5.3.5.txt[1.5.3.5],
412 link:RelNotes/1.5.3.4.txt[1.5.3.4],
413 link:RelNotes/1.5.3.3.txt[1.5.3.3],
414 link:RelNotes/1.5.3.2.txt[1.5.3.2],
415 link:RelNotes/1.5.3.1.txt[1.5.3.1],
416 link:RelNotes/1.5.3.txt[1.5.3].
418 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
421 link:RelNotes/1.5.2.5.txt[1.5.2.5],
422 link:RelNotes/1.5.2.4.txt[1.5.2.4],
423 link:RelNotes/1.5.2.3.txt[1.5.2.3],
424 link:RelNotes/1.5.2.2.txt[1.5.2.2],
425 link:RelNotes/1.5.2.1.txt[1.5.2.1],
426 link:RelNotes/1.5.2.txt[1.5.2].
428 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
431 link:RelNotes/1.5.1.6.txt[1.5.1.6],
432 link:RelNotes/1.5.1.5.txt[1.5.1.5],
433 link:RelNotes/1.5.1.4.txt[1.5.1.4],
434 link:RelNotes/1.5.1.3.txt[1.5.1.3],
435 link:RelNotes/1.5.1.2.txt[1.5.1.2],
436 link:RelNotes/1.5.1.1.txt[1.5.1.1],
437 link:RelNotes/1.5.1.txt[1.5.1].
439 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
442 link:RelNotes/1.5.0.7.txt[1.5.0.7],
443 link:RelNotes/1.5.0.6.txt[1.5.0.6],
444 link:RelNotes/1.5.0.5.txt[1.5.0.5],
445 link:RelNotes/1.5.0.3.txt[1.5.0.3],
446 link:RelNotes/1.5.0.2.txt[1.5.0.2],
447 link:RelNotes/1.5.0.1.txt[1.5.0.1],
448 link:RelNotes/1.5.0.txt[1.5.0].
450 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
451 link:v1.3.3/git.html[1.3.3],
452 link:v1.2.6/git.html[1.2.6],
453 link:v1.0.13/git.html[1.0.13].
462 Prints the Git suite version that the 'git' program came from.
465 Prints the synopsis and a list of the most commonly used
466 commands. If the option '--all' or '-a' is given then all
467 available commands are printed. If a Git command is named this
468 option will bring up the manual page for that command.
470 Other options are available to control how the manual page is
471 displayed. See linkgit:git-help[1] for more information,
472 because `git --help ...` is converted internally into `git
476 Run as if git was started in '<path>' instead of the current working
477 directory. When multiple `-C` options are given, each subsequent
478 non-absolute `-C <path>` is interpreted relative to the preceding `-C
481 This option affects options that expect path name like `--git-dir` and
482 `--work-tree` in that their interpretations of the path names would be
483 made relative to the working directory caused by the `-C` option. For
484 example the following invocations are equivalent:
486 git --git-dir=a.git --work-tree=b -C c status
487 git --git-dir=c/a.git --work-tree=c/b status
490 Pass a configuration parameter to the command. The value
491 given will override values from configuration files.
492 The <name> is expected in the same format as listed by
493 'git config' (subkeys separated by dots).
495 Note that omitting the `=` in `git -c foo.bar ...` is allowed and sets
496 `foo.bar` to the boolean true value (just like `[foo]bar` would in a
497 config file). Including the equals but with an empty value (like `git -c
498 foo.bar= ...`) sets `foo.bar` to the empty string.
500 --exec-path[=<path>]::
501 Path to wherever your core Git programs are installed.
502 This can also be controlled by setting the GIT_EXEC_PATH
503 environment variable. If no path is given, 'git' will print
504 the current setting and then exit.
507 Print the path, without trailing slash, where Git's HTML
508 documentation is installed and exit.
511 Print the manpath (see `man(1)`) for the man pages for
512 this version of Git and exit.
515 Print the path where the Info files documenting this
516 version of Git are installed and exit.
520 Pipe all output into 'less' (or if set, $PAGER) if standard
521 output is a terminal. This overrides the `pager.<cmd>`
522 configuration options (see the "Configuration Mechanism" section
526 Do not pipe Git output into a pager.
529 Set the path to the repository. This can also be controlled by
530 setting the GIT_DIR environment variable. It can be an absolute
531 path or relative path to current working directory.
534 Set the path to the working tree. It can be an absolute path
535 or a path relative to the current working directory.
536 This can also be controlled by setting the GIT_WORK_TREE
537 environment variable and the core.worktree configuration
538 variable (see core.worktree in linkgit:git-config[1] for a
539 more detailed discussion).
542 Set the Git namespace. See linkgit:gitnamespaces[7] for more
543 details. Equivalent to setting the `GIT_NAMESPACE` environment
547 Treat the repository as a bare repository. If GIT_DIR
548 environment is not set, it is set to the current working
551 --no-replace-objects::
552 Do not use replacement refs to replace Git objects. See
553 linkgit:git-replace[1] for more information.
555 --literal-pathspecs::
556 Treat pathspecs literally (i.e. no globbing, no pathspec magic).
557 This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
561 Add "glob" magic to all pathspec. This is equivalent to setting
562 the `GIT_GLOB_PATHSPECS` environment variable to `1`. Disabling
563 globbing on individual pathspecs can be done using pathspec
567 Add "literal" magic to all pathspec. This is equivalent to setting
568 the `GIT_NOGLOB_PATHSPECS` environment variable to `1`. Enabling
569 globbing on individual pathspecs can be done using pathspec
573 Add "icase" magic to all pathspec. This is equivalent to setting
574 the `GIT_ICASE_PATHSPECS` environment variable to `1`.
579 We divide Git into high level ("porcelain") commands and low level
580 ("plumbing") commands.
582 High-level commands (porcelain)
583 -------------------------------
585 We separate the porcelain commands into the main commands and some
586 ancillary user utilities.
588 Main porcelain commands
589 ~~~~~~~~~~~~~~~~~~~~~~~
591 include::cmds-mainporcelain.txt[]
597 include::cmds-ancillarymanipulators.txt[]
601 include::cmds-ancillaryinterrogators.txt[]
604 Interacting with Others
605 ~~~~~~~~~~~~~~~~~~~~~~~
607 These commands are to interact with foreign SCM and with other
608 people via patch over e-mail.
610 include::cmds-foreignscminterface.txt[]
613 Low-level commands (plumbing)
614 -----------------------------
616 Although Git includes its
617 own porcelain layer, its low-level commands are sufficient to support
618 development of alternative porcelains. Developers of such porcelains
619 might start by reading about linkgit:git-update-index[1] and
620 linkgit:git-read-tree[1].
622 The interface (input, output, set of options and the semantics)
623 to these low-level commands are meant to be a lot more stable
624 than Porcelain level commands, because these commands are
625 primarily for scripted use. The interface to Porcelain commands
626 on the other hand are subject to change in order to improve the
629 The following description divides
630 the low-level commands into commands that manipulate objects (in
631 the repository, index, and working tree), commands that interrogate and
632 compare objects, and commands that move objects and references between
636 Manipulation commands
637 ~~~~~~~~~~~~~~~~~~~~~
639 include::cmds-plumbingmanipulators.txt[]
642 Interrogation commands
643 ~~~~~~~~~~~~~~~~~~~~~~
645 include::cmds-plumbinginterrogators.txt[]
647 In general, the interrogate commands do not touch the files in
651 Synching repositories
652 ~~~~~~~~~~~~~~~~~~~~~
654 include::cmds-synchingrepositories.txt[]
656 The following are helper commands used by the above; end users
657 typically do not use them directly.
659 include::cmds-synchelpers.txt[]
662 Internal helper commands
663 ~~~~~~~~~~~~~~~~~~~~~~~~
665 These are internal helper commands used by other commands; end
666 users typically do not use them directly.
668 include::cmds-purehelpers.txt[]
671 Configuration Mechanism
672 -----------------------
674 Git uses a simple text format to store customizations that are per
675 repository and are per user. Such a configuration file may look
680 # A '#' or ';' character indicates a comment.
685 ; Don't trust file modes
690 name = "Junio C Hamano"
691 email = "gitster@pobox.com"
695 Various commands read from the configuration file and adjust
696 their operation accordingly. See linkgit:git-config[1] for a
697 list and more details about the configuration mechanism.
700 Identifier Terminology
701 ----------------------
703 Indicates the object name for any type of object.
706 Indicates a blob object name.
709 Indicates a tree object name.
712 Indicates a commit object name.
715 Indicates a tree, commit or tag object name. A
716 command that takes a <tree-ish> argument ultimately wants to
717 operate on a <tree> object but automatically dereferences
718 <commit> and <tag> objects that point at a <tree>.
721 Indicates a commit or tag object name. A
722 command that takes a <commit-ish> argument ultimately wants to
723 operate on a <commit> object but automatically dereferences
724 <tag> objects that point at a <commit>.
727 Indicates that an object type is required.
728 Currently one of: `blob`, `tree`, `commit`, or `tag`.
731 Indicates a filename - almost always relative to the
732 root of the tree structure `GIT_INDEX_FILE` describes.
736 Any Git command accepting any <object> can also use the following
740 indicates the head of the current branch.
744 (i.e. a `refs/tags/<tag>` reference).
748 (i.e. a `refs/heads/<head>` reference).
750 For a more complete list of ways to spell object names, see
751 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
754 File/Directory Structure
755 ------------------------
757 Please see the linkgit:gitrepository-layout[5] document.
759 Read linkgit:githooks[5] for more details about each hook.
761 Higher level SCMs may provide and manage additional information in the
767 Please see linkgit:gitglossary[7].
770 Environment Variables
771 ---------------------
772 Various Git commands use the following environment variables:
776 These environment variables apply to 'all' core Git commands. Nb: it
777 is worth noting that they may be used/overridden by SCMS sitting above
778 Git so take care if using Cogito etc.
781 This environment allows the specification of an alternate
782 index file. If not specified, the default of `$GIT_DIR/index`
785 'GIT_INDEX_VERSION'::
786 This environment variable allows the specification of an index
787 version for new repositories. It won't affect existing index
788 files. By default index file version 2 or 3 is used. See
789 linkgit:git-update-index[1] for more information.
791 'GIT_OBJECT_DIRECTORY'::
792 If the object storage directory is specified via this
793 environment variable then the sha1 directories are created
794 underneath - otherwise the default `$GIT_DIR/objects`
797 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
798 Due to the immutable nature of Git objects, old objects can be
799 archived into shared, read-only directories. This variable
800 specifies a ":" separated (on Windows ";" separated) list
801 of Git object directories which can be used to search for Git
802 objects. New objects will not be written to these directories.
805 If the 'GIT_DIR' environment variable is set then it
806 specifies a path to use instead of the default `.git`
807 for the base of the repository.
808 The '--git-dir' command-line option also sets this value.
811 Set the path to the root of the working tree.
812 This can also be controlled by the '--work-tree' command-line
813 option and the core.worktree configuration variable.
816 Set the Git namespace; see linkgit:gitnamespaces[7] for details.
817 The '--namespace' command-line option also sets this value.
819 'GIT_CEILING_DIRECTORIES'::
820 This should be a colon-separated list of absolute paths. If
821 set, it is a list of directories that Git should not chdir up
822 into while looking for a repository directory (useful for
823 excluding slow-loading network directories). It will not
824 exclude the current working directory or a GIT_DIR set on the
825 command line or in the environment. Normally, Git has to read
826 the entries in this list and resolve any symlink that
827 might be present in order to compare them with the current
828 directory. However, if even this access is slow, you
829 can add an empty entry to the list to tell Git that the
830 subsequent entries are not symlinks and needn't be resolved;
832 'GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink'.
834 'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
835 When run in a directory that does not have ".git" repository
836 directory, Git tries to find such a directory in the parent
837 directories to find the top of the working tree, but by default it
838 does not cross filesystem boundaries. This environment variable
839 can be set to true to tell Git not to stop at filesystem
840 boundaries. Like 'GIT_CEILING_DIRECTORIES', this will not affect
841 an explicit repository directory set via 'GIT_DIR' or on the
849 'GIT_COMMITTER_NAME'::
850 'GIT_COMMITTER_EMAIL'::
851 'GIT_COMMITTER_DATE'::
853 see linkgit:git-commit-tree[1]
858 Only valid setting is "--unified=??" or "-u??" to set the
859 number of context lines shown when a unified diff is created.
860 This takes precedence over any "-U" or "--unified" option
861 value passed on the Git diff command line.
863 'GIT_EXTERNAL_DIFF'::
864 When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
865 program named by it is called, instead of the diff invocation
866 described above. For a path that is added, removed, or modified,
867 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
869 path old-file old-hex old-mode new-file new-hex new-mode
873 <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
874 contents of <old|new>,
875 <old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
876 <old|new>-mode:: are the octal representation of the file modes.
878 The file parameters can point at the user's working file
879 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
880 when a new file is added), or a temporary file (e.g. `old-file` in the
881 index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
882 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
884 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
887 For each path 'GIT_EXTERNAL_DIFF' is called, two environment variables,
888 'GIT_DIFF_PATH_COUNTER' and 'GIT_DIFF_PATH_TOTAL' are set.
890 'GIT_DIFF_PATH_COUNTER'::
891 A 1-based counter incremented by one for every path.
893 'GIT_DIFF_PATH_TOTAL'::
894 The total number of paths.
898 'GIT_MERGE_VERBOSITY'::
899 A number controlling the amount of output shown by
900 the recursive merge strategy. Overrides merge.verbosity.
901 See linkgit:git-merge[1]
904 This environment variable overrides `$PAGER`. If it is set
905 to an empty string or to the value "cat", Git will not launch
906 a pager. See also the `core.pager` option in
907 linkgit:git-config[1].
910 This environment variable overrides `$EDITOR` and `$VISUAL`.
911 It is used by several Git commands when, on interactive mode,
912 an editor is to be launched. See also linkgit:git-var[1]
913 and the `core.editor` option in linkgit:git-config[1].
917 If either of these environment variables is set then 'git fetch'
918 and 'git push' will use the specified command instead of 'ssh'
919 when they need to connect to a remote system.
920 The command will be given exactly two or four arguments: the
921 'username@host' (or just 'host') from the URL and the shell
922 command to execute on that remote system, optionally preceded by
923 '-p' (literally) and the 'port' from the URL when it specifies
924 something other than the default SSH port.
926 `$GIT_SSH_COMMAND` takes precedence over `$GIT_SSH`, and is interpreted
927 by the shell, which allows additional arguments to be included.
928 `$GIT_SSH` on the other hand must be just the path to a program
929 (which can be a wrapper shell script, if additional arguments are
932 Usually it is easier to configure any desired options through your
933 personal `.ssh/config` file. Please consult your ssh documentation
937 If this environment variable is set, then Git commands which need to
938 acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
939 will call this program with a suitable prompt as command-line argument
940 and read the password from its STDOUT. See also the 'core.askPass'
941 option in linkgit:git-config[1].
943 'GIT_TERMINAL_PROMPT'::
944 If this environment variable is set to `0`, git will not prompt
945 on the terminal (e.g., when asking for HTTP authentication).
947 'GIT_CONFIG_NOSYSTEM'::
948 Whether to skip reading settings from the system-wide
949 `$(prefix)/etc/gitconfig` file. This environment variable can
950 be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
951 predictable environment for a picky script, or you can set it
952 temporarily to avoid using a buggy `/etc/gitconfig` file while
953 waiting for someone with sufficient permissions to fix it.
956 If this environment variable is set to "1", then commands such
957 as 'git blame' (in incremental mode), 'git rev-list', 'git log',
958 'git check-attr' and 'git check-ignore' will
959 force a flush of the output stream after each record have been
961 variable is set to "0", the output of these commands will be done
962 using completely buffered I/O. If this environment variable is
963 not set, Git will choose buffered or record-oriented flushing
964 based on whether stdout appears to be redirected to a file or not.
967 Enables general trace messages, e.g. alias expansion, built-in
968 command execution and external command execution.
970 If this variable is set to "1", "2" or "true" (comparison
971 is case insensitive), trace messages will be printed to
974 If the variable is set to an integer value greater than 2
975 and lower than 10 (strictly) then Git will interpret this
976 value as an open file descriptor and will try to write the
977 trace messages into this file descriptor.
979 Alternatively, if the variable is set to an absolute path
980 (starting with a '/' character), Git will interpret this
981 as a file path and will try to write the trace messages
984 Unsetting the variable, or setting it to empty, "0" or
985 "false" (case insensitive) disables trace messages.
987 'GIT_TRACE_PACK_ACCESS'::
988 Enables trace messages for all accesses to any packs. For each
989 access, the pack file name and an offset in the pack is
990 recorded. This may be helpful for troubleshooting some
991 pack-related performance problems.
992 See 'GIT_TRACE' for available trace output options.
995 Enables trace messages for all packets coming in or out of a
996 given program. This can help with debugging object negotiation
997 or other protocol issues. Tracing is turned off at a packet
998 starting with "PACK".
999 See 'GIT_TRACE' for available trace output options.
1001 'GIT_TRACE_PERFORMANCE'::
1002 Enables performance related trace messages, e.g. total execution
1003 time of each Git command.
1004 See 'GIT_TRACE' for available trace output options.
1007 Enables trace messages printing the .git, working tree and current
1008 working directory after Git has completed its setup phase.
1009 See 'GIT_TRACE' for available trace output options.
1011 'GIT_TRACE_SHALLOW'::
1012 Enables trace messages that can help debugging fetching /
1013 cloning of shallow repositories.
1014 See 'GIT_TRACE' for available trace output options.
1016 GIT_LITERAL_PATHSPECS::
1017 Setting this variable to `1` will cause Git to treat all
1018 pathspecs literally, rather than as glob patterns. For example,
1019 running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
1020 for commits that touch the path `*.c`, not any paths that the
1021 glob `*.c` matches. You might want this if you are feeding
1022 literal paths to Git (e.g., paths previously given to you by
1023 `git ls-tree`, `--raw` diff output, etc).
1025 GIT_GLOB_PATHSPECS::
1026 Setting this variable to `1` will cause Git to treat all
1027 pathspecs as glob patterns (aka "glob" magic).
1029 GIT_NOGLOB_PATHSPECS::
1030 Setting this variable to `1` will cause Git to treat all
1031 pathspecs as literal (aka "literal" magic).
1033 GIT_ICASE_PATHSPECS::
1034 Setting this variable to `1` will cause Git to treat all
1035 pathspecs as case-insensitive.
1037 'GIT_REFLOG_ACTION'::
1038 When a ref is updated, reflog entries are created to keep
1039 track of the reason why the ref was updated (which is
1040 typically the name of the high-level command that updated
1041 the ref), in addition to the old and new values of the ref.
1042 A scripted Porcelain command can use set_reflog_action
1043 helper function in `git-sh-setup` to set its name to this
1044 variable when it is invoked as the top level command by the
1045 end user, to be recorded in the body of the reflog.
1047 `GIT_REF_PARANOIA`::
1048 If set to `1`, include broken or badly named refs when iterating
1049 over lists of refs. In a normal, non-corrupted repository, this
1050 does nothing. However, enabling it may help git to detect and
1051 abort some operations in the presence of broken refs. Git sets
1052 this variable automatically when performing destructive
1053 operations like linkgit:git-prune[1]. You should not need to set
1054 it yourself unless you want to be paranoid about making sure
1055 an operation has touched every ref (e.g., because you are
1056 cloning a repository to make a backup).
1059 Discussion[[Discussion]]
1060 ------------------------
1062 More detail on the following is available from the
1063 link:user-manual.html#git-concepts[Git concepts chapter of the
1064 user-manual] and linkgit:gitcore-tutorial[7].
1066 A Git project normally consists of a working directory with a ".git"
1067 subdirectory at the top level. The .git directory contains, among other
1068 things, a compressed object database representing the complete history
1069 of the project, an "index" file which links that history to the current
1070 contents of the working tree, and named pointers into that history such
1071 as tags and branch heads.
1073 The object database contains objects of three main types: blobs, which
1074 hold file data; trees, which point to blobs and other trees to build up
1075 directory hierarchies; and commits, which each reference a single tree
1076 and some number of parent commits.
1078 The commit, equivalent to what other systems call a "changeset" or
1079 "version", represents a step in the project's history, and each parent
1080 represents an immediately preceding step. Commits with more than one
1081 parent represent merges of independent lines of development.
1083 All objects are named by the SHA-1 hash of their contents, normally
1084 written as a string of 40 hex digits. Such names are globally unique.
1085 The entire history leading up to a commit can be vouched for by signing
1086 just that commit. A fourth object type, the tag, is provided for this
1089 When first created, objects are stored in individual files, but for
1090 efficiency may later be compressed together into "pack files".
1092 Named pointers called refs mark interesting points in history. A ref
1093 may contain the SHA-1 name of an object or the name of another ref. Refs
1094 with names beginning `ref/head/` contain the SHA-1 name of the most
1095 recent commit (or "head") of a branch under development. SHA-1 names of
1096 tags of interest are stored under `ref/tags/`. A special ref named
1097 `HEAD` contains the name of the currently checked-out branch.
1099 The index file is initialized with a list of all paths and, for each
1100 path, a blob object and a set of attributes. The blob object represents
1101 the contents of the file as of the head of the current branch. The
1102 attributes (last modified time, size, etc.) are taken from the
1103 corresponding file in the working tree. Subsequent changes to the
1104 working tree can be found by comparing these attributes. The index may
1105 be updated with new content, and new commits may be created from the
1106 content stored in the index.
1108 The index is also capable of storing multiple entries (called "stages")
1109 for a given pathname. These stages are used to hold the various
1110 unmerged version of a file when a merge is in progress.
1112 FURTHER DOCUMENTATION
1113 ---------------------
1115 See the references in the "description" section to get started
1116 using Git. The following is probably more detail than necessary
1117 for a first-time user.
1119 The link:user-manual.html#git-concepts[Git concepts chapter of the
1120 user-manual] and linkgit:gitcore-tutorial[7] both provide
1121 introductions to the underlying Git architecture.
1123 See linkgit:gitworkflows[7] for an overview of recommended workflows.
1125 See also the link:howto-index.html[howto] documents for some useful
1128 The internals are documented in the
1129 link:technical/api-index.html[Git API documentation].
1131 Users migrating from CVS may also want to
1132 read linkgit:gitcvs-migration[7].
1137 Git was started by Linus Torvalds, and is currently maintained by Junio
1138 C Hamano. Numerous contributions have come from the Git mailing list
1139 <git@vger.kernel.org>. http://www.openhub.net/p/git/contributors/summary
1140 gives you a more complete list of contributors.
1142 If you have a clone of git.git itself, the
1143 output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
1144 the authors for specific parts of the project.
1149 Report bugs to the Git mailing list <git@vger.kernel.org> where the
1150 development and maintenance is primarily done. You do not have to be
1151 subscribed to the list to send a message there.
1155 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
1156 linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
1157 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
1158 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
1159 linkgit:gitworkflows[7]
1163 Part of the linkgit:git[1] suite